MCUX CLNS
MCUX Crypto Library Normal Secure
mcuxClKey_Functions

Defines all functions of mcuxClKey. More...

Functions

 MCUX_CSSL_FP_PROTECTED_TYPE (mcuxClKey_Status_t) mcuxClKey_init(mcuxClSession_Handle_t pSession
 Initializes a key handle. More...
 

Variables

mcuxClKey_Handle_t key
 
mcuxClKey_Handle_t mcuxClKey_Type_t type
 
mcuxClKey_Handle_t mcuxClKey_Type_t mcuxCl_InputBuffer_t pKeyData
 
mcuxClKey_Handle_t mcuxClKey_Type_t mcuxCl_InputBuffer_t uint32_t keyDataLength
 
mcuxClKey_Handle_t privKey
 
mcuxClKey_Handle_t mcuxClKey_Handle_t pubKey
 
mcuxClKey_Handle_t mcuxClKey_Protection_t protection
 
mcuxClKey_Handle_t mcuxClKey_Protection_t mcuxCl_Buffer_t pAuxData
 
mcuxClKey_Handle_t mcuxClKey_Protection_t mcuxCl_Buffer_t mcuxClKey_Handle_t parentKey
 
mcuxClKey_Handle_t uint32_t dstSlot
 
mcuxClKey_Handle_t uint32_t * dstData
 
mcuxClEls_KeyProp_tkey_properties
 

Detailed Description

Defines all functions of mcuxClKey.

Function Documentation

◆ MCUX_CSSL_FP_PROTECTED_TYPE()

MCUX_CSSL_FP_PROTECTED_TYPE ( mcuxClKey_Status_t  )

Initializes a key handle.

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.

Set the requested key properties of the destination key.

Flush key from destination which can be a key slot of coprocessor or memory buffer.

Load key into destination memory buffer.

Load key into destination key slot of a coprocessor.

Configures they protection mechanism for to the given key handle.

Establishes a key pair link between a private and public key handle.

Initializes a key handle with default protection values.

Parameters
[in]pSessionSession handle to provide session dependent information
[in,out]keyKey handle that will be initialized
[in]typeDefine which key type shall be initialized
[in]pKeyDataProvide pointer to source data of the key. This can be a pointer to a plain key buffer, a share, or a key blob. The protection function defines the purpose of this parameter
[in]keyDataLengthLength of the provided key data pKeyData
Returns
An error code that can be any error code in MCUXCLKEY_STATUS_, see individual documentation for more information
Return values
MCUXCLKEY_STATUS_ERRORon unsuccessful operation
MCUXCLKEY_STATUS_OKon successful operation
Parameters
[in]pSessionSession handle to provide session dependent information
[in,out]privKeyKey handle of private key
[in,out]pubKeyKey handle of public key
Returns
An error code that can be any error code in MCUXCLKEY_STATUS_, see individual documentation for more information
Return values
MCUXCLKEY_STATUS_ERRORon unsuccessful operation
MCUXCLKEY_STATUS_OKon successful operation
Parameters
[in]pSessionSession handle to provide session dependent information
[in,out]keyKey handle that will be configured
[in]protectionDefine the protection and flush mechanism that shall be used with this key
[in]pAuxDataProvide pointer to additional data the protection function may use
[in]parentKeyProvide parent key information in case it exists. The protection function defines the purpose of this parameter
Returns
An error code that can be any error code in MCUXCLKEY_STATUS_, see individual documentation for more information
Return values
MCUXCLKEY_STATUS_ERRORon unsuccessful operation
MCUXCLKEY_STATUS_OKon successful operation
Parameters
[in]pSessionSession handle to provide session dependent information
[in]keyKey handle that provides information to load the key
[out]dstSlotProvide destination key slot in case the key has to loaded to a key slot. The protection function defines the purpose of this parameter
Returns
An error code that can be any error code in MCUXCLKEY_STATUS_, see individual documentation for more information
Return values
MCUXCLKEY_STATUS_ERRORon unsuccessful operation
MCUXCLKEY_STATUS_OKon successful operation
Parameters
[in]pSessionSession handle to provide session dependent information
[in]keyKey handle that provides information to load the key
[out]dstDataProvide pointer to destination key memory in case the key has to be loaded to memory. The protection function defines the purpose of this parameter
Returns
An error code that can be any error code in MCUXCLKEY_STATUS_, see individual documentation for more information
Return values
MCUXCLKEY_STATUS_ERRORon unsuccessful operation
MCUXCLKEY_STATUS_OKon successful operation
Parameters
[in]pSessionSession handle to provide session dependent information
[in]keyKey handle that provides information to flush the key
Returns
An error code that can be any error code in MCUXCLKEY_STATUS_, see individual documentation for more information
Return values
MCUXCLKEY_STATUS_ERRORon unsuccessful operation
MCUXCLKEY_STATUS_OKon successful operation
Parameters
[in,out]keykey handle that provides information to flush the key
[in]key_propertiesPointer to the requested key properties of the destination key. Will be set in key->container.pAuxData
Returns
An error code that can be any error code in MCUXCLKEY_STATUS_, see individual documentation for more information
Return values
MCUXCLKEY_STATUS_ERRORon unsuccessful operation
MCUXCLKEY_STATUS_OKon successful operation