CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha1.c

   1 /** @file
   2   HMAC-SHA1 Wrapper Implementation over OpenSSL.
   3
   4 Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>
   5 This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #include "InternalCryptLib.h"
  16 #include <openssl/hmac.h>
  17
  18 /**
  19   Retrieves the size, in bytes, of the context buffer required for HMAC-SHA1 operations.
  20
  21   @return  The size, in bytes, of the context buffer required for HMAC-SHA1 operations.
  22
  23 **/
  24 UINTN
  25 EFIAPI
  26 HmacSha1GetContextSize (
  27   VOID
  28   )
  29 {
  30   //
  31   // Retrieves the OpenSSL HMAC-SHA1 Context Size
  32   //
  33   return (UINTN)(sizeof (HMAC_CTX));
  34 }
  35
  36 /**
  37   Initializes user-supplied memory pointed by HmacSha1Context as HMAC-SHA1 context for
  38   subsequent use.
  39
  40   If HmacSha1Context is NULL, then ASSERT().
  41
  42   @param[out]  HmacSha1Context  Pointer to HMAC-SHA1 context being initialized.
  43   @param[in]   Key              Pointer to the user-supplied key.
  44   @param[in]   KeySize          Key size in bytes.
  45
  46   @retval TRUE   HMAC-SHA1 context initialization succeeded.
  47   @retval FALSE  HMAC-SHA1 context initialization failed.
  48
  49 **/
  50 BOOLEAN
  51 EFIAPI
  52 HmacSha1Init (
  53   OUT  VOID         *HmacSha1Context,
  54   IN   CONST UINT8  *Key,
  55   IN   UINTN        KeySize
  56   )
  57 {
  58   //
  59   // ASSERT if HmacSha1Context is NULL.
  60   //
  61   ASSERT (HmacSha1Context != NULL);
  62
  63   //
  64   // OpenSSL HMAC-SHA1 Context Initialization
  65   //
  66   HMAC_CTX_init (HmacSha1Context);
  67   HMAC_Init_ex (HmacSha1Context, Key, (UINT32) KeySize, EVP_sha1(), NULL);
  68
  69   return TRUE;
  70 }
  71
  72 /**
  73   Makes a copy of an existing HMAC-SHA1 context.
  74
  75   If HmacSha1Context is NULL, then ASSERT().
  76   If NewHmacSha1Context is NULL, then ASSERT().
  77
  78   @param[in]  HmacSha1Context     Pointer to HMAC-SHA1 context being copied.
  79   @param[out] NewHmacSha1Context  Pointer to new HMAC-SHA1 context.
  80
  81   @retval TRUE   HMAC-SHA1 context copy succeeded.
  82   @retval FALSE  HMAC-SHA1 context copy failed.
  83
  84 **/
  85 BOOLEAN
  86 EFIAPI
  87 HmacSha1Duplicate (
  88   IN   CONST VOID  *HmacSha1Context,
  89   OUT  VOID        *NewHmacSha1Context
  90   )
  91 {
  92   CopyMem (NewHmacSha1Context, HmacSha1Context, sizeof (HMAC_CTX));
  93
  94   return TRUE;
  95 }
  96
  97 /**
  98   Digests the input data and updates HMAC-SHA1 context.
  99
 100   This function performs HMAC-SHA1 digest on a data buffer of the specified size.
 101   It can be called multiple times to compute the digest of long or discontinuous data streams.
 102   HMAC-SHA1 context should be already correctly intialized by HmacSha1Init(), and should not
 103   be finalized by HmacSha1Final(). Behavior with invalid context is undefined.
 104
 105   If HmacSha1Context is NULL, then ASSERT().
 106
 107   @param[in, out]  HmacSha1Context Pointer to the HMAC-SHA1 context.
 108   @param[in]       Data            Pointer to the buffer containing the data to be digested.
 109   @param[in]       DataSize        Size of Data buffer in bytes.
 110
 111   @retval TRUE   HMAC-SHA1 data digest succeeded.
 112   @retval FALSE  HMAC-SHA1 data digest failed.
 113
 114 **/
 115 BOOLEAN
 116 EFIAPI
 117 HmacSha1Update (
 118   IN OUT  VOID        *HmacSha1Context,
 119   IN      CONST VOID  *Data,
 120   IN      UINTN       DataSize
 121   )
 122 {
 123   //
 124   // ASSERT if HmacSha1Context is NULL
 125   //
 126   ASSERT (HmacSha1Context != NULL);
 127
 128   //
 129   // ASSERT if invalid parameters, in case that only DataLength was checked in OpenSSL
 130   //
 131   if (Data == NULL) {
 132     ASSERT (DataSize == 0);
 133   }
 134
 135   //
 136   // OpenSSL HMAC-SHA1 digest update
 137   //
 138   HMAC_Update (HmacSha1Context, Data, DataSize);
 139
 140   return TRUE;
 141 }
 142
 143 /**
 144   Completes computation of the HMAC-SHA1 digest value.
 145
 146   This function completes HMAC-SHA1 digest computation and retrieves the digest value into
 147   the specified memory. After this function has been called, the HMAC-SHA1 context cannot
 148   be used again.
 149   HMAC-SHA1 context should be already correctly intialized by HmacSha1Init(), and should
 150   not be finalized by HmacSha1Final(). Behavior with invalid HMAC-SHA1 context is undefined.
 151
 152   If HmacSha1Context is NULL, then ASSERT().
 153   If HmacValue is NULL, then ASSERT().
 154
 155   @param[in, out]  HmacSha1Context  Pointer to the HMAC-SHA1 context.
 156   @param[out]      HmacValue        Pointer to a buffer that receives the HMAC-SHA1 digest
 157                                     value (20 bytes).
 158
 159   @retval TRUE   HMAC-SHA1 digest computation succeeded.
 160   @retval FALSE  HMAC-SHA1 digest computation failed.
 161
 162 **/
 163 BOOLEAN
 164 EFIAPI
 165 HmacSha1Final (
 166   IN OUT  VOID   *HmacSha1Context,
 167   OUT     UINT8  *HmacValue
 168   )
 169 {
 170   UINT32  Length;
 171
 172   //
 173   // ASSERT if HmacSha1Context is NULL or HmacValue is NULL
 174   //
 175   ASSERT (HmacSha1Context != NULL);
 176   ASSERT (HmacValue != NULL);
 177
 178   //
 179   // OpenSSL HMAC-SHA1 digest finalization
 180   //
 181   HMAC_Final (HmacSha1Context, HmacValue, &Length);
 182   HMAC_CTX_cleanup (HmacSha1Context);
 183
 184   return TRUE;
 185 }