#include "InternalCryptLib.h"
#include <mbedtls/md.h>

Functions
STATIC VOID *	HmacMdNew (VOID)

VOID	HmacMdFree (IN VOID *HmacMdCtx)

STATIC BOOLEAN	HmacMdSetKey (IN mbedtls_md_type_t MdType, OUT VOID HmacMdContext, IN CONST UINT8 Key, IN UINTN KeySize)

int	HmacMdGetBlockSize (mbedtls_md_type_t MdType)

STATIC BOOLEAN	HmacMdDuplicate (IN CONST mbedtls_md_type_t MdType, IN CONST VOID HmacMdContext, OUT VOID NewHmacMdContext)

STATIC BOOLEAN	HmacMdUpdate (IN OUT VOID HmacMdContext, IN CONST VOID Data, IN UINTN DataSize)

STATIC BOOLEAN	HmacMdFinal (IN OUT VOID HmacMdContext, OUT UINT8 HmacValue)

STATIC BOOLEAN	HmacMdAll (IN mbedtls_md_type_t MdType, IN CONST VOID Data, IN UINTN DataSize, IN CONST UINT8 Key, IN UINTN KeySize, OUT UINT8 *HmacValue)

VOID *EFIAPI	HmacSha256New (VOID)

VOID EFIAPI	HmacSha256Free (IN VOID *HmacSha256Ctx)

BOOLEAN EFIAPI	HmacSha256SetKey (OUT VOID HmacSha256Context, IN CONST UINT8 Key, IN UINTN KeySize)

BOOLEAN EFIAPI	HmacSha256Duplicate (IN CONST VOID HmacSha256Context, OUT VOID NewHmacSha256Context)

BOOLEAN EFIAPI	HmacSha256Update (IN OUT VOID HmacSha256Context, IN CONST VOID Data, IN UINTN DataSize)

BOOLEAN EFIAPI	HmacSha256Final (IN OUT VOID HmacSha256Context, OUT UINT8 HmacValue)

BOOLEAN EFIAPI	HmacSha256All (IN CONST VOID Data, IN UINTN DataSize, IN CONST UINT8 Key, IN UINTN KeySize, OUT UINT8 *HmacValue)

VOID *EFIAPI	HmacSha384New (VOID)

VOID EFIAPI	HmacSha384Free (IN VOID *HmacSha384Ctx)

BOOLEAN EFIAPI	HmacSha384SetKey (OUT VOID HmacSha384Context, IN CONST UINT8 Key, IN UINTN KeySize)

BOOLEAN EFIAPI	HmacSha384Duplicate (IN CONST VOID HmacSha384Context, OUT VOID NewHmacSha384Context)

BOOLEAN EFIAPI	HmacSha384Update (IN OUT VOID HmacSha384Context, IN CONST VOID Data, IN UINTN DataSize)

BOOLEAN EFIAPI	HmacSha384Final (IN OUT VOID HmacSha384Context, OUT UINT8 HmacValue)

BOOLEAN EFIAPI	HmacSha384All (IN CONST VOID Data, IN UINTN DataSize, IN CONST UINT8 Key, IN UINTN KeySize, OUT UINT8 *HmacValue)

Detailed Description

HMAC-SHA256 Wrapper Implementation over MbedTLS.

Copyright (c) 2023, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file CryptHmac.c.

Function Documentation

◆ HmacMdAll()

STATIC BOOLEAN HmacMdAll	(	IN mbedtls_md_type_t	MdType,
		IN CONST VOID *	Data,
		IN UINTN	DataSize,
		IN CONST UINT8 *	Key,
		IN UINTN	KeySize,
		OUT UINT8 *	HmacValue
	)

Computes the HMAC-MD digest of a input data buffer.

This function performs the HMAC-MD digest of a given data buffer, and places the digest value into the specified memory.

If this interface is not supported, then return FALSE.

Parameters

[in]	MdType	Message Digest Type.
[in]	Data	Pointer to the buffer containing the data to be digested.
[in]	DataSize	Size of Data buffer in bytes.
[in]	Key	Pointer to the user-supplied key.
[in]	KeySize	Key size in bytes.
[out]	HmacValue	Pointer to a buffer that receives the HMAC-MD digest value.

Return values

TRUE	HMAC-MD digest computation succeeded.
FALSE	HMAC-MD digest computation failed.
FALSE	This interface is not supported.

Definition at line 307 of file CryptHmac.c.

◆ HmacMdDuplicate()

STATIC BOOLEAN HmacMdDuplicate	(	IN CONST mbedtls_md_type_t	MdType,
		IN CONST VOID *	HmacMdContext,
		OUT VOID *	NewHmacMdContext
	)

Makes a copy of an existing HMAC-MD context.

If HmacMdContext is NULL, then return FALSE. If NewHmacMdContext is NULL, then return FALSE.

Parameters

[in]	MdType	message digest Type.
[in]	HmacMdContext	Pointer to HMAC-MD context being copied.
[out]	NewHmacMdContext	Pointer to new HMAC-MD context.

Return values

TRUE	HMAC-MD context copy succeeded.
FALSE	HMAC-MD context copy failed.

Definition at line 142 of file CryptHmac.c.

◆ HmacMdFinal()

STATIC BOOLEAN HmacMdFinal	(	IN OUT VOID *	HmacMdContext,
		OUT UINT8 *	HmacValue
	)

Completes computation of the HMAC-MD digest value.

This function completes HMAC-MD hash computation and retrieves the digest value into the specified memory. After this function has been called, the HMAC-MD context cannot be used again. HMAC-MD context should be initialized by HmacMdNew(), and should not be finalized by HmacMdFinal(). Behavior with invalid HMAC-MD context is undefined.

If HmacMdContext is NULL, then return FALSE. If HmacValue is NULL, then return FALSE.

Parameters

[in,out]	HmacMdContext	Pointer to the HMAC-MD context.
[out]	HmacValue	Pointer to a buffer that receives the HMAC-MD digest value.

Return values

TRUE	HMAC-MD digest computation succeeded.
FALSE	HMAC-MD digest computation failed.

Definition at line 260 of file CryptHmac.c.

◆ HmacMdFree()

VOID HmacMdFree ( IN VOID * HmacMdCtx )

Release the specified HMAC_CTX context.

Parameters

[in] HmacMdCtx Pointer to the HMAC_CTX context to be released.

Definition at line 42 of file CryptHmac.c.

◆ HmacMdGetBlockSize()

int HmacMdGetBlockSize ( mbedtls_md_type_t MdType )

Return block size in md_type.

Parameters

[in] MdType message digest Type.

Return values

blocksize in md_type.

Definition at line 111 of file CryptHmac.c.

◆ HmacMdNew()

STATIC VOID * HmacMdNew ( VOID )

Allocates and initializes one HMAC_CTX context for subsequent HMAC-MD use.

Returns: Pointer to the HMAC_CTX context that has been initialized. If the allocations fails, HmacShaMdNew() returns NULL.

Definition at line 21 of file CryptHmac.c.

◆ HmacMdSetKey()

STATIC BOOLEAN HmacMdSetKey	(	IN mbedtls_md_type_t	MdType,
		OUT VOID *	HmacMdContext,
		IN CONST UINT8 *	Key,
		IN UINTN	KeySize
	)

Set user-supplied key for subsequent use. It must be done before any calling to HmacMdUpdate().

If HmacMdContext is NULL, then return FALSE.

Parameters

[in]	MdType	Message Digest Type.
[out]	HmacMdContext	Pointer to HMAC-MD context.
[in]	Key	Pointer to the user-supplied key.
[in]	KeySize	Key size in bytes.

Return values

TRUE	The Key is set successfully.
FALSE	The Key is set unsuccessfully.

Definition at line 69 of file CryptHmac.c.

◆ HmacMdUpdate()

STATIC BOOLEAN HmacMdUpdate	(	IN OUT VOID *	HmacMdContext,
		IN CONST VOID *	Data,
		IN UINTN	DataSize
	)

Digests the input data and updates HMAC-MD context.

This function performs HMAC-MD digest on a data buffer of the specified size. It can be called multiple times to compute the digest of long or discontinuous data streams. HMAC-MD context should be initialized by HmacMdNew(), and should not be finalized by HmacMdFinal(). Behavior with invalid context is undefined.

If HmacMdContext is NULL, then return FALSE.

Parameters

[in,out]	HmacMdContext	Pointer to the HMAC-MD context.
[in]	Data	Pointer to the buffer containing the data to be digested.
[in]	DataSize	Size of Data buffer in bytes.

Return values

TRUE	HMAC-MD data digest succeeded.
FALSE	HMAC-MD data digest failed.

Definition at line 210 of file CryptHmac.c.

◆ HmacSha256All()

BOOLEAN EFIAPI HmacSha256All	(	IN CONST VOID *	Data,
		IN UINTN	DataSize,
		IN CONST UINT8 *	Key,
		IN UINTN	KeySize,
		OUT UINT8 *	HmacValue
	)

Computes the HMAC-SHA256 digest of a input data buffer.

This function performs the HMAC-SHA256 digest of a given data buffer, and places the digest value into the specified memory.

If this interface is not supported, then return FALSE.

Parameters

[in]	Data	Pointer to the buffer containing the data to be digested.
[in]	DataSize	Size of Data buffer in bytes.
[in]	Key	Pointer to the user-supplied key.
[in]	KeySize	Key size in bytes.
[out]	HmacValue	Pointer to a buffer that receives the HMAC-SHA256 digest value (32 bytes).

Return values

TRUE	HMAC-SHA256 digest computation succeeded.
FALSE	HMAC-SHA256 digest computation failed.
FALSE	This interface is not supported.

Definition at line 490 of file CryptHmac.c.

◆ HmacSha256Duplicate()

BOOLEAN EFIAPI HmacSha256Duplicate	(	IN CONST VOID *	HmacSha256Context,
		OUT VOID *	NewHmacSha256Context
	)

Makes a copy of an existing HMAC-SHA256 context.

If HmacSha256Context is NULL, then return FALSE. If NewHmacSha256Context is NULL, then return FALSE.

Parameters

[in]	HmacSha256Context	Pointer to HMAC-SHA256 context being copied.
[out]	NewHmacSha256Context	Pointer to new HMAC-SHA256 context.

Return values

TRUE	HMAC-SHA256 context copy succeeded.
FALSE	HMAC-SHA256 context copy failed.

Definition at line 401 of file CryptHmac.c.

◆ HmacSha256Final()

BOOLEAN EFIAPI HmacSha256Final	(	IN OUT VOID *	HmacSha256Context,
		OUT UINT8 *	HmacValue
	)

Completes computation of the HMAC-SHA256 digest value.

This function completes HMAC-SHA256 hash computation and retrieves the digest value into the specified memory. After this function has been called, the HMAC-SHA256 context cannot be used again. HMAC-SHA256 context should be initialized by HmacSha256New(), and should not be finalized by HmacSha256Final(). Behavior with invalid HMAC-SHA256 context is undefined.

If HmacSha256Context is NULL, then return FALSE. If HmacValue is NULL, then return FALSE.

Parameters

[in,out]	HmacSha256Context	Pointer to the HMAC-SHA256 context.
[out]	HmacValue	Pointer to a buffer that receives the HMAC-SHA256 digest value (32 bytes).

Return values

TRUE	HMAC-SHA256 digest computation succeeded.
FALSE	HMAC-SHA256 digest computation failed.

Definition at line 460 of file CryptHmac.c.

◆ HmacSha256Free()

VOID EFIAPI HmacSha256Free ( IN VOID * HmacSha256Ctx )

Release the specified HMAC_CTX context.

Parameters

[in] HmacSha256Ctx Pointer to the HMAC_CTX context to be released.

Definition at line 354 of file CryptHmac.c.

◆ HmacSha256New()

VOID *EFIAPI HmacSha256New ( VOID )

Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA256 use.

Returns: Pointer to the HMAC_CTX context that has been initialized. If the allocations fails, HmacSha256New() returns NULL.

Definition at line 339 of file CryptHmac.c.

◆ HmacSha256SetKey()

BOOLEAN EFIAPI HmacSha256SetKey	(	OUT VOID *	HmacSha256Context,
		IN CONST UINT8 *	Key,
		IN UINTN	KeySize
	)

Set user-supplied key for subsequent use. It must be done before any calling to HmacSha256Update().

If HmacSha256Context is NULL, then return FALSE.

Parameters

[out]	HmacSha256Context	Pointer to HMAC-SHA256 context.
[in]	Key	Pointer to the user-supplied key.
[in]	KeySize	Key size in bytes.

Return values

TRUE	The Key is set successfully.
FALSE	The Key is set unsuccessfully.

Definition at line 377 of file CryptHmac.c.

◆ HmacSha256Update()

BOOLEAN EFIAPI HmacSha256Update	(	IN OUT VOID *	HmacSha256Context,
		IN CONST VOID *	Data,
		IN UINTN	DataSize
	)

Digests the input data and updates HMAC-SHA256 context.

This function performs HMAC-SHA256 digest on a data buffer of the specified size. It can be called multiple times to compute the digest of long or discontinuous data streams. HMAC-SHA256 context should be initialized by HmacSha256New(), and should not be finalized by HmacSha256Final(). Behavior with invalid context is undefined.

If HmacSha256Context is NULL, then return FALSE.

Parameters

[in,out]	HmacSha256Context	Pointer to the HMAC-SHA256 context.
[in]	Data	Pointer to the buffer containing the data to be digested.
[in]	DataSize	Size of Data buffer in bytes.

Return values

TRUE	HMAC-SHA256 data digest succeeded.
FALSE	HMAC-SHA256 data digest failed.

Definition at line 429 of file CryptHmac.c.

◆ HmacSha384All()

BOOLEAN EFIAPI HmacSha384All	(	IN CONST VOID *	Data,
		IN UINTN	DataSize,
		IN CONST UINT8 *	Key,
		IN UINTN	KeySize,
		OUT UINT8 *	HmacValue
	)

Computes the HMAC-SHA384 digest of a input data buffer.

This function performs the HMAC-SHA384 digest of a given data buffer, and places the digest value into the specified memory.

If this interface is not supported, then return FALSE.

Parameters

[in]	Data	Pointer to the buffer containing the data to be digested.
[in]	DataSize	Size of Data buffer in bytes.
[in]	Key	Pointer to the user-supplied key.
[in]	KeySize	Key size in bytes.
[out]	HmacValue	Pointer to a buffer that receives the HMAC-SHA384 digest value (48 bytes).

Return values

TRUE	HMAC-SHA384 digest computation succeeded.
FALSE	HMAC-SHA384 digest computation failed.
FALSE	This interface is not supported.

Definition at line 669 of file CryptHmac.c.

◆ HmacSha384Duplicate()

BOOLEAN EFIAPI HmacSha384Duplicate	(	IN CONST VOID *	HmacSha384Context,
		OUT VOID *	NewHmacSha384Context
	)

Makes a copy of an existing HMAC-SHA384 context.

If HmacSha384Context is NULL, then return FALSE. If NewHmacSha384Context is NULL, then return FALSE. If this interface is not supported, then return FALSE.

Parameters

[in]	HmacSha384Context	Pointer to HMAC-SHA384 context being copied.
[out]	NewHmacSha384Context	Pointer to new HMAC-SHA384 context.

Return values

TRUE	HMAC-SHA384 context copy succeeded.
FALSE	HMAC-SHA384 context copy failed.
FALSE	This interface is not supported.

Definition at line 576 of file CryptHmac.c.

◆ HmacSha384Final()

BOOLEAN EFIAPI HmacSha384Final	(	IN OUT VOID *	HmacSha384Context,
		OUT UINT8 *	HmacValue
	)

Completes computation of the HMAC-SHA384 digest value.

This function completes HMAC-SHA384 hash computation and retrieves the digest value into the specified memory. After this function has been called, the HMAC-SHA384 context cannot be used again. HMAC-SHA384 context should be initialized by HmacSha384New(), and should not be finalized by HmacSha384Final(). Behavior with invalid HMAC-SHA384 context is undefined.

If HmacSha384Context is NULL, then return FALSE. If HmacValue is NULL, then return FALSE. If this interface is not supported, then return FALSE.

Parameters

[in,out]	HmacSha384Context	Pointer to the HMAC-SHA384 context.
[out]	HmacValue	Pointer to a buffer that receives the HMAC-SHA384 digest value (48 bytes).

Return values

TRUE	HMAC-SHA384 digest computation succeeded.
FALSE	HMAC-SHA384 digest computation failed.
FALSE	This interface is not supported.

Definition at line 639 of file CryptHmac.c.

◆ HmacSha384Free()

VOID EFIAPI HmacSha384Free ( IN VOID * HmacSha384Ctx )

Release the specified HMAC_CTX context.

Parameters

[in] HmacSha384Ctx Pointer to the HMAC_CTX context to be released.

Definition at line 525 of file CryptHmac.c.

◆ HmacSha384New()

VOID *EFIAPI HmacSha384New ( VOID )

Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA384 use.

Returns: Pointer to the HMAC_CTX context that has been initialized. If the allocations fails, HmacSha384New() returns NULL.

Definition at line 510 of file CryptHmac.c.

◆ HmacSha384SetKey()

BOOLEAN EFIAPI HmacSha384SetKey	(	OUT VOID *	HmacSha384Context,
		IN CONST UINT8 *	Key,
		IN UINTN	KeySize
	)

Set user-supplied key for subsequent use. It must be done before any calling to HmacSha384Update().

If HmacSha384Context is NULL, then return FALSE. If this interface is not supported, then return FALSE.

Parameters

[out]	HmacSha384Context	Pointer to HMAC-SHA384 context.
[in]	Key	Pointer to the user-supplied key.
[in]	KeySize	Key size in bytes.

Return values

TRUE	The Key is set successfully.
FALSE	The Key is set unsuccessfully.
FALSE	This interface is not supported.

Definition at line 550 of file CryptHmac.c.

◆ HmacSha384Update()

BOOLEAN EFIAPI HmacSha384Update	(	IN OUT VOID *	HmacSha384Context,
		IN CONST VOID *	Data,
		IN UINTN	DataSize
	)

Digests the input data and updates HMAC-SHA384 context.

This function performs HMAC-SHA384 digest on a data buffer of the specified size. It can be called multiple times to compute the digest of long or discontinuous data streams. HMAC-SHA384 context should be initialized by HmacSha384New(), and should not be finalized by HmacSha384Final(). Behavior with invalid context is undefined.

If HmacSha384Context is NULL, then return FALSE. If this interface is not supported, then return FALSE.

Parameters

[in,out]	HmacSha384Context	Pointer to the HMAC-SHA384 context.
[in]	Data	Pointer to the buffer containing the data to be digested.
[in]	DataSize	Size of Data buffer in bytes.

Return values

TRUE	HMAC-SHA384 data digest succeeded.
FALSE	HMAC-SHA384 data digest failed.
FALSE	This interface is not supported.

Definition at line 606 of file CryptHmac.c.

Functions

Detailed Description

Function Documentation

◆ HmacMdAll()

◆ HmacMdDuplicate()

◆ HmacMdFinal()

◆ HmacMdFree()

◆ HmacMdGetBlockSize()

◆ HmacMdNew()

◆ HmacMdSetKey()

◆ HmacMdUpdate()

◆ HmacSha256All()

◆ HmacSha256Duplicate()

◆ HmacSha256Final()

◆ HmacSha256Free()

◆ HmacSha256New()

◆ HmacSha256SetKey()

◆ HmacSha256Update()

◆ HmacSha384All()

◆ HmacSha384Duplicate()

◆ HmacSha384Final()

◆ HmacSha384Free()

◆ HmacSha384New()

◆ HmacSha384SetKey()

◆ HmacSha384Update()