]> git.proxmox.com Git - mirror_edk2.git/blobdiff - CryptoPkg/Driver/Crypto.c
CryptoPkg/BaseCryptLib: Retire HMAC SHA1 algorithm
[mirror_edk2.git] / CryptoPkg / Driver / Crypto.c
index 1cd5923ce228d1cda3a87ee9c5a5f27b3aff8532..73ae56675548add2e26245c9ebfed08a3c78c07a 100644 (file)
@@ -1277,154 +1277,120 @@ DeprecatedCryptoServiceHmacMd5Final (
 }\r
 \r
 /**\r
-  Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA1 use.\r
-\r
-  If this interface is not supported, then return NULL.\r
+  HMAC SHA1 is deprecated and unsupported any longer.\r
+  Keep the function field for binary compability.\r
 \r
-  @return  Pointer to the HMAC_CTX context that has been initialized.\r
-           If the allocations fails, HmacSha1New() returns NULL.\r
   @return  NULL   This interface is not supported.\r
 \r
 **/\r
 VOID *\r
 EFIAPI\r
-CryptoServiceHmacSha1New (\r
+DeprecatedCryptoServiceHmacSha1New (\r
   VOID\r
   )\r
 {\r
-  return CALL_BASECRYPTLIB (HmacSha1.Services.New, HmacSha1New, (), NULL);\r
+  return BaseCryptLibServiceDeprecated ("HmacSha1New"), NULL;\r
 }\r
 \r
 /**\r
-  Release the specified HMAC_CTX context.\r
-\r
-  If this interface is not supported, then do nothing.\r
+  HMAC SHA1 is deprecated and unsupported any longer.\r
+  Keep the function field for binary compability.\r
 \r
   @param[in]  HmacSha1Ctx  Pointer to the HMAC_CTX context to be released.\r
 \r
 **/\r
 VOID\r
 EFIAPI\r
-CryptoServiceHmacSha1Free (\r
+DeprecatedCryptoServiceHmacSha1Free (\r
   IN  VOID  *HmacSha1Ctx\r
   )\r
 {\r
-  CALL_VOID_BASECRYPTLIB (HmacSha1.Services.Free, HmacSha1Free, (HmacSha1Ctx));\r
+  BaseCryptLibServiceDeprecated ("HmacSha1Free");\r
 }\r
 \r
 /**\r
-  Set user-supplied key for subsequent use. It must be done before any\r
-  calling to HmacSha1Update().\r
-\r
-  If HmacSha1Context is NULL, then return FALSE.\r
-  If this interface is not supported, then return FALSE.\r
+  HMAC SHA1 is deprecated and unsupported any longer.\r
+  Keep the function field for binary compability.\r
 \r
   @param[out]  HmacSha1Context  Pointer to HMAC-SHA1 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
-CryptoServiceHmacSha1SetKey (\r
+DeprecatedCryptoServiceHmacSha1SetKey (\r
   OUT  VOID         *HmacSha1Context,\r
   IN   CONST UINT8  *Key,\r
   IN   UINTN        KeySize\r
   )\r
 {\r
-  return CALL_BASECRYPTLIB (HmacSha1.Services.SetKey, HmacSha1SetKey, (HmacSha1Context, Key, KeySize), FALSE);\r
+  return BaseCryptLibServiceDeprecated ("HmacSha1SetKey"), FALSE;\r
 }\r
 \r
 /**\r
-  Makes a copy of an existing HMAC-SHA1 context.\r
-\r
-  If HmacSha1Context is NULL, then return FALSE.\r
-  If NewHmacSha1Context is NULL, then return FALSE.\r
-  If this interface is not supported, then return FALSE.\r
+  HMAC SHA1 is deprecated and unsupported any longer.\r
+  Keep the function field for binary compability.\r
 \r
   @param[in]  HmacSha1Context     Pointer to HMAC-SHA1 context being copied.\r
   @param[out] NewHmacSha1Context  Pointer to new HMAC-SHA1 context.\r
 \r
-  @retval TRUE   HMAC-SHA1 context copy succeeded.\r
-  @retval FALSE  HMAC-SHA1 context copy failed.\r
   @retval FALSE  This interface is not supported.\r
 \r
 **/\r
 BOOLEAN\r
 EFIAPI\r
-CryptoServiceHmacSha1Duplicate (\r
+DeprecatedCryptoServiceHmacSha1Duplicate (\r
   IN   CONST VOID  *HmacSha1Context,\r
   OUT  VOID        *NewHmacSha1Context\r
   )\r
 {\r
-  return CALL_BASECRYPTLIB (HmacSha1.Services.Duplicate, HmacSha1Duplicate, (HmacSha1Context, NewHmacSha1Context), FALSE);\r
+  return BaseCryptLibServiceDeprecated ("HmacSha1Duplicate"), FALSE;\r
 }\r
 \r
 /**\r
-  Digests the input data and updates HMAC-SHA1 context.\r
-\r
-  This function performs HMAC-SHA1 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-SHA1 context should be initialized by HmacSha1New(), and should not be finalized by\r
-  HmacSha1Final(). Behavior with invalid context is undefined.\r
-\r
-  If HmacSha1Context is NULL, then return FALSE.\r
-  If this interface is not supported, then return FALSE.\r
+  HMAC SHA1 is deprecated and unsupported any longer.\r
+  Keep the function field for binary compability.\r
 \r
   @param[in, out]  HmacSha1Context Pointer to the HMAC-SHA1 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-SHA1 data digest succeeded.\r
-  @retval FALSE  HMAC-SHA1 data digest failed.\r
   @retval FALSE  This interface is not supported.\r
 \r
 **/\r
 BOOLEAN\r
 EFIAPI\r
-CryptoServiceHmacSha1Update (\r
+DeprecatedCryptoServiceHmacSha1Update (\r
   IN OUT  VOID        *HmacSha1Context,\r
   IN      CONST VOID  *Data,\r
   IN      UINTN       DataSize\r
   )\r
 {\r
-  return CALL_BASECRYPTLIB (HmacSha1.Services.Update, HmacSha1Update, (HmacSha1Context, Data, DataSize), FALSE);\r
+  return BaseCryptLibServiceDeprecated ("HmacSha1Update"), FALSE;\r
 }\r
 \r
 /**\r
-  Completes computation of the HMAC-SHA1 digest value.\r
-\r
-  This function completes HMAC-SHA1 hash computation and retrieves the digest value into\r
-  the specified memory. After this function has been called, the HMAC-SHA1 context cannot\r
-  be used again.\r
-  HMAC-SHA1 context should be initialized by HmacSha1New(), and should not be finalized\r
-  by HmacSha1Final(). Behavior with invalid HMAC-SHA1 context is undefined.\r
-\r
-  If HmacSha1Context is NULL, then return FALSE.\r
-  If HmacValue is NULL, then return FALSE.\r
-  If this interface is not supported, then return FALSE.\r
+  HMAC SHA1 is deprecated and unsupported any longer.\r
+  Keep the function field for binary compability.\r
 \r
   @param[in, out]  HmacSha1Context  Pointer to the HMAC-SHA1 context.\r
   @param[out]      HmacValue        Pointer to a buffer that receives the HMAC-SHA1 digest\r
                                     value (20 bytes).\r
 \r
-  @retval TRUE   HMAC-SHA1 digest computation succeeded.\r
-  @retval FALSE  HMAC-SHA1 digest computation failed.\r
   @retval FALSE  This interface is not supported.\r
 \r
 **/\r
 BOOLEAN\r
 EFIAPI\r
-CryptoServiceHmacSha1Final (\r
+DeprecatedCryptoServiceHmacSha1Final (\r
   IN OUT  VOID   *HmacSha1Context,\r
   OUT     UINT8  *HmacValue\r
   )\r
 {\r
-  return CALL_BASECRYPTLIB (HmacSha1.Services.Final, HmacSha1Final, (HmacSha1Context, HmacValue), FALSE);\r
+  return BaseCryptLibServiceDeprecated ("HmacSha1Final"), FALSE;\r
 }\r
 \r
 /**\r
@@ -4207,13 +4173,13 @@ const EDKII_CRYPTO_PROTOCOL mEdkiiCrypto = {
   DeprecatedCryptoServiceHmacMd5Duplicate,\r
   DeprecatedCryptoServiceHmacMd5Update,\r
   DeprecatedCryptoServiceHmacMd5Final,\r
-  /// HMAC SHA1\r
-  CryptoServiceHmacSha1New,\r
-  CryptoServiceHmacSha1Free,\r
-  CryptoServiceHmacSha1SetKey,\r
-  CryptoServiceHmacSha1Duplicate,\r
-  CryptoServiceHmacSha1Update,\r
-  CryptoServiceHmacSha1Final,\r
+  /// HMAC SHA1 - deprecated and unsupported\r
+  DeprecatedCryptoServiceHmacSha1New,\r
+  DeprecatedCryptoServiceHmacSha1Free,\r
+  DeprecatedCryptoServiceHmacSha1SetKey,\r
+  DeprecatedCryptoServiceHmacSha1Duplicate,\r
+  DeprecatedCryptoServiceHmacSha1Update,\r
+  DeprecatedCryptoServiceHmacSha1Final,\r
   /// HMAC SHA256\r
   CryptoServiceHmacSha256New,\r
   CryptoServiceHmacSha256Free,\r