CryptoPkg: Update HMAC Wrapper with opaque HMAC_CTX object.

[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
index b183ae562e9390e5c1c1447e9cdfdb49e7ef7cbd..09c5867d536a0443e2e6a0e5a95d82901e29b1e5 100644 (file)
--- a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha1.c
+++ b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha1.c
@@ -1,7 +1,7 @@
 /** @file\r
   HMAC-SHA1 Wrapper Implementation over OpenSSL.\r
 \r
-Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2010 - 2017, 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
@@ -15,8 +15,13 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #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
@@ -29,8 +34,49 @@ HmacSha1GetContextSize (
 {\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) (sizeof (HMAC_CTX));\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
@@ -58,15 +104,20 @@ HmacSha1Init (
   //\r
   // Check input parameters.\r
   //\r
-  if (HmacSha1Context == NULL) {\r
+  if (HmacSha1Context == NULL || KeySize > INT_MAX) {\r
     return FALSE;\r
   }\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
+  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
@@ -98,7 +149,9 @@ HmacSha1Duplicate (
     return FALSE;\r
   }\r
 \r
-  CopyMem (NewHmacSha1Context, HmacSha1Context, sizeof (HMAC_CTX));\r
+  if (HMAC_CTX_copy ((HMAC_CTX *)NewHmacSha1Context, (HMAC_CTX *)HmacSha1Context) != 1) {\r
+    return FALSE;\r
+  }\r
 \r
   return TRUE;\r
 }\r
@@ -108,7 +161,7 @@ HmacSha1Duplicate (
 \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
+  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
@@ -146,7 +199,9 @@ HmacSha1Update (
   //\r
   // OpenSSL HMAC-SHA1 digest update\r
   //\r
-  HMAC_Update (HmacSha1Context, Data, DataSize);\r
+  if (HMAC_Update ((HMAC_CTX *)HmacSha1Context, Data, DataSize) != 1) {\r
+    return FALSE;\r
+  }\r
 \r
   return TRUE;\r
 }\r
@@ -157,7 +212,7 @@ HmacSha1Update (
   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
+  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
@@ -190,8 +245,12 @@ HmacSha1Final (
   //\r
   // OpenSSL HMAC-SHA1 digest finalization\r
   //\r
-  HMAC_Final (HmacSha1Context, HmacValue, &Length);\r
-  HMAC_CTX_cleanup (HmacSha1Context);\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