Defines all functions of mcuxClEls_KeyManagement. More...
Functions | |
MCUXCLELS_API mcuxClEls_Status_t | mcuxClEls_KeyDelete_Async (mcuxClEls_KeyIndex_t keyIdx) |
Deletes a key from keystore at the given index. More... | |
MCUXCLELS_API mcuxClEls_Status_t | mcuxClEls_KeyImport_Async (mcuxClEls_KeyImportOption_t options, uint8_t const *pImportKey, size_t importKeyLength, mcuxClEls_KeyIndex_t wrappingKeyIdx, mcuxClEls_KeyIndex_t targetKeyIdx) |
Imports a key from external storage to an internal key register. More... | |
MCUXCLELS_API mcuxClEls_Status_t | mcuxClEls_KeyExport_Async (mcuxClEls_KeyIndex_t wrappingKeyIdx, mcuxClEls_KeyIndex_t exportKeyIdx, uint8_t *pOutput) |
Exports a key from an internal key register to external storage, using a wrapping key. More... | |
MCUXCLELS_API mcuxClEls_Status_t | mcuxClEls_GetKeyProperties (mcuxClEls_KeyIndex_t keyIdx, mcuxClEls_KeyProp_t *pKeyProp) |
Exports the properties of the keys stored in the ELS internal keystore. More... | |
Defines all functions of mcuxClEls_KeyManagement.
MCUXCLELS_API mcuxClEls_Status_t mcuxClEls_KeyDelete_Async | ( | mcuxClEls_KeyIndex_t | keyIdx | ) |
Deletes a key from keystore at the given index.
Before execution, ELS will wait until mcuxClEls_HwState_t.drbgentlvl == MCUXCLELS_STATUS_DRBGENTLVL_LOW. This can lead to a delay if the DRBG is in a state with less security strength at the time of the call.
Call mcuxClEls_WaitForOperation to complete the operation.
[in] | keyIdx | The index of the key to be deleted |
MCUXCLELS_STATUS_SW_INVALID_PARAM | if invalid parameters were specified |
MCUXCLELS_STATUS_SW_CANNOT_INTERRUPT | if a running operation prevented the request |
MCUXCLELS_STATUS_SW_FAULT | if a failure occurred |
MCUXCLELS_STATUS_OK_WAIT | on successful request |
MCUXCLELS_API mcuxClEls_Status_t mcuxClEls_KeyImport_Async | ( | mcuxClEls_KeyImportOption_t | options, |
uint8_t const * | pImportKey, | ||
size_t | importKeyLength, | ||
mcuxClEls_KeyIndex_t | wrappingKeyIdx, | ||
mcuxClEls_KeyIndex_t | targetKeyIdx | ||
) |
Imports a key from external storage to an internal key register.
Call mcuxClEls_WaitForOperation to complete the operation.
[in] | options | One of MCUXCLELS_KEYIMPORT_KFMT_ |
[in] | pImportKey | Pointer to the RFC3394 container of the key to be imported |
[in] | importKeyLength | Length of the RFC3394 container of the key to be imported |
[in] | wrappingKeyIdx | Index of the key wrapping key, if importing RFC3394 format |
[in] | targetKeyIdx | The desired key index of the imported key |
options.kfmt
!= MCUXCLELS_KEYIMPORT_KFMT_RFC3394pImportKey
is ignored. importKeyLength
is ignored. wrappingKeyIdx
is ignored. targetKeyIdx
is ignored. The unpacked key is automatically stored in key slots 0, 1. MCUXCLELS_STATUS_SW_INVALID_PARAM | if invalid parameters were specified |
MCUXCLELS_STATUS_SW_CANNOT_INTERRUPT | if a running operation prevented the request |
MCUXCLELS_STATUS_OK_WAIT | on successful request |
MCUXCLELS_API mcuxClEls_Status_t mcuxClEls_KeyExport_Async | ( | mcuxClEls_KeyIndex_t | wrappingKeyIdx, |
mcuxClEls_KeyIndex_t | exportKeyIdx, | ||
uint8_t * | pOutput | ||
) |
Exports a key from an internal key register to external storage, using a wrapping key.
Call mcuxClEls_WaitForOperation to complete the operation.
[in] | wrappingKeyIdx | The key used for key wrapping |
[in] | exportKeyIdx | The key to export |
[out] | pOutput | The memory address of the exported key |
MCUXCLELS_STATUS_SW_INVALID_PARAM | if invalid parameters were specified |
MCUXCLELS_STATUS_SW_CANNOT_INTERRUPT | if a running operation prevented the request |
MCUXCLELS_STATUS_OK_WAIT | on successful request |
[in] | wrappingKeyIdx | The key used for key wrapping |
[in] | exportKeyIdx | The key to export |
[out] | pOutput | The memory address of the exported key |
MCUXCLELS_API mcuxClEls_Status_t mcuxClEls_GetKeyProperties | ( | mcuxClEls_KeyIndex_t | keyIdx, |
mcuxClEls_KeyProp_t * | pKeyProp | ||
) |
Exports the properties of the keys stored in the ELS internal keystore.
Call mcuxClEls_WaitForOperation to complete the operation.
[in] | keyIdx | Request key properties of the index defined here |
[out] | pKeyProp | Key properties of the index provided |
MCUXCLELS_STATUS_SW_CANNOT_INTERRUPT | if a running operation prevented the request |
MCUXCLELS_STATUS_OK | on successful request |