CryptoPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / CryptoPkg / Library / BaseCryptLib / Hmac / CryptHmacSha1.c

/** @file\r
  HMAC-SHA1 Wrapper Implementation over OpenSSL.\r
\r
Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "InternalCryptLib.h"\r
#include <openssl/hmac.h>\r
\r
#define HMAC_SHA1_CTX_SIZE   sizeof(void *) * 4 + sizeof(unsigned int) + \\r
                             sizeof(unsigned char) * HMAC_MAX_MD_CBLOCK\r
\r
/**\r
  Retrieves the size, in bytes, of the context buffer required for HMAC-SHA1 operations.\r
  (NOTE: This API is deprecated.\r
         Use HmacSha1New() / HmacSha1Free() for HMAC-SHA1 Context operations.)\r
\r
  @return  The size, in bytes, of the context buffer required for HMAC-SHA1 operations.\r
\r
**/\r
UINTN\r
EFIAPI\r
HmacSha1GetContextSize (\r
  VOID\r
  )\r
{\r
  //\r
  // Retrieves the OpenSSL HMAC-SHA1 Context Size\r
  // NOTE: HMAC_CTX object was made opaque in openssl-1.1.x, here we just use the\r
  //       fixed size as a workaround to make this API work for compatibility.\r
  //       We should retire HmacSha15GetContextSize() in future, and use HmacSha1New()\r
  //       and HmacSha1Free() for context allocation and release.\r
  //\r
  return (UINTN) HMAC_SHA1_CTX_SIZE;\r
}\r
\r
/**\r
  Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA1 use.\r
\r
  @return  Pointer to the HMAC_CTX context that has been initialized.\r
           If the allocations fails, HmacSha1New() returns NULL.\r
\r
**/\r
VOID *\r
EFIAPI\r
HmacSha1New (\r
  VOID\r
  )\r
{\r
  //\r
  // Allocates & Initializes HMAC_CTX Context by OpenSSL HMAC_CTX_new()\r
  //\r
  return (VOID *) HMAC_CTX_new ();\r
}\r
\r
/**\r
  Release the specified HMAC_CTX context.\r
\r
  @param[in]  HmacSha1Ctx  Pointer to the HMAC_CTX context to be released.\r
\r
**/\r
VOID\r
EFIAPI\r
HmacSha1Free (\r
  IN  VOID  *HmacSha1Ctx\r
  )\r
{\r
  //\r
  // Free OpenSSL HMAC_CTX Context\r
  //\r
  HMAC_CTX_free ((HMAC_CTX *)HmacSha1Ctx);\r
}\r
\r
/**\r
  Initializes user-supplied memory pointed by HmacSha1Context as HMAC-SHA1 context for\r
  subsequent use.\r
\r
  If HmacSha1Context is NULL, then return FALSE.\r
\r
  @param[out]  HmacSha1Context  Pointer to HMAC-SHA1 context being initialized.\r
  @param[in]   Key              Pointer to the user-supplied key.\r
  @param[in]   KeySize          Key size in bytes.\r
\r
  @retval TRUE   HMAC-SHA1 context initialization succeeded.\r
  @retval FALSE  HMAC-SHA1 context initialization failed.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
HmacSha1Init (\r
  OUT  VOID         *HmacSha1Context,\r
  IN   CONST UINT8  *Key,\r
  IN   UINTN        KeySize\r
  )\r
{\r
  //\r
  // Check input parameters.\r
  //\r
  if (HmacSha1Context == NULL || KeySize > INT_MAX) {\r
    return FALSE;\r
  }\r
\r
  //\r
  // OpenSSL HMAC-SHA1 Context Initialization\r
  //\r
  memset(HmacSha1Context, 0, HMAC_SHA1_CTX_SIZE);\r
  if (HMAC_CTX_reset ((HMAC_CTX *)HmacSha1Context) != 1) {\r
    return FALSE;\r
  }\r
  if (HMAC_Init_ex ((HMAC_CTX *)HmacSha1Context, Key, (UINT32) KeySize, EVP_sha1(), NULL) != 1) {\r
    return FALSE;\r
  }\r
\r
  return TRUE;\r
}\r
\r
/**\r
  Makes a copy of an existing HMAC-SHA1 context.\r
\r
  If HmacSha1Context is NULL, then return FALSE.\r
  If NewHmacSha1Context is NULL, then return FALSE.\r
\r
  @param[in]  HmacSha1Context     Pointer to HMAC-SHA1 context being copied.\r
  @param[out] NewHmacSha1Context  Pointer to new HMAC-SHA1 context.\r
\r
  @retval TRUE   HMAC-SHA1 context copy succeeded.\r
  @retval FALSE  HMAC-SHA1 context copy failed.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
HmacSha1Duplicate (\r
  IN   CONST VOID  *HmacSha1Context,\r
  OUT  VOID        *NewHmacSha1Context\r
  )\r
{\r
  //\r
  // Check input parameters.\r
  //\r
  if (HmacSha1Context == NULL || NewHmacSha1Context == NULL) {\r
    return FALSE;\r
  }\r
\r
  if (HMAC_CTX_copy ((HMAC_CTX *)NewHmacSha1Context, (HMAC_CTX *)HmacSha1Context) != 1) {\r
    return FALSE;\r
  }\r
\r
  return TRUE;\r
}\r
\r
/**\r
  Digests the input data and updates HMAC-SHA1 context.\r
\r
  This function performs HMAC-SHA1 digest on a data buffer of the specified size.\r
  It can be called multiple times to compute the digest of long or discontinuous data streams.\r
  HMAC-SHA1 context should be already correctly initialized by HmacSha1Init(), and should not\r
  be finalized by HmacSha1Final(). Behavior with invalid context is undefined.\r
\r
  If HmacSha1Context is NULL, then return FALSE.\r
\r
  @param[in, out]  HmacSha1Context Pointer to the HMAC-SHA1 context.\r
  @param[in]       Data            Pointer to the buffer containing the data to be digested.\r
  @param[in]       DataSize        Size of Data buffer in bytes.\r
\r
  @retval TRUE   HMAC-SHA1 data digest succeeded.\r
  @retval FALSE  HMAC-SHA1 data digest failed.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
HmacSha1Update (\r
  IN OUT  VOID        *HmacSha1Context,\r
  IN      CONST VOID  *Data,\r
  IN      UINTN       DataSize\r
  )\r
{\r
  //\r
  // Check input parameters.\r
  //\r
  if (HmacSha1Context == NULL) {\r
    return FALSE;\r
  }\r
\r
  //\r
  // Check invalid parameters, in case that only DataLength was checked in OpenSSL\r
  //\r
  if (Data == NULL && DataSize != 0) {\r
    return FALSE;\r
  }\r
\r
  //\r
  // OpenSSL HMAC-SHA1 digest update\r
  //\r
  if (HMAC_Update ((HMAC_CTX *)HmacSha1Context, Data, DataSize) != 1) {\r
    return FALSE;\r
  }\r
\r
  return TRUE;\r
}\r
\r
/**\r
  Completes computation of the HMAC-SHA1 digest value.\r
\r
  This function completes HMAC-SHA1 digest computation and retrieves the digest value into\r
  the specified memory. After this function has been called, the HMAC-SHA1 context cannot\r
  be used again.\r
  HMAC-SHA1 context should be already correctly initialized by HmacSha1Init(), and should\r
  not be finalized by HmacSha1Final(). Behavior with invalid HMAC-SHA1 context is undefined.\r
\r
  If HmacSha1Context is NULL, then return FALSE.\r
  If HmacValue is NULL, then return FALSE.\r
\r
  @param[in, out]  HmacSha1Context  Pointer to the HMAC-SHA1 context.\r
  @param[out]      HmacValue        Pointer to a buffer that receives the HMAC-SHA1 digest\r
                                    value (20 bytes).\r
\r
  @retval TRUE   HMAC-SHA1 digest computation succeeded.\r
  @retval FALSE  HMAC-SHA1 digest computation failed.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
HmacSha1Final (\r
  IN OUT  VOID   *HmacSha1Context,\r
  OUT     UINT8  *HmacValue\r
  )\r
{\r
  UINT32  Length;\r
\r
  //\r
  // Check input parameters.\r
  //\r
  if (HmacSha1Context == NULL || HmacValue == NULL) {\r
    return FALSE;\r
  }\r
\r
  //\r
  // OpenSSL HMAC-SHA1 digest finalization\r
  //\r
  if (HMAC_Final ((HMAC_CTX *)HmacSha1Context, HmacValue, &Length) != 1) {\r
    return FALSE;\r
  }\r
  if (HMAC_CTX_reset ((HMAC_CTX *)HmacSha1Context) != 1) {\r
    return FALSE;\r
  }\r
\r
  return TRUE;\r
}\r