CryptoPkg: Update HMAC Wrapper with opaque HMAC_CTX object.

OpenSSL-1.1.xx makes most data structures opaque.
This patch updated HMAC Wrapper implementation with opaque
HMAC_CTX object.
The HmacXXGetContextSize() is marked as deprecated, and updated
to use the fixed HMAC_CTX size, which is just kept for compatibility.
New APIs (HmacXXNew(), HmacXXFree()) were added  as the recommended
HMAC_CTX usage interfaces for HMAC-XXXX operations.

Cc: Ting Ye <ting.ye@intel.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Cc: Gary Lin <glin@suse.com>
Cc: Ronald Cron <ronald.cron@arm.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Qin Long <qin.long@intel.com>
Reviewed-by: Ting Ye <ting.ye@intel.com>
Tested-by: Laszlo Ersek <lersek@redhat.com>

6 files changed, 319 insertions, 28 deletions

diff --git a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacMd5.c b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacMd5.c
index 61750616c8..ff7b8e5466 100644
--- a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacMd5.c
+++ b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacMd5.c
@@ -1,7 +1,7 @@
 /** @file

   HMAC-MD5 Wrapper Implementation over OpenSSL.

 

-Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -15,8 +15,13 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include "InternalCryptLib.h"

 #include <openssl/hmac.h>

 

+#define HMAC_MD5_CTX_SIZE    sizeof(void *) * 4 + sizeof(unsigned int) + \

+                             sizeof(unsigned char) * HMAC_MAX_MD_CBLOCK

+

 /**

   Retrieves the size, in bytes, of the context buffer required for HMAC-MD5 operations.

+  (NOTE: This API is deprecated.

+         Use HmacMd5New() / HmacMd5Free() for HMAC-MD5 Context operations.)

 

   @return  The size, in bytes, of the context buffer required for HMAC-MD5 operations.

 

@@ -29,8 +34,49 @@ HmacMd5GetContextSize (
 {

   //

   // Retrieves the OpenSSL HMAC-MD5 Context Size

+  // NOTE: HMAC_CTX object was made opaque in openssl-1.1.x, here we just use the

+  //       fixed size as a workaround to make this API work for compatibility.

+  //       We should retire HmacMd5GetContextSize() in future, and use HmacMd5New()

+  //       and HmacMd5Free() for context allocation and release.

   //

-  return (UINTN) (sizeof (HMAC_CTX));

+  return (UINTN) HMAC_MD5_CTX_SIZE;

+}

+

+/**

+  Allocates and initializes one HMAC_CTX context for subsequent HMAC-MD5 use.

+

+  @return  Pointer to the HMAC_CTX context that has been initialized.

+           If the allocations fails, HmacMd5New() returns NULL.

+

+**/

+VOID *

+EFIAPI

+HmacMd5New (

+  VOID

+  )

+{

+  //

+  // Allocates & Initializes HMAC_CTX Context by OpenSSL HMAC_CTX_new()

+  //

+  return (VOID *) HMAC_CTX_new ();

+}

+

+/**

+  Release the specified HMAC_CTX context.

+

+  @param[in]  HmacMd5Ctx  Pointer to the HMAC_CTX context to be released.

+

+**/

+VOID

+EFIAPI

+HmacMd5Free (

+  IN  VOID  *HmacMd5Ctx

+  )

+{

+  //

+  // Free OpenSSL HMAC_CTX Context

+  //

+  HMAC_CTX_free ((HMAC_CTX *)HmacMd5Ctx);

 }

 

 /**

@@ -65,8 +111,13 @@ HmacMd5Init (
   //

   // OpenSSL HMAC-MD5 Context Initialization

   //

-  HMAC_CTX_init (HmacMd5Context);

-  HMAC_Init_ex (HmacMd5Context, Key, (UINT32) KeySize, EVP_md5(), NULL);

+  memset(HmacMd5Context, 0, HMAC_MD5_CTX_SIZE);

+  if (HMAC_CTX_reset ((HMAC_CTX *)HmacMd5Context) != 1) {

+    return FALSE;

+  }

+  if (HMAC_Init_ex ((HMAC_CTX *)HmacMd5Context, Key, (UINT32) KeySize, EVP_md5(), NULL) != 1) {

+    return FALSE;

+  }

 

   return TRUE;

 }

@@ -97,8 +148,10 @@ HmacMd5Duplicate (
   if (HmacMd5Context == NULL || NewHmacMd5Context == NULL) {

     return FALSE;

   }

-  

-  CopyMem (NewHmacMd5Context, HmacMd5Context, sizeof (HMAC_CTX));

+

+  if (HMAC_CTX_copy ((HMAC_CTX *)NewHmacMd5Context, (HMAC_CTX *)HmacMd5Context) != 1) {

+    return FALSE;

+  }

 

   return TRUE;

 }

@@ -146,7 +199,9 @@ HmacMd5Update (
   //

   // OpenSSL HMAC-MD5 digest update

   //

-  HMAC_Update (HmacMd5Context, Data, DataSize);

+  if (HMAC_Update ((HMAC_CTX *)HmacMd5Context, Data, DataSize) != 1) {

+    return FALSE;

+  }

 

   return TRUE;

 }

@@ -190,8 +245,12 @@ HmacMd5Final (
   //

   // OpenSSL HMAC-MD5 digest finalization

   //

-  HMAC_Final (HmacMd5Context, HmacValue, &Length);

-  HMAC_CTX_cleanup (HmacMd5Context);

+  if (HMAC_Final ((HMAC_CTX *)HmacMd5Context, HmacValue, &Length) != 1) {

+    return FALSE;

+  }

+  if (HMAC_CTX_reset ((HMAC_CTX *)HmacMd5Context) != 1) {

+    return FALSE;

+  }

 

   return TRUE;

 }

diff --git a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacMd5Null.c b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacMd5Null.c
index b4bdde0433..bfe68ab916 100644
--- a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacMd5Null.c
+++ b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacMd5Null.c
@@ -1,7 +1,7 @@
 /** @file

   HMAC-MD5 Wrapper Implementation which does not provide real capabilities.

 

-Copyright (c) 2012, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2012 - 2017, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -16,6 +16,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 

 /**

   Retrieves the size, in bytes, of the context buffer required for HMAC-MD5 operations.

+  (NOTE: This API is deprecated.

+         Use HmacMd5New() / HmacMd5Free() for HMAC-MD5 Context operations.)

 

   Return zero to indicate this interface is not supported.

 

@@ -33,6 +35,42 @@ HmacMd5GetContextSize (
 }

 

 /**

+  Allocates and initializes one HMAC_CTX context for subsequent HMAC-MD5 use.

+

+  Return NULL to indicate this interface is not supported.

+

+  @retval NULL  This interface is not supported.

+

+**/

+VOID *

+EFIAPI

+HmacMd5New (

+  VOID

+  )

+{

+  ASSERT (FALSE);

+  return NULL;

+}

+

+/**

+  Release the specified HMAC_CTX context.

+

+  This function will do nothing.

+

+  @param[in]  HmacMd5Ctx  Pointer to the HMAC_CTX context to be released.

+

+**/

+VOID

+EFIAPI

+HmacMd5Free (

+  IN  VOID  *HmacMd5Ctx

+  )

+{

+  ASSERT (FALSE);

+  return;

+}

+

+/**

   Initializes user-supplied memory pointed by HmacMd5Context as HMAC-MD5 context for

   subsequent use. 

 

diff --git a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha1.c b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha1.c
index e6602586ac..09c5867d53 100644
--- a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha1.c
+++ b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha1.c
@@ -1,7 +1,7 @@
 /** @file

   HMAC-SHA1 Wrapper Implementation over OpenSSL.

 

-Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -15,8 +15,13 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include "InternalCryptLib.h"

 #include <openssl/hmac.h>

 

+#define HMAC_SHA1_CTX_SIZE   sizeof(void *) * 4 + sizeof(unsigned int) + \

+                             sizeof(unsigned char) * HMAC_MAX_MD_CBLOCK

+

 /**

   Retrieves the size, in bytes, of the context buffer required for HMAC-SHA1 operations.

+  (NOTE: This API is deprecated.

+         Use HmacSha1New() / HmacSha1Free() for HMAC-SHA1 Context operations.)

 

   @return  The size, in bytes, of the context buffer required for HMAC-SHA1 operations.

 

@@ -29,8 +34,49 @@ HmacSha1GetContextSize (
 {

   //

   // Retrieves the OpenSSL HMAC-SHA1 Context Size

+  // NOTE: HMAC_CTX object was made opaque in openssl-1.1.x, here we just use the

+  //       fixed size as a workaround to make this API work for compatibility.

+  //       We should retire HmacSha15GetContextSize() in future, and use HmacSha1New()

+  //       and HmacSha1Free() for context allocation and release.

+  //

+  return (UINTN) HMAC_SHA1_CTX_SIZE;

+}

+

+/**

+  Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA1 use.

+

+  @return  Pointer to the HMAC_CTX context that has been initialized.

+           If the allocations fails, HmacSha1New() returns NULL.

+

+**/

+VOID *

+EFIAPI

+HmacSha1New (

+  VOID

+  )

+{

+  //

+  // Allocates & Initializes HMAC_CTX Context by OpenSSL HMAC_CTX_new()

+  //

+  return (VOID *) HMAC_CTX_new ();

+}

+

+/**

+  Release the specified HMAC_CTX context.

+

+  @param[in]  HmacSha1Ctx  Pointer to the HMAC_CTX context to be released.

+

+**/

+VOID

+EFIAPI

+HmacSha1Free (

+  IN  VOID  *HmacSha1Ctx

+  )

+{

   //

-  return (UINTN) (sizeof (HMAC_CTX));

+  // Free OpenSSL HMAC_CTX Context

+  //

+  HMAC_CTX_free ((HMAC_CTX *)HmacSha1Ctx);

 }

 

 /**

@@ -65,8 +111,13 @@ HmacSha1Init (
   //

   // OpenSSL HMAC-SHA1 Context Initialization

   //

-  HMAC_CTX_init (HmacSha1Context);

-  HMAC_Init_ex (HmacSha1Context, Key, (UINT32) KeySize, EVP_sha1(), NULL);

+  memset(HmacSha1Context, 0, HMAC_SHA1_CTX_SIZE);

+  if (HMAC_CTX_reset ((HMAC_CTX *)HmacSha1Context) != 1) {

+    return FALSE;

+  }

+  if (HMAC_Init_ex ((HMAC_CTX *)HmacSha1Context, Key, (UINT32) KeySize, EVP_sha1(), NULL) != 1) {

+    return FALSE;

+  }

 

   return TRUE;

 }

@@ -98,7 +149,9 @@ HmacSha1Duplicate (
     return FALSE;

   }

 

-  CopyMem (NewHmacSha1Context, HmacSha1Context, sizeof (HMAC_CTX));

+  if (HMAC_CTX_copy ((HMAC_CTX *)NewHmacSha1Context, (HMAC_CTX *)HmacSha1Context) != 1) {

+    return FALSE;

+  }

 

   return TRUE;

 }

@@ -146,7 +199,9 @@ HmacSha1Update (
   //

   // OpenSSL HMAC-SHA1 digest update

   //

-  HMAC_Update (HmacSha1Context, Data, DataSize);

+  if (HMAC_Update ((HMAC_CTX *)HmacSha1Context, Data, DataSize) != 1) {

+    return FALSE;

+  }

 

   return TRUE;

 }

@@ -190,8 +245,12 @@ HmacSha1Final (
   //

   // OpenSSL HMAC-SHA1 digest finalization

   //

-  HMAC_Final (HmacSha1Context, HmacValue, &Length);

-  HMAC_CTX_cleanup (HmacSha1Context);

+  if (HMAC_Final ((HMAC_CTX *)HmacSha1Context, HmacValue, &Length) != 1) {

+    return FALSE;

+  }

+  if (HMAC_CTX_reset ((HMAC_CTX *)HmacSha1Context) != 1) {

+    return FALSE;

+  }

 

   return TRUE;

 }

diff --git a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha1Null.c b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha1Null.c
index b31d0d1402..466c4885c3 100644
--- a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha1Null.c
+++ b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha1Null.c
@@ -1,7 +1,7 @@
 /** @file

   HMAC-SHA1 Wrapper Implementation which does not provide real capabilities.  

 

-Copyright (c) 2012, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2012 - 2017, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -16,6 +16,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 

 /**

   Retrieves the size, in bytes, of the context buffer required for HMAC-SHA1 operations.

+  (NOTE: This API is deprecated.

+         Use HmacSha1New() / HmacSha1Free() for HMAC-SHA1 Context operations.)

 

   Return zero to indicate this interface is not supported.

 

@@ -33,6 +35,42 @@ HmacSha1GetContextSize (
 }

 

 /**

+  Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA1 use.

+

+  Return NULL to indicate this interface is not supported.

+

+  @return  NULL  This interface is not supported..

+

+**/

+VOID *

+EFIAPI

+HmacSha1New (

+  VOID

+  )

+{

+  ASSERT (FALSE);

+  return NULL;

+}

+

+/**

+  Release the specified HMAC_CTX context.

+

+  This function will do nothing.

+

+  @param[in]  HmacSha1Ctx  Pointer to the HMAC_CTX context to be released.

+

+**/

+VOID

+EFIAPI

+HmacSha1Free (

+  IN  VOID  *HmacSha1Ctx

+  )

+{

+  ASSERT (FALSE);

+  return;

+}

+

+/**

   Initializes user-supplied memory pointed by HmacSha1Context as HMAC-SHA1 context for

   subsequent use.

 

diff --git a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c
index 7726e404f6..d6b3ae4883 100644
--- a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c
+++ b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256.c
@@ -1,7 +1,7 @@
 /** @file

   HMAC-SHA256 Wrapper Implementation over OpenSSL.

 

-Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2016 - 2017, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -15,8 +15,13 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include "InternalCryptLib.h"

 #include <openssl/hmac.h>

 

+#define HMAC_SHA256_CTX_SIZE   sizeof(void *) * 4 + sizeof(unsigned int) + \

+                               sizeof(unsigned char) * HMAC_MAX_MD_CBLOCK

+

 /**

   Retrieves the size, in bytes, of the context buffer required for HMAC-SHA256 operations.

+  (NOTE: This API is deprecated.

+         Use HmacSha256New() / HmacSha256Free() for HMAC-SHA256 Context operations.)

 

   @return  The size, in bytes, of the context buffer required for HMAC-SHA256 operations.

 

@@ -29,8 +34,49 @@ HmacSha256GetContextSize (
 {

   //

   // Retrieves the OpenSSL HMAC-SHA256 Context Size

+  // NOTE: HMAC_CTX object was made opaque in openssl-1.1.x, here we just use the

+  //       fixed size as a workaround to make this API work for compatibility.

+  //       We should retire HmacSha256GetContextSize() in future, and use HmacSha256New()

+  //       and HmacSha256Free() for context allocation and release.

+  //

+  return (UINTN)HMAC_SHA256_CTX_SIZE;

+}

+

+/**

+  Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA256 use.

+

+  @return  Pointer to the HMAC_CTX context that has been initialized.

+           If the allocations fails, HmacSha256New() returns NULL.

+

+**/

+VOID *

+EFIAPI

+HmacSha256New (

+  VOID

+  )

+{

+  //

+  // Allocates & Initializes HMAC_CTX Context by OpenSSL HMAC_CTX_new()

+  //

+  return (VOID *) HMAC_CTX_new ();

+}

+

+/**

+  Release the specified HMAC_CTX context.

+

+  @param[in]  HmacSha256Ctx  Pointer to the HMAC_CTX context to be released.

+

+**/

+VOID

+EFIAPI

+HmacSha256Free (

+  IN  VOID  *HmacSha256Ctx

+  )

+{

   //

-  return (UINTN) (sizeof (HMAC_CTX));

+  // Free OpenSSL HMAC_CTX Context

+  //

+  HMAC_CTX_free ((HMAC_CTX *)HmacSha256Ctx);

 }

 

 /**

@@ -65,8 +111,13 @@ HmacSha256Init (
   //

   // OpenSSL HMAC-SHA256 Context Initialization

   //

-  HMAC_CTX_init (HmacSha256Context);

-  HMAC_Init_ex (HmacSha256Context, Key, (UINT32) KeySize, EVP_sha256(), NULL);

+  memset(HmacSha256Context, 0, HMAC_SHA256_CTX_SIZE);

+  if (HMAC_CTX_reset ((HMAC_CTX *)HmacSha256Context) != 1) {

+    return FALSE;

+  }

+  if (HMAC_Init_ex ((HMAC_CTX *)HmacSha256Context, Key, (UINT32) KeySize, EVP_sha256(), NULL) != 1) {

+    return FALSE;

+  }

 

   return TRUE;

 }

@@ -98,7 +149,9 @@ HmacSha256Duplicate (
     return FALSE;

   }

 

-  CopyMem (NewHmacSha256Context, HmacSha256Context, sizeof (HMAC_CTX));

+  if (HMAC_CTX_copy ((HMAC_CTX *)NewHmacSha256Context, (HMAC_CTX *)HmacSha256Context) != 1) {

+    return FALSE;

+  }

 

   return TRUE;

 }

@@ -146,7 +199,9 @@ HmacSha256Update (
   //

   // OpenSSL HMAC-SHA256 digest update

   //

-  HMAC_Update (HmacSha256Context, Data, DataSize);

+  if (HMAC_Update ((HMAC_CTX *)HmacSha256Context, Data, DataSize) != 1) {

+    return FALSE;

+  }

 

   return TRUE;

 }

@@ -190,8 +245,12 @@ HmacSha256Final (
   //

   // OpenSSL HMAC-SHA256 digest finalization

   //

-  HMAC_Final (HmacSha256Context, HmacValue, &Length);

-  HMAC_CTX_cleanup (HmacSha256Context);

+  if (HMAC_Final ((HMAC_CTX *)HmacSha256Context, HmacValue, &Length) != 1) {

+    return FALSE;

+  }

+  if (HMAC_CTX_reset ((HMAC_CTX *)HmacSha256Context) != 1) {

+    return FALSE;

+  }

 

   return TRUE;

 }

diff --git a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c
index 35abddaa92..1696fa1eb9 100644
--- a/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c
+++ b/CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha256Null.c
@@ -1,7 +1,7 @@
 /** @file

   HMAC-SHA256 Wrapper Implementation which does not provide real capabilities.

 

-Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2016 - 2017, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -16,6 +16,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 

 /**

   Retrieves the size, in bytes, of the context buffer required for HMAC-SHA256 operations.

+  (NOTE: This API is deprecated.

+         Use HmacSha256New() / HmacSha256Free() for HMAC-SHA256 Context operations.)

 

   Return zero to indicate this interface is not supported.

 

@@ -33,6 +35,42 @@ HmacSha256GetContextSize (
 }

 

 /**

+  Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA256 use.

+

+  Return NULL to indicate this interface is not supported.

+

+  @return  NULL  This interface is not supported..

+

+**/

+VOID *

+EFIAPI

+HmacSha256New (

+  VOID

+  )

+{

+  ASSERT (FALSE);

+  return NULL;

+}

+

+/**

+  Release the specified HMAC_CTX context.

+

+  This function will do nothing.

+

+  @param[in]  HmacSha256Ctx  Pointer to the HMAC_CTX context to be released.

+

+**/

+VOID

+EFIAPI

+HmacSha256Free (

+  IN  VOID  *HmacSha256Ctx

+  )

+{

+  ASSERT (FALSE);

+  return;

+}

+

+/**

   Initializes user-supplied memory pointed by HmacSha256Context as HMAC-SHA256 context for

   subsequent use.