Rename file from CryptHmacSha256 to CryptHmac and add HmacSha384 and HmacSha256All funcitons. REF: https://bugzilla.tianocore.org/show_bug.cgi?id=4025 Signed-off-by: Qi Zhang <qi1.zhang@intel.com> 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> Reviewed-by: Jiewen Yao <jiewen.yao@intel.com>
		
			
				
	
	
		
			360 lines
		
	
	
		
			9.3 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			360 lines
		
	
	
		
			9.3 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/** @file
 | 
						|
  HMAC-SHA256/SHA384 Wrapper Implementation which does not provide real capabilities.
 | 
						|
 | 
						|
Copyright (c) 2016 - 2022, Intel Corporation. All rights reserved.<BR>
 | 
						|
SPDX-License-Identifier: BSD-2-Clause-Patent
 | 
						|
 | 
						|
**/
 | 
						|
 | 
						|
#include "InternalCryptLib.h"
 | 
						|
 | 
						|
/**
 | 
						|
  Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA256 use.
 | 
						|
 | 
						|
  Return NULL to indicate this interface is not supported.
 | 
						|
 | 
						|
  @return  NULL  This interface is not supported..
 | 
						|
 | 
						|
**/
 | 
						|
VOID *
 | 
						|
EFIAPI
 | 
						|
HmacSha256New (
 | 
						|
  VOID
 | 
						|
  )
 | 
						|
{
 | 
						|
  ASSERT (FALSE);
 | 
						|
  return NULL;
 | 
						|
}
 | 
						|
 | 
						|
/**
 | 
						|
  Release the specified HMAC_CTX context.
 | 
						|
 | 
						|
  This function will do nothing.
 | 
						|
 | 
						|
  @param[in]  HmacSha256Ctx  Pointer to the HMAC_CTX context to be released.
 | 
						|
 | 
						|
**/
 | 
						|
VOID
 | 
						|
EFIAPI
 | 
						|
HmacSha256Free (
 | 
						|
  IN  VOID  *HmacSha256Ctx
 | 
						|
  )
 | 
						|
{
 | 
						|
  ASSERT (FALSE);
 | 
						|
  return;
 | 
						|
}
 | 
						|
 | 
						|
/**
 | 
						|
  Set user-supplied key for subsequent use. It must be done before any
 | 
						|
  calling to HmacSha256Update().
 | 
						|
 | 
						|
  Return FALSE to indicate this interface is not supported.
 | 
						|
 | 
						|
  @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 FALSE  This interface is not supported.
 | 
						|
 | 
						|
**/
 | 
						|
BOOLEAN
 | 
						|
EFIAPI
 | 
						|
HmacSha256SetKey (
 | 
						|
  OUT  VOID         *HmacSha256Context,
 | 
						|
  IN   CONST UINT8  *Key,
 | 
						|
  IN   UINTN        KeySize
 | 
						|
  )
 | 
						|
{
 | 
						|
  ASSERT (FALSE);
 | 
						|
  return FALSE;
 | 
						|
}
 | 
						|
 | 
						|
/**
 | 
						|
  Makes a copy of an existing HMAC-SHA256 context.
 | 
						|
 | 
						|
  Return FALSE to indicate this interface is not supported.
 | 
						|
 | 
						|
  @param[in]  HmacSha256Context     Pointer to HMAC-SHA256 context being copied.
 | 
						|
  @param[out] NewHmacSha256Context  Pointer to new HMAC-SHA256 context.
 | 
						|
 | 
						|
  @retval FALSE  This interface is not supported.
 | 
						|
 | 
						|
**/
 | 
						|
BOOLEAN
 | 
						|
EFIAPI
 | 
						|
HmacSha256Duplicate (
 | 
						|
  IN   CONST VOID  *HmacSha256Context,
 | 
						|
  OUT  VOID        *NewHmacSha256Context
 | 
						|
  )
 | 
						|
{
 | 
						|
  ASSERT (FALSE);
 | 
						|
  return FALSE;
 | 
						|
}
 | 
						|
 | 
						|
/**
 | 
						|
  Digests the input data and updates HMAC-SHA256 context.
 | 
						|
 | 
						|
  Return FALSE to indicate this interface is not supported.
 | 
						|
 | 
						|
  @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 FALSE  This interface is not supported.
 | 
						|
 | 
						|
**/
 | 
						|
BOOLEAN
 | 
						|
EFIAPI
 | 
						|
HmacSha256Update (
 | 
						|
  IN OUT  VOID        *HmacSha256Context,
 | 
						|
  IN      CONST VOID  *Data,
 | 
						|
  IN      UINTN       DataSize
 | 
						|
  )
 | 
						|
{
 | 
						|
  ASSERT (FALSE);
 | 
						|
  return FALSE;
 | 
						|
}
 | 
						|
 | 
						|
/**
 | 
						|
  Completes computation of the HMAC-SHA256 digest value.
 | 
						|
 | 
						|
  Return FALSE to indicate this interface is not supported.
 | 
						|
 | 
						|
  @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 FALSE  This interface is not supported.
 | 
						|
 | 
						|
**/
 | 
						|
BOOLEAN
 | 
						|
EFIAPI
 | 
						|
HmacSha256Final (
 | 
						|
  IN OUT  VOID   *HmacSha256Context,
 | 
						|
  OUT     UINT8  *HmacValue
 | 
						|
  )
 | 
						|
{
 | 
						|
  ASSERT (FALSE);
 | 
						|
  return FALSE;
 | 
						|
}
 | 
						|
 | 
						|
/**
 | 
						|
  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
 | 
						|
  )
 | 
						|
{
 | 
						|
  ASSERT (FALSE);
 | 
						|
  return FALSE;
 | 
						|
}
 | 
						|
 | 
						|
/**
 | 
						|
  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
 | 
						|
  )
 | 
						|
{
 | 
						|
  ASSERT (FALSE);
 | 
						|
  return NULL;
 | 
						|
}
 | 
						|
 | 
						|
/**
 | 
						|
  Release the specified HMAC_CTX context.
 | 
						|
 | 
						|
  @param[in]  HmacSha384Ctx  Pointer to the HMAC_CTX context to be released.
 | 
						|
 | 
						|
**/
 | 
						|
VOID
 | 
						|
EFIAPI
 | 
						|
HmacSha384Free (
 | 
						|
  IN  VOID  *HmacSha384Ctx
 | 
						|
  )
 | 
						|
{
 | 
						|
  ASSERT (FALSE);
 | 
						|
  return;
 | 
						|
}
 | 
						|
 | 
						|
/**
 | 
						|
  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
 | 
						|
  )
 | 
						|
{
 | 
						|
  ASSERT (FALSE);
 | 
						|
  return FALSE;
 | 
						|
}
 | 
						|
 | 
						|
/**
 | 
						|
  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
 | 
						|
  )
 | 
						|
{
 | 
						|
  ASSERT (FALSE);
 | 
						|
  return FALSE;
 | 
						|
}
 | 
						|
 | 
						|
/**
 | 
						|
  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
 | 
						|
  )
 | 
						|
{
 | 
						|
  ASSERT (FALSE);
 | 
						|
  return FALSE;
 | 
						|
}
 | 
						|
 | 
						|
/**
 | 
						|
  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
 | 
						|
  )
 | 
						|
{
 | 
						|
  ASSERT (FALSE);
 | 
						|
  return FALSE;
 | 
						|
}
 | 
						|
 | 
						|
/**
 | 
						|
  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
 | 
						|
  )
 | 
						|
{
 | 
						|
  ASSERT (FALSE);
 | 
						|
  return FALSE;
 | 
						|
}
 |