You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
257 lines
6.7 KiB
257 lines
6.7 KiB
/** @file
|
|
HMAC-SHA256 Wrapper Implementation over OpenSSL.
|
|
|
|
Copyright (c) 2016 - 2017, Intel Corporation. All rights reserved.<BR>
|
|
This program and the accompanying materials
|
|
are licensed and made available under the terms and conditions of the BSD License
|
|
which accompanies this distribution. The full text of the license may be found at
|
|
http://opensource.org/licenses/bsd-license.php
|
|
|
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
|
|
**/
|
|
|
|
#include "InternalCryptLib.h"
|
|
#include <openssl/hmac.h>
|
|
|
|
#define HMAC_SHA256_CTX_SIZE sizeof(void *) * 4 + sizeof(unsigned int) + \
|
|
sizeof(unsigned char) * HMAC_MAX_MD_CBLOCK
|
|
|
|
/**
|
|
Retrieves the size, in bytes, of the context buffer required for HMAC-SHA256 operations.
|
|
(NOTE: This API is deprecated.
|
|
Use HmacSha256New() / HmacSha256Free() for HMAC-SHA256 Context operations.)
|
|
|
|
@return The size, in bytes, of the context buffer required for HMAC-SHA256 operations.
|
|
|
|
**/
|
|
UINTN
|
|
EFIAPI
|
|
HmacSha256GetContextSize (
|
|
VOID
|
|
)
|
|
{
|
|
//
|
|
// Retrieves the OpenSSL HMAC-SHA256 Context Size
|
|
// NOTE: HMAC_CTX object was made opaque in openssl-1.1.x, here we just use the
|
|
// fixed size as a workaround to make this API work for compatibility.
|
|
// We should retire HmacSha256GetContextSize() in future, and use HmacSha256New()
|
|
// and HmacSha256Free() for context allocation and release.
|
|
//
|
|
return (UINTN)HMAC_SHA256_CTX_SIZE;
|
|
}
|
|
|
|
/**
|
|
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
|
|
)
|
|
{
|
|
//
|
|
// Allocates & Initializes HMAC_CTX Context by OpenSSL HMAC_CTX_new()
|
|
//
|
|
return (VOID *) HMAC_CTX_new ();
|
|
}
|
|
|
|
/**
|
|
Release the specified HMAC_CTX context.
|
|
|
|
@param[in] HmacSha256Ctx Pointer to the HMAC_CTX context to be released.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
HmacSha256Free (
|
|
IN VOID *HmacSha256Ctx
|
|
)
|
|
{
|
|
//
|
|
// Free OpenSSL HMAC_CTX Context
|
|
//
|
|
HMAC_CTX_free ((HMAC_CTX *)HmacSha256Ctx);
|
|
}
|
|
|
|
/**
|
|
Initializes user-supplied memory pointed by HmacSha256Context as HMAC-SHA256 context for
|
|
subsequent use.
|
|
|
|
If HmacSha256Context is NULL, then return FALSE.
|
|
|
|
@param[out] HmacSha256Context Pointer to HMAC-SHA256 context being initialized.
|
|
@param[in] Key Pointer to the user-supplied key.
|
|
@param[in] KeySize Key size in bytes.
|
|
|
|
@retval TRUE HMAC-SHA256 context initialization succeeded.
|
|
@retval FALSE HMAC-SHA256 context initialization failed.
|
|
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
HmacSha256Init (
|
|
OUT VOID *HmacSha256Context,
|
|
IN CONST UINT8 *Key,
|
|
IN UINTN KeySize
|
|
)
|
|
{
|
|
//
|
|
// Check input parameters.
|
|
//
|
|
if (HmacSha256Context == NULL || KeySize > INT_MAX) {
|
|
return FALSE;
|
|
}
|
|
|
|
//
|
|
// OpenSSL HMAC-SHA256 Context Initialization
|
|
//
|
|
memset(HmacSha256Context, 0, HMAC_SHA256_CTX_SIZE);
|
|
if (HMAC_CTX_reset ((HMAC_CTX *)HmacSha256Context) != 1) {
|
|
return FALSE;
|
|
}
|
|
if (HMAC_Init_ex ((HMAC_CTX *)HmacSha256Context, Key, (UINT32) KeySize, EVP_sha256(), NULL) != 1) {
|
|
return FALSE;
|
|
}
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
/**
|
|
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
|
|
)
|
|
{
|
|
//
|
|
// Check input parameters.
|
|
//
|
|
if (HmacSha256Context == NULL || NewHmacSha256Context == NULL) {
|
|
return FALSE;
|
|
}
|
|
|
|
if (HMAC_CTX_copy ((HMAC_CTX *)NewHmacSha256Context, (HMAC_CTX *)HmacSha256Context) != 1) {
|
|
return FALSE;
|
|
}
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
/**
|
|
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 already correctly initialized by HmacSha256Init(), 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
|
|
)
|
|
{
|
|
//
|
|
// Check input parameters.
|
|
//
|
|
if (HmacSha256Context == NULL) {
|
|
return FALSE;
|
|
}
|
|
|
|
//
|
|
// Check invalid parameters, in case that only DataLength was checked in OpenSSL
|
|
//
|
|
if (Data == NULL && DataSize != 0) {
|
|
return FALSE;
|
|
}
|
|
|
|
//
|
|
// OpenSSL HMAC-SHA256 digest update
|
|
//
|
|
if (HMAC_Update ((HMAC_CTX *)HmacSha256Context, Data, DataSize) != 1) {
|
|
return FALSE;
|
|
}
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
/**
|
|
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 already correctly initialized by HmacSha256Init(), 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
|
|
)
|
|
{
|
|
UINT32 Length;
|
|
|
|
//
|
|
// Check input parameters.
|
|
//
|
|
if (HmacSha256Context == NULL || HmacValue == NULL) {
|
|
return FALSE;
|
|
}
|
|
|
|
//
|
|
// OpenSSL HMAC-SHA256 digest finalization
|
|
//
|
|
if (HMAC_Final ((HMAC_CTX *)HmacSha256Context, HmacValue, &Length) != 1) {
|
|
return FALSE;
|
|
}
|
|
if (HMAC_CTX_reset ((HMAC_CTX *)HmacSha256Context) != 1) {
|
|
return FALSE;
|
|
}
|
|
|
|
return TRUE;
|
|
}
|