mcuxClKey_Functions.h File Reference

Top-level API of the mcuxClKey component. More...

#include <mcuxClConfig.h>
#include <mcuxClSession.h>
#include <mcuxClSession_Types.h>
#include <mcuxClKey_Types.h>
#include <mcuxCsslFlowProtection.h>
#include <mcuxClCore_FunctionIdentifiers.h>

Go to the source code of this file.

Functions
mcuxClKey_Status_t	mcuxClKey_init (mcuxClSession_Handle_t session, mcuxClKey_Handle_t key, mcuxClKey_Type_t type, const uint8_t *pKeyData, uint32_t keyDataLength)
	Initializes a key handle.
void	mcuxClKey_linkKeyPair (mcuxClSession_Handle_t session, mcuxClKey_Handle_t privKey, mcuxClKey_Handle_t pubKey)
	Establishes a key pair link between a private and public key handle.
mcuxClKey_Status_t	mcuxClKey_setEncoding (mcuxClSession_Handle_t session, mcuxClKey_Handle_t key, mcuxClKey_Encoding_t encoding, const uint8_t *pAuxData, uint32_t auxDataLength)
	Configures the encoding mechanism for the given key handle.
mcuxClKey_Status_t	mcuxClKey_loadCopro (mcuxClSession_Handle_t session, mcuxClKey_Handle_t key, uint32_t loadOptions)
	Load key into destination key slot of a coprocessor.
mcuxClKey_Status_t	mcuxClKey_flush (mcuxClSession_Handle_t session, mcuxClKey_Handle_t key)
	Flush key from destination which can be a key slot of coprocessor or memory buffer.
mcuxClKey_Status_t	mcuxClKey_generate_keypair (mcuxClSession_Handle_t session, mcuxClKey_Generation_t generation, mcuxClKey_Handle_t privKey, mcuxClKey_Handle_t pubKey)
	Key-pair generation function.
mcuxClKey_Status_t	mcuxClKey_agreement (mcuxClSession_Handle_t session, mcuxClKey_Agreement_t agreement, mcuxClKey_Handle_t key, mcuxClKey_Handle_t otherKey, mcuxClKey_Agreement_AdditionalInput_t additionalInputs[], uint32_t numberOfInputs, uint8_t *pOut, uint32_t *const pOutLength)
	Key agreement function.
mcuxClKey_Status_t	mcuxClKey_encode (mcuxClSession_Handle_t session, mcuxClKey_Encoding_t encoding, mcuxClKey_Handle_t encodedKey, mcuxClKey_Type_t type, const uint8_t *pPlainKeyData, uint32_t plainKeyDataLength, const uint8_t *pAuxData, uint32_t auxDataLength, uint8_t *pEncodedKeyData, uint32_t *const pEncodedKeyDataLength)
	Key descriptor initialization function including applying a encoding mechanism.
mcuxClKey_Status_t	mcuxClKey_recode (mcuxClSession_Handle_t session, mcuxClKey_Handle_t encodedKey, mcuxClKey_Encoding_t encoding, mcuxClKey_Handle_t recodedKey, const uint8_t *pAuxData, uint32_t auxDataLength, uint8_t *pEncodedKeyData, uint32_t *const pEncodedKeyDataLength)
	Key recoding (re-encoding) function to apply a new encoding to key material.
mcuxClKey_Status_t	mcuxClKey_validate (mcuxClSession_Handle_t session, mcuxClKey_Validation_t validation, mcuxClKey_Handle_t key)
	Key validation function.

Detailed Description

Top-level API of the mcuxClKey component.

It is capable to load and flush keys into memory locations or coprocessors.