HASH processing functions in polling mode

HASH processing functions using polling mode. More...

Collaboration diagram for HASH processing functions in polling mode:

Functions
HAL_StatusTypeDef	HAL_HASH_SHA1_Start (HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t *pOutBuffer, uint32_t Timeout)
	Initialize the HASH peripheral in SHA1 mode, next process pInBuffer then read the computed digest.
HAL_StatusTypeDef	HAL_HASH_MD5_Start (HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t *pOutBuffer, uint32_t Timeout)
	Initialize the HASH peripheral in MD5 mode, next process pInBuffer then read the computed digest.
HAL_StatusTypeDef	HAL_HASH_MD5_Accmlt (HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size)
	If not already done, initialize the HASH peripheral in MD5 mode then processes pInBuffer.
HAL_StatusTypeDef	HAL_HASH_SHA1_Accmlt (HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size)
	If not already done, initialize the HASH peripheral in SHA1 mode then processes pInBuffer.
HAL_StatusTypeDef	HAL_HASH_MD5_Accmlt_End (HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t *pOutBuffer, uint32_t Timeout)
	End computation of a single HASH signature after several calls to HAL_HASH_MD5_Accmlt() API.
HAL_StatusTypeDef	HAL_HASH_SHA1_Accmlt_End (HASH_HandleTypeDef *hhash, uint8_t *pInBuffer, uint32_t Size, uint8_t *pOutBuffer, uint32_t Timeout)
	End computation of a single HASH signature after several calls to HAL_HASH_SHA1_Accmlt() API.

Detailed Description

HASH processing functions using polling mode.

 ===============================================================================
                 ##### Polling mode HASH processing functions #####
 ===============================================================================
    [..]  This section provides functions allowing to calculate in polling mode
          the hash value using one of the following algorithms:
      (+) MD5
         (++) HAL_HASH_MD5_Start()
         (++) HAL_HASH_MD5_Accmlt()
         (++) HAL_HASH_MD5_Accmlt_End()
      (+) SHA1
         (++) HAL_HASH_SHA1_Start()
         (++) HAL_HASH_SHA1_Accmlt()
         (++) HAL_HASH_SHA1_Accmlt_End()

    [..] For a single buffer to be hashed, user can resort to HAL_HASH_xxx_Start().

    [..]  In case of multi-buffer HASH processing (a single digest is computed while
          several buffers are fed to the Peripheral), the user can resort to successive calls
          to HAL_HASH_xxx_Accumulate() and wrap-up the digest computation by a call
          to HAL_HASH_xxx_Accumulate_End().

Function Documentation

HAL_HASH_SHA1_Start()

HAL_StatusTypeDef HAL_HASH_SHA1_Start	(	HASH_HandleTypeDef *	hhash,
		uint8_t *	pInBuffer,
		uint32_t	Size,
		uint8_t *	pOutBuffer,
		uint32_t	Timeout )

#include <stm32f4xx_hal_hash.h>

Initialize the HASH peripheral in SHA1 mode, next process pInBuffer then read the computed digest.

Note

Digest is available in pOutBuffer.

Parameters

hhash	HASH handle.
pInBuffer	pointer to the input buffer (buffer to be hashed).
Size	length of the input buffer in bytes.
pOutBuffer	pointer to the computed digest. Digest size is 20 bytes.
Timeout	Timeout value

Return values

HAL

status

Definition at line 827 of file stm32f4xx_hal_hash.c.

References HASH_ALGOSELECTION_SHA1, and HASH_Start().

HAL_HASH_MD5_Start()

HAL_StatusTypeDef HAL_HASH_MD5_Start	(	HASH_HandleTypeDef *	hhash,
		uint8_t *	pInBuffer,
		uint32_t	Size,
		uint8_t *	pOutBuffer,
		uint32_t	Timeout )

#include <stm32f4xx_hal_hash.h>

Initialize the HASH peripheral in MD5 mode, next process pInBuffer then read the computed digest.

Note

Digest is available in pOutBuffer.

Parameters

hhash	HASH handle.
pInBuffer	pointer to the input buffer (buffer to be hashed).
Size	length of the input buffer in bytes.
pOutBuffer	pointer to the computed digest. Digest size is 16 bytes.
Timeout	Timeout value

Return values

HAL

status

Definition at line 769 of file stm32f4xx_hal_hash.c.

References HASH_ALGOSELECTION_MD5, and HASH_Start().

HAL_HASH_MD5_Accmlt()

HAL_StatusTypeDef HAL_HASH_MD5_Accmlt	(	HASH_HandleTypeDef *	hhash,
		uint8_t *	pInBuffer,
		uint32_t	Size )

#include <stm32f4xx_hal_hash.h>

If not already done, initialize the HASH peripheral in MD5 mode then processes pInBuffer.

Note

Consecutive calls to HAL_HASH_MD5_Accmlt() can be used to feed several input buffers back-to-back to the Peripheral that will yield a single HASH signature once all buffers have been entered. Wrap-up of input buffers feeding and retrieval of digest is done by a call to HAL_HASH_MD5_Accmlt_End().

Field hhash->Phase of HASH handle is tested to check whether or not the Peripheral has already been initialized.

Digest is not retrieved by this API, user must resort to HAL_HASH_MD5_Accmlt_End() to read it, feeding at the same time the last input buffer to the Peripheral.

The input buffer size (in bytes) must be a multiple of 4 otherwise, the HASH digest computation is corrupted. Only HAL_HASH_MD5_Accmlt_End() is able to manage the ending buffer with a length in bytes not a multiple of 4.

Parameters

hhash	HASH handle.
pInBuffer	pointer to the input buffer (buffer to be hashed).
Size	length of the input buffer in bytes, must be a multiple of 4.

Return values

HAL

status

Definition at line 795 of file stm32f4xx_hal_hash.c.

References HASH_Accumulate(), and HASH_ALGOSELECTION_MD5.

HAL_HASH_SHA1_Accmlt()

HAL_StatusTypeDef HAL_HASH_SHA1_Accmlt	(	HASH_HandleTypeDef *	hhash,
		uint8_t *	pInBuffer,
		uint32_t	Size )

#include <stm32f4xx_hal_hash.h>

If not already done, initialize the HASH peripheral in SHA1 mode then processes pInBuffer.

Note

Consecutive calls to HAL_HASH_SHA1_Accmlt() can be used to feed several input buffers back-to-back to the Peripheral that will yield a single HASH signature once all buffers have been entered. Wrap-up of input buffers feeding and retrieval of digest is done by a call to HAL_HASH_SHA1_Accmlt_End().

Field hhash->Phase of HASH handle is tested to check whether or not the Peripheral has already been initialized.

Digest is not retrieved by this API, user must resort to HAL_HASH_SHA1_Accmlt_End() to read it, feeding at the same time the last input buffer to the Peripheral.

The input buffer size (in bytes) must be a multiple of 4 otherwise, the HASH digest computation is corrupted. Only HAL_HASH_SHA1_Accmlt_End() is able to manage the ending buffer with a length in bytes not a multiple of 4.

Parameters

hhash	HASH handle.
pInBuffer	pointer to the input buffer (buffer to be hashed).
Size	length of the input buffer in bytes, must be a multiple of 4.

Return values

HAL

status

Definition at line 853 of file stm32f4xx_hal_hash.c.

References HASH_Accumulate(), and HASH_ALGOSELECTION_SHA1.

HAL_HASH_MD5_Accmlt_End()

HAL_StatusTypeDef HAL_HASH_MD5_Accmlt_End	(	HASH_HandleTypeDef *	hhash,
		uint8_t *	pInBuffer,
		uint32_t	Size,
		uint8_t *	pOutBuffer,
		uint32_t	Timeout )

#include <stm32f4xx_hal_hash.h>

End computation of a single HASH signature after several calls to HAL_HASH_MD5_Accmlt() API.

Note

Digest is available in pOutBuffer.

Parameters

hhash	HASH handle.
pInBuffer	pointer to the input buffer (buffer to be hashed).
Size	length of the input buffer in bytes.
pOutBuffer	pointer to the computed digest. Digest size is 16 bytes.
Timeout	Timeout value

Return values

HAL

status

Definition at line 810 of file stm32f4xx_hal_hash.c.

References HASH_ALGOSELECTION_MD5, and HASH_Start().

HAL_HASH_SHA1_Accmlt_End()

HAL_StatusTypeDef HAL_HASH_SHA1_Accmlt_End	(	HASH_HandleTypeDef *	hhash,
		uint8_t *	pInBuffer,
		uint32_t	Size,
		uint8_t *	pOutBuffer,
		uint32_t	Timeout )

#include <stm32f4xx_hal_hash.h>

End computation of a single HASH signature after several calls to HAL_HASH_SHA1_Accmlt() API.

Note

Digest is available in pOutBuffer.

Parameters

hhash	HASH handle.
pInBuffer	pointer to the input buffer (buffer to be hashed).
Size	length of the input buffer in bytes.
pOutBuffer	pointer to the computed digest. Digest size is 20 bytes.
Timeout	Timeout value

Return values

HAL

status

Definition at line 868 of file stm32f4xx_hal_hash.c.

References HASH_ALGOSELECTION_SHA1, and HASH_Start().