CryptoPkg: Add xxxxHashAll APIs to facilitate the digest computation

[mirror_edk2.git] / CryptoPkg / Library / BaseCryptLib / Hash / CryptSha1.c

diff --git a/CryptoPkg/Library/BaseCryptLib/Hash/CryptSha1.c b/CryptoPkg/Library/BaseCryptLib/Hash/CryptSha1.c
index 27526bcd404a834a438818dd59cfa285935ec271..b8a6d0cda0472adc034f5aab728243f62ddf5096 100644 (file)
--- a/CryptoPkg/Library/BaseCryptLib/Hash/CryptSha1.c
+++ b/CryptoPkg/Library/BaseCryptLib/Hash/CryptSha1.c
@@ -1,7 +1,7 @@
 /** @file\r
   SHA-1 Digest Wrapper Implementation over OpenSSL.\r
 \r
-Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2009 - 2016, 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
@@ -31,14 +31,14 @@ Sha1GetContextSize (
   //\r
   // Retrieves OpenSSL SHA Context Size\r
   //\r
-  return (UINTN)(sizeof (SHA_CTX));\r
+  return (UINTN) (sizeof (SHA_CTX));\r
 }\r
 \r
 /**\r
   Initializes user-supplied memory pointed by Sha1Context as SHA-1 hash context for\r
   subsequent use.\r
 \r
-  If Sha1Context is NULL, then ASSERT().\r
+  If Sha1Context is NULL, then return FALSE.\r
 \r
   @param[out]  Sha1Context  Pointer to SHA-1 context being initialized.\r
 \r
@@ -53,21 +53,23 @@ Sha1Init (
   )\r
 {\r
   //\r
-  // ASSERT if Sha1Context is NULL\r
+  // Check input parameters.\r
   //\r
-  ASSERT (Sha1Context != NULL);\r
+  if (Sha1Context == NULL) {\r
+    return FALSE;\r
+  }\r
 \r
   //\r
   // OpenSSL SHA-1 Context Initialization\r
   //\r
-  return (BOOLEAN) (SHA1_Init ((SHA_CTX *)Sha1Context));\r
+  return (BOOLEAN) (SHA1_Init ((SHA_CTX *) Sha1Context));\r
 }\r
 \r
 /**\r
   Makes a copy of an existing SHA-1 context.\r
 \r
-  If Sha1Context is NULL, then ASSERT().\r
-  If NewSha1Context is NULL, then ASSERT().\r
+  If Sha1Context is NULL, then return FALSE.\r
+  If NewSha1Context is NULL, then return FALSE.\r
 \r
   @param[in]  Sha1Context     Pointer to SHA-1 context being copied.\r
   @param[out] NewSha1Context  Pointer to new SHA-1 context.\r
@@ -84,10 +86,11 @@ Sha1Duplicate (
   )\r
 {\r
   //\r
-  // ASSERT if Sha1Context or NewSha1Context is NULL.\r
+  // Check input parameters.\r
   //\r
-  ASSERT (Sha1Context    != NULL);\r
-  ASSERT (NewSha1Context != NULL);\r
+  if (Sha1Context == NULL || NewSha1Context == NULL) {\r
+    return FALSE;\r
+  }\r
 \r
   CopyMem (NewSha1Context, Sha1Context, sizeof (SHA_CTX));\r
 \r
@@ -102,7 +105,7 @@ Sha1Duplicate (
   SHA-1 context should be already correctly intialized by Sha1Init(), and should not be finalized\r
   by Sha1Final(). Behavior with invalid context is undefined.\r
 \r
-  If Sha1Context is NULL, then ASSERT().\r
+  If Sha1Context is NULL, then return FALSE.\r
 \r
   @param[in, out]  Sha1Context  Pointer to the SHA-1 context.\r
   @param[in]       Data         Pointer to the buffer containing the data to be hashed.\r
@@ -121,21 +124,23 @@ Sha1Update (
   )\r
 {\r
   //\r
-  // ASSERT if Sha1Context is NULL\r
+  // Check input parameters.\r
   //\r
-  ASSERT (Sha1Context != NULL);\r
+  if (Sha1Context == NULL) {\r
+    return FALSE;\r
+  }\r
 \r
   //\r
-  // ASSERT if invalid parameters, in case that only DataLength was checked in OpenSSL\r
+  // Check invalid parameters, in case that only DataLength was checked in OpenSSL\r
   //\r
-  if (Data == NULL) {\r
-    ASSERT (DataSize == 0);\r
+  if (Data == NULL && DataSize != 0) {\r
+    return FALSE;\r
   }\r
 \r
   //\r
   // OpenSSL SHA-1 Hash Update\r
   //\r
-  return (BOOLEAN) (SHA1_Update ((SHA_CTX *)Sha1Context, Data, DataSize));\r
+  return (BOOLEAN) (SHA1_Update ((SHA_CTX *) Sha1Context, Data, DataSize));\r
 }\r
 \r
 /**\r
@@ -147,8 +152,8 @@ Sha1Update (
   SHA-1 context should be already correctly intialized by Sha1Init(), and should not be\r
   finalized by Sha1Final(). Behavior with invalid SHA-1 context is undefined.\r
 \r
-  If Sha1Context is NULL, then ASSERT().\r
-  If HashValue is NULL, then ASSERT().\r
+  If Sha1Context is NULL, then return FALSE.\r
+  If HashValue is NULL, then return FALSE.\r
 \r
   @param[in, out]  Sha1Context  Pointer to the SHA-1 context.\r
   @param[out]      HashValue    Pointer to a buffer that receives the SHA-1 digest\r
@@ -166,13 +171,60 @@ Sha1Final (
   )\r
 {\r
   //\r
-  // ASSERT if Sha1Context is NULL or HashValue is NULL\r
+  // Check input parameters.\r
   //\r
-  ASSERT (Sha1Context != NULL);\r
-  ASSERT (HashValue   != NULL);\r
+  if (Sha1Context == NULL || HashValue == NULL) {\r
+    return FALSE;\r
+  }\r
 \r
   //\r
   // OpenSSL SHA-1 Hash Finalization\r
   //\r
-  return (BOOLEAN) (SHA1_Final (HashValue, (SHA_CTX *)Sha1Context));\r
+  return (BOOLEAN) (SHA1_Final (HashValue, (SHA_CTX *) Sha1Context));\r
+}\r
+\r
+/**\r
+  Computes the SHA-1 message digest of a input data buffer.\r
+\r
+  This function performs the SHA-1 message digest of a given data buffer, and places\r
+  the digest value into the specified memory.\r
+\r
+  If this interface is not supported, then return FALSE.\r
+\r
+  @param[in]   Data        Pointer to the buffer containing the data to be hashed.\r
+  @param[in]   DataSize    Size of Data buffer in bytes.\r
+  @param[out]  HashValue   Pointer to a buffer that receives the SHA-1 digest\r
+                           value (20 bytes).\r
+\r
+  @retval TRUE   SHA-1 digest computation succeeded.\r
+  @retval FALSE  SHA-1 digest computation failed.\r
+  @retval FALSE  This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+Sha1HashAll (\r
+  IN   CONST VOID  *Data,\r
+  IN   UINTN       DataSize,\r
+  OUT  UINT8       *HashValue\r
+  )\r
+{\r
+  //\r
+  // Check input parameters.\r
+  //\r
+  if (HashValue == NULL) {\r
+    return FALSE;\r
+  }\r
+  if (Data == NULL && DataSize != 0) {\r
+    return FALSE;\r
+  }\r
+\r
+  //\r
+  // OpenSSL SHA-1 Hash Computation.\r
+  //\r
+  if (SHA1 (Data, DataSize, HashValue) == NULL) {\r
+    return FALSE;\r
+  } else {\r
+    return TRUE;\r
+  }\r
 }\r