]> git.proxmox.com Git - mirror_edk2.git/blobdiff - CryptoPkg/Driver/Crypto.c
CryptoPkg/BaseCryptLib: Retire HMAC MD5 algorithm
[mirror_edk2.git] / CryptoPkg / Driver / Crypto.c
index 1337fea42ad687cfb445dad3357260b316bd9d57..1cd5923ce228d1cda3a87ee9c5a5f27b3aff8532 100644 (file)
@@ -1160,154 +1160,120 @@ CryptoServiceSm3HashAll (
 //=====================================================================================\r
 \r
 /**\r
-  Allocates and initializes one HMAC_CTX context for subsequent HMAC-MD5 use.\r
-\r
-  If this interface is not supported, then return NULL.\r
+  HMAC MD5 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, HmacMd5New() returns NULL.\r
   @retval  NULL  This interface is not supported.\r
 \r
 **/\r
 VOID *\r
 EFIAPI\r
-CryptoServiceHmacMd5New (\r
+DeprecatedCryptoServiceHmacMd5New (\r
   VOID\r
   )\r
 {\r
-  return CALL_BASECRYPTLIB (HmacMd5.Services.New, HmacMd5New, (), NULL);\r
+  return BaseCryptLibServiceDeprecated ("HmacMd5New"), NULL;\r
 }\r
 \r
 /**\r
-  Release the specified HMAC_CTX context.\r
-\r
-  If this interface is not supported, then do nothing.\r
+  HMAC MD5 is deprecated and unsupported any longer.\r
+  Keep the function field for binary compability.\r
 \r
   @param[in]  HmacMd5Ctx  Pointer to the HMAC_CTX context to be released.\r
 \r
 **/\r
 VOID\r
 EFIAPI\r
-CryptoServiceHmacMd5Free (\r
+DeprecatedCryptoServiceHmacMd5Free (\r
   IN  VOID  *HmacMd5Ctx\r
   )\r
 {\r
-  CALL_VOID_BASECRYPTLIB (HmacMd5.Services.Free, HmacMd5Free, (HmacMd5Ctx));\r
+  BaseCryptLibServiceDeprecated ("HmacMd5Free");\r
 }\r
 \r
 /**\r
-  Set user-supplied key for subsequent use. It must be done before any\r
-  calling to HmacMd5Update().\r
-\r
-  If HmacMd5Context is NULL, then return FALSE.\r
-  If this interface is not supported, then return FALSE.\r
+  HMAC MD5 is deprecated and unsupported any longer.\r
+  Keep the function field for binary compability.\r
 \r
   @param[out]  HmacMd5Context  Pointer to HMAC-MD5 context.\r
   @param[in]   Key             Pointer to the user-supplied key.\r
   @param[in]   KeySize         Key size in bytes.\r
 \r
-  @retval TRUE   Key is set successfully.\r
-  @retval FALSE  Key is set unsuccessfully.\r
   @retval FALSE  This interface is not supported.\r
 \r
 **/\r
 BOOLEAN\r
 EFIAPI\r
-CryptoServiceHmacMd5SetKey (\r
+DeprecatedCryptoServiceHmacMd5SetKey (\r
   OUT  VOID         *HmacMd5Context,\r
   IN   CONST UINT8  *Key,\r
   IN   UINTN        KeySize\r
   )\r
 {\r
-  return CALL_BASECRYPTLIB (HmacMd5.Services.SetKey, HmacMd5SetKey, (HmacMd5Context, Key, KeySize), FALSE);\r
+  return BaseCryptLibServiceDeprecated ("HmacMd5SetKey"), FALSE;\r
 }\r
 \r
 /**\r
-  Makes a copy of an existing HMAC-MD5 context.\r
-\r
-  If HmacMd5Context is NULL, then return FALSE.\r
-  If NewHmacMd5Context is NULL, then return FALSE.\r
-  If this interface is not supported, then return FALSE.\r
+  HMAC MD5 is deprecated and unsupported any longer.\r
+  Keep the function field for binary compability.\r
 \r
   @param[in]  HmacMd5Context     Pointer to HMAC-MD5 context being copied.\r
   @param[out] NewHmacMd5Context  Pointer to new HMAC-MD5 context.\r
 \r
-  @retval TRUE   HMAC-MD5 context copy succeeded.\r
-  @retval FALSE  HMAC-MD5 context copy failed.\r
   @retval FALSE  This interface is not supported.\r
 \r
 **/\r
 BOOLEAN\r
 EFIAPI\r
-CryptoServiceHmacMd5Duplicate (\r
+DeprecatedCryptoServiceHmacMd5Duplicate (\r
   IN   CONST VOID  *HmacMd5Context,\r
   OUT  VOID        *NewHmacMd5Context\r
   )\r
 {\r
-  return CALL_BASECRYPTLIB (HmacMd5.Services.Duplicate, HmacMd5Duplicate, (HmacMd5Context, NewHmacMd5Context), FALSE);\r
+  return BaseCryptLibServiceDeprecated ("HmacMd5Duplicate"), FALSE;\r
 }\r
 \r
 /**\r
-  Digests the input data and updates HMAC-MD5 context.\r
-\r
-  This function performs HMAC-MD5 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-MD5 context should be initialized by HmacMd5New(), and should not be finalized by\r
-  HmacMd5Final(). Behavior with invalid context is undefined.\r
-\r
-  If HmacMd5Context is NULL, then return FALSE.\r
-  If this interface is not supported, then return FALSE.\r
+  HMAC MD5 is deprecated and unsupported any longer.\r
+  Keep the function field for binary compability.\r
 \r
   @param[in, out]  HmacMd5Context  Pointer to the HMAC-MD5 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-MD5 data digest succeeded.\r
-  @retval FALSE  HMAC-MD5 data digest failed.\r
   @retval FALSE  This interface is not supported.\r
 \r
 **/\r
 BOOLEAN\r
 EFIAPI\r
-CryptoServiceHmacMd5Update (\r
+DeprecatedCryptoServiceHmacMd5Update (\r
   IN OUT  VOID        *HmacMd5Context,\r
   IN      CONST VOID  *Data,\r
   IN      UINTN       DataSize\r
   )\r
 {\r
-  return CALL_BASECRYPTLIB (HmacMd5.Services.Update, HmacMd5Update, (HmacMd5Context, Data, DataSize), FALSE);\r
+  return BaseCryptLibServiceDeprecated ("HmacMd5Update"), FALSE;\r
 }\r
 \r
 /**\r
-  Completes computation of the HMAC-MD5 digest value.\r
-\r
-  This function completes HMAC-MD5 hash computation and retrieves the digest value into\r
-  the specified memory. After this function has been called, the HMAC-MD5 context cannot\r
-  be used again.\r
-  HMAC-MD5 context should be initialized by HmacMd5New(), and should not be finalized by\r
-  HmacMd5Final(). Behavior with invalid HMAC-MD5 context is undefined.\r
-\r
-  If HmacMd5Context 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 MD5 is deprecated and unsupported any longer.\r
+  Keep the function field for binary compability.\r
 \r
   @param[in, out]  HmacMd5Context  Pointer to the HMAC-MD5 context.\r
   @param[out]      HmacValue       Pointer to a buffer that receives the HMAC-MD5 digest\r
                                    value (16 bytes).\r
 \r
-  @retval TRUE   HMAC-MD5 digest computation succeeded.\r
-  @retval FALSE  HMAC-MD5 digest computation failed.\r
   @retval FALSE  This interface is not supported.\r
 \r
 **/\r
 BOOLEAN\r
 EFIAPI\r
-CryptoServiceHmacMd5Final (\r
+DeprecatedCryptoServiceHmacMd5Final (\r
   IN OUT  VOID   *HmacMd5Context,\r
   OUT     UINT8  *HmacValue\r
   )\r
 {\r
-  return CALL_BASECRYPTLIB (HmacMd5.Services.Final, HmacMd5Final, (HmacMd5Context, HmacValue), FALSE);\r
+  return BaseCryptLibServiceDeprecated ("HmacMd5Final"), FALSE;\r
 }\r
 \r
 /**\r
@@ -4234,13 +4200,13 @@ CryptoServiceTlsGetCertRevocationList (
 const EDKII_CRYPTO_PROTOCOL mEdkiiCrypto = {\r
   /// Version\r
   CryptoServiceGetCryptoVersion,\r
-  /// HMAC MD5\r
-  CryptoServiceHmacMd5New,\r
-  CryptoServiceHmacMd5Free,\r
-  CryptoServiceHmacMd5SetKey,\r
-  CryptoServiceHmacMd5Duplicate,\r
-  CryptoServiceHmacMd5Update,\r
-  CryptoServiceHmacMd5Final,\r
+  /// HMAC MD5 - deprecated and unsupported\r
+  DeprecatedCryptoServiceHmacMd5New,\r
+  DeprecatedCryptoServiceHmacMd5Free,\r
+  DeprecatedCryptoServiceHmacMd5SetKey,\r
+  DeprecatedCryptoServiceHmacMd5Duplicate,\r
+  DeprecatedCryptoServiceHmacMd5Update,\r
+  DeprecatedCryptoServiceHmacMd5Final,\r
   /// HMAC SHA1\r
   CryptoServiceHmacSha1New,\r
   CryptoServiceHmacSha1Free,\r