CryptoPkg: Add HMAC-SHA256 cipher support

[mirror_edk2.git] / CryptoPkg / Include / Library / BaseCryptLib.h

diff --git a/CryptoPkg/Include/Library/BaseCryptLib.h b/CryptoPkg/Include/Library/BaseCryptLib.h
index 346362678533f74e6b854249f244099f237f0f44..9693793da3f0a3dd8e4200ea7116f905f4da8371 100644 (file)
--- a/CryptoPkg/Include/Library/BaseCryptLib.h
+++ b/CryptoPkg/Include/Library/BaseCryptLib.h
@@ -1131,6 +1131,124 @@ HmacSha1Final (
   OUT     UINT8  *HmacValue\r
   );\r
 \r
+/**\r
+  Retrieves the size, in bytes, of the context buffer required for HMAC-SHA256 operations.\r
+\r
+  If this interface is not supported, then return zero.\r
+\r
+  @return  The size, in bytes, of the context buffer required for HMAC-SHA256 operations.\r
+  @retval  0   This interface is not supported.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+HmacSha256GetContextSize (\r
+  VOID\r
+  );\r
+\r
+/**\r
+  Initializes user-supplied memory pointed by HmacSha256Context as HMAC-SHA256 context for\r
+  subsequent use.\r
+\r
+  If HmacSha256Context is NULL, then return FALSE.\r
+  If this interface is not supported, then return FALSE.\r
+\r
+  @param[out]  HmacSha256Context  Pointer to HMAC-SHA256 context being initialized.\r
+  @param[in]   Key                Pointer to the user-supplied key.\r
+  @param[in]   KeySize            Key size in bytes.\r
+\r
+  @retval TRUE   HMAC-SHA256 context initialization succeeded.\r
+  @retval FALSE  HMAC-SHA256 context initialization failed.\r
+  @retval FALSE  This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+HmacSha256Init (\r
+  OUT  VOID         *HmacSha256Context,\r
+  IN   CONST UINT8  *Key,\r
+  IN   UINTN        KeySize\r
+  );\r
+\r
+/**\r
+  Makes a copy of an existing HMAC-SHA256 context.\r
+\r
+  If HmacSha256Context is NULL, then return FALSE.\r
+  If NewHmacSha256Context is NULL, then return FALSE.\r
+  If this interface is not supported, then return FALSE.\r
+\r
+  @param[in]  HmacSha256Context     Pointer to HMAC-SHA256 context being copied.\r
+  @param[out] NewHmacSha256Context  Pointer to new HMAC-SHA256 context.\r
+\r
+  @retval TRUE   HMAC-SHA256 context copy succeeded.\r
+  @retval FALSE  HMAC-SHA256 context copy failed.\r
+  @retval FALSE  This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+HmacSha256Duplicate (\r
+  IN   CONST VOID  *HmacSha256Context,\r
+  OUT  VOID        *NewHmacSha256Context\r
+  );\r
+\r
+/**\r
+  Digests the input data and updates HMAC-SHA256 context.\r
+\r
+  This function performs HMAC-SHA256 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
+  HMAC-SHA256 context should be already correctly initialized by HmacSha256Init(), and should not\r
+  be finalized by HmacSha256Final(). Behavior with invalid context is undefined.\r
+\r
+  If HmacSha256Context is NULL, then return FALSE.\r
+  If this interface is not supported, then return FALSE.\r
+\r
+  @param[in, out]  HmacSha256Context Pointer to the HMAC-SHA256 context.\r
+  @param[in]       Data              Pointer to the buffer containing the data to be digested.\r
+  @param[in]       DataSize          Size of Data buffer in bytes.\r
+\r
+  @retval TRUE   HMAC-SHA256 data digest succeeded.\r
+  @retval FALSE  HMAC-SHA256 data digest failed.\r
+  @retval FALSE  This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+HmacSha256Update (\r
+  IN OUT  VOID        *HmacSha256Context,\r
+  IN      CONST VOID  *Data,\r
+  IN      UINTN       DataSize\r
+  );\r
+\r
+/**\r
+  Completes computation of the HMAC-SHA256 digest value.\r
+\r
+  This function completes HMAC-SHA256 hash computation and retrieves the digest value into\r
+  the specified memory. After this function has been called, the HMAC-SHA256 context cannot\r
+  be used again.\r
+  HMAC-SHA256 context should be already correctly initialized by HmacSha256Init(), and should\r
+  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 this interface is not supported, 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
+                                      value (32 bytes).\r
+\r
+  @retval TRUE   HMAC-SHA256 digest computation succeeded.\r
+  @retval FALSE  HMAC-SHA256 digest computation failed.\r
+  @retval FALSE  This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+HmacSha256Final (\r
+  IN OUT  VOID   *HmacSha256Context,\r
+  OUT     UINT8  *HmacValue\r
+  );\r
+\r
 //=====================================================================================\r
 //    Symmetric Cryptography Primitive\r
 //=====================================================================================\r