--- /dev/null
+/** @file\r
+ HMAC-SHA256/SHA384 Wrapper Implementation over OpenSSL.\r
+\r
+Copyright (c) 2016 - 2022, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
+\r
+**/\r
+\r
+#include "InternalCryptLib.h"\r
+#include <openssl/hmac.h>\r
+\r
+/**\r
+ Allocates and initializes one HMAC_CTX context for subsequent HMAC-MD use.\r
+\r
+ @return Pointer to the HMAC_CTX context that has been initialized.\r
+ If the allocations fails, HmacMdNew() returns NULL.\r
+\r
+**/\r
+VOID *\r
+HmacMdNew (\r
+ VOID\r
+ )\r
+{\r
+ //\r
+ // Allocates & Initializes HMAC_CTX Context by OpenSSL HMAC_CTX_new()\r
+ //\r
+ return (VOID *)HMAC_CTX_new ();\r
+}\r
+\r
+/**\r
+ Release the specified HMAC_CTX context.\r
+\r
+ @param[in] HmacMdCtx Pointer to the HMAC_CTX context to be released.\r
+\r
+**/\r
+VOID\r
+HmacMdFree (\r
+ IN VOID *HmacMdCtx\r
+ )\r
+{\r
+ //\r
+ // Free OpenSSL HMAC_CTX Context\r
+ //\r
+ HMAC_CTX_free ((HMAC_CTX *)HmacMdCtx);\r
+}\r
+\r
+/**\r
+ Set user-supplied key for subsequent use. It must be done before any\r
+ calling to HmacMdUpdate().\r
+\r
+ If HmacMdContext is NULL, then return FALSE.\r
+\r
+ @param[in] Md Message Digest.\r
+ @param[out] HmacMdContext Pointer to HMAC-MD 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
+\r
+**/\r
+BOOLEAN\r
+HmacMdSetKey (\r
+ IN CONST EVP_MD *Md,\r
+ OUT VOID *HmacMdContext,\r
+ IN CONST UINT8 *Key,\r
+ IN UINTN KeySize\r
+ )\r
+{\r
+ //\r
+ // Check input parameters.\r
+ //\r
+ if ((HmacMdContext == NULL) || (KeySize > INT_MAX)) {\r
+ return FALSE;\r
+ }\r
+\r
+ if (HMAC_Init_ex ((HMAC_CTX *)HmacMdContext, Key, (UINT32)KeySize, Md, NULL) != 1) {\r
+ return FALSE;\r
+ }\r
+\r
+ return TRUE;\r
+}\r
+\r
+/**\r
+ Makes a copy of an existing HMAC-MD context.\r
+\r
+ If HmacMdContext is NULL, then return FALSE.\r
+ If NewHmacMdContext is NULL, then return FALSE.\r
+\r
+ @param[in] HmacMdContext Pointer to HMAC-MD context being copied.\r
+ @param[out] NewHmacMdContext Pointer to new HMAC-MD context.\r
+\r
+ @retval TRUE HMAC-MD context copy succeeded.\r
+ @retval FALSE HMAC-MD context copy failed.\r
+\r
+**/\r
+BOOLEAN\r
+HmacMdDuplicate (\r
+ IN CONST VOID *HmacMdContext,\r
+ OUT VOID *NewHmacMdContext\r
+ )\r
+{\r
+ //\r
+ // Check input parameters.\r
+ //\r
+ if ((HmacMdContext == NULL) || (NewHmacMdContext == NULL)) {\r
+ return FALSE;\r
+ }\r
+\r
+ if (HMAC_CTX_copy ((HMAC_CTX *)NewHmacMdContext, (HMAC_CTX *)HmacMdContext) != 1) {\r
+ return FALSE;\r
+ }\r
+\r
+ return TRUE;\r
+}\r
+\r
+/**\r
+ Digests the input data and updates HMAC-MD context.\r
+\r
+ This function performs HMAC-MD 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-MD context should be initialized by HmacMdNew(), and should not be finalized\r
+ by HmacMdFinal(). Behavior with invalid context is undefined.\r
+\r
+ If HmacMdContext is NULL, then return FALSE.\r
+\r
+ @param[in, out] HmacMdContext Pointer to the HMAC-MD 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-MD data digest succeeded.\r
+ @retval FALSE HMAC-MD data digest failed.\r
+\r
+**/\r
+BOOLEAN\r
+HmacMdUpdate (\r
+ IN OUT VOID *HmacMdContext,\r
+ IN CONST VOID *Data,\r
+ IN UINTN DataSize\r
+ )\r
+{\r
+ //\r
+ // Check input parameters.\r
+ //\r
+ if (HmacMdContext == NULL) {\r
+ return FALSE;\r
+ }\r
+\r
+ //\r
+ // Check invalid parameters, in case that only DataLength was checked in OpenSSL\r
+ //\r
+ if ((Data == NULL) && (DataSize != 0)) {\r
+ return FALSE;\r
+ }\r
+\r
+ //\r
+ // OpenSSL HMAC-MD digest update\r
+ //\r
+ if (HMAC_Update ((HMAC_CTX *)HmacMdContext, Data, DataSize) != 1) {\r
+ return FALSE;\r
+ }\r
+\r
+ return TRUE;\r
+}\r
+\r
+/**\r
+ Completes computation of the HMAC-MD digest value.\r
+\r
+ This function completes HMAC-MD hash computation and retrieves the digest value into\r
+ the specified memory. After this function has been called, the HMAC-MD context cannot\r
+ be used again.\r
+ HMAC-MD context should be initialized by HmacMdNew(), and should not be finalized\r
+ by HmacMdFinal(). Behavior with invalid HMAC-MD context is undefined.\r
+\r
+ If HmacMdContext is NULL, then return FALSE.\r
+ If HmacValue is NULL, then return FALSE.\r
+\r
+ @param[in, out] HmacMdContext Pointer to the HMAC-MD context.\r
+ @param[out] HmacValue Pointer to a buffer that receives the HMAC-MD digest\r
+ value.\r
+\r
+ @retval TRUE HMAC-MD digest computation succeeded.\r
+ @retval FALSE HMAC-MD digest computation failed.\r
+\r
+**/\r
+BOOLEAN\r
+HmacMdFinal (\r
+ IN OUT VOID *HmacMdContext,\r
+ OUT UINT8 *HmacValue\r
+ )\r
+{\r
+ UINT32 Length;\r
+\r
+ //\r
+ // Check input parameters.\r
+ //\r
+ if ((HmacMdContext == NULL) || (HmacValue == NULL)) {\r
+ return FALSE;\r
+ }\r
+\r
+ //\r
+ // OpenSSL HMAC-MD digest finalization\r
+ //\r
+ if (HMAC_Final ((HMAC_CTX *)HmacMdContext, HmacValue, &Length) != 1) {\r
+ return FALSE;\r
+ }\r
+\r
+ if (HMAC_CTX_reset ((HMAC_CTX *)HmacMdContext) != 1) {\r
+ return FALSE;\r
+ }\r
+\r
+ return TRUE;\r
+}\r
+\r
+/**\r
+ Computes the HMAC-MD digest of a input data buffer.\r
+\r
+ This function performs the HMAC-MD 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] Md Message Digest.\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] HmacValue Pointer to a buffer that receives the HMAC-MD digest\r
+ value.\r
+\r
+ @retval TRUE HMAC-MD digest computation succeeded.\r
+ @retval FALSE HMAC-MD digest computation failed.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+HmacMdAll (\r
+ IN CONST EVP_MD *Md,\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
+ UINT32 Length;\r
+ HMAC_CTX *Ctx;\r
+ BOOLEAN RetVal;\r
+\r
+ Ctx = HMAC_CTX_new ();\r
+ if (Ctx == NULL) {\r
+ return FALSE;\r
+ }\r
+\r
+ RetVal = (BOOLEAN)HMAC_CTX_reset (Ctx);\r
+ if (!RetVal) {\r
+ goto Done;\r
+ }\r
+\r
+ RetVal = (BOOLEAN)HMAC_Init_ex (Ctx, Key, (UINT32)KeySize, Md, NULL);\r
+ if (!RetVal) {\r
+ goto Done;\r
+ }\r
+\r
+ RetVal = (BOOLEAN)HMAC_Update (Ctx, Data, DataSize);\r
+ if (!RetVal) {\r
+ goto Done;\r
+ }\r
+\r
+ RetVal = (BOOLEAN)HMAC_Final (Ctx, HmacValue, &Length);\r
+ if (!RetVal) {\r
+ goto Done;\r
+ }\r
+\r
+Done:\r
+ HMAC_CTX_free (Ctx);\r
+\r
+ return RetVal;\r
+}\r
+\r
+/**\r
+ Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA256 use.\r
+\r
+ @return Pointer to the HMAC_CTX context that has been initialized.\r
+ If the allocations fails, HmacSha256New() returns NULL.\r
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+HmacSha256New (\r
+ VOID\r
+ )\r
+{\r
+ return HmacMdNew ();\r
+}\r
+\r
+/**\r
+ Release the specified HMAC_CTX context.\r
+\r
+ @param[in] HmacSha256Ctx Pointer to the HMAC_CTX context to be released.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+HmacSha256Free (\r
+ IN VOID *HmacSha256Ctx\r
+ )\r
+{\r
+ HmacMdFree (HmacSha256Ctx);\r
+}\r
+\r
+/**\r
+ Set user-supplied key for subsequent use. It must be done before any\r
+ calling to HmacSha256Update().\r
+\r
+ If HmacSha256Context is NULL, then return FALSE.\r
+\r
+ @param[out] HmacSha256Context Pointer to HMAC-SHA256 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
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+HmacSha256SetKey (\r
+ OUT VOID *HmacSha256Context,\r
+ IN CONST UINT8 *Key,\r
+ IN UINTN KeySize\r
+ )\r
+{\r
+ return HmacMdSetKey (EVP_sha256 (), HmacSha256Context, Key, 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
+\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
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+HmacSha256Duplicate (\r
+ IN CONST VOID *HmacSha256Context,\r
+ OUT VOID *NewHmacSha256Context\r
+ )\r
+{\r
+ return HmacMdDuplicate (HmacSha256Context, 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 initialized by HmacSha256New(), and should not be finalized\r
+ by HmacSha256Final(). Behavior with invalid context is undefined.\r
+\r
+ If HmacSha256Context is NULL, 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
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+HmacSha256Update (\r
+ IN OUT VOID *HmacSha256Context,\r
+ IN CONST VOID *Data,\r
+ IN UINTN DataSize\r
+ )\r
+{\r
+ return HmacMdUpdate (HmacSha256Context, Data, 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 initialized by HmacSha256New(), and should not be finalized\r
+ by HmacSha256Final(). Behavior with invalid HMAC-SHA256 context is undefined.\r
+\r
+ If HmacSha256Context is NULL, then return FALSE.\r
+ If HmacValue is NULL, then return FALSE.\r
+\r
+ @param[in, out] HmacSha256Context Pointer to the HMAC-SHA256 context.\r
+ @param[out] HmacValue 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
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+HmacSha256Final (\r
+ IN OUT VOID *HmacSha256Context,\r
+ OUT UINT8 *HmacValue\r
+ )\r
+{\r
+ return HmacMdFinal (HmacSha256Context, 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] HmacValue 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
+ return HmacMdAll (EVP_sha256 (), Data, DataSize, Key, KeySize, 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
+ return HmacMdNew ();\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
+ HmacMdFree (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
+ return HmacMdSetKey (EVP_sha384 (), HmacSha384Context, Key, 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
+ return HmacMdDuplicate (HmacSha384Context, 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
+ return HmacMdUpdate (HmacSha384Context, Data, 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
+ return HmacMdFinal (HmacSha384Context, 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] 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
+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
+ return HmacMdAll (EVP_sha384 (), Data, DataSize, Key, KeySize, HmacValue);\r
+}\r
projects / mirror_edk2.git / blobdiff