4.4.2.1 Crypto_Hash_Shake_Init
crypto_Hash_Status_E Crypto_Hash_Shake_Init(
st_Crypto_Hash_Shake_Ctx *ptr_shakeCtx_st,
crypto_Hash_Algo_E shakeAlgorithm_en,
uint32_t digestlen,
crypto_HandlerType_E shakeHandlerType_en,
uint32_t shakeSessionId
);Description
This API is used to initiate context for SHAKE algorithms variants.
Parameters
| No. | Argument Type | Argument Name | Type | Description |
|---|---|---|---|---|
| 1 | st_Crypto_Sha_Hash_Ctx | *ptr_shakeCtx_st | Output | Hash algorithm and crypto handler selection |
| 2 | crypto_Hash_Algo_E | shakeAlgorithm_en | Input | Hash algorithm selection |
| 3 | uint32_t | digestlen | Input | Expected length of hash/digest input data in number of bytes |
| 4 | crypto_HandlerType_E | shakeHandlerType_en | Input | Input to select the crypto engine i.e., SW library or HW crypto |
| 5 | uint32_t | shakeSessionId | Input | It defines the session ID, must be more than zero |
Returns
| Return Type | Description |
|---|---|
| crypto_Hash_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_Hash_Shake_Final.