MCUX CLNS
MCUX Crypto Library Normal Secure
mcuxClEls_KeyManagement_Functions

Defines all functions of mcuxClEls_KeyManagement. More...

Functions

MCUXCLELS_API MCUX_CSSL_FP_PROTECTED_TYPE (mcuxClEls_Status_t) mcuxClEls_KeyDelete_Async(mcuxClEls_KeyIndex_t keyIdx)
 Deletes a key from keystore at the given index. More...
 

Variables

MCUXCLELS_API uint8_t const * pImportKey
 
MCUXCLELS_API uint8_t const size_t importKeyLength
 
MCUXCLELS_API uint8_t const size_t mcuxClEls_KeyIndex_t wrappingKeyIdx
 
MCUXCLELS_API uint8_t const size_t mcuxClEls_KeyIndex_t mcuxClEls_KeyIndex_t targetKeyIdx
 
MCUXCLELS_API mcuxClEls_KeyIndex_t exportKeyIdx
 < [in] The key used for key wrapping More...
 
MCUXCLELS_API mcuxClEls_KeyIndex_t uint8_t * pOutput
 < [out] The memory address of the exported key More...
 
MCUXCLELS_API mcuxClEls_KeyProp_tpKeyProp
 

Detailed Description

Defines all functions of mcuxClEls_KeyManagement.

Function Documentation

◆ MCUX_CSSL_FP_PROTECTED_TYPE()

MCUXCLELS_API MCUX_CSSL_FP_PROTECTED_TYPE ( mcuxClEls_Status_t  )

Deletes a key from keystore at the given index.

Deprecated type for mcuxClSession protected status codes.

Deprecated type for RSA protected status codes.

Deprecated type for error codes used by code-flow protected PKC component functions.

Deprecated type for error codes used by code-flow protected mcuxClMemory component functions.

Deprecated type for error codes used by code-flow protected Math component functions.

Deprecated type for Key component error codes, returned by functions with code-flow protection.

Deprecated type for ELS driver protected status codes.

Deprecated type for mcuxClEcc component return codes.

Exports the properties of the keys stored in the ELS internal keystore.

Exports a key from an internal key register to external storage, using a wrapping key.

Imports a key from external storage to an internal key register.

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.

Parameters
[in]keyIdxThe index of the key to be deleted
Returns
An error code that can be any error code in MCUXCLELS_STATUS_, see individual documentation for more information
Return values
MCUXCLELS_STATUS_SW_INVALID_PARAMif invalid parameters were specified
MCUXCLELS_STATUS_SW_CANNOT_INTERRUPTif a running operation prevented the request
MCUXCLELS_STATUS_OK_WAITon successful request

Call #mcuxClEls_WaitForOperation to complete the operation.

Parameters
[in]optionsOne of MCUXCLELS_KEYIMPORT_KFMT_
[in]pImportKeyPointer to the RFC3394 container of the key to be imported
[in]importKeyLengthLength of the RFC3394 container of the key to be imported
[in]wrappingKeyIdxIndex of the key wrapping key, if importing RFC3394 format
[in]targetKeyIdxThe desired key index of the imported key
Parameter properties
options.kfmt != MCUXCLELS_KEYIMPORT_KFMT_RFC3394
  • pImportKey is ignored.
  • importKeyLength is ignored.
  • wrappingKeyIdx is ignored.
  • targetKeyIdx is ignored. The unpacked key is automatically stored in key slots 0, 1.
Returns
An error code that can be any error code in MCUXCLELS_STATUS_, see individual documentation for more information
Return values
MCUXCLELS_STATUS_SW_INVALID_PARAMif invalid parameters were specified
MCUXCLELS_STATUS_SW_CANNOT_INTERRUPTif a running operation prevented the request
MCUXCLELS_STATUS_OK_WAITon successful request

Call #mcuxClEls_WaitForOperation to complete the operation.

Parameters
[in]wrappingKeyIdxThe key used for key wrapping
[in]exportKeyIdxThe key to export
[out]pOutputThe memory address of the exported key
Returns
An error code that can be any error code in MCUXCLELS_STATUS_, see individual documentation for more information
Return values
MCUXCLELS_STATUS_SW_INVALID_PARAMif invalid parameters were specified
MCUXCLELS_STATUS_SW_CANNOT_INTERRUPTif a running operation prevented the request
MCUXCLELS_STATUS_OK_WAITon successful request

Call #mcuxClEls_WaitForOperation to complete the operation.

Parameters
[in]keyIdxRequest key properties of the index defined here
[out]pKeyPropKey properties of the index provided
Returns
An error code that can be any error code in MCUXCLELS_STATUS_, see individual documentation for more information
Return values
MCUXCLELS_STATUS_SW_CANNOT_INTERRUPTif a running operation prevented the request
MCUXCLELS_STATUS_OKon successful request

Variable Documentation

◆ exportKeyIdx

< [in] The key used for key wrapping

[in] The key to export

◆ pOutput

< [out] The memory address of the exported key