]> git.proxmox.com Git - mirror_edk2.git/blobdiff - CryptoPkg/Library/BaseCryptLib/Hash/CryptSha256.c
CryptoPkg: Fix typos in comments
[mirror_edk2.git] / CryptoPkg / Library / BaseCryptLib / Hash / CryptSha256.c
index 7e6c6c691f87eca030ead2733a44a17588c2f715..06ecb2e98098f00fa7402a84472ededb8751a327 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   SHA-256 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
@@ -30,14 +30,14 @@ Sha256GetContextSize (
   //\r
   // Retrieves OpenSSL SHA-256 Context Size\r
   //\r
-  return (UINTN)(sizeof (SHA256_CTX));\r
+  return (UINTN) (sizeof (SHA256_CTX));\r
 }\r
 \r
 /**\r
   Initializes user-supplied memory pointed by Sha256Context as SHA-256 hash context for\r
   subsequent use.\r
 \r
-  If Sha256Context is NULL, then ASSERT().\r
+  If Sha256Context is NULL, then return FALSE.\r
 \r
   @param[out]  Sha256Context  Pointer to SHA-256 context being initialized.\r
 \r
@@ -52,21 +52,23 @@ Sha256Init (
   )\r
 {\r
   //\r
-  // ASSERT if Sha256Context is NULL\r
+  // Check input parameters.\r
   //\r
-  ASSERT (Sha256Context != NULL);\r
+  if (Sha256Context == NULL) {\r
+    return FALSE;\r
+  }\r
 \r
   //\r
   // OpenSSL SHA-256 Context Initialization\r
   //\r
-  return (BOOLEAN) (SHA256_Init ((SHA256_CTX *)Sha256Context));\r
+  return (BOOLEAN) (SHA256_Init ((SHA256_CTX *) Sha256Context));\r
 }\r
 \r
 /**\r
   Makes a copy of an existing SHA-256 context.\r
 \r
-  If Sha256Context is NULL, then ASSERT().\r
-  If NewSha256Context is NULL, then ASSERT().\r
+  If Sha256Context is NULL, then return FALSE.\r
+  If NewSha256Context is NULL, then return FALSE.\r
 \r
   @param[in]  Sha256Context     Pointer to SHA-256 context being copied.\r
   @param[out] NewSha256Context  Pointer to new SHA-256 context.\r
@@ -82,6 +84,13 @@ Sha256Duplicate (
   OUT  VOID        *NewSha256Context\r
   )\r
 {\r
+  //\r
+  // Check input parameters.\r
+  //\r
+  if (Sha256Context == NULL || NewSha256Context == NULL) {\r
+    return FALSE;\r
+  }\r
+\r
   CopyMem (NewSha256Context, Sha256Context, sizeof (SHA256_CTX));\r
 \r
   return TRUE;\r
@@ -92,10 +101,10 @@ Sha256Duplicate (
 \r
   This function performs SHA-256 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
-  SHA-256 context should be already correctly intialized by Sha256Init(), and should not be finalized\r
+  SHA-256 context should be already correctly initialized by Sha256Init(), and should not be finalized\r
   by Sha256Final(). Behavior with invalid context is undefined.\r
 \r
-  If Sha256Context is NULL, then ASSERT().\r
+  If Sha256Context is NULL, then return FALSE.\r
 \r
   @param[in, out]  Sha256Context  Pointer to the SHA-256 context.\r
   @param[in]       Data           Pointer to the buffer containing the data to be hashed.\r
@@ -114,21 +123,23 @@ Sha256Update (
   )\r
 {\r
   //\r
-  // ASSERT if Sha256Context is NULL\r
+  // Check input parameters.\r
   //\r
-  ASSERT (Sha256Context != NULL);\r
+  if (Sha256Context == 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-256 Hash Update\r
   //\r
-  return (BOOLEAN) (SHA256_Update ((SHA256_CTX *)Sha256Context, Data, DataSize));\r
+  return (BOOLEAN) (SHA256_Update ((SHA256_CTX *) Sha256Context, Data, DataSize));\r
 }\r
 \r
 /**\r
@@ -137,11 +148,11 @@ Sha256Update (
   This function completes SHA-256 hash computation and retrieves the digest value into\r
   the specified memory. After this function has been called, the SHA-256 context cannot\r
   be used again.\r
-  SHA-256 context should be already correctly intialized by Sha256Init(), and should not be\r
+  SHA-256 context should be already correctly initialized by Sha256Init(), and should not be\r
   finalized by Sha256Final(). Behavior with invalid SHA-256 context is undefined.\r
 \r
-  If Sha256Context is NULL, then ASSERT().\r
-  If HashValue is NULL, then ASSERT().\r
+  If Sha256Context is NULL, then return FALSE.\r
+  If HashValue is NULL, then return FALSE.\r
 \r
   @param[in, out]  Sha256Context  Pointer to the SHA-256 context.\r
   @param[out]      HashValue      Pointer to a buffer that receives the SHA-256 digest\r
@@ -159,13 +170,60 @@ Sha256Final (
   )\r
 {\r
   //\r
-  // ASSERT if Sha256Context is NULL or HashValue is NULL\r
+  // Check input parameters.\r
   //\r
-  ASSERT (Sha256Context != NULL);\r
-  ASSERT (HashValue     != NULL);\r
+  if (Sha256Context == NULL || HashValue == NULL) {\r
+    return FALSE;\r
+  }\r
 \r
   //\r
   // OpenSSL SHA-256 Hash Finalization\r
   //\r
-  return (BOOLEAN) (SHA256_Final (HashValue, (SHA256_CTX *)Sha256Context));\r
+  return (BOOLEAN) (SHA256_Final (HashValue, (SHA256_CTX *) Sha256Context));\r
+}\r
+\r
+/**\r
+  Computes the SHA-256 message digest of a input data buffer.\r
+\r
+  This function performs the SHA-256 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-256 digest\r
+                           value (32 bytes).\r
+\r
+  @retval TRUE   SHA-256 digest computation succeeded.\r
+  @retval FALSE  SHA-256 digest computation failed.\r
+  @retval FALSE  This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+Sha256HashAll (\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-256 Hash Computation.\r
+  //\r
+  if (SHA256 (Data, DataSize, HashValue) == NULL) {\r
+    return FALSE;\r
+  } else {\r
+    return TRUE;\r
+  }\r
 }\r