]> git.proxmox.com Git - mirror_edk2.git/blobdiff - CryptoPkg/Include/Library/BaseCryptLib.h
CryptoPkg: Add new hmac definition to cryptlib
[mirror_edk2.git] / CryptoPkg / Include / Library / BaseCryptLib.h
index 7d1499350a495617f66e3280da071288df6ea12f..3a42e3494f8a7bc834dfe7fe82b2da3c01c4f3c6 100644 (file)
@@ -1045,6 +1045,194 @@ HmacSha256Final (
   OUT     UINT8  *HmacValue\r
   );\r
 \r
+/**\r
+  Computes the HMAC-SHA256 digest of a input data buffer.\r
+\r
+  This function performs the HMAC-SHA256 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 digested.\r
+  @param[in]   DataSize    Size of Data buffer in bytes.\r
+  @param[in]   Key         Pointer to the user-supplied key.\r
+  @param[in]   KeySize     Key size in bytes.\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
+HmacSha256All (\r
+  IN   CONST VOID   *Data,\r
+  IN   UINTN        DataSize,\r
+  IN   CONST UINT8  *Key,\r
+  IN   UINTN        KeySize,\r
+  OUT  UINT8        *HmacValue\r
+  );\r
+\r
+/**\r
+  Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA384 use.\r
+\r
+  @return  Pointer to the HMAC_CTX context that has been initialized.\r
+           If the allocations fails, HmacSha384New() returns NULL.\r
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+HmacSha384New (\r
+  VOID\r
+  );\r
+\r
+/**\r
+  Release the specified HMAC_CTX context.\r
+\r
+  @param[in]  HmacSha384Ctx  Pointer to the HMAC_CTX context to be released.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+HmacSha384Free (\r
+  IN  VOID  *HmacSha384Ctx\r
+  );\r
+\r
+/**\r
+  Set user-supplied key for subsequent use. It must be done before any\r
+  calling to HmacSha384Update().\r
+\r
+  If HmacSha384Context is NULL, then return FALSE.\r
+  If this interface is not supported, then return FALSE.\r
+\r
+  @param[out]  HmacSha384Context  Pointer to HMAC-SHA384 context.\r
+  @param[in]   Key                Pointer to the user-supplied key.\r
+  @param[in]   KeySize            Key size in bytes.\r
+\r
+  @retval TRUE   The Key is set successfully.\r
+  @retval FALSE  The Key is set unsuccessfully.\r
+  @retval FALSE  This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+HmacSha384SetKey (\r
+  OUT  VOID         *HmacSha384Context,\r
+  IN   CONST UINT8  *Key,\r
+  IN   UINTN        KeySize\r
+  );\r
+\r
+/**\r
+  Makes a copy of an existing HMAC-SHA384 context.\r
+\r
+  If HmacSha384Context is NULL, then return FALSE.\r
+  If NewHmacSha384Context is NULL, then return FALSE.\r
+  If this interface is not supported, then return FALSE.\r
+\r
+  @param[in]  HmacSha384Context     Pointer to HMAC-SHA384 context being copied.\r
+  @param[out] NewHmacSha384Context  Pointer to new HMAC-SHA384 context.\r
+\r
+  @retval TRUE   HMAC-SHA384 context copy succeeded.\r
+  @retval FALSE  HMAC-SHA384 context copy failed.\r
+  @retval FALSE  This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+HmacSha384Duplicate (\r
+  IN   CONST VOID  *HmacSha384Context,\r
+  OUT  VOID        *NewHmacSha384Context\r
+  );\r
+\r
+/**\r
+  Digests the input data and updates HMAC-SHA384 context.\r
+\r
+  This function performs HMAC-SHA384 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-SHA384 context should be initialized by HmacSha384New(), and should not be finalized\r
+  by HmacSha384Final(). Behavior with invalid context is undefined.\r
+\r
+  If HmacSha384Context is NULL, then return FALSE.\r
+  If this interface is not supported, then return FALSE.\r
+\r
+  @param[in, out]  HmacSha384Context Pointer to the HMAC-SHA384 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-SHA384 data digest succeeded.\r
+  @retval FALSE  HMAC-SHA384 data digest failed.\r
+  @retval FALSE  This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+HmacSha384Update (\r
+  IN OUT  VOID        *HmacSha384Context,\r
+  IN      CONST VOID  *Data,\r
+  IN      UINTN       DataSize\r
+  );\r
+\r
+/**\r
+  Completes computation of the HMAC-SHA384 digest value.\r
+\r
+  This function completes HMAC-SHA384 hash computation and retrieves the digest value into\r
+  the specified memory. After this function has been called, the HMAC-SHA384 context cannot\r
+  be used again.\r
+  HMAC-SHA384 context should be initialized by HmacSha384New(), and should not be finalized\r
+  by HmacSha384Final(). Behavior with invalid HMAC-SHA384 context is undefined.\r
+\r
+  If HmacSha384Context is NULL, then return FALSE.\r
+  If HmacValue is NULL, then return FALSE.\r
+  If this interface is not supported, then return FALSE.\r
+\r
+  @param[in, out]  HmacSha384Context  Pointer to the HMAC-SHA384 context.\r
+  @param[out]      HmacValue          Pointer to a buffer that receives the HMAC-SHA384 digest\r
+                                      value (48 bytes).\r
+\r
+  @retval TRUE   HMAC-SHA384 digest computation succeeded.\r
+  @retval FALSE  HMAC-SHA384 digest computation failed.\r
+  @retval FALSE  This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+HmacSha384Final (\r
+  IN OUT  VOID   *HmacSha384Context,\r
+  OUT     UINT8  *HmacValue\r
+  );\r
+\r
+/**\r
+  Computes the HMAC-SHA384 digest of a input data buffer.\r
+\r
+  This function performs the HMAC-SHA384 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 digested.\r
+  @param[in]   DataSize    Size of Data buffer in bytes.\r
+  @param[in]   Key         Pointer to the user-supplied key.\r
+  @param[in]   KeySize     Key size in bytes.\r
+  @param[out]  HashValue   Pointer to a buffer that receives the HMAC-SHA384 digest\r
+                           value (48 bytes).\r
+\r
+  @retval TRUE   HMAC-SHA384 digest computation succeeded.\r
+  @retval FALSE  HMAC-SHA384 digest computation failed.\r
+  @retval FALSE  This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+HmacSha384All (\r
+  IN   CONST VOID   *Data,\r
+  IN   UINTN        DataSize,\r
+  IN   CONST UINT8  *Key,\r
+  IN   UINTN        KeySize,\r
+  OUT  UINT8        *HmacValue\r
+  );\r
+\r
 // =====================================================================================\r
 //    Symmetric Cryptography Primitive\r
 // =====================================================================================\r