Update CryptoPkg for new ciphers (HMAC, Block Cipher, etc) supports.

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

diff --git a/CryptoPkg/Library/BaseCryptLib/Hash/CryptSha256.c b/CryptoPkg/Library/BaseCryptLib/Hash/CryptSha256.c
index 9b566a4c599c99f4d74e3b90f4ed74b15d77fc63..7e6c6c691f87eca030ead2733a44a17588c2f715 100644 (file)
--- a/CryptoPkg/Library/BaseCryptLib/Hash/CryptSha256.c
+++ b/CryptoPkg/Library/BaseCryptLib/Hash/CryptSha256.c
@@ -12,17 +12,13 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-#include <Library/BaseLib.h>\r
-#include <Library/DebugLib.h>\r
-\r
-#include <Library/BaseCryptLib.h>\r
+#include "InternalCryptLib.h"\r
 #include <openssl/sha.h>\r
 \r
-\r
 /**\r
-  Retrieves the size, in bytes, of the context buffer required for SHA-256 operations.\r
+  Retrieves the size, in bytes, of the context buffer required for SHA-256 hash operations.\r
 \r
-  @return  The size, in bytes, of the context buffer required for SHA-256 operations.\r
+  @return  The size, in bytes, of the context buffer required for SHA-256 hash operations.\r
 \r
 **/\r
 UINTN\r
@@ -37,14 +33,13 @@ Sha256GetContextSize (
   return (UINTN)(sizeof (SHA256_CTX));\r
 }\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
 \r
-  @param[in, out]  Sha256Context  Pointer to SHA-256 Context being initialized.\r
+  @param[out]  Sha256Context  Pointer to SHA-256 context being initialized.\r
 \r
   @retval TRUE   SHA-256 context initialization succeeded.\r
   @retval FALSE  SHA-256 context initialization failed.\r
@@ -53,7 +48,7 @@ Sha256GetContextSize (
 BOOLEAN\r
 EFIAPI\r
 Sha256Init (\r
-  IN OUT  VOID  *Sha256Context\r
+  OUT  VOID  *Sha256Context\r
   )\r
 {\r
   //\r
@@ -67,20 +62,47 @@ Sha256Init (
   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
+\r
+  @param[in]  Sha256Context     Pointer to SHA-256 context being copied.\r
+  @param[out] NewSha256Context  Pointer to new SHA-256 context.\r
+\r
+  @retval TRUE   SHA-256 context copy succeeded.\r
+  @retval FALSE  SHA-256 context copy failed.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+Sha256Duplicate (\r
+  IN   CONST VOID  *Sha256Context,\r
+  OUT  VOID        *NewSha256Context\r
+  )\r
+{\r
+  CopyMem (NewSha256Context, Sha256Context, sizeof (SHA256_CTX));\r
+\r
+  return TRUE;\r
+}\r
 \r
 /**\r
-  Performs SHA-256 digest on a data buffer of the specified length. This function can\r
-  be called multiple times to compute the digest of long or discontinuous data streams.\r
+  Digests the input data and updates SHA-256 context.\r
+\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
+  by Sha256Final(). Behavior with invalid context is undefined.\r
 \r
   If Sha256Context is NULL, then ASSERT().\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
-  @param[in]       DataLength     Length of Data buffer in bytes.\r
+  @param[in]       DataSize       Size of Data buffer in bytes.\r
 \r
   @retval TRUE   SHA-256 data digest succeeded.\r
-  @retval FALSE  Invalid SHA-256 context. After Sha256Final function has been called, the\r
-                 SHA-256 context cannot be reused.\r
+  @retval FALSE  SHA-256 data digest failed.\r
 \r
 **/\r
 BOOLEAN\r
@@ -88,7 +110,7 @@ EFIAPI
 Sha256Update (\r
   IN OUT  VOID        *Sha256Context,\r
   IN      CONST VOID  *Data,\r
-  IN      UINTN       DataLength\r
+  IN      UINTN       DataSize\r
   )\r
 {\r
   //\r
@@ -100,24 +122,28 @@ Sha256Update (
   // ASSERT if invalid parameters, in case that only DataLength was checked in OpenSSL\r
   //\r
   if (Data == NULL) {\r
-    ASSERT (DataLength == 0);\r
+    ASSERT (DataSize == 0);\r
   }\r
 \r
   //\r
   // OpenSSL SHA-256 Hash Update\r
   //\r
-  return (BOOLEAN) (SHA256_Update ((SHA256_CTX *)Sha256Context, Data, DataLength));\r
+  return (BOOLEAN) (SHA256_Update ((SHA256_CTX *)Sha256Context, Data, DataSize));\r
 }\r
 \r
-\r
 /**\r
-  Completes SHA-256 hash computation and retrieves the digest value into the specified\r
-  memory. After this function has been called, the SHA-256 context cannot be used again.\r
+  Completes computation of the SHA-256 digest value.\r
+\r
+  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
+  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
 \r
-  @param[in, out]  Sha256Context  Pointer to SHA-256 context\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
                                   value (32 bytes).\r
 \r