CryptoPkg: Update HMAC Wrapper with opaque HMAC_CTX object.

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

diff --git a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c
index 5d349dc0850bae5bf582b6ac0806f7df49181145..d6b3ae4883297f09d2e220487f1a736dd7493a51 100644 (file)
--- a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c
+++ b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c
@@ -1,7 +1,7 @@
 /** @file\r
   HMAC-SHA256 Wrapper Implementation over OpenSSL.\r
 \r
-Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2016 - 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_SHA256_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-SHA256 operations.\r
+  (NOTE: This API is deprecated.\r
+         Use HmacSha256New() / HmacSha256Free() for HMAC-SHA256 Context operations.)\r
 \r
   @return  The size, in bytes, of the context buffer required for HMAC-SHA256 operations.\r
 \r
@@ -29,8 +34,49 @@ HmacSha256GetContextSize (
 {\r
   //\r
   // Retrieves the OpenSSL HMAC-SHA256 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 HmacSha256GetContextSize() in future, and use HmacSha256New()\r
+  //       and HmacSha256Free() for context allocation and release.\r
+  //\r
+  return (UINTN)HMAC_SHA256_CTX_SIZE;\r
+}\r
+\r
+/**\r
+  Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA256 use.\r
+\r
+  @return  Pointer to the HMAC_CTX context that has been initialized.\r
+           If the allocations fails, HmacSha256New() returns NULL.\r
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+HmacSha256New (\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]  HmacSha256Ctx  Pointer to the HMAC_CTX context to be released.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+HmacSha256Free (\r
+  IN  VOID  *HmacSha256Ctx\r
+  )\r
+{\r
   //\r
-  return (UINTN) (sizeof (HMAC_CTX));\r
+  // Free OpenSSL HMAC_CTX Context\r
+  //\r
+  HMAC_CTX_free ((HMAC_CTX *)HmacSha256Ctx);\r
 }\r
 \r
 /**\r
@@ -65,8 +111,13 @@ HmacSha256Init (
   //\r
   // OpenSSL HMAC-SHA256 Context Initialization\r
   //\r
-  HMAC_CTX_init (HmacSha256Context);\r
-  HMAC_Init_ex (HmacSha256Context, Key, (UINT32) KeySize, EVP_sha256(), NULL);\r
+  memset(HmacSha256Context, 0, HMAC_SHA256_CTX_SIZE);\r
+  if (HMAC_CTX_reset ((HMAC_CTX *)HmacSha256Context) != 1) {\r
+    return FALSE;\r
+  }\r
+  if (HMAC_Init_ex ((HMAC_CTX *)HmacSha256Context, Key, (UINT32) KeySize, EVP_sha256(), NULL) != 1) {\r
+    return FALSE;\r
+  }\r
 \r
   return TRUE;\r
 }\r
@@ -98,7 +149,9 @@ HmacSha256Duplicate (
     return FALSE;\r
   }\r
 \r
-  CopyMem (NewHmacSha256Context, HmacSha256Context, sizeof (HMAC_CTX));\r
+  if (HMAC_CTX_copy ((HMAC_CTX *)NewHmacSha256Context, (HMAC_CTX *)HmacSha256Context) != 1) {\r
+    return FALSE;\r
+  }\r
 \r
   return TRUE;\r
 }\r
@@ -146,7 +199,9 @@ HmacSha256Update (
   //\r
   // OpenSSL HMAC-SHA256 digest update\r
   //\r
-  HMAC_Update (HmacSha256Context, Data, DataSize);\r
+  if (HMAC_Update ((HMAC_CTX *)HmacSha256Context, Data, DataSize) != 1) {\r
+    return FALSE;\r
+  }\r
 \r
   return TRUE;\r
 }\r
@@ -161,10 +216,10 @@ HmacSha256Update (
   not be finalized by HmacSha256Final(). Behavior with invalid HMAC-SHA256 context is undefined.\r
 \r
   If HmacSha256Context is NULL, then return FALSE.\r
-  If HashValue is NULL, then return FALSE.\r
+  If HmacValue is NULL, then return FALSE.\r
 \r
   @param[in, out]  HmacSha256Context  Pointer to the HMAC-SHA256 context.\r
-  @param[out]      HashValue          Pointer to a buffer that receives the HMAC-SHA256 digest\r
+  @param[out]      HmacValue          Pointer to a buffer that receives the HMAC-SHA256 digest\r
                                       value (32 bytes).\r
 \r
   @retval TRUE   HMAC-SHA256 digest computation succeeded.\r
@@ -190,8 +245,12 @@ HmacSha256Final (
   //\r
   // OpenSSL HMAC-SHA256 digest finalization\r
   //\r
-  HMAC_Final (HmacSha256Context, HmacValue, &Length);\r
-  HMAC_CTX_cleanup (HmacSha256Context);\r
+  if (HMAC_Final ((HMAC_CTX *)HmacSha256Context, HmacValue, &Length) != 1) {\r
+    return FALSE;\r
+  }\r
+  if (HMAC_CTX_reset ((HMAC_CTX *)HmacSha256Context) != 1) {\r
+    return FALSE;\r
+  }\r
 \r
   return TRUE;\r
 }\r