MD5

This section introduces the MD5 driver APIs including terms and acronyms, supported features, software architecture, details on how to use this driver. More...

Overview

This section introduces the MD5 driver APIs including terms and acronyms, supported features, software architecture, details on how to use this driver.

MD5 function groups, enums, structures and functions.

Terms and acronyms

Terms	Details
MD5	Message-Digest Algorithm. For more information, please refer to introduction to the MD5 in Wikipedia .

Supported features

How to use this driver

• Step 1. Call hal_md5_init to() initialize the module.
• Step 2. Call hal_md5_append() to encrypt.
• Step 3. Call hal_md5_end() to get data.
• sample code:

  uint8_t *data = "abcdefghijklmnopqrstwxyz1234567";
  uint8_t digest[HAL_MD5_DIGEST_SIZE] = {0};
  hal_md5_context_t context = {0};
  hal_md5_init(&context);
  hal_md5_append(&context, data, strlen(data));
  hal_md5_end(&context, digest);

Functions
hal_md5_status_t	hal_md5_init (hal_md5_context_t *context)
	This function initializes the MD5 engine. More...
hal_md5_status_t	hal_md5_append (hal_md5_context_t *context, uint8_t *message, uint32_t length)
	This function appends data for MD5 operation. More...
hal_md5_status_t	hal_md5_end (hal_md5_context_t *context, uint8_t digest_message[HAL_MD5_DIGEST_SIZE])
	This function finishes the MD5 operation and receives the MD5 result. More...

Modules
	Define
	Enum
	Struct

Function Documentation

hal_md5_status_t hal_md5_append	(	hal_md5_context_t *	context,
		uint8_t *	message,
		uint32_t	length
	)

This function appends data for MD5 operation.

Parameters

[in]	context	is the parameter of this API, see hal_md5_context_t.
[in]	message	is the source data buffer.
[in]	length	is the length of the parameter message.

Returns

HAL_MD5_STATUS_OK, if the operation completed successfully.

Example

Sample code, please refer to How to use this driver.

hal_md5_status_t hal_md5_end	(	hal_md5_context_t *	context,
		uint8_t	digest_message[HAL_MD5_DIGEST_SIZE]
	)

This function finishes the MD5 operation and receives the MD5 result.

Parameters

[in]	context	is the parameter of this API, see hal_md5_context_t.
[out]	digest_message	is the MD5 result.

Returns

HAL_MD5_STATUS_OK, if the operation completed successfully.

Example

Sample code, please refer to How to use this driver.

hal_md5_status_t hal_md5_init

(

hal_md5_context_t *

context

)

This function initializes the MD5 engine.

Parameters

[in]

context

is the parameter of this API, see hal_md5_context_t.

Returns

HAL_MD5_STATUS_OK, if the operation completed successfully.

See also

hal_md5_init

Example

Sample code, please refer to How to use this driver.