5.4.2.1 Crypto_Aead_AesEax_Init
crypto_Aead_Status_E Crypto_Aead_AesEax_Init(
st_Crypto_Aead_AesEax_ctx *ptr_aesEaxCtx_st,
crypto_HandlerType_E handlerType_en,
crypto_CipherOper_E cipherOper_en,
uint8_t *ptr_key,
uint32_t keyLen,
uint8_t *ptr_nonce,
uint32_t nonceLen,
uint8_t *ptr_aad,
uint32_t aadLen,
uint32_t sessionID
);
Description
This API is used to initiate the AES-EAX algorithm parameters for the context.
Parameters
No. | Argument Type | Argument Name | Type | Description |
---|---|---|---|---|
1 | st_Crypto_Aead_AesEax_ctx* | ptr_aesEaxCtx_st | Output | AES-EAX Algorithm context. |
2 | crypto_HandlerType_E | handlerType_en | Input | Enum for Crypto operation handler i.e., SW, HW. |
3 | crypto_CipherOper_E | cipherOper_en_en | Input | Select cipher operation, encryption or decryption. |
4 | uint8_t* | ptr_key | Input | Key for the AES-EAX cipher operation. |
5 | uint32_t | keyLen | Input | Key length in bytes for the AES-EAX algorithm. |
6 | uint8_t* | ptr_nonce | Input | Pointer for the Nonce value. |
7 | uint32_t | nonceLen | Input | Length of Nonce. |
8 | uint8_t* | ptr_aad | Input | Pointer for additional authentication data. It is optional to use, so it can be NULL also. |
9 | uint32_t | aadLen | Input | Length of additional authentication data in bytes, as it is optional so it can be 0 also. |
10 | 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. |