Mayank Gupta / Mbed OS pelion-example-frdm

Dependencies:   FXAS21002 FXOS8700Q

Embed: (wiki syntax)

« Back to documentation index

pal_plat_rot.h File Reference

pal_plat_rot.h File Reference

PAL RoT - platform. This file contains the RoT (Root of Trust) API. More...

Go to the source code of this file.

Functions

palStatus_t pal_plat_osGetRoT (uint8_t *keyBuf, size_t keyLenBytes)
 Retrieves a platform Root of Trust certificate.
palStatus_t pal_plat_osGetRoTFromHW (uint8_t *keyBuf, size_t keyLenBytes)
 Retrieves a hardware platform Root of Trust certificate.
palStatus_t pal_plat_osSetRoT (uint8_t *keyBuf, size_t keyLenBytes)
 Sets a Root of Trust certificate.

Detailed Description

PAL RoT - platform. This file contains the RoT (Root of Trust) API.

Definition in file pal_plat_rot.h.


Function Documentation

palStatus_t pal_plat_osGetRoT ( uint8_t *  keyBuf,
size_t  keyLenBytes 
)

Retrieves a platform Root of Trust certificate.

Parameters:
[in,out]*keyBufA pointer to the buffer that holds the RoT. The buffer needs to be able to hold 16 bytes of data.
[in]keyLenBytesThe size of the buffer must be 16 bytes.
Returns:
PAL_SUCCESS(0) in case of success. A negative value indicating a specific error code in case of failure.

Definition at line 23 of file pal_plat_rot_hw.c.

palStatus_t pal_plat_osGetRoTFromHW ( uint8_t *  keyBuf,
size_t  keyLenBytes 
)

Retrieves a hardware platform Root of Trust certificate.

This function must be implemented for hardware RoT configuration.

Parameters:
[in,out]*keyBufA pointer to the buffer that holds the RoT. The buffer needs to be able to hold 16 bytes of data.
[in]keyLenBytesThe size of the buffer must be 16 bytes.
Returns:
PAL_SUCCESS(0) in case of success. A negative value indicating a specific error code in case of failure.

Definition at line 25 of file pal_plat_rot_insecure.c.

palStatus_t pal_plat_osSetRoT ( uint8_t *  keyBuf,
size_t  keyLenBytes 
)

Sets a Root of Trust certificate.

The size of the Root of Trust must be 16 bytes. This function is not implemented for hardware RoT configuration.

Parameters:
[in]keyBufA 16-byte buffer with a Root of Trust key to set.
[in]keyLenBytesThe size of the buffer must be 16 bytes.
Returns:
PAL_SUCCESS in case of success and one of the following error codes in case of failure:
PAL_ERR_ITEM_EXIST - RoT key already exists.
PAL_ERR_INVALID_ARGUMENT - invalid parameter.
PAL_ERR_GENERIC_FAILURE - set operation failed.

Definition at line 74 of file pal_plat_rot_sotp.c.