]> git.proxmox.com Git - mirror_edk2.git/blobdiff - CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha1.c
Update CryptoPkg for new ciphers (HMAC, Block Cipher, etc) supports.
[mirror_edk2.git] / CryptoPkg / Library / BaseCryptLib / Hmac / CryptHmacSha1.c
diff --git a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha1.c b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha1.c
new file mode 100644 (file)
index 0000000..0298b80
--- /dev/null
@@ -0,0 +1,185 @@
+/** @file\r
+  HMAC-SHA1 Wrapper Implementation over OpenSSL.\r
+\r
+Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution.  The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#include "InternalCryptLib.h"\r
+#include <openssl/hmac.h>\r
+\r
+/**\r
+  Retrieves the size, in bytes, of the context buffer required for HMAC-SHA1 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
+  //\r
+  return (UINTN)(sizeof (HMAC_CTX));\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 ASSERT().\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
+  // ASSERT if HmacSha1Context is NULL.\r
+  //\r
+  ASSERT (HmacSha1Context != NULL);\r
+\r
+  //\r
+  // OpenSSL HMAC-SHA1 Context Initialization\r
+  //\r
+  HMAC_CTX_init (HmacSha1Context);\r
+  HMAC_Init_ex (HmacSha1Context, Key, (UINT32) KeySize, EVP_sha1(), NULL);\r
+\r
+  return TRUE;\r
+}\r
+\r
+/**\r
+  Makes a copy of an existing HMAC-SHA1 context.\r
+\r
+  If HmacSha1Context is NULL, then ASSERT().\r
+  If NewHmacSha1Context is NULL, then ASSERT().\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
+  CopyMem (NewHmacSha1Context, HmacSha1Context, sizeof (HMAC_CTX));\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 intialized by HmacSha1Init(), and should not\r
+  be finalized by HmacSha1Final(). Behavior with invalid context is undefined.\r
+\r
+  If HmacSha1Context is NULL, then ASSERT().\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
+  // ASSERT if HmacSha1Context is NULL\r
+  //\r
+  ASSERT (HmacSha1Context != NULL);\r
+\r
+  //\r
+  // ASSERT if invalid parameters, in case that only DataLength was checked in OpenSSL\r
+  //\r
+  if (Data == NULL) {\r
+    ASSERT (DataSize == 0);\r
+  }\r
+\r
+  //\r
+  // OpenSSL HMAC-SHA1 digest update\r
+  //\r
+  HMAC_Update (HmacSha1Context, Data, DataSize);\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 intialized 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 ASSERT().\r
+  If HmacValue is NULL, then ASSERT().\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
+  // ASSERT if HmacSha1Context is NULL or HmacValue is NULL\r
+  //\r
+  ASSERT (HmacSha1Context != NULL);\r
+  ASSERT (HmacValue != NULL);\r
+\r
+  //\r
+  // OpenSSL HMAC-SHA1 digest finalization\r
+  //\r
+  HMAC_Final (HmacSha1Context, HmacValue, &Length);\r
+  HMAC_CTX_cleanup (HmacSha1Context);\r
+\r
+  return TRUE;\r
+}\r