8f8372439d
* Update BaseCryptLib internal worker functions to be 'STATIC' * Update BaseCryptLib internal working functions to not use EFIAPI * Add GLOBAL_REMOVE_IF_UNREFERENCED to BaseCryptLib global variables Cc: Jiewen Yao <jiewen.yao@intel.com> Cc: Jian J Wang <jian.j.wang@intel.com> Cc: Xiaoyu Lu <xiaoyu1.lu@intel.com> Cc: Guomin Jiang <guomin.jiang@intel.com> Cc: Christopher Zurcher <christopher.zurcher@microsoft.com> Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com> Reviewed-by: Jiewen Yao <jiewen.yao@intel.com>
637 lines
17 KiB
C
637 lines
17 KiB
C
/** @file
|
|
HMAC-SHA256/SHA384 Wrapper Implementation over OpenSSL.
|
|
|
|
Copyright (c) 2016 - 2022, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#include "InternalCryptLib.h"
|
|
#include <openssl/hmac.h>
|
|
|
|
/**
|
|
Allocates and initializes one HMAC_CTX context for subsequent HMAC-MD use.
|
|
|
|
@return Pointer to the HMAC_CTX context that has been initialized.
|
|
If the allocations fails, HmacMdNew() returns NULL.
|
|
|
|
**/
|
|
STATIC
|
|
VOID *
|
|
HmacMdNew (
|
|
VOID
|
|
)
|
|
{
|
|
//
|
|
// Allocates & Initializes HMAC_CTX Context by OpenSSL HMAC_CTX_new()
|
|
//
|
|
return (VOID *)HMAC_CTX_new ();
|
|
}
|
|
|
|
/**
|
|
Release the specified HMAC_CTX context.
|
|
|
|
@param[in] HmacMdCtx Pointer to the HMAC_CTX context to be released.
|
|
|
|
**/
|
|
STATIC
|
|
VOID
|
|
HmacMdFree (
|
|
IN VOID *HmacMdCtx
|
|
)
|
|
{
|
|
//
|
|
// Free OpenSSL HMAC_CTX Context
|
|
//
|
|
HMAC_CTX_free ((HMAC_CTX *)HmacMdCtx);
|
|
}
|
|
|
|
/**
|
|
Set user-supplied key for subsequent use. It must be done before any
|
|
calling to HmacMdUpdate().
|
|
|
|
If HmacMdContext is NULL, then return FALSE.
|
|
|
|
@param[in] Md Message Digest.
|
|
@param[out] HmacMdContext Pointer to HMAC-MD context.
|
|
@param[in] Key Pointer to the user-supplied key.
|
|
@param[in] KeySize Key size in bytes.
|
|
|
|
@retval TRUE The Key is set successfully.
|
|
@retval FALSE The Key is set unsuccessfully.
|
|
|
|
**/
|
|
STATIC
|
|
BOOLEAN
|
|
HmacMdSetKey (
|
|
IN CONST EVP_MD *Md,
|
|
OUT VOID *HmacMdContext,
|
|
IN CONST UINT8 *Key,
|
|
IN UINTN KeySize
|
|
)
|
|
{
|
|
//
|
|
// Check input parameters.
|
|
//
|
|
if ((HmacMdContext == NULL) || (KeySize > INT_MAX)) {
|
|
return FALSE;
|
|
}
|
|
|
|
if (HMAC_Init_ex ((HMAC_CTX *)HmacMdContext, Key, (UINT32)KeySize, Md, NULL) != 1) {
|
|
return FALSE;
|
|
}
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
/**
|
|
Makes a copy of an existing HMAC-MD context.
|
|
|
|
If HmacMdContext is NULL, then return FALSE.
|
|
If NewHmacMdContext is NULL, then return FALSE.
|
|
|
|
@param[in] HmacMdContext Pointer to HMAC-MD context being copied.
|
|
@param[out] NewHmacMdContext Pointer to new HMAC-MD context.
|
|
|
|
@retval TRUE HMAC-MD context copy succeeded.
|
|
@retval FALSE HMAC-MD context copy failed.
|
|
|
|
**/
|
|
STATIC
|
|
BOOLEAN
|
|
HmacMdDuplicate (
|
|
IN CONST VOID *HmacMdContext,
|
|
OUT VOID *NewHmacMdContext
|
|
)
|
|
{
|
|
//
|
|
// Check input parameters.
|
|
//
|
|
if ((HmacMdContext == NULL) || (NewHmacMdContext == NULL)) {
|
|
return FALSE;
|
|
}
|
|
|
|
if (HMAC_CTX_copy ((HMAC_CTX *)NewHmacMdContext, (HMAC_CTX *)HmacMdContext) != 1) {
|
|
return FALSE;
|
|
}
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
/**
|
|
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.
|
|
|
|
@param[in, out] HmacMdContext Pointer to the HMAC-MD context.
|
|
@param[in] Data Pointer to the buffer containing the data to be digested.
|
|
@param[in] DataSize Size of Data buffer in bytes.
|
|
|
|
@retval TRUE HMAC-MD data digest succeeded.
|
|
@retval FALSE HMAC-MD data digest failed.
|
|
|
|
**/
|
|
STATIC
|
|
BOOLEAN
|
|
HmacMdUpdate (
|
|
IN OUT VOID *HmacMdContext,
|
|
IN CONST VOID *Data,
|
|
IN UINTN DataSize
|
|
)
|
|
{
|
|
//
|
|
// Check input parameters.
|
|
//
|
|
if (HmacMdContext == NULL) {
|
|
return FALSE;
|
|
}
|
|
|
|
//
|
|
// Check invalid parameters, in case that only DataLength was checked in OpenSSL
|
|
//
|
|
if ((Data == NULL) && (DataSize != 0)) {
|
|
return FALSE;
|
|
}
|
|
|
|
//
|
|
// OpenSSL HMAC-MD digest update
|
|
//
|
|
if (HMAC_Update ((HMAC_CTX *)HmacMdContext, Data, DataSize) != 1) {
|
|
return FALSE;
|
|
}
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
/**
|
|
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.
|
|
|
|
@param[in, out] HmacMdContext Pointer to the HMAC-MD context.
|
|
@param[out] HmacValue Pointer to a buffer that receives the HMAC-MD digest
|
|
value.
|
|
|
|
@retval TRUE HMAC-MD digest computation succeeded.
|
|
@retval FALSE HMAC-MD digest computation failed.
|
|
|
|
**/
|
|
STATIC
|
|
BOOLEAN
|
|
HmacMdFinal (
|
|
IN OUT VOID *HmacMdContext,
|
|
OUT UINT8 *HmacValue
|
|
)
|
|
{
|
|
UINT32 Length;
|
|
|
|
//
|
|
// Check input parameters.
|
|
//
|
|
if ((HmacMdContext == NULL) || (HmacValue == NULL)) {
|
|
return FALSE;
|
|
}
|
|
|
|
//
|
|
// OpenSSL HMAC-MD digest finalization
|
|
//
|
|
if (HMAC_Final ((HMAC_CTX *)HmacMdContext, HmacValue, &Length) != 1) {
|
|
return FALSE;
|
|
}
|
|
|
|
if (HMAC_CTX_reset ((HMAC_CTX *)HmacMdContext) != 1) {
|
|
return FALSE;
|
|
}
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
/**
|
|
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.
|
|
|
|
@param[in] Md Message Digest.
|
|
@param[in] Data Pointer to the buffer containing the data to be digested.
|
|
@param[in] DataSize Size of Data buffer in bytes.
|
|
@param[in] Key Pointer to the user-supplied key.
|
|
@param[in] KeySize Key size in bytes.
|
|
@param[out] HmacValue Pointer to a buffer that receives the HMAC-MD digest
|
|
value.
|
|
|
|
@retval TRUE HMAC-MD digest computation succeeded.
|
|
@retval FALSE HMAC-MD digest computation failed.
|
|
@retval FALSE This interface is not supported.
|
|
|
|
**/
|
|
STATIC
|
|
BOOLEAN
|
|
HmacMdAll (
|
|
IN CONST EVP_MD *Md,
|
|
IN CONST VOID *Data,
|
|
IN UINTN DataSize,
|
|
IN CONST UINT8 *Key,
|
|
IN UINTN KeySize,
|
|
OUT UINT8 *HmacValue
|
|
)
|
|
{
|
|
UINT32 Length;
|
|
HMAC_CTX *Ctx;
|
|
BOOLEAN RetVal;
|
|
|
|
Ctx = HMAC_CTX_new ();
|
|
if (Ctx == NULL) {
|
|
return FALSE;
|
|
}
|
|
|
|
RetVal = (BOOLEAN)HMAC_CTX_reset (Ctx);
|
|
if (!RetVal) {
|
|
goto Done;
|
|
}
|
|
|
|
RetVal = (BOOLEAN)HMAC_Init_ex (Ctx, Key, (UINT32)KeySize, Md, NULL);
|
|
if (!RetVal) {
|
|
goto Done;
|
|
}
|
|
|
|
RetVal = (BOOLEAN)HMAC_Update (Ctx, Data, DataSize);
|
|
if (!RetVal) {
|
|
goto Done;
|
|
}
|
|
|
|
RetVal = (BOOLEAN)HMAC_Final (Ctx, HmacValue, &Length);
|
|
if (!RetVal) {
|
|
goto Done;
|
|
}
|
|
|
|
Done:
|
|
HMAC_CTX_free (Ctx);
|
|
|
|
return RetVal;
|
|
}
|
|
|
|
/**
|
|
Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA256 use.
|
|
|
|
@return Pointer to the HMAC_CTX context that has been initialized.
|
|
If the allocations fails, HmacSha256New() returns NULL.
|
|
|
|
**/
|
|
VOID *
|
|
EFIAPI
|
|
HmacSha256New (
|
|
VOID
|
|
)
|
|
{
|
|
return HmacMdNew ();
|
|
}
|
|
|
|
/**
|
|
Release the specified HMAC_CTX context.
|
|
|
|
@param[in] HmacSha256Ctx Pointer to the HMAC_CTX context to be released.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
HmacSha256Free (
|
|
IN VOID *HmacSha256Ctx
|
|
)
|
|
{
|
|
HmacMdFree (HmacSha256Ctx);
|
|
}
|
|
|
|
/**
|
|
Set user-supplied key for subsequent use. It must be done before any
|
|
calling to HmacSha256Update().
|
|
|
|
If HmacSha256Context is NULL, then return FALSE.
|
|
|
|
@param[out] HmacSha256Context Pointer to HMAC-SHA256 context.
|
|
@param[in] Key Pointer to the user-supplied key.
|
|
@param[in] KeySize Key size in bytes.
|
|
|
|
@retval TRUE The Key is set successfully.
|
|
@retval FALSE The Key is set unsuccessfully.
|
|
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
HmacSha256SetKey (
|
|
OUT VOID *HmacSha256Context,
|
|
IN CONST UINT8 *Key,
|
|
IN UINTN KeySize
|
|
)
|
|
{
|
|
return HmacMdSetKey (EVP_sha256 (), HmacSha256Context, Key, KeySize);
|
|
}
|
|
|
|
/**
|
|
Makes a copy of an existing HMAC-SHA256 context.
|
|
|
|
If HmacSha256Context is NULL, then return FALSE.
|
|
If NewHmacSha256Context is NULL, then return FALSE.
|
|
|
|
@param[in] HmacSha256Context Pointer to HMAC-SHA256 context being copied.
|
|
@param[out] NewHmacSha256Context Pointer to new HMAC-SHA256 context.
|
|
|
|
@retval TRUE HMAC-SHA256 context copy succeeded.
|
|
@retval FALSE HMAC-SHA256 context copy failed.
|
|
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
HmacSha256Duplicate (
|
|
IN CONST VOID *HmacSha256Context,
|
|
OUT VOID *NewHmacSha256Context
|
|
)
|
|
{
|
|
return HmacMdDuplicate (HmacSha256Context, NewHmacSha256Context);
|
|
}
|
|
|
|
/**
|
|
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.
|
|
|
|
@param[in, out] HmacSha256Context Pointer to the HMAC-SHA256 context.
|
|
@param[in] Data Pointer to the buffer containing the data to be digested.
|
|
@param[in] DataSize Size of Data buffer in bytes.
|
|
|
|
@retval TRUE HMAC-SHA256 data digest succeeded.
|
|
@retval FALSE HMAC-SHA256 data digest failed.
|
|
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
HmacSha256Update (
|
|
IN OUT VOID *HmacSha256Context,
|
|
IN CONST VOID *Data,
|
|
IN UINTN DataSize
|
|
)
|
|
{
|
|
return HmacMdUpdate (HmacSha256Context, Data, DataSize);
|
|
}
|
|
|
|
/**
|
|
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.
|
|
|
|
@param[in, out] HmacSha256Context Pointer to the HMAC-SHA256 context.
|
|
@param[out] HmacValue Pointer to a buffer that receives the HMAC-SHA256 digest
|
|
value (32 bytes).
|
|
|
|
@retval TRUE HMAC-SHA256 digest computation succeeded.
|
|
@retval FALSE HMAC-SHA256 digest computation failed.
|
|
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
HmacSha256Final (
|
|
IN OUT VOID *HmacSha256Context,
|
|
OUT UINT8 *HmacValue
|
|
)
|
|
{
|
|
return HmacMdFinal (HmacSha256Context, 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.
|
|
|
|
@param[in] Data Pointer to the buffer containing the data to be digested.
|
|
@param[in] DataSize Size of Data buffer in bytes.
|
|
@param[in] Key Pointer to the user-supplied key.
|
|
@param[in] KeySize Key size in bytes.
|
|
@param[out] HmacValue Pointer to a buffer that receives the HMAC-SHA256 digest
|
|
value (32 bytes).
|
|
|
|
@retval TRUE HMAC-SHA256 digest computation succeeded.
|
|
@retval FALSE HMAC-SHA256 digest computation failed.
|
|
@retval FALSE This interface is not supported.
|
|
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
HmacSha256All (
|
|
IN CONST VOID *Data,
|
|
IN UINTN DataSize,
|
|
IN CONST UINT8 *Key,
|
|
IN UINTN KeySize,
|
|
OUT UINT8 *HmacValue
|
|
)
|
|
{
|
|
return HmacMdAll (EVP_sha256 (), Data, DataSize, Key, KeySize, HmacValue);
|
|
}
|
|
|
|
/**
|
|
Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA384 use.
|
|
|
|
@return Pointer to the HMAC_CTX context that has been initialized.
|
|
If the allocations fails, HmacSha384New() returns NULL.
|
|
|
|
**/
|
|
VOID *
|
|
EFIAPI
|
|
HmacSha384New (
|
|
VOID
|
|
)
|
|
{
|
|
return HmacMdNew ();
|
|
}
|
|
|
|
/**
|
|
Release the specified HMAC_CTX context.
|
|
|
|
@param[in] HmacSha384Ctx Pointer to the HMAC_CTX context to be released.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
HmacSha384Free (
|
|
IN VOID *HmacSha384Ctx
|
|
)
|
|
{
|
|
HmacMdFree (HmacSha384Ctx);
|
|
}
|
|
|
|
/**
|
|
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.
|
|
|
|
@param[out] HmacSha384Context Pointer to HMAC-SHA384 context.
|
|
@param[in] Key Pointer to the user-supplied key.
|
|
@param[in] KeySize Key size in bytes.
|
|
|
|
@retval TRUE The Key is set successfully.
|
|
@retval FALSE The Key is set unsuccessfully.
|
|
@retval FALSE This interface is not supported.
|
|
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
HmacSha384SetKey (
|
|
OUT VOID *HmacSha384Context,
|
|
IN CONST UINT8 *Key,
|
|
IN UINTN KeySize
|
|
)
|
|
{
|
|
return HmacMdSetKey (EVP_sha384 (), HmacSha384Context, Key, KeySize);
|
|
}
|
|
|
|
/**
|
|
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.
|
|
|
|
@param[in] HmacSha384Context Pointer to HMAC-SHA384 context being copied.
|
|
@param[out] NewHmacSha384Context Pointer to new HMAC-SHA384 context.
|
|
|
|
@retval TRUE HMAC-SHA384 context copy succeeded.
|
|
@retval FALSE HMAC-SHA384 context copy failed.
|
|
@retval FALSE This interface is not supported.
|
|
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
HmacSha384Duplicate (
|
|
IN CONST VOID *HmacSha384Context,
|
|
OUT VOID *NewHmacSha384Context
|
|
)
|
|
{
|
|
return HmacMdDuplicate (HmacSha384Context, NewHmacSha384Context);
|
|
}
|
|
|
|
/**
|
|
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.
|
|
|
|
@param[in, out] HmacSha384Context Pointer to the HMAC-SHA384 context.
|
|
@param[in] Data Pointer to the buffer containing the data to be digested.
|
|
@param[in] DataSize Size of Data buffer in bytes.
|
|
|
|
@retval TRUE HMAC-SHA384 data digest succeeded.
|
|
@retval FALSE HMAC-SHA384 data digest failed.
|
|
@retval FALSE This interface is not supported.
|
|
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
HmacSha384Update (
|
|
IN OUT VOID *HmacSha384Context,
|
|
IN CONST VOID *Data,
|
|
IN UINTN DataSize
|
|
)
|
|
{
|
|
return HmacMdUpdate (HmacSha384Context, Data, DataSize);
|
|
}
|
|
|
|
/**
|
|
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.
|
|
|
|
@param[in, out] HmacSha384Context Pointer to the HMAC-SHA384 context.
|
|
@param[out] HmacValue Pointer to a buffer that receives the HMAC-SHA384 digest
|
|
value (48 bytes).
|
|
|
|
@retval TRUE HMAC-SHA384 digest computation succeeded.
|
|
@retval FALSE HMAC-SHA384 digest computation failed.
|
|
@retval FALSE This interface is not supported.
|
|
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
HmacSha384Final (
|
|
IN OUT VOID *HmacSha384Context,
|
|
OUT UINT8 *HmacValue
|
|
)
|
|
{
|
|
return HmacMdFinal (HmacSha384Context, 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.
|
|
|
|
@param[in] Data Pointer to the buffer containing the data to be digested.
|
|
@param[in] DataSize Size of Data buffer in bytes.
|
|
@param[in] Key Pointer to the user-supplied key.
|
|
@param[in] KeySize Key size in bytes.
|
|
@param[out] HmacValue Pointer to a buffer that receives the HMAC-SHA384 digest
|
|
value (48 bytes).
|
|
|
|
@retval TRUE HMAC-SHA384 digest computation succeeded.
|
|
@retval FALSE HMAC-SHA384 digest computation failed.
|
|
@retval FALSE This interface is not supported.
|
|
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
HmacSha384All (
|
|
IN CONST VOID *Data,
|
|
IN UINTN DataSize,
|
|
IN CONST UINT8 *Key,
|
|
IN UINTN KeySize,
|
|
OUT UINT8 *HmacValue
|
|
)
|
|
{
|
|
return HmacMdAll (EVP_sha384 (), Data, DataSize, Key, KeySize, HmacValue);
|
|
}
|