Defines all functions of mcuxClKey.
More...
|
mcuxClKey_Status_t | mcuxClKey_init (mcuxClSession_Handle_t pSession, mcuxClKey_Handle_t key, mcuxClKey_Type_t type, const uint8_t *pKeyData, uint32_t keyDataLength) |
| Initializes a key handle.
|
|
mcuxClKey_Status_t | mcuxClKey_linkKeyPair (mcuxClSession_Handle_t pSession, mcuxClKey_Handle_t privKey, mcuxClKey_Handle_t pubKey) |
| Establishes a key pair link between a private and public key handle.
|
|
mcuxClKey_Status_t | mcuxClKey_setProtection (mcuxClSession_Handle_t pSession, mcuxClKey_Handle_t key, mcuxClKey_Protection_t protection, uint8_t *pAuxData, mcuxClKey_Handle_t parentKey) |
| Configures they protection mechanism for to the given key handle.
|
|
mcuxClKey_Status_t | mcuxClKey_loadCopro (mcuxClSession_Handle_t pSession, mcuxClKey_Handle_t key, uint32_t dstSlot) |
| Load key into destination key slot of a coprocessor.
|
|
mcuxClKey_Status_t | mcuxClKey_loadMemory (mcuxClSession_Handle_t pSession, mcuxClKey_Handle_t key, uint32_t *dstData) |
| Load key into destination memory buffer.
|
|
mcuxClKey_Status_t | mcuxClKey_flush (mcuxClSession_Handle_t pSession, mcuxClKey_Handle_t key) |
| Flush key from destination which can be a key slot of coprocessor or memory buffer.
|
|
mcuxClKey_Status_t | mcuxClKey_setKeyproperties (mcuxClKey_Handle_t key, mcuxClEls_KeyProp_t *key_properties) |
| Set the requested key properties of the destination key.
|
|
Defines all functions of mcuxClKey.
◆ mcuxClKey_init()
Initializes a key handle.
Initializes a key handle with default protection values.
- Parameters
-
[in] | pSession | Session handle to provide session dependent information |
[in,out] | key | Key handle that will be initialized |
[in] | type | Define which key type shall be initialized |
[in] | pKeyData | Provide pointer to source data of the key. This can be a pointer to a plain key, a share, or a key blob. The protection function defines the purpose of this parameter |
[in] | keyDataLength | Length 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
-
- Examples
- mcuxClEcc_EdDSA_Ed25519_example.c, mcuxClEcc_EdDSA_Ed25519ctx_example.c, mcuxClEcc_EdDSA_Ed25519ph_example.c, mcuxClEcc_EdDSA_GenerateSignature_Ed25519_example.c, mcuxClEcc_EdDSA_VerifySignature_Ed25519_example.c, mcuxClEcc_MontDH_Curve25519_example.c, and mcuxClEcc_MontDH_Curve448_example.c.
◆ mcuxClKey_linkKeyPair()
Establishes a key pair link between a private and public key handle.
- Parameters
-
[in] | pSession | Session handle to provide session dependent information |
[in,out] | privKey | Key handle of private key |
[in,out] | pubKey | Key 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_setProtection()
Configures they protection mechanism for to the given key handle.
- Parameters
-
[in] | pSession | Session handle to provide session dependent information |
[in,out] | key | Key handle that will be configured |
[in] | protection | Define the protection and flush mechanism that shall be used with this key |
[in] | pAuxData | Provide pointer to additional data the protection function may use |
[in] | parentKey | Provide 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_loadCopro()
Load key into destination key slot of a coprocessor.
- Parameters
-
[in] | pSession | Session handle to provide session dependent information |
[in] | key | Key handle that provides information to load the key |
[out] | dstSlot | Provide 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_loadMemory()
Load key into destination memory buffer.
- Parameters
-
[in] | pSession | Session handle to provide session dependent information |
[in] | key | Key handle that provides information to load the key |
[out] | dstData | Provide 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_flush()
Flush key from destination which can be a key slot of coprocessor or memory buffer.
- Parameters
-
[in] | pSession | Session handle to provide session dependent information |
[in] | key | Key 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
-
- Examples
- mcuxClKey_example.c, and mcuxClMacModes_Els_Cmac_Aes128_Oneshot_Example.c.
◆ mcuxClKey_setKeyproperties()
Set the requested key properties of the destination key.
- Parameters
-
[in,out] | key | key handle that provides information to flush the key |
[in] | key_properties | Pointer 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
-