2.3.2.1 Crypto_Aead_AesCcm_Init

crypto_Aead_Status_E Crypto_Aead_AesCcm_Init(
    st_Crypto_Aead_AesCcm_ctx *ptr_aesCcmCtx_st, 
    crypto_HandlerType_E handlerType_en, 
    uint8_t *ptr_key, 
    uint32_t keyLen, 
    uint32_t sessionID
    );

Description

This API is used to initiate the AES-CCM algorithm parameters for the context.

Parameters


No.	Argument Type	Argument Name	Type	Description
1	st_Crypto_Aead_AesCcm_ctx*	ptr_aesCcmCtx_st	Output	AES-CCM algorithm context
2	crypto_HandlerType_E	handlerType_en	Input	Enum for crypto operation handler i.e., SW, HW
3	uint8_t*	ptr_key	Input	Key for the AES-CCM cipher operation
4	uint32_t	keyLen	Input	Key length in bytes for the AES-CCM algorithm
5	uint32_t	sessionID	Input	It defines the session ID, must be more than zero

Returns


Return Type	Description
crypto_Aead_Status_E	Function returns the status of the API.

Prerequisites

To use the HW handler, the algorithm must be enabled in Crypto v4 in MPLAB® Code Configurator.
To use the SW handler, the algorithm must be enabled in wolfCrypt, and linked to Crypto V4 in MPLAB® Code Configurator.

Example

Example provided in Crypto_Aead_AesCcm_Cipher.