from BaseCryptLib and TlsLib.\r
\r
Copyright (C) Microsoft Corporation. All rights reserved.\r
- Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>\r
+ Copyright (c) 2019 - 2022, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
A macro used to retrieve the FixedAtBuild PcdCryptoServiceFamilyEnable with a\r
typecast to its associcted structure type PCD_CRYPTO_SERVICE_FAMILY_ENABLE.\r
**/\r
-#define EDKII_CRYPTO_PCD ((const PCD_CRYPTO_SERVICE_FAMILY_ENABLE *) \\r
+#define EDKII_CRYPTO_PCD ((const PCD_CRYPTO_SERVICE_FAMILY_ENABLE *)\\r
(FixedPcdGetPtr (PcdCryptoServiceFamilyEnable)))\r
\r
/**\r
return EDKII_CRYPTO_VERSION;\r
}\r
\r
-//=====================================================================================\r
+// =====================================================================================\r
// One-Way Cryptographic Hash Primitives\r
-//=====================================================================================\r
+// =====================================================================================\r
\r
/**\r
- Retrieves the size, in bytes, of the context buffer required for MD4 hash operations.\r
+ MD4 is deprecated and unsupported any longer.\r
+ Keep the function field for binary compability.\r
+\r
+ @retval 0 This interface is not supported.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+DeprecatedCryptoServiceMd4GetContextSize (\r
+ VOID\r
+ )\r
+{\r
+ return BaseCryptLibServiceDeprecated ("Md4GetContextSize"), 0;\r
+}\r
+\r
+/**\r
+ MD4 is deprecated and unsupported any longer.\r
+ Keep the function field for binary compability.\r
+\r
+ @param[out] Md4Context Pointer to MD4 context being initialized.\r
+\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+DeprecatedCryptoServiceMd4Init (\r
+ OUT VOID *Md4Context\r
+ )\r
+{\r
+ return BaseCryptLibServiceDeprecated ("Md4Init"), FALSE;\r
+}\r
+\r
+/**\r
+ MD4 is deprecated and unsupported any longer.\r
+ Keep the function field for binary compability.\r
+\r
+ @param[in] Md4Context Pointer to MD4 context being copied.\r
+ @param[out] NewMd4Context Pointer to new MD4 context.\r
+\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+DeprecatedCryptoServiceMd4Duplicate (\r
+ IN CONST VOID *Md4Context,\r
+ OUT VOID *NewMd4Context\r
+ )\r
+{\r
+ return BaseCryptLibServiceDeprecated ("Md4Duplicate"), FALSE;\r
+}\r
+\r
+/**\r
+ MD4 is deprecated and unsupported any longer.\r
+ Keep the function field for binary compability.\r
+\r
+ @param[in, out] Md4Context Pointer to the MD4 context.\r
+ @param[in] Data Pointer to the buffer containing the data to be hashed.\r
+ @param[in] DataSize Size of Data buffer in bytes.\r
+\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+DeprecatedCryptoServiceMd4Update (\r
+ IN OUT VOID *Md4Context,\r
+ IN CONST VOID *Data,\r
+ IN UINTN DataSize\r
+ )\r
+{\r
+ return BaseCryptLibServiceDeprecated ("Md4Update"), FALSE;\r
+}\r
+\r
+/**\r
+ MD4 is deprecated and unsupported any longer.\r
+ Keep the function field for binary compability.\r
+\r
+ @param[in, out] Md4Context Pointer to the MD4 context.\r
+ @param[out] HashValue Pointer to a buffer that receives the MD4 digest\r
+ value (16 bytes).\r
+\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+DeprecatedCryptoServiceMd4Final (\r
+ IN OUT VOID *Md4Context,\r
+ OUT UINT8 *HashValue\r
+ )\r
+{\r
+ return BaseCryptLibServiceDeprecated ("Md4Final"), FALSE;\r
+}\r
+\r
+/**\r
+ MD4 is deprecated and unsupported any longer.\r
+ Keep the function field for binary compability.\r
+\r
+ @param[in] Data Pointer to the buffer containing the data to be hashed.\r
+ @param[in] DataSize Size of Data buffer in bytes.\r
+ @param[out] HashValue Pointer to a buffer that receives the MD4 digest\r
+ value (16 bytes).\r
+\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+DeprecatedCryptoServiceMd4HashAll (\r
+ IN CONST VOID *Data,\r
+ IN UINTN DataSize,\r
+ OUT UINT8 *HashValue\r
+ )\r
+{\r
+ return BaseCryptLibServiceDeprecated ("Md4HashAll"), FALSE;\r
+}\r
+\r
+#ifndef ENABLE_MD5_DEPRECATED_INTERFACES\r
+\r
+/**\r
+ Retrieves the size, in bytes, of the context buffer required for MD5 hash 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 MD4 hash operations.\r
@retval 0 This interface is not supported.\r
\r
**/\r
UINTN\r
EFIAPI\r
-CryptoServiceMd4GetContextSize (\r
+DeprecatedCryptoServiceMd5GetContextSize (\r
VOID\r
)\r
{\r
- return CALL_BASECRYPTLIB (Md4.Services.GetContextSize, Md4GetContextSize, (), 0);\r
+ return BaseCryptLibServiceDeprecated ("Md5GetContextSize"), 0;\r
}\r
\r
/**\r
- Initializes user-supplied memory pointed by Md4Context as MD4 hash context for\r
+ Initializes user-supplied memory pointed by Md5Context as MD5 hash context for\r
subsequent use.\r
\r
- If Md4Context is NULL, then return FALSE.\r
+ If Md5Context is NULL, then return FALSE.\r
If this interface is not supported, then return FALSE.\r
\r
- @param[out] Md4Context Pointer to MD4 context being initialized.\r
+ @param[out] Md5Context Pointer to MD5 context being initialized.\r
\r
- @retval TRUE MD4 context initialization succeeded.\r
- @retval FALSE MD4 context initialization failed.\r
@retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-CryptoServiceMd4Init (\r
- OUT VOID *Md4Context\r
+DeprecatedCryptoServiceMd5Init (\r
+ OUT VOID *Md5Context\r
)\r
{\r
- return CALL_BASECRYPTLIB (Md4.Services.Init, Md4Init, (Md4Context), FALSE);\r
+ return BaseCryptLibServiceDeprecated ("Md5Init"), FALSE;\r
}\r
\r
/**\r
- Makes a copy of an existing MD4 context.\r
+ Makes a copy of an existing MD5 context.\r
\r
- If Md4Context is NULL, then return FALSE.\r
- If NewMd4Context is NULL, then return FALSE.\r
+ If Md5Context is NULL, then return FALSE.\r
+ If NewMd5Context is NULL, then return FALSE.\r
If this interface is not supported, then return FALSE.\r
\r
- @param[in] Md4Context Pointer to MD4 context being copied.\r
- @param[out] NewMd4Context Pointer to new MD4 context.\r
+ @param[in] Md5Context Pointer to MD5 context being copied.\r
+ @param[out] NewMd5Context Pointer to new MD5 context.\r
\r
- @retval TRUE MD4 context copy succeeded.\r
- @retval FALSE MD4 context copy failed.\r
@retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-CryptoServiceMd4Duplicate (\r
- IN CONST VOID *Md4Context,\r
- OUT VOID *NewMd4Context\r
+DeprecatedCryptoServiceMd5Duplicate (\r
+ IN CONST VOID *Md5Context,\r
+ OUT VOID *NewMd5Context\r
)\r
{\r
- return CALL_BASECRYPTLIB (Md4.Services.Duplicate, Md4Duplicate, (Md4Context, NewMd4Context), FALSE);\r
+ return BaseCryptLibServiceDeprecated ("Md5Init"), FALSE;\r
}\r
\r
/**\r
- Digests the input data and updates MD4 context.\r
+ Digests the input data and updates MD5 context.\r
\r
- This function performs MD4 digest on a data buffer of the specified size.\r
+ This function performs 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
- MD4 context should be already correctly initialized by Md4Init(), and should not be finalized\r
- by Md4Final(). Behavior with invalid context is undefined.\r
+ MD5 context should be already correctly initialized by Md5Init(), and should not be finalized\r
+ by Md5Final(). Behavior with invalid context is undefined.\r
\r
- If Md4Context is NULL, then return FALSE.\r
+ If Md5Context is NULL, then return FALSE.\r
If this interface is not supported, then return FALSE.\r
\r
- @param[in, out] Md4Context Pointer to the MD4 context.\r
+ @param[in, out] Md5Context Pointer to the MD5 context.\r
@param[in] Data Pointer to the buffer containing the data to be hashed.\r
@param[in] DataSize Size of Data buffer in bytes.\r
\r
- @retval TRUE MD4 data digest succeeded.\r
- @retval FALSE MD4 data digest failed.\r
@retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-CryptoServiceMd4Update (\r
- IN OUT VOID *Md4Context,\r
+DeprecatedCryptoServiceMd5Update (\r
+ IN OUT VOID *Md5Context,\r
IN CONST VOID *Data,\r
IN UINTN DataSize\r
)\r
{\r
- return CALL_BASECRYPTLIB (Md4.Services.Update, Md4Update, (Md4Context, Data, DataSize), FALSE);\r
+ return BaseCryptLibServiceDeprecated ("Md5Init"), FALSE;\r
}\r
\r
/**\r
- Completes computation of the MD4 digest value.\r
+ Completes computation of the MD5 digest value.\r
\r
- This function completes MD4 hash computation and retrieves the digest value into\r
- the specified memory. After this function has been called, the MD4 context cannot\r
+ This function completes MD5 hash computation and retrieves the digest value into\r
+ the specified memory. After this function has been called, the MD5 context cannot\r
be used again.\r
- MD4 context should be already correctly initialized by Md4Init(), and should not be\r
- finalized by Md4Final(). Behavior with invalid MD4 context is undefined.\r
+ MD5 context should be already correctly initialized by Md5Init(), and should not be\r
+ finalized by Md5Final(). Behavior with invalid MD5 context is undefined.\r
\r
- If Md4Context is NULL, then return FALSE.\r
+ If Md5Context 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] Md4Context Pointer to the MD4 context.\r
- @param[out] HashValue Pointer to a buffer that receives the MD4 digest\r
+ @param[in, out] Md5Context Pointer to the MD5 context.\r
+ @param[out] HashValue Pointer to a buffer that receives the MD5 digest\r
value (16 bytes).\r
\r
- @retval TRUE MD4 digest computation succeeded.\r
- @retval FALSE MD4 digest computation failed.\r
@retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-CryptoServiceMd4Final (\r
- IN OUT VOID *Md4Context,\r
+DeprecatedCryptoServiceMd5Final (\r
+ IN OUT VOID *Md5Context,\r
OUT UINT8 *HashValue\r
)\r
{\r
- return CALL_BASECRYPTLIB (Md4.Services.Final, Md4Final, (Md4Context, HashValue), FALSE);\r
+ return BaseCryptLibServiceDeprecated ("Md5Final"), FALSE;\r
}\r
\r
/**\r
- Computes the MD4 message digest of a input data buffer.\r
+ Computes the MD5 message digest of a input data buffer.\r
\r
- This function performs the MD4 message digest of a given data buffer, and places\r
+ This function performs the MD5 message 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 hashed.\r
@param[in] DataSize Size of Data buffer in bytes.\r
- @param[out] HashValue Pointer to a buffer that receives the MD4 digest\r
+ @param[out] HashValue Pointer to a buffer that receives the MD5 digest\r
value (16 bytes).\r
\r
- @retval TRUE MD4 digest computation succeeded.\r
- @retval FALSE MD4 digest computation failed.\r
@retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-CryptoServiceMd4HashAll (\r
+DeprecatedCryptoServiceMd5HashAll (\r
IN CONST VOID *Data,\r
IN UINTN DataSize,\r
OUT UINT8 *HashValue\r
)\r
{\r
- return CALL_BASECRYPTLIB (Md4.Services.HashAll, Md4HashAll, (Data, DataSize, HashValue), FALSE);\r
+ return BaseCryptLibServiceDeprecated ("Md5HashAll"), FALSE;\r
}\r
\r
+#else\r
+\r
/**\r
Retrieves the size, in bytes, of the context buffer required for MD5 hash operations.\r
\r
return CALL_BASECRYPTLIB (Md5.Services.HashAll, Md5HashAll, (Data, DataSize, HashValue), FALSE);\r
}\r
\r
+#endif\r
+\r
+#ifdef DISABLE_SHA1_DEPRECATED_INTERFACES\r
+\r
/**\r
Retrieves the size, in bytes, of the context buffer required for SHA-1 hash 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 SHA-1 hash operations.\r
@retval 0 This interface is not supported.\r
\r
**/\r
UINTN\r
EFIAPI\r
-CryptoServiceSha1GetContextSize (\r
+DeprecatedCryptoServiceSha1GetContextSize (\r
VOID\r
)\r
{\r
- return CALL_BASECRYPTLIB (Sha1.Services.GetContextSize, Sha1GetContextSize, (), 0);\r
+ return BaseCryptLibServiceDeprecated ("Sha1GetContextSize"), 0;\r
}\r
\r
/**\r
**/\r
BOOLEAN\r
EFIAPI\r
-CryptoServiceSha1Init (\r
+DeprecatedCryptoServiceSha1Init (\r
OUT VOID *Sha1Context\r
)\r
{\r
- return CALL_BASECRYPTLIB (Sha1.Services.Init, Sha1Init, (Sha1Context), FALSE);\r
+ return BaseCryptLibServiceDeprecated ("Sha1Init"), FALSE;\r
}\r
\r
/**\r
@param[in] Sha1Context Pointer to SHA-1 context being copied.\r
@param[out] NewSha1Context Pointer to new SHA-1 context.\r
\r
- @retval TRUE SHA-1 context copy succeeded.\r
- @retval FALSE SHA-1 context copy failed.\r
@retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-CryptoServiceSha1Duplicate (\r
+DeprecatedCryptoServiceSha1Duplicate (\r
IN CONST VOID *Sha1Context,\r
OUT VOID *NewSha1Context\r
)\r
{\r
- return CALL_BASECRYPTLIB (Sha1.Services.Duplicate, Sha1Duplicate, (Sha1Context, NewSha1Context), FALSE);\r
+ return BaseCryptLibServiceDeprecated ("Sha1Duplicate"), FALSE;\r
}\r
\r
/**\r
@param[in] Data Pointer to the buffer containing the data to be hashed.\r
@param[in] DataSize Size of Data buffer in bytes.\r
\r
- @retval TRUE SHA-1 data digest succeeded.\r
- @retval FALSE SHA-1 data digest failed.\r
@retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-CryptoServiceSha1Update (\r
+DeprecatedCryptoServiceSha1Update (\r
IN OUT VOID *Sha1Context,\r
IN CONST VOID *Data,\r
IN UINTN DataSize\r
)\r
{\r
- return CALL_BASECRYPTLIB (Sha1.Services.Update, Sha1Update, (Sha1Context, Data, DataSize), FALSE);\r
+ return BaseCryptLibServiceDeprecated ("Sha1Update"), FALSE;\r
}\r
\r
/**\r
@param[out] HashValue Pointer to a buffer that receives the SHA-1 digest\r
value (20 bytes).\r
\r
- @retval TRUE SHA-1 digest computation succeeded.\r
- @retval FALSE SHA-1 digest computation failed.\r
@retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-CryptoServiceSha1Final (\r
+DeprecatedCryptoServiceSha1Final (\r
IN OUT VOID *Sha1Context,\r
OUT UINT8 *HashValue\r
)\r
{\r
- return CALL_BASECRYPTLIB (Sha1.Services.Final, Sha1Final, (Sha1Context, HashValue), FALSE);\r
+ return BaseCryptLibServiceDeprecated ("Sha1Final"), FALSE;\r
}\r
\r
/**\r
@param[out] HashValue Pointer to a buffer that receives the SHA-1 digest\r
value (20 bytes).\r
\r
- @retval TRUE SHA-1 digest computation succeeded.\r
- @retval FALSE SHA-1 digest computation failed.\r
@retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-CryptoServiceSha1HashAll (\r
+DeprecatedCryptoServiceSha1HashAll (\r
IN CONST VOID *Data,\r
IN UINTN DataSize,\r
OUT UINT8 *HashValue\r
)\r
{\r
- return CALL_BASECRYPTLIB (Sha1.Services.HashAll, Sha1HashAll, (Data, DataSize, HashValue), FALSE);\r
+ return BaseCryptLibServiceDeprecated ("Sha1HashAll"), FALSE;\r
}\r
\r
+#else\r
+\r
/**\r
- Retrieves the size, in bytes, of the context buffer required for SHA-256 hash operations.\r
+ Retrieves the size, in bytes, of the context buffer required for SHA-1 hash operations.\r
\r
- @return The size, in bytes, of the context buffer required for SHA-256 hash operations.\r
+ If this interface is not supported, then return zero.\r
+\r
+ @return The size, in bytes, of the context buffer required for SHA-1 hash operations.\r
+ @retval 0 This interface is not supported.\r
\r
**/\r
UINTN\r
EFIAPI\r
-CryptoServiceSha256GetContextSize (\r
+CryptoServiceSha1GetContextSize (\r
VOID\r
)\r
{\r
- return CALL_BASECRYPTLIB (Sha256.Services.GetContextSize, Sha256GetContextSize, (), 0);\r
+ return CALL_BASECRYPTLIB (Sha1.Services.GetContextSize, Sha1GetContextSize, (), 0);\r
}\r
\r
/**\r
- Initializes user-supplied memory pointed by Sha256Context as SHA-256 hash context for\r
+ Initializes user-supplied memory pointed by Sha1Context as SHA-1 hash context for\r
subsequent use.\r
\r
- If Sha256Context is NULL, then return FALSE.\r
+ If Sha1Context is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
- @param[out] Sha256Context Pointer to SHA-256 context being initialized.\r
+ @param[out] Sha1Context Pointer to SHA-1 context being initialized.\r
\r
- @retval TRUE SHA-256 context initialization succeeded.\r
- @retval FALSE SHA-256 context initialization failed.\r
+ @retval TRUE SHA-1 context initialization succeeded.\r
+ @retval FALSE SHA-1 context initialization failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-CryptoServiceSha256Init (\r
- OUT VOID *Sha256Context\r
+CryptoServiceSha1Init (\r
+ OUT VOID *Sha1Context\r
)\r
{\r
- return CALL_BASECRYPTLIB (Sha256.Services.Init, Sha256Init, (Sha256Context), FALSE);\r
+ return CALL_BASECRYPTLIB (Sha1.Services.Init, Sha1Init, (Sha1Context), FALSE);\r
}\r
\r
/**\r
- Makes a copy of an existing SHA-256 context.\r
+ Makes a copy of an existing SHA-1 context.\r
\r
- If Sha256Context is NULL, then return FALSE.\r
- If NewSha256Context is NULL, then return FALSE.\r
+ If Sha1Context is NULL, then return FALSE.\r
+ If NewSha1Context is NULL, then return FALSE.\r
If this interface is not supported, then return FALSE.\r
\r
- @param[in] Sha256Context Pointer to SHA-256 context being copied.\r
- @param[out] NewSha256Context Pointer to new SHA-256 context.\r
+ @param[in] Sha1Context Pointer to SHA-1 context being copied.\r
+ @param[out] NewSha1Context Pointer to new SHA-1 context.\r
\r
- @retval TRUE SHA-256 context copy succeeded.\r
- @retval FALSE SHA-256 context copy failed.\r
+ @retval TRUE SHA-1 context copy succeeded.\r
+ @retval FALSE SHA-1 context copy failed.\r
@retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-CryptoServiceSha256Duplicate (\r
- IN CONST VOID *Sha256Context,\r
- OUT VOID *NewSha256Context\r
+CryptoServiceSha1Duplicate (\r
+ IN CONST VOID *Sha1Context,\r
+ OUT VOID *NewSha1Context\r
)\r
{\r
- return CALL_BASECRYPTLIB (Sha256.Services.Duplicate, Sha256Duplicate, (Sha256Context, NewSha256Context), FALSE);\r
+ return CALL_BASECRYPTLIB (Sha1.Services.Duplicate, Sha1Duplicate, (Sha1Context, NewSha1Context), FALSE);\r
}\r
\r
/**\r
- Digests the input data and updates SHA-256 context.\r
+ Digests the input data and updates SHA-1 context.\r
\r
- This function performs SHA-256 digest on a data buffer of the specified size.\r
+ This function performs SHA-1 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
- SHA-256 context should be already correctly initialized by Sha256Init(), and should not be finalized\r
- by Sha256Final(). Behavior with invalid context is undefined.\r
+ SHA-1 context should be already correctly initialized by Sha1Init(), and should not be finalized\r
+ by Sha1Final(). Behavior with invalid context is undefined.\r
\r
- If Sha256Context is NULL, then return FALSE.\r
+ If Sha1Context is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
- @param[in, out] Sha256Context Pointer to the SHA-256 context.\r
- @param[in] Data Pointer to the buffer containing the data to be hashed.\r
- @param[in] DataSize Size of Data buffer in bytes.\r
+ @param[in, out] Sha1Context Pointer to the SHA-1 context.\r
+ @param[in] Data Pointer to the buffer containing the data to be hashed.\r
+ @param[in] DataSize Size of Data buffer in bytes.\r
\r
- @retval TRUE SHA-256 data digest succeeded.\r
- @retval FALSE SHA-256 data digest failed.\r
+ @retval TRUE SHA-1 data digest succeeded.\r
+ @retval FALSE SHA-1 data digest failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-CryptoServiceSha256Update (\r
- IN OUT VOID *Sha256Context,\r
+CryptoServiceSha1Update (\r
+ IN OUT VOID *Sha1Context,\r
IN CONST VOID *Data,\r
IN UINTN DataSize\r
)\r
{\r
- return CALL_BASECRYPTLIB (Sha256.Services.Update, Sha256Update, (Sha256Context, Data, DataSize), FALSE);\r
+ return CALL_BASECRYPTLIB (Sha1.Services.Update, Sha1Update, (Sha1Context, Data, DataSize), FALSE);\r
}\r
\r
/**\r
- Completes computation of the SHA-256 digest value.\r
+ Completes computation of the SHA-1 digest value.\r
\r
- This function completes SHA-256 hash computation and retrieves the digest value into\r
- the specified memory. After this function has been called, the SHA-256 context cannot\r
+ This function completes SHA-1 hash computation and retrieves the digest value into\r
+ the specified memory. After this function has been called, the SHA-1 context cannot\r
be used again.\r
- SHA-256 context should be already correctly initialized by Sha256Init(), and should not be\r
- finalized by Sha256Final(). Behavior with invalid SHA-256 context is undefined.\r
+ SHA-1 context should be already correctly initialized by Sha1Init(), and should not be\r
+ finalized by Sha1Final(). Behavior with invalid SHA-1 context is undefined.\r
\r
- If Sha256Context is NULL, then return FALSE.\r
+ If Sha1Context 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] Sha1Context Pointer to the SHA-1 context.\r
+ @param[out] HashValue Pointer to a buffer that receives the SHA-1 digest\r
+ value (20 bytes).\r
+\r
+ @retval TRUE SHA-1 digest computation succeeded.\r
+ @retval FALSE SHA-1 digest computation failed.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceSha1Final (\r
+ IN OUT VOID *Sha1Context,\r
+ OUT UINT8 *HashValue\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Sha1.Services.Final, Sha1Final, (Sha1Context, HashValue), FALSE);\r
+}\r
+\r
+/**\r
+ Computes the SHA-1 message digest of a input data buffer.\r
+\r
+ This function performs the SHA-1 message 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 hashed.\r
+ @param[in] DataSize Size of Data buffer in bytes.\r
+ @param[out] HashValue Pointer to a buffer that receives the SHA-1 digest\r
+ value (20 bytes).\r
+\r
+ @retval TRUE SHA-1 digest computation succeeded.\r
+ @retval FALSE SHA-1 digest computation failed.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceSha1HashAll (\r
+ IN CONST VOID *Data,\r
+ IN UINTN DataSize,\r
+ OUT UINT8 *HashValue\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Sha1.Services.HashAll, Sha1HashAll, (Data, DataSize, HashValue), FALSE);\r
+}\r
+\r
+#endif\r
+\r
+/**\r
+ Retrieves the size, in bytes, of the context buffer required for SHA-256 hash operations.\r
+\r
+ @return The size, in bytes, of the context buffer required for SHA-256 hash operations.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+CryptoServiceSha256GetContextSize (\r
+ VOID\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Sha256.Services.GetContextSize, Sha256GetContextSize, (), 0);\r
+}\r
+\r
+/**\r
+ Initializes user-supplied memory pointed by Sha256Context as SHA-256 hash context for\r
+ subsequent use.\r
+\r
+ If Sha256Context is NULL, then return FALSE.\r
+\r
+ @param[out] Sha256Context Pointer to SHA-256 context being initialized.\r
+\r
+ @retval TRUE SHA-256 context initialization succeeded.\r
+ @retval FALSE SHA-256 context initialization failed.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceSha256Init (\r
+ OUT VOID *Sha256Context\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Sha256.Services.Init, Sha256Init, (Sha256Context), FALSE);\r
+}\r
+\r
+/**\r
+ Makes a copy of an existing SHA-256 context.\r
+\r
+ If Sha256Context is NULL, then return FALSE.\r
+ If NewSha256Context is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
+\r
+ @param[in] Sha256Context Pointer to SHA-256 context being copied.\r
+ @param[out] NewSha256Context Pointer to new SHA-256 context.\r
+\r
+ @retval TRUE SHA-256 context copy succeeded.\r
+ @retval FALSE SHA-256 context copy failed.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceSha256Duplicate (\r
+ IN CONST VOID *Sha256Context,\r
+ OUT VOID *NewSha256Context\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Sha256.Services.Duplicate, Sha256Duplicate, (Sha256Context, NewSha256Context), FALSE);\r
+}\r
+\r
+/**\r
+ Digests the input data and updates SHA-256 context.\r
+\r
+ This function performs SHA-256 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
+ SHA-256 context should be already correctly initialized by Sha256Init(), and should not be finalized\r
+ by Sha256Final(). Behavior with invalid context is undefined.\r
+\r
+ If Sha256Context is NULL, then return FALSE.\r
+\r
+ @param[in, out] Sha256Context Pointer to the SHA-256 context.\r
+ @param[in] Data Pointer to the buffer containing the data to be hashed.\r
+ @param[in] DataSize Size of Data buffer in bytes.\r
+\r
+ @retval TRUE SHA-256 data digest succeeded.\r
+ @retval FALSE SHA-256 data digest failed.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceSha256Update (\r
+ IN OUT VOID *Sha256Context,\r
+ IN CONST VOID *Data,\r
+ IN UINTN DataSize\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Sha256.Services.Update, Sha256Update, (Sha256Context, Data, DataSize), FALSE);\r
+}\r
+\r
+/**\r
+ Completes computation of the SHA-256 digest value.\r
+\r
+ This function completes SHA-256 hash computation and retrieves the digest value into\r
+ the specified memory. After this function has been called, the SHA-256 context cannot\r
+ be used again.\r
+ SHA-256 context should be already correctly initialized by Sha256Init(), and should not be\r
+ finalized by Sha256Final(). Behavior with invalid SHA-256 context is undefined.\r
+\r
+ If Sha256Context is NULL, then return FALSE.\r
If HashValue is NULL, then return FALSE.\r
\r
@param[in, out] Sha256Context Pointer to the SHA-256 context.\r
return CALL_BASECRYPTLIB (Sm3.Services.HashAll, Sm3HashAll, (Data, DataSize, HashValue), FALSE);\r
}\r
\r
-//=====================================================================================\r
+// =====================================================================================\r
// MAC (Message Authentication Code) Primitive\r
-//=====================================================================================\r
+// =====================================================================================\r
\r
/**\r
- Allocates and initializes one HMAC_CTX context for subsequent HMAC-MD5 use.\r
+ HMAC MD5 is deprecated and unsupported any longer.\r
+ Keep the function field for binary compability.\r
\r
- If this interface is not supported, then return NULL.\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
- Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA1 use.\r
+ HMAC SHA1 is deprecated and unsupported any longer.\r
+ Keep the function field for binary compability.\r
\r
- If this interface is not supported, then return NULL.\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
return CALL_BASECRYPTLIB (HmacSha256.Services.Final, HmacSha256Final, (HmacSha256Context, HmacValue), FALSE);\r
}\r
\r
-//=====================================================================================\r
-// Symmetric Cryptography Primitive\r
-//=====================================================================================\r
-\r
/**\r
- Retrieves the size, in bytes, of the context buffer required for TDES operations.\r
+ Computes the HMAC-SHA256 digest of a input data buffer.\r
\r
- If this interface is not supported, then return zero.\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
- @return The size, in bytes, of the context buffer required for TDES operations.\r
- @retval 0 This interface is not supported.\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
-UINTN\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceHmacSha256All (\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 CALL_BASECRYPTLIB (HmacSha256.Services.All, HmacSha256All, (Data, DataSize, Key, KeySize, HmacValue), FALSE);\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
-CryptoServiceTdesGetContextSize (\r
+CryptoServiceHmacSha384New (\r
VOID\r
)\r
{\r
- return CALL_BASECRYPTLIB (Tdes.Services.GetContextSize, TdesGetContextSize, (), 0);\r
+ return CALL_BASECRYPTLIB (HmacSha384.Services.New, HmacSha384New, (), NULL);\r
}\r
\r
/**\r
- Initializes user-supplied memory as TDES context for subsequent use.\r
+ Release the specified HMAC_CTX context.\r
\r
- This function initializes user-supplied memory pointed by TdesContext as TDES context.\r
- In addition, it sets up all TDES key materials for subsequent encryption and decryption\r
- operations.\r
- There are 3 key options as follows:\r
- KeyLength = 64, Keying option 1: K1 == K2 == K3 (Backward compatibility with DES)\r
- KeyLength = 128, Keying option 2: K1 != K2 and K3 = K1 (Less Security)\r
- KeyLength = 192 Keying option 3: K1 != K2 != K3 (Strongest)\r
+ @param[in] HmacSha384Ctx Pointer to the HMAC_CTX context to be released.\r
\r
- If TdesContext is NULL, then return FALSE.\r
- If Key is NULL, then return FALSE.\r
- If KeyLength is not valid, then return FALSE.\r
+**/\r
+VOID\r
+EFIAPI\r
+CryptoServiceHmacSha384Free (\r
+ IN VOID *HmacSha384Ctx\r
+ )\r
+{\r
+ CALL_VOID_BASECRYPTLIB (HmacSha384.Services.Free, HmacSha384Free, (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] TdesContext Pointer to TDES context being initialized.\r
- @param[in] Key Pointer to the user-supplied TDES key.\r
- @param[in] KeyLength Length of TDES key in bits.\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 TDES context initialization succeeded.\r
- @retval FALSE TDES context initialization failed.\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
-CryptoServiceTdesInit (\r
- OUT VOID *TdesContext,\r
+CryptoServiceHmacSha384SetKey (\r
+ OUT VOID *HmacSha384Context,\r
IN CONST UINT8 *Key,\r
- IN UINTN KeyLength\r
+ IN UINTN KeySize\r
)\r
{\r
- return CALL_BASECRYPTLIB (Tdes.Services.Init, TdesInit, (TdesContext, Key, KeyLength), FALSE);\r
+ return CALL_BASECRYPTLIB (HmacSha384.Services.SetKey, HmacSha384SetKey, (HmacSha384Context, Key, KeySize), FALSE);\r
}\r
\r
/**\r
- Performs TDES encryption on a data buffer of the specified size in ECB mode.\r
-\r
- This function performs TDES encryption on data buffer pointed by Input, of specified\r
- size of InputSize, in ECB mode.\r
- InputSize must be multiple of block size (8 bytes). This function does not perform\r
- padding. Caller must perform padding, if necessary, to ensure valid input data size.\r
- TdesContext should be already correctly initialized by TdesInit(). Behavior with\r
- invalid TDES context is undefined.\r
+ Makes a copy of an existing HMAC-SHA384 context.\r
\r
- If TdesContext is NULL, then return FALSE.\r
- If Input is NULL, then return FALSE.\r
- If InputSize is not multiple of block size (8 bytes), then return FALSE.\r
- If Output is NULL, then return FALSE.\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] TdesContext Pointer to the TDES context.\r
- @param[in] Input Pointer to the buffer containing the data to be encrypted.\r
- @param[in] InputSize Size of the Input buffer in bytes.\r
- @param[out] Output Pointer to a buffer that receives the TDES encryption output.\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 TDES encryption succeeded.\r
- @retval FALSE TDES encryption failed.\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
-CryptoServiceTdesEcbEncrypt (\r
- IN VOID *TdesContext,\r
- IN CONST UINT8 *Input,\r
- IN UINTN InputSize,\r
- OUT UINT8 *Output\r
+CryptoServiceHmacSha384Duplicate (\r
+ IN CONST VOID *HmacSha384Context,\r
+ OUT VOID *NewHmacSha384Context\r
)\r
{\r
- return CALL_BASECRYPTLIB (Tdes.Services.EcbEncrypt, TdesEcbEncrypt, (TdesContext, Input, InputSize, Output), FALSE);\r
+ return CALL_BASECRYPTLIB (HmacSha384.Services.Duplicate, HmacSha256Duplicate, (HmacSha384Context, NewHmacSha384Context), FALSE);\r
}\r
\r
/**\r
- Performs TDES decryption on a data buffer of the specified size in ECB mode.\r
+ Digests the input data and updates HMAC-SHA384 context.\r
\r
- This function performs TDES decryption on data buffer pointed by Input, of specified\r
- size of InputSize, in ECB mode.\r
- InputSize must be multiple of block size (8 bytes). This function does not perform\r
- padding. Caller must perform padding, if necessary, to ensure valid input data size.\r
- TdesContext should be already correctly initialized by TdesInit(). Behavior with\r
- invalid TDES context is undefined.\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
+CryptoServiceHmacSha384Update (\r
+ IN OUT VOID *HmacSha384Context,\r
+ IN CONST VOID *Data,\r
+ IN UINTN DataSize\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (HmacSha384.Services.Update, HmacSha384Update, (HmacSha384Context, Data, DataSize), FALSE);\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
+CryptoServiceHmacSha384Final (\r
+ IN OUT VOID *HmacSha384Context,\r
+ OUT UINT8 *HmacValue\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (HmacSha384.Services.Final, HmacSha384Final, (HmacSha384Context, HmacValue), FALSE);\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 TdesContext is NULL, then return FALSE.\r
- If Input is NULL, then return FALSE.\r
- If InputSize is not multiple of block size (8 bytes), then return FALSE.\r
- If Output is NULL, then return FALSE.\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
+CryptoServiceHmacSha384All (\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 CALL_BASECRYPTLIB (HmacSha384.Services.All, HmacSha384All, (Data, DataSize, Key, KeySize, HmacValue), FALSE);\r
+}\r
+\r
+// =====================================================================================\r
+// Symmetric Cryptography Primitive\r
+// =====================================================================================\r
+\r
+/**\r
+ TDES is deprecated and unsupported any longer.\r
+ Keep the function field for binary compability.\r
+\r
+ @retval 0 This interface is not supported.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+DeprecatedCryptoServiceTdesGetContextSize (\r
+ VOID\r
+ )\r
+{\r
+ return BaseCryptLibServiceDeprecated ("TdesGetContextSize"), 0;\r
+}\r
+\r
+/**\r
+ TDES is deprecated and unsupported any longer.\r
+ Keep the function field for binary compability.\r
+\r
+ @param[out] TdesContext Pointer to TDES context being initialized.\r
+ @param[in] Key Pointer to the user-supplied TDES key.\r
+ @param[in] KeyLength Length of TDES key in bits.\r
+\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+DeprecatedCryptoServiceTdesInit (\r
+ OUT VOID *TdesContext,\r
+ IN CONST UINT8 *Key,\r
+ IN UINTN KeyLength\r
+ )\r
+{\r
+ return BaseCryptLibServiceDeprecated ("TdesInit"), FALSE;\r
+}\r
+\r
+/**\r
+ TDES is deprecated and unsupported any longer.\r
+ Keep the function field for binary compability.\r
+\r
@param[in] TdesContext Pointer to the TDES context.\r
- @param[in] Input Pointer to the buffer containing the data to be decrypted.\r
+ @param[in] Input Pointer to the buffer containing the data to be encrypted.\r
@param[in] InputSize Size of the Input buffer in bytes.\r
- @param[out] Output Pointer to a buffer that receives the TDES decryption output.\r
+ @param[out] Output Pointer to a buffer that receives the TDES encryption output.\r
\r
- @retval TRUE TDES decryption succeeded.\r
- @retval FALSE TDES decryption failed.\r
@retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-CryptoServiceTdesEcbDecrypt (\r
+DeprecatedCryptoServiceTdesEcbEncrypt (\r
IN VOID *TdesContext,\r
IN CONST UINT8 *Input,\r
IN UINTN InputSize,\r
OUT UINT8 *Output\r
)\r
{\r
- return CALL_BASECRYPTLIB (Tdes.Services.EcbDecrypt, TdesEcbDecrypt, (TdesContext, Input, InputSize, Output), FALSE);\r
+ return BaseCryptLibServiceDeprecated ("TdesEcbEncrypt"), FALSE;\r
}\r
\r
/**\r
- Performs TDES encryption on a data buffer of the specified size in CBC mode.\r
+ TDES is deprecated and unsupported any longer.\r
+ Keep the function field for binary compability.\r
\r
- This function performs TDES encryption on data buffer pointed by Input, of specified\r
- size of InputSize, in CBC mode.\r
- InputSize must be multiple of block size (8 bytes). This function does not perform\r
- padding. Caller must perform padding, if necessary, to ensure valid input data size.\r
- Initialization vector should be one block size (8 bytes).\r
- TdesContext should be already correctly initialized by TdesInit(). Behavior with\r
- invalid TDES context is undefined.\r
+ @param[in] TdesContext Pointer to the TDES context.\r
+ @param[in] Input Pointer to the buffer containing the data to be decrypted.\r
+ @param[in] InputSize Size of the Input buffer in bytes.\r
+ @param[out] Output Pointer to a buffer that receives the TDES decryption output.\r
\r
- If TdesContext is NULL, then return FALSE.\r
- If Input is NULL, then return FALSE.\r
- If InputSize is not multiple of block size (8 bytes), then return FALSE.\r
- If Ivec is NULL, then return FALSE.\r
- If Output is NULL, then return FALSE.\r
- If this interface is not supported, then return FALSE.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+DeprecatedCryptoServiceTdesEcbDecrypt (\r
+ IN VOID *TdesContext,\r
+ IN CONST UINT8 *Input,\r
+ IN UINTN InputSize,\r
+ OUT UINT8 *Output\r
+ )\r
+{\r
+ return BaseCryptLibServiceDeprecated ("TdesEcbDecrypt"), FALSE;\r
+}\r
+\r
+/**\r
+ TDES is deprecated and unsupported any longer.\r
+ Keep the function field for binary compability.\r
\r
@param[in] TdesContext Pointer to the TDES context.\r
@param[in] Input Pointer to the buffer containing the data to be encrypted.\r
@param[in] Ivec Pointer to initialization vector.\r
@param[out] Output Pointer to a buffer that receives the TDES encryption output.\r
\r
- @retval TRUE TDES encryption succeeded.\r
- @retval FALSE TDES encryption failed.\r
@retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-CryptoServiceTdesCbcEncrypt (\r
+DeprecatedCryptoServiceTdesCbcEncrypt (\r
IN VOID *TdesContext,\r
IN CONST UINT8 *Input,\r
IN UINTN InputSize,\r
OUT UINT8 *Output\r
)\r
{\r
- return CALL_BASECRYPTLIB (Tdes.Services.CbcEncrypt, TdesCbcEncrypt, (TdesContext, Input, InputSize, Ivec, Output), FALSE);\r
+ return BaseCryptLibServiceDeprecated ("TdesCbcEncrypt"), FALSE;\r
}\r
\r
/**\r
- Performs TDES decryption on a data buffer of the specified size in CBC mode.\r
-\r
- This function performs TDES decryption on data buffer pointed by Input, of specified\r
- size of InputSize, in CBC mode.\r
- InputSize must be multiple of block size (8 bytes). This function does not perform\r
- padding. Caller must perform padding, if necessary, to ensure valid input data size.\r
- Initialization vector should be one block size (8 bytes).\r
- TdesContext should be already correctly initialized by TdesInit(). Behavior with\r
- invalid TDES context is undefined.\r
-\r
- If TdesContext is NULL, then return FALSE.\r
- If Input is NULL, then return FALSE.\r
- If InputSize is not multiple of block size (8 bytes), then return FALSE.\r
- If Ivec is NULL, then return FALSE.\r
- If Output is NULL, then return FALSE.\r
- If this interface is not supported, then return FALSE.\r
+ TDES is deprecated and unsupported any longer.\r
+ Keep the function field for binary compability.\r
\r
@param[in] TdesContext Pointer to the TDES context.\r
@param[in] Input Pointer to the buffer containing the data to be encrypted.\r
@param[in] Ivec Pointer to initialization vector.\r
@param[out] Output Pointer to a buffer that receives the TDES encryption output.\r
\r
- @retval TRUE TDES decryption succeeded.\r
- @retval FALSE TDES decryption failed.\r
@retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-CryptoServiceTdesCbcDecrypt (\r
+DeprecatedCryptoServiceTdesCbcDecrypt (\r
IN VOID *TdesContext,\r
IN CONST UINT8 *Input,\r
IN UINTN InputSize,\r
OUT UINT8 *Output\r
)\r
{\r
- return CALL_BASECRYPTLIB (Tdes.Services.CbcDecrypt, TdesCbcDecrypt, (TdesContext, Input, InputSize, Ivec, Output), FALSE);\r
+ return BaseCryptLibServiceDeprecated ("TdesCbcDecrypt"), FALSE;\r
}\r
\r
/**\r
}\r
\r
/**\r
- Performs AES encryption on a data buffer of the specified size in ECB mode.\r
-\r
- This function performs AES encryption on data buffer pointed by Input, of specified\r
- size of InputSize, in ECB mode.\r
- InputSize must be multiple of block size (16 bytes). This function does not perform\r
- padding. Caller must perform padding, if necessary, to ensure valid input data size.\r
- AesContext should be already correctly initialized by AesInit(). Behavior with\r
- invalid AES context is undefined.\r
-\r
- If AesContext is NULL, then return FALSE.\r
- If Input is NULL, then return FALSE.\r
- If InputSize is not multiple of block size (16 bytes), then return FALSE.\r
- If Output is NULL, then return FALSE.\r
- If this interface is not supported, then return FALSE.\r
+ AES ECB Mode is deprecated and unsupported any longer.\r
+ Keep the function field for binary compability.\r
\r
@param[in] AesContext Pointer to the AES context.\r
@param[in] Input Pointer to the buffer containing the data to be encrypted.\r
@param[in] InputSize Size of the Input buffer in bytes.\r
@param[out] Output Pointer to a buffer that receives the AES encryption output.\r
\r
- @retval TRUE AES encryption succeeded.\r
- @retval FALSE AES encryption failed.\r
@retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-CryptoServiceAesEcbEncrypt (\r
+DeprecatedCryptoServiceAesEcbEncrypt (\r
IN VOID *AesContext,\r
IN CONST UINT8 *Input,\r
IN UINTN InputSize,\r
OUT UINT8 *Output\r
)\r
{\r
- return CALL_BASECRYPTLIB (Aes.Services.EcbEncrypt, AesEcbEncrypt, (AesContext, Input, InputSize, Output), FALSE);\r
+ return BaseCryptLibServiceDeprecated ("AesEcbEncrypt"), FALSE;\r
}\r
\r
/**\r
- Performs AES decryption on a data buffer of the specified size in ECB mode.\r
-\r
- This function performs AES decryption on data buffer pointed by Input, of specified\r
- size of InputSize, in ECB mode.\r
- InputSize must be multiple of block size (16 bytes). This function does not perform\r
- padding. Caller must perform padding, if necessary, to ensure valid input data size.\r
- AesContext should be already correctly initialized by AesInit(). Behavior with\r
- invalid AES context is undefined.\r
-\r
- If AesContext is NULL, then return FALSE.\r
- If Input is NULL, then return FALSE.\r
- If InputSize is not multiple of block size (16 bytes), then return FALSE.\r
- If Output is NULL, then return FALSE.\r
- If this interface is not supported, then return FALSE.\r
+ AES ECB Mode is deprecated and unsupported any longer.\r
+ Keep the function field for binary compability.\r
\r
@param[in] AesContext Pointer to the AES context.\r
@param[in] Input Pointer to the buffer containing the data to be decrypted.\r
@param[in] InputSize Size of the Input buffer in bytes.\r
@param[out] Output Pointer to a buffer that receives the AES decryption output.\r
\r
- @retval TRUE AES decryption succeeded.\r
- @retval FALSE AES decryption failed.\r
@retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-CryptoServiceAesEcbDecrypt (\r
+DeprecatedCryptoServiceAesEcbDecrypt (\r
IN VOID *AesContext,\r
IN CONST UINT8 *Input,\r
IN UINTN InputSize,\r
OUT UINT8 *Output\r
)\r
{\r
- return CALL_BASECRYPTLIB (Aes.Services.EcbDecrypt, AesEcbDecrypt, (AesContext, Input, InputSize, Output), FALSE);\r
+ return BaseCryptLibServiceDeprecated ("AesEcbDecrypt"), FALSE;\r
}\r
\r
/**\r
}\r
\r
/**\r
- Retrieves the size, in bytes, of the context buffer required for ARC4 operations.\r
+ ARC4 is deprecated and unsupported any longer.\r
+ Keep the function field for binary compability.\r
\r
- If this interface is not supported, then return zero.\r
-\r
- @return The size, in bytes, of the context buffer required for ARC4 operations.\r
@retval 0 This interface is not supported.\r
\r
**/\r
UINTN\r
EFIAPI\r
-CryptoServiceArc4GetContextSize (\r
+DeprecatedCryptoServiceArc4GetContextSize (\r
VOID\r
)\r
{\r
- return CALL_BASECRYPTLIB (Arc4.Services.GetContextSize, Arc4GetContextSize, (), 0);\r
+ return BaseCryptLibServiceDeprecated ("Arc4GetContextSize"), 0;\r
}\r
\r
/**\r
- Initializes user-supplied memory as ARC4 context for subsequent use.\r
-\r
- This function initializes user-supplied memory pointed by Arc4Context as ARC4 context.\r
- In addition, it sets up all ARC4 key materials for subsequent encryption and decryption\r
- operations.\r
-\r
- If Arc4Context is NULL, then return FALSE.\r
- If Key is NULL, then return FALSE.\r
- If KeySize does not in the range of [5, 256] bytes, then return FALSE.\r
- If this interface is not supported, then return FALSE.\r
+ ARC4 is deprecated and unsupported any longer.\r
+ Keep the function field for binary compability.\r
\r
@param[out] Arc4Context Pointer to ARC4 context being initialized.\r
@param[in] Key Pointer to the user-supplied ARC4 key.\r
@param[in] KeySize Size of ARC4 key in bytes.\r
\r
- @retval TRUE ARC4 context initialization succeeded.\r
- @retval FALSE ARC4 context initialization failed.\r
@retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-CryptoServiceArc4Init (\r
+DeprecatedCryptoServiceArc4Init (\r
OUT VOID *Arc4Context,\r
IN CONST UINT8 *Key,\r
IN UINTN KeySize\r
)\r
{\r
- return CALL_BASECRYPTLIB (Arc4.Services.Init, Arc4Init, (Arc4Context, Key, KeySize), FALSE);\r
+ return BaseCryptLibServiceDeprecated ("Arc4Init"), FALSE;\r
}\r
\r
/**\r
- Performs ARC4 encryption on a data buffer of the specified size.\r
-\r
- This function performs ARC4 encryption on data buffer pointed by Input, of specified\r
- size of InputSize.\r
- Arc4Context should be already correctly initialized by Arc4Init(). Behavior with\r
- invalid ARC4 context is undefined.\r
-\r
- If Arc4Context is NULL, then return FALSE.\r
- If Input is NULL, then return FALSE.\r
- If Output is NULL, then return FALSE.\r
- If this interface is not supported, then return FALSE.\r
+ ARC4 is deprecated and unsupported any longer.\r
+ Keep the function field for binary compability.\r
\r
@param[in, out] Arc4Context Pointer to the ARC4 context.\r
@param[in] Input Pointer to the buffer containing the data to be encrypted.\r
@param[in] InputSize Size of the Input buffer in bytes.\r
@param[out] Output Pointer to a buffer that receives the ARC4 encryption output.\r
\r
- @retval TRUE ARC4 encryption succeeded.\r
- @retval FALSE ARC4 encryption failed.\r
@retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-CryptoServiceArc4Encrypt (\r
+DeprecatedCryptoServiceArc4Encrypt (\r
IN OUT VOID *Arc4Context,\r
IN CONST UINT8 *Input,\r
IN UINTN InputSize,\r
OUT UINT8 *Output\r
)\r
{\r
- return CALL_BASECRYPTLIB (Arc4.Services.Encrypt, Arc4Encrypt, (Arc4Context, Input, InputSize, Output), FALSE);\r
+ return BaseCryptLibServiceDeprecated ("Arc4Encrypt"), FALSE;\r
}\r
\r
/**\r
- Performs ARC4 decryption on a data buffer of the specified size.\r
-\r
- This function performs ARC4 decryption on data buffer pointed by Input, of specified\r
- size of InputSize.\r
- Arc4Context should be already correctly initialized by Arc4Init(). Behavior with\r
- invalid ARC4 context is undefined.\r
-\r
- If Arc4Context is NULL, then return FALSE.\r
- If Input is NULL, then return FALSE.\r
- If Output is NULL, then return FALSE.\r
- If this interface is not supported, then return FALSE.\r
+ ARC4 is deprecated and unsupported any longer.\r
+ Keep the function field for binary compability.\r
\r
@param[in, out] Arc4Context Pointer to the ARC4 context.\r
@param[in] Input Pointer to the buffer containing the data to be decrypted.\r
@param[in] InputSize Size of the Input buffer in bytes.\r
@param[out] Output Pointer to a buffer that receives the ARC4 decryption output.\r
\r
- @retval TRUE ARC4 decryption succeeded.\r
- @retval FALSE ARC4 decryption failed.\r
@retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-CryptoServiceArc4Decrypt (\r
+DeprecatedCryptoServiceArc4Decrypt (\r
IN OUT VOID *Arc4Context,\r
IN UINT8 *Input,\r
IN UINTN InputSize,\r
OUT UINT8 *Output\r
)\r
{\r
- return CALL_BASECRYPTLIB (Arc4.Services.Decrypt, Arc4Decrypt, (Arc4Context, Input, InputSize, Output), FALSE);\r
+ return BaseCryptLibServiceDeprecated ("Arc4Decrypt"), FALSE;\r
}\r
\r
/**\r
- Resets the ARC4 context to the initial state.\r
-\r
- The function resets the ARC4 context to the state it had immediately after the\r
- ARC4Init() function call.\r
- Contrary to ARC4Init(), Arc4Reset() requires no secret key as input, but ARC4 context\r
- should be already correctly initialized by ARC4Init().\r
-\r
- If Arc4Context is NULL, then return FALSE.\r
- If this interface is not supported, then return FALSE.\r
+ ARC4 is deprecated and unsupported any longer.\r
+ Keep the function field for binary compability.\r
\r
@param[in, out] Arc4Context Pointer to the ARC4 context.\r
\r
- @retval TRUE ARC4 reset succeeded.\r
- @retval FALSE ARC4 reset failed.\r
@retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-CryptoServiceArc4Reset (\r
+DeprecatedCryptoServiceArc4Reset (\r
IN OUT VOID *Arc4Context\r
)\r
{\r
- return CALL_BASECRYPTLIB (Arc4.Services.Reset, Arc4Reset, (Arc4Context), FALSE);\r
+ return BaseCryptLibServiceDeprecated ("Arc4Reset"), FALSE;\r
}\r
\r
-//=====================================================================================\r
+// =====================================================================================\r
// Asymmetric Cryptography Primitive\r
-//=====================================================================================\r
+// =====================================================================================\r
\r
/**\r
Allocates and initializes one RSA context for subsequent use.\r
CryptoServiceX509GetCommonName (\r
IN CONST UINT8 *Cert,\r
IN UINTN CertSize,\r
- OUT CHAR8 *CommonName, OPTIONAL\r
+ OUT CHAR8 *CommonName OPTIONAL,\r
IN OUT UINTN *CommonNameSize\r
)\r
{\r
RETURN_STATUS\r
EFIAPI\r
CryptoServiceX509GetOrganizationName (\r
- IN CONST UINT8 *Cert,\r
- IN UINTN CertSize,\r
- OUT CHAR8 *NameBuffer, OPTIONAL\r
- IN OUT UINTN *NameBufferSize\r
+ IN CONST UINT8 *Cert,\r
+ IN UINTN CertSize,\r
+ OUT CHAR8 *NameBuffer OPTIONAL,\r
+ IN OUT UINTN *NameBufferSize\r
)\r
{\r
return CALL_BASECRYPTLIB (X509.Services.GetOrganizationName, X509GetOrganizationName, (Cert, CertSize, NameBuffer, NameBufferSize), RETURN_UNSUPPORTED);\r
IN UINTN PublicKeySize,\r
IN UINT8 *InData,\r
IN UINTN InDataSize,\r
- IN CONST UINT8 *PrngSeed, OPTIONAL\r
- IN UINTN PrngSeedSize, OPTIONAL\r
+ IN CONST UINT8 *PrngSeed OPTIONAL,\r
+ IN UINTN PrngSeedSize OPTIONAL,\r
OUT UINT8 **EncryptedData,\r
OUT UINTN *EncryptedDataSize\r
)\r
VOID\r
EFIAPI\r
CryptoServicePkcs7FreeSigners (\r
- IN UINT8 *Certs\r
+ IN UINT8 *Certs\r
)\r
{\r
CALL_VOID_BASECRYPTLIB (Pkcs.Services.Pkcs7FreeSigners, Pkcs7FreeSigners, (Certs));\r
return CALL_BASECRYPTLIB (Pkcs.Services.VerifyEKUsInPkcs7Signature, VerifyEKUsInPkcs7Signature, (Pkcs7Signature, SignatureSize, RequiredEKUs, RequiredEKUsSize, RequireAllPresent), FALSE);\r
}\r
\r
-\r
/**\r
Extracts the attached content from a PKCS#7 signed data if existed. The input signed\r
data could be wrapped in a ContentInfo structure.\r
return CALL_BASECRYPTLIB (Pkcs.Services.ImageTimestampVerify, ImageTimestampVerify, (AuthData, DataSize, TsaCert, CertSize, SigningTime), FALSE);\r
}\r
\r
-//=====================================================================================\r
+// =====================================================================================\r
// DH Key Exchange Primitive\r
-//=====================================================================================\r
+// =====================================================================================\r
\r
/**\r
Allocates and Initializes one Diffie-Hellman Context for subsequent use.\r
return CALL_BASECRYPTLIB (Dh.Services.ComputeKey, DhComputeKey, (DhContext, PeerPublicKey, PeerPublicKeySize, Key, KeySize), FALSE);\r
}\r
\r
-//=====================================================================================\r
+// =====================================================================================\r
// Pseudo-Random Generation Primitive\r
-//=====================================================================================\r
+// =====================================================================================\r
\r
/**\r
Sets up the seed value for the pseudorandom number generator.\r
return CALL_BASECRYPTLIB (Random.Services.Bytes, RandomBytes, (Output, Size), FALSE);\r
}\r
\r
-//=====================================================================================\r
+// =====================================================================================\r
// Key Derivation Function Primitive\r
-//=====================================================================================\r
+// =====================================================================================\r
\r
/**\r
Derive key data using HMAC-SHA256 based KDF.\r
}\r
\r
/**\r
- Initializes the OpenSSL library.\r
+ Derive SHA256 HMAC-based Extract key Derivation Function (HKDF).\r
\r
- This function registers ciphers and digests used directly and indirectly\r
- by SSL/TLS, and initializes the readable error messages.\r
- This function must be called before any other action takes places.\r
+ @param[in] Key Pointer to the user-supplied key.\r
+ @param[in] KeySize key size in bytes.\r
+ @param[in] Salt Pointer to the salt(non-secret) value.\r
+ @param[in] SaltSize salt size in bytes.\r
+ @param[out] PrkOut Pointer to buffer to receive hkdf value.\r
+ @param[in] PrkOutSize size of hkdf bytes to generate.\r
\r
- @retval TRUE The OpenSSL library has been initialized.\r
- @retval FALSE Failed to initialize the OpenSSL library.\r
+ @retval true Hkdf generated successfully.\r
+ @retval false Hkdf generation failed.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-CryptoServiceTlsInitialize (\r
- VOID\r
+CryptoServiceHkdfSha256Extract (\r
+ IN CONST UINT8 *Key,\r
+ IN UINTN KeySize,\r
+ IN CONST UINT8 *Salt,\r
+ IN UINTN SaltSize,\r
+ OUT UINT8 *PrkOut,\r
+ UINTN PrkOutSize\r
)\r
{\r
- return CALL_BASECRYPTLIB (Tls.Services.Initialize, TlsInitialize, (), FALSE);\r
+ return CALL_BASECRYPTLIB (Hkdf.Services.Sha256Extract, HkdfSha256Extract, (Key, KeySize, Salt, SaltSize, PrkOut, PrkOutSize), FALSE);\r
}\r
\r
/**\r
- Free an allocated SSL_CTX object.\r
+ Derive SHA256 HMAC-based Expand Key Derivation Function (HKDF).\r
\r
- @param[in] TlsCtx Pointer to the SSL_CTX object to be released.\r
+ @param[in] Prk Pointer to the user-supplied key.\r
+ @param[in] PrkSize Key size in bytes.\r
+ @param[in] Info Pointer to the application specific info.\r
+ @param[in] InfoSize Info size in bytes.\r
+ @param[out] Out Pointer to buffer to receive hkdf value.\r
+ @param[in] OutSize Size of hkdf bytes to generate.\r
+\r
+ @retval TRUE Hkdf generated successfully.\r
+ @retval FALSE Hkdf generation failed.\r
\r
**/\r
-VOID\r
+BOOLEAN\r
EFIAPI\r
-CryptoServiceTlsCtxFree (\r
- IN VOID *TlsCtx\r
+CryptoServiceHkdfSha256Expand (\r
+ IN CONST UINT8 *Prk,\r
+ IN UINTN PrkSize,\r
+ IN CONST UINT8 *Info,\r
+ IN UINTN InfoSize,\r
+ OUT UINT8 *Out,\r
+ IN UINTN OutSize\r
)\r
{\r
- CALL_VOID_BASECRYPTLIB (Tls.Services.CtxFree, TlsCtxFree, (TlsCtx));\r
+ return CALL_BASECRYPTLIB (Hkdf.Services.Sha256Expand, HkdfSha256Expand, (Prk, PrkSize, Info, InfoSize, Out, OutSize), FALSE);\r
}\r
\r
/**\r
- Creates a new SSL_CTX object as framework to establish TLS/SSL enabled\r
- connections.\r
+ Derive SHA384 HMAC-based Extract-and-Expand Key Derivation Function (HKDF).\r
\r
- @param[in] MajorVer Major Version of TLS/SSL Protocol.\r
- @param[in] MinorVer Minor Version of TLS/SSL Protocol.\r
+ @param[in] Key Pointer to the user-supplied key.\r
+ @param[in] KeySize Key size in bytes.\r
+ @param[in] Salt Pointer to the salt(non-secret) value.\r
+ @param[in] SaltSize Salt size in bytes.\r
+ @param[in] Info Pointer to the application specific info.\r
+ @param[in] InfoSize Info size in bytes.\r
+ @param[out] Out Pointer to buffer to receive hkdf value.\r
+ @param[in] OutSize Size of hkdf bytes to generate.\r
\r
- @return Pointer to an allocated SSL_CTX object.\r
- If the creation failed, TlsCtxNew() returns NULL.\r
+ @retval TRUE Hkdf generated successfully.\r
+ @retval FALSE Hkdf generation failed.\r
\r
**/\r
-VOID *\r
+BOOLEAN\r
EFIAPI\r
-CryptoServiceTlsCtxNew (\r
- IN UINT8 MajorVer,\r
- IN UINT8 MinorVer\r
+CryptoServiceHkdfSha384ExtractAndExpand (\r
+ IN CONST UINT8 *Key,\r
+ IN UINTN KeySize,\r
+ IN CONST UINT8 *Salt,\r
+ IN UINTN SaltSize,\r
+ IN CONST UINT8 *Info,\r
+ IN UINTN InfoSize,\r
+ OUT UINT8 *Out,\r
+ IN UINTN OutSize\r
)\r
{\r
- return CALL_BASECRYPTLIB (Tls.Services.CtxNew, TlsCtxNew, (MajorVer, MinorVer), NULL);\r
+ return CALL_BASECRYPTLIB (Hkdf.Services.Sha384ExtractAndExpand, HkdfSha384ExtractAndExpand, (Key, KeySize, Salt, SaltSize, Info, InfoSize, Out, OutSize), FALSE);\r
}\r
\r
/**\r
- Free an allocated TLS object.\r
+ Derive SHA384 HMAC-based Extract key Derivation Function (HKDF).\r
\r
- This function removes the TLS object pointed to by Tls and frees up the\r
- allocated memory. If Tls is NULL, nothing is done.\r
+ @param[in] Key Pointer to the user-supplied key.\r
+ @param[in] KeySize key size in bytes.\r
+ @param[in] Salt Pointer to the salt(non-secret) value.\r
+ @param[in] SaltSize salt size in bytes.\r
+ @param[out] PrkOut Pointer to buffer to receive hkdf value.\r
+ @param[in] PrkOutSize size of hkdf bytes to generate.\r
\r
- @param[in] Tls Pointer to the TLS object to be freed.\r
+ @retval true Hkdf generated successfully.\r
+ @retval false Hkdf generation failed.\r
\r
**/\r
-VOID\r
+BOOLEAN\r
EFIAPI\r
-CryptoServiceTlsFree (\r
- IN VOID *Tls\r
+CryptoServiceHkdfSha384Extract (\r
+ IN CONST UINT8 *Key,\r
+ IN UINTN KeySize,\r
+ IN CONST UINT8 *Salt,\r
+ IN UINTN SaltSize,\r
+ OUT UINT8 *PrkOut,\r
+ UINTN PrkOutSize\r
)\r
{\r
- CALL_VOID_BASECRYPTLIB (Tls.Services.Free, TlsFree, (Tls));\r
+ return CALL_BASECRYPTLIB (Hkdf.Services.Sha384Extract, HkdfSha384Extract, (Key, KeySize, Salt, SaltSize, PrkOut, PrkOutSize), FALSE);\r
}\r
\r
/**\r
- Create a new TLS object for a connection.\r
-\r
- This function creates a new TLS object for a connection. The new object\r
- inherits the setting of the underlying context TlsCtx: connection method,\r
- options, verification setting.\r
+ Derive SHA384 HMAC-based Expand Key Derivation Function (HKDF).\r
\r
- @param[in] TlsCtx Pointer to the SSL_CTX object.\r
+ @param[in] Prk Pointer to the user-supplied key.\r
+ @param[in] PrkSize Key size in bytes.\r
+ @param[in] Info Pointer to the application specific info.\r
+ @param[in] InfoSize Info size in bytes.\r
+ @param[out] Out Pointer to buffer to receive hkdf value.\r
+ @param[in] OutSize Size of hkdf bytes to generate.\r
\r
- @return Pointer to an allocated SSL object.\r
- If the creation failed, TlsNew() returns NULL.\r
+ @retval TRUE Hkdf generated successfully.\r
+ @retval FALSE Hkdf generation failed.\r
\r
**/\r
-VOID *\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceHkdfSha384Expand (\r
+ IN CONST UINT8 *Prk,\r
+ IN UINTN PrkSize,\r
+ IN CONST UINT8 *Info,\r
+ IN UINTN InfoSize,\r
+ OUT UINT8 *Out,\r
+ IN UINTN OutSize\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Hkdf.Services.Sha384Expand, HkdfSha384Expand, (Prk, PrkSize, Info, InfoSize, Out, OutSize), FALSE);\r
+}\r
+\r
+/**\r
+ Initializes the OpenSSL library.\r
+\r
+ This function registers ciphers and digests used directly and indirectly\r
+ by SSL/TLS, and initializes the readable error messages.\r
+ This function must be called before any other action takes places.\r
+\r
+ @retval TRUE The OpenSSL library has been initialized.\r
+ @retval FALSE Failed to initialize the OpenSSL library.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceTlsInitialize (\r
+ VOID\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Tls.Services.Initialize, TlsInitialize, (), FALSE);\r
+}\r
+\r
+/**\r
+ Free an allocated SSL_CTX object.\r
+\r
+ @param[in] TlsCtx Pointer to the SSL_CTX object to be released.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+CryptoServiceTlsCtxFree (\r
+ IN VOID *TlsCtx\r
+ )\r
+{\r
+ CALL_VOID_BASECRYPTLIB (Tls.Services.CtxFree, TlsCtxFree, (TlsCtx));\r
+}\r
+\r
+/**\r
+ Creates a new SSL_CTX object as framework to establish TLS/SSL enabled\r
+ connections.\r
+\r
+ @param[in] MajorVer Major Version of TLS/SSL Protocol.\r
+ @param[in] MinorVer Minor Version of TLS/SSL Protocol.\r
+\r
+ @return Pointer to an allocated SSL_CTX object.\r
+ If the creation failed, TlsCtxNew() returns NULL.\r
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+CryptoServiceTlsCtxNew (\r
+ IN UINT8 MajorVer,\r
+ IN UINT8 MinorVer\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Tls.Services.CtxNew, TlsCtxNew, (MajorVer, MinorVer), NULL);\r
+}\r
+\r
+/**\r
+ Free an allocated TLS object.\r
+\r
+ This function removes the TLS object pointed to by Tls and frees up the\r
+ allocated memory. If Tls is NULL, nothing is done.\r
+\r
+ @param[in] Tls Pointer to the TLS object to be freed.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+CryptoServiceTlsFree (\r
+ IN VOID *Tls\r
+ )\r
+{\r
+ CALL_VOID_BASECRYPTLIB (Tls.Services.Free, TlsFree, (Tls));\r
+}\r
+\r
+/**\r
+ Create a new TLS object for a connection.\r
+\r
+ This function creates a new TLS object for a connection. The new object\r
+ inherits the setting of the underlying context TlsCtx: connection method,\r
+ options, verification setting.\r
+\r
+ @param[in] TlsCtx Pointer to the SSL_CTX object.\r
+\r
+ @return Pointer to an allocated SSL object.\r
+ If the creation failed, TlsNew() returns NULL.\r
+\r
+**/\r
+VOID *\r
EFIAPI\r
CryptoServiceTlsNew (\r
- IN VOID *TlsCtx\r
+ IN VOID *TlsCtx\r
)\r
{\r
return CALL_BASECRYPTLIB (Tls.Services.New, TlsNew, (TlsCtx), NULL);\r
BOOLEAN\r
EFIAPI\r
CryptoServiceTlsInHandshake (\r
- IN VOID *Tls\r
+ IN VOID *Tls\r
)\r
{\r
return CALL_BASECRYPTLIB (Tls.Services.InHandshake, TlsInHandshake, (Tls), FALSE);\r
EFI_STATUS\r
EFIAPI\r
CryptoServiceTlsDoHandshake (\r
- IN VOID *Tls,\r
- IN UINT8 *BufferIn, OPTIONAL\r
- IN UINTN BufferInSize, OPTIONAL\r
- OUT UINT8 *BufferOut, OPTIONAL\r
- IN OUT UINTN *BufferOutSize\r
+ IN VOID *Tls,\r
+ IN UINT8 *BufferIn OPTIONAL,\r
+ IN UINTN BufferInSize OPTIONAL,\r
+ OUT UINT8 *BufferOut OPTIONAL,\r
+ IN OUT UINTN *BufferOutSize\r
)\r
{\r
return CALL_BASECRYPTLIB (Tls.Services.DoHandshake, TlsDoHandshake, (Tls, BufferIn, BufferInSize, BufferOut, BufferOutSize), EFI_UNSUPPORTED);\r
EFI_STATUS\r
EFIAPI\r
CryptoServiceTlsHandleAlert (\r
- IN VOID *Tls,\r
- IN UINT8 *BufferIn, OPTIONAL\r
- IN UINTN BufferInSize, OPTIONAL\r
- OUT UINT8 *BufferOut, OPTIONAL\r
- IN OUT UINTN *BufferOutSize\r
+ IN VOID *Tls,\r
+ IN UINT8 *BufferIn OPTIONAL,\r
+ IN UINTN BufferInSize OPTIONAL,\r
+ OUT UINT8 *BufferOut OPTIONAL,\r
+ IN OUT UINTN *BufferOutSize\r
)\r
{\r
return CALL_BASECRYPTLIB (Tls.Services.HandleAlert, TlsHandleAlert, (Tls, BufferIn, BufferInSize, BufferOut, BufferOutSize), EFI_UNSUPPORTED);\r
EFI_STATUS\r
EFIAPI\r
CryptoServiceTlsCloseNotify (\r
- IN VOID *Tls,\r
- IN OUT UINT8 *Buffer,\r
- IN OUT UINTN *BufferSize\r
+ IN VOID *Tls,\r
+ IN OUT UINT8 *Buffer,\r
+ IN OUT UINTN *BufferSize\r
)\r
{\r
return CALL_BASECRYPTLIB (Tls.Services.CloseNotify, TlsCloseNotify, (Tls, Buffer, BufferSize), EFI_UNSUPPORTED);\r
INTN\r
EFIAPI\r
CryptoServiceTlsCtrlTrafficOut (\r
- IN VOID *Tls,\r
- IN OUT VOID *Buffer,\r
- IN UINTN BufferSize\r
+ IN VOID *Tls,\r
+ IN OUT VOID *Buffer,\r
+ IN UINTN BufferSize\r
)\r
{\r
return CALL_BASECRYPTLIB (Tls.Services.CtrlTrafficOut, TlsCtrlTrafficOut, (Tls, Buffer, BufferSize), 0);\r
INTN\r
EFIAPI\r
CryptoServiceTlsCtrlTrafficIn (\r
- IN VOID *Tls,\r
- IN VOID *Buffer,\r
- IN UINTN BufferSize\r
+ IN VOID *Tls,\r
+ IN VOID *Buffer,\r
+ IN UINTN BufferSize\r
)\r
{\r
return CALL_BASECRYPTLIB (Tls.Services.CtrlTrafficIn, TlsCtrlTrafficIn, (Tls, Buffer, BufferSize), 0);\r
INTN\r
EFIAPI\r
CryptoServiceTlsRead (\r
- IN VOID *Tls,\r
- IN OUT VOID *Buffer,\r
- IN UINTN BufferSize\r
+ IN VOID *Tls,\r
+ IN OUT VOID *Buffer,\r
+ IN UINTN BufferSize\r
)\r
{\r
return CALL_BASECRYPTLIB (Tls.Services.Read, TlsRead, (Tls, Buffer, BufferSize), 0);\r
INTN\r
EFIAPI\r
CryptoServiceTlsWrite (\r
- IN VOID *Tls,\r
- IN VOID *Buffer,\r
- IN UINTN BufferSize\r
+ IN VOID *Tls,\r
+ IN VOID *Buffer,\r
+ IN UINTN BufferSize\r
)\r
{\r
return CALL_BASECRYPTLIB (Tls.Services.Write, TlsWrite, (Tls, Buffer, BufferSize), 0);\r
EFI_STATUS\r
EFIAPI\r
CryptoServiceTlsSetVersion (\r
- IN VOID *Tls,\r
- IN UINT8 MajorVer,\r
- IN UINT8 MinorVer\r
+ IN VOID *Tls,\r
+ IN UINT8 MajorVer,\r
+ IN UINT8 MinorVer\r
)\r
{\r
return CALL_BASECRYPTLIB (TlsSet.Services.Version, TlsSetVersion, (Tls, MajorVer, MinorVer), EFI_UNSUPPORTED);\r
EFI_STATUS\r
EFIAPI\r
CryptoServiceTlsSetConnectionEnd (\r
- IN VOID *Tls,\r
- IN BOOLEAN IsServer\r
+ IN VOID *Tls,\r
+ IN BOOLEAN IsServer\r
)\r
{\r
return CALL_BASECRYPTLIB (TlsSet.Services.ConnectionEnd, TlsSetConnectionEnd, (Tls, IsServer), EFI_UNSUPPORTED);\r
EFI_STATUS\r
EFIAPI\r
CryptoServiceTlsSetCipherList (\r
- IN VOID *Tls,\r
- IN UINT16 *CipherId,\r
- IN UINTN CipherNum\r
+ IN VOID *Tls,\r
+ IN UINT16 *CipherId,\r
+ IN UINTN CipherNum\r
)\r
{\r
return CALL_BASECRYPTLIB (TlsSet.Services.CipherList, TlsSetCipherList, (Tls, CipherId, CipherNum), EFI_UNSUPPORTED);\r
EFI_STATUS\r
EFIAPI\r
CryptoServiceTlsSetCompressionMethod (\r
- IN UINT8 CompMethod\r
+ IN UINT8 CompMethod\r
)\r
{\r
return CALL_BASECRYPTLIB (TlsSet.Services.CompressionMethod, TlsSetCompressionMethod, (CompMethod), EFI_UNSUPPORTED);\r
VOID\r
EFIAPI\r
CryptoServiceTlsSetVerify (\r
- IN VOID *Tls,\r
- IN UINT32 VerifyMode\r
+ IN VOID *Tls,\r
+ IN UINT32 VerifyMode\r
)\r
{\r
CALL_VOID_BASECRYPTLIB (TlsSet.Services.Verify, TlsSetVerify, (Tls, VerifyMode));\r
EFI_STATUS\r
EFIAPI\r
CryptoServiceTlsSetVerifyHost (\r
- IN VOID *Tls,\r
- IN UINT32 Flags,\r
- IN CHAR8 *HostName\r
+ IN VOID *Tls,\r
+ IN UINT32 Flags,\r
+ IN CHAR8 *HostName\r
)\r
{\r
return CALL_BASECRYPTLIB (TlsSet.Services.VerifyHost, TlsSetVerifyHost, (Tls, Flags, HostName), EFI_UNSUPPORTED);\r
EFI_STATUS\r
EFIAPI\r
CryptoServiceTlsSetSessionId (\r
- IN VOID *Tls,\r
- IN UINT8 *SessionId,\r
- IN UINT16 SessionIdLen\r
+ IN VOID *Tls,\r
+ IN UINT8 *SessionId,\r
+ IN UINT16 SessionIdLen\r
)\r
{\r
return CALL_BASECRYPTLIB (TlsSet.Services.SessionId, TlsSetSessionId, (Tls, SessionId, SessionIdLen), EFI_UNSUPPORTED);\r
EFI_STATUS\r
EFIAPI\r
CryptoServiceTlsSetCaCertificate (\r
- IN VOID *Tls,\r
- IN VOID *Data,\r
- IN UINTN DataSize\r
+ IN VOID *Tls,\r
+ IN VOID *Data,\r
+ IN UINTN DataSize\r
)\r
{\r
return CALL_BASECRYPTLIB (TlsSet.Services.CaCertificate, TlsSetCaCertificate, (Tls, Data, DataSize), EFI_UNSUPPORTED);\r
EFI_STATUS\r
EFIAPI\r
CryptoServiceTlsSetHostPublicCert (\r
- IN VOID *Tls,\r
- IN VOID *Data,\r
- IN UINTN DataSize\r
+ IN VOID *Tls,\r
+ IN VOID *Data,\r
+ IN UINTN DataSize\r
)\r
{\r
return CALL_BASECRYPTLIB (TlsSet.Services.HostPublicCert, TlsSetHostPublicCert, (Tls, Data, DataSize), EFI_UNSUPPORTED);\r
EFI_STATUS\r
EFIAPI\r
CryptoServiceTlsSetHostPrivateKey (\r
- IN VOID *Tls,\r
- IN VOID *Data,\r
- IN UINTN DataSize\r
+ IN VOID *Tls,\r
+ IN VOID *Data,\r
+ IN UINTN DataSize\r
)\r
{\r
return CALL_BASECRYPTLIB (TlsSet.Services.HostPrivateKey, TlsSetHostPrivateKey, (Tls, Data, DataSize), EFI_UNSUPPORTED);\r
EFI_STATUS\r
EFIAPI\r
CryptoServiceTlsSetCertRevocationList (\r
- IN VOID *Data,\r
- IN UINTN DataSize\r
+ IN VOID *Data,\r
+ IN UINTN DataSize\r
)\r
{\r
return CALL_BASECRYPTLIB (TlsSet.Services.CertRevocationList, TlsSetCertRevocationList, (Data, DataSize), EFI_UNSUPPORTED);\r
UINT16\r
EFIAPI\r
CryptoServiceTlsGetVersion (\r
- IN VOID *Tls\r
+ IN VOID *Tls\r
)\r
{\r
return CALL_BASECRYPTLIB (TlsGet.Services.Version, TlsGetVersion, (Tls), 0);\r
UINT8\r
EFIAPI\r
CryptoServiceTlsGetConnectionEnd (\r
- IN VOID *Tls\r
+ IN VOID *Tls\r
)\r
{\r
return CALL_BASECRYPTLIB (TlsGet.Services.ConnectionEnd, TlsGetConnectionEnd, (Tls), 0);\r
EFI_STATUS\r
EFIAPI\r
CryptoServiceTlsGetCurrentCipher (\r
- IN VOID *Tls,\r
- IN OUT UINT16 *CipherId\r
+ IN VOID *Tls,\r
+ IN OUT UINT16 *CipherId\r
)\r
{\r
return CALL_BASECRYPTLIB (TlsGet.Services.CurrentCipher, TlsGetCurrentCipher, (Tls, CipherId), EFI_UNSUPPORTED);\r
EFI_STATUS\r
EFIAPI\r
CryptoServiceTlsGetCurrentCompressionId (\r
- IN VOID *Tls,\r
- IN OUT UINT8 *CompressionId\r
+ IN VOID *Tls,\r
+ IN OUT UINT8 *CompressionId\r
)\r
{\r
return CALL_BASECRYPTLIB (TlsGet.Services.CurrentCompressionId, TlsGetCurrentCompressionId, (Tls, CompressionId), EFI_UNSUPPORTED);\r
UINT32\r
EFIAPI\r
CryptoServiceTlsGetVerify (\r
- IN VOID *Tls\r
+ IN VOID *Tls\r
)\r
{\r
return CALL_BASECRYPTLIB (TlsGet.Services.Verify, TlsGetVerify, (Tls), 0);\r
EFI_STATUS\r
EFIAPI\r
CryptoServiceTlsGetSessionId (\r
- IN VOID *Tls,\r
- IN OUT UINT8 *SessionId,\r
- IN OUT UINT16 *SessionIdLen\r
+ IN VOID *Tls,\r
+ IN OUT UINT8 *SessionId,\r
+ IN OUT UINT16 *SessionIdLen\r
)\r
{\r
return CALL_BASECRYPTLIB (TlsGet.Services.SessionId, TlsGetSessionId, (Tls, SessionId, SessionIdLen), EFI_UNSUPPORTED);\r
VOID\r
EFIAPI\r
CryptoServiceTlsGetClientRandom (\r
- IN VOID *Tls,\r
- IN OUT UINT8 *ClientRandom\r
+ IN VOID *Tls,\r
+ IN OUT UINT8 *ClientRandom\r
)\r
{\r
CALL_VOID_BASECRYPTLIB (TlsGet.Services.ClientRandom, TlsGetClientRandom, (Tls, ClientRandom));\r
VOID\r
EFIAPI\r
CryptoServiceTlsGetServerRandom (\r
- IN VOID *Tls,\r
- IN OUT UINT8 *ServerRandom\r
+ IN VOID *Tls,\r
+ IN OUT UINT8 *ServerRandom\r
)\r
{\r
CALL_VOID_BASECRYPTLIB (TlsGet.Services.ServerRandom, TlsGetServerRandom, (Tls, ServerRandom));\r
EFI_STATUS\r
EFIAPI\r
CryptoServiceTlsGetKeyMaterial (\r
- IN VOID *Tls,\r
- IN OUT UINT8 *KeyMaterial\r
+ IN VOID *Tls,\r
+ IN OUT UINT8 *KeyMaterial\r
)\r
{\r
return CALL_BASECRYPTLIB (TlsGet.Services.KeyMaterial, TlsGetKeyMaterial, (Tls, KeyMaterial), EFI_UNSUPPORTED);\r
EFI_STATUS\r
EFIAPI\r
CryptoServiceTlsGetCaCertificate (\r
- IN VOID *Tls,\r
- OUT VOID *Data,\r
- IN OUT UINTN *DataSize\r
+ IN VOID *Tls,\r
+ OUT VOID *Data,\r
+ IN OUT UINTN *DataSize\r
)\r
{\r
return CALL_BASECRYPTLIB (TlsGet.Services.CaCertificate, TlsGetCaCertificate, (Tls, Data, DataSize), EFI_UNSUPPORTED);\r
EFI_STATUS\r
EFIAPI\r
CryptoServiceTlsGetHostPublicCert (\r
- IN VOID *Tls,\r
- OUT VOID *Data,\r
- IN OUT UINTN *DataSize\r
+ IN VOID *Tls,\r
+ OUT VOID *Data,\r
+ IN OUT UINTN *DataSize\r
)\r
{\r
return CALL_BASECRYPTLIB (TlsGet.Services.HostPublicCert, TlsGetHostPublicCert, (Tls, Data, DataSize), EFI_UNSUPPORTED);\r
EFI_STATUS\r
EFIAPI\r
CryptoServiceTlsGetHostPrivateKey (\r
- IN VOID *Tls,\r
- OUT VOID *Data,\r
- IN OUT UINTN *DataSize\r
+ IN VOID *Tls,\r
+ OUT VOID *Data,\r
+ IN OUT UINTN *DataSize\r
)\r
{\r
return CALL_BASECRYPTLIB (TlsGet.Services.HostPrivateKey, TlsGetHostPrivateKey, (Tls, Data, DataSize), EFI_UNSUPPORTED);\r
EFI_STATUS\r
EFIAPI\r
CryptoServiceTlsGetCertRevocationList (\r
- OUT VOID *Data,\r
- IN OUT UINTN *DataSize\r
+ OUT VOID *Data,\r
+ IN OUT UINTN *DataSize\r
)\r
{\r
return CALL_BASECRYPTLIB (TlsGet.Services.CertRevocationList, TlsGetCertRevocationList, (Data, DataSize), EFI_UNSUPPORTED);\r
}\r
\r
-const EDKII_CRYPTO_PROTOCOL mEdkiiCrypto = {\r
+/**\r
+ Carries out the RSA-SSA signature generation with EMSA-PSS encoding scheme.\r
+\r
+ This function carries out the RSA-SSA signature generation with EMSA-PSS encoding scheme defined in\r
+ RFC 8017.\r
+ Mask generation function is the same as the message digest algorithm.\r
+ If the Signature buffer is too small to hold the contents of signature, FALSE\r
+ is returned and SigSize is set to the required buffer size to obtain the signature.\r
+\r
+ If RsaContext is NULL, then return FALSE.\r
+ If Message is NULL, then return FALSE.\r
+ If MsgSize is zero or > INT_MAX, then return FALSE.\r
+ If DigestLen is NOT 32, 48 or 64, return FALSE.\r
+ If SaltLen is not equal to DigestLen, then return FALSE.\r
+ If SigSize is large enough but Signature is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
+\r
+ @param[in] RsaContext Pointer to RSA context for signature generation.\r
+ @param[in] Message Pointer to octet message to be signed.\r
+ @param[in] MsgSize Size of the message in bytes.\r
+ @param[in] DigestLen Length of the digest in bytes to be used for RSA signature operation.\r
+ @param[in] SaltLen Length of the salt in bytes to be used for PSS encoding.\r
+ @param[out] Signature Pointer to buffer to receive RSA PSS signature.\r
+ @param[in, out] SigSize On input, the size of Signature buffer in bytes.\r
+ On output, the size of data returned in Signature buffer in bytes.\r
+\r
+ @retval TRUE Signature successfully generated in RSASSA-PSS.\r
+ @retval FALSE Signature generation failed.\r
+ @retval FALSE SigSize is too small.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceRsaPssSign (\r
+ IN VOID *RsaContext,\r
+ IN CONST UINT8 *Message,\r
+ IN UINTN MsgSize,\r
+ IN UINT16 DigestLen,\r
+ IN UINT16 SaltLen,\r
+ OUT UINT8 *Signature,\r
+ IN OUT UINTN *SigSize\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (RsaPss.Services.Sign, RsaPssSign, (RsaContext, Message, MsgSize, DigestLen, SaltLen, Signature, SigSize), FALSE);\r
+}\r
+\r
+/**\r
+ Verifies the RSA signature with RSASSA-PSS signature scheme defined in RFC 8017.\r
+ Implementation determines salt length automatically from the signature encoding.\r
+ Mask generation function is the same as the message digest algorithm.\r
+ Salt length should be equal to digest length.\r
+\r
+ @param[in] RsaContext Pointer to RSA context for signature verification.\r
+ @param[in] Message Pointer to octet message to be verified.\r
+ @param[in] MsgSize Size of the message in bytes.\r
+ @param[in] Signature Pointer to RSASSA-PSS signature to be verified.\r
+ @param[in] SigSize Size of signature in bytes.\r
+ @param[in] DigestLen Length of digest for RSA operation.\r
+ @param[in] SaltLen Salt length for PSS encoding.\r
+\r
+ @retval TRUE Valid signature encoded in RSASSA-PSS.\r
+ @retval FALSE Invalid signature or invalid RSA context.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceRsaPssVerify (\r
+ IN VOID *RsaContext,\r
+ IN CONST UINT8 *Message,\r
+ IN UINTN MsgSize,\r
+ IN CONST UINT8 *Signature,\r
+ IN UINTN SigSize,\r
+ IN UINT16 DigestLen,\r
+ IN UINT16 SaltLen\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (RsaPss.Services.Verify, RsaPssVerify, (RsaContext, Message, MsgSize, Signature, SigSize, DigestLen, SaltLen), FALSE);\r
+}\r
+\r
+/**\r
+ Parallel hash function ParallelHash256, as defined in NIST's Special Publication 800-185,\r
+ published December 2016.\r
+\r
+ @param[in] Input Pointer to the input message (X).\r
+ @param[in] InputByteLen The number(>0) of input bytes provided for the input data.\r
+ @param[in] BlockSize The size of each block (B).\r
+ @param[out] Output Pointer to the output buffer.\r
+ @param[in] OutputByteLen The desired number of output bytes (L).\r
+ @param[in] Customization Pointer to the customization string (S).\r
+ @param[in] CustomByteLen The length of the customization string in bytes.\r
+\r
+ @retval TRUE ParallelHash256 digest computation succeeded.\r
+ @retval FALSE ParallelHash256 digest computation failed.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceParallelHash256HashAll (\r
+ IN CONST VOID *Input,\r
+ IN UINTN InputByteLen,\r
+ IN UINTN BlockSize,\r
+ OUT VOID *Output,\r
+ IN UINTN OutputByteLen,\r
+ IN CONST VOID *Customization,\r
+ IN UINTN CustomByteLen\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (ParallelHash.Services.HashAll, ParallelHash256HashAll, (Input, InputByteLen, BlockSize, Output, OutputByteLen, Customization, CustomByteLen), FALSE);\r
+}\r
+\r
+/**\r
+ Performs AEAD AES-GCM authenticated encryption on a data buffer and additional authenticated data (AAD).\r
+\r
+ IvSize must be 12, otherwise FALSE is returned.\r
+ KeySize must be 16, 24 or 32, otherwise FALSE is returned.\r
+ TagSize must be 12, 13, 14, 15, 16, otherwise FALSE is returned.\r
+\r
+ @param[in] Key Pointer to the encryption key.\r
+ @param[in] KeySize Size of the encryption key in bytes.\r
+ @param[in] Iv Pointer to the IV value.\r
+ @param[in] IvSize Size of the IV value in bytes.\r
+ @param[in] AData Pointer to the additional authenticated data (AAD).\r
+ @param[in] ADataSize Size of the additional authenticated data (AAD) in bytes.\r
+ @param[in] DataIn Pointer to the input data buffer to be encrypted.\r
+ @param[in] DataInSize Size of the input data buffer in bytes.\r
+ @param[out] TagOut Pointer to a buffer that receives the authentication tag output.\r
+ @param[in] TagSize Size of the authentication tag in bytes.\r
+ @param[out] DataOut Pointer to a buffer that receives the encryption output.\r
+ @param[out] DataOutSize Size of the output data buffer in bytes.\r
+\r
+ @retval TRUE AEAD AES-GCM authenticated encryption succeeded.\r
+ @retval FALSE AEAD AES-GCM authenticated encryption failed.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceAeadAesGcmEncrypt (\r
+ IN CONST UINT8 *Key,\r
+ IN UINTN KeySize,\r
+ IN CONST UINT8 *Iv,\r
+ IN UINTN IvSize,\r
+ IN CONST UINT8 *AData,\r
+ IN UINTN ADataSize,\r
+ IN CONST UINT8 *DataIn,\r
+ IN UINTN DataInSize,\r
+ OUT UINT8 *TagOut,\r
+ IN UINTN TagSize,\r
+ OUT UINT8 *DataOut,\r
+ OUT UINTN *DataOutSize\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (AeadAesGcm.Services.Encrypt, AeadAesGcmEncrypt, (Key, KeySize, Iv, IvSize, AData, ADataSize, DataIn, DataInSize, TagOut, TagSize, DataOut, DataOutSize), FALSE);\r
+}\r
+\r
+/**\r
+ Performs AEAD AES-GCM authenticated decryption on a data buffer and additional authenticated data (AAD).\r
+\r
+ IvSize must be 12, otherwise FALSE is returned.\r
+ KeySize must be 16, 24 or 32, otherwise FALSE is returned.\r
+ TagSize must be 12, 13, 14, 15, 16, otherwise FALSE is returned.\r
+ If additional authenticated data verification fails, FALSE is returned.\r
+\r
+ @param[in] Key Pointer to the encryption key.\r
+ @param[in] KeySize Size of the encryption key in bytes.\r
+ @param[in] Iv Pointer to the IV value.\r
+ @param[in] IvSize Size of the IV value in bytes.\r
+ @param[in] AData Pointer to the additional authenticated data (AAD).\r
+ @param[in] ADataSize Size of the additional authenticated data (AAD) in bytes.\r
+ @param[in] DataIn Pointer to the input data buffer to be decrypted.\r
+ @param[in] DataInSize Size of the input data buffer in bytes.\r
+ @param[in] Tag Pointer to a buffer that contains the authentication tag.\r
+ @param[in] TagSize Size of the authentication tag in bytes.\r
+ @param[out] DataOut Pointer to a buffer that receives the decryption output.\r
+ @param[out] DataOutSize Size of the output data buffer in bytes.\r
+\r
+ @retval TRUE AEAD AES-GCM authenticated decryption succeeded.\r
+ @retval FALSE AEAD AES-GCM authenticated decryption failed.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceAeadAesGcmDecrypt (\r
+ IN CONST UINT8 *Key,\r
+ IN UINTN KeySize,\r
+ IN CONST UINT8 *Iv,\r
+ IN UINTN IvSize,\r
+ IN CONST UINT8 *AData,\r
+ IN UINTN ADataSize,\r
+ IN CONST UINT8 *DataIn,\r
+ IN UINTN DataInSize,\r
+ IN CONST UINT8 *Tag,\r
+ IN UINTN TagSize,\r
+ OUT UINT8 *DataOut,\r
+ OUT UINTN *DataOutSize\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (AeadAesGcm.Services.Decrypt, AeadAesGcmDecrypt, (Key, KeySize, Iv, IvSize, AData, ADataSize, DataIn, DataInSize, Tag, TagSize, DataOut, DataOutSize), FALSE);\r
+}\r
+\r
+// =====================================================================================\r
+// Big number primitives\r
+// =====================================================================================\r
+\r
+/**\r
+ Allocate new Big Number.\r
+\r
+ @retval New BigNum opaque structure or NULL on failure.\r
+**/\r
+VOID *\r
+EFIAPI\r
+CryptoServiceBigNumInit (\r
+ VOID\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Bn.Services.Init, BigNumInit, (), NULL);\r
+}\r
+\r
+/**\r
+ Allocate new Big Number and assign the provided value to it.\r
+\r
+ @param[in] Buf Big endian encoded buffer.\r
+ @param[in] Len Buffer length.\r
+\r
+ @retval New BigNum opaque structure or NULL on failure.\r
+**/\r
+VOID *\r
+EFIAPI\r
+CryptoServiceBigNumFromBin (\r
+ IN CONST UINT8 *Buf,\r
+ IN UINTN Len\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Bn.Services.FromBin, BigNumFromBin, (Buf, Len), NULL);\r
+}\r
+\r
+/**\r
+ Convert the absolute value of Bn into big-endian form and store it at Buf.\r
+ The Buf array should have at least BigNumBytes() in it.\r
+\r
+ @param[in] Bn Big number to convert.\r
+ @param[out] Buf Output buffer.\r
+\r
+ @retval The length of the big-endian number placed at Buf or -1 on error.\r
+**/\r
+INTN\r
+EFIAPI\r
+CryptoServiceBigNumToBin (\r
+ IN CONST VOID *Bn,\r
+ OUT UINT8 *Buf\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Bn.Services.ToBin, BigNumToBin, (Bn, Buf), -1);\r
+}\r
+\r
+/**\r
+ Free the Big Number.\r
+\r
+ @param[in] Bn Big number to free.\r
+ @param[in] Clear TRUE if the buffer should be cleared.\r
+**/\r
+VOID\r
+EFIAPI\r
+CryptoServiceBigNumFree (\r
+ IN VOID *Bn,\r
+ IN BOOLEAN Clear\r
+ )\r
+{\r
+ CALL_VOID_BASECRYPTLIB (Bn.Services.Free, BigNumFree, (Bn, Clear));\r
+}\r
+\r
+/**\r
+ Calculate the sum of two Big Numbers.\r
+ Please note, all "out" Big number arguments should be properly initialized\r
+ by calling to BigNumInit() or BigNumFromBin() functions.\r
+\r
+ @param[in] BnA Big number.\r
+ @param[in] BnB Big number.\r
+ @param[out] BnRes The result of BnA + BnB.\r
+\r
+ @retval TRUE On success.\r
+ @retval FALSE Otherwise.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceBigNumAdd (\r
+ IN CONST VOID *BnA,\r
+ IN CONST VOID *BnB,\r
+ OUT VOID *BnRes\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Bn.Services.Add, BigNumAdd, (BnA, BnB, BnRes), FALSE);\r
+}\r
+\r
+/**\r
+ Subtract two Big Numbers.\r
+ Please note, all "out" Big number arguments should be properly initialized\r
+ by calling to BigNumInit() or BigNumFromBin() functions.\r
+\r
+ @param[in] BnA Big number.\r
+ @param[in] BnB Big number.\r
+ @param[out] BnRes The result of BnA - BnB.\r
+\r
+ @retval TRUE On success.\r
+ @retval FALSE Otherwise.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceBigNumSub (\r
+ IN CONST VOID *BnA,\r
+ IN CONST VOID *BnB,\r
+ OUT VOID *BnRes\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Bn.Services.Sub, BigNumSub, (BnA, BnB, BnRes), FALSE);\r
+}\r
+\r
+/**\r
+ Calculate remainder: BnRes = BnA % BnB.\r
+ Please note, all "out" Big number arguments should be properly initialized\r
+ by calling to BigNumInit() or BigNumFromBin() functions.\r
+\r
+ @param[in] BnA Big number.\r
+ @param[in] BnB Big number.\r
+ @param[out] BnRes The result of BnA % BnB.\r
+\r
+ @retval TRUE On success.\r
+ @retval FALSE Otherwise.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceBigNumMod (\r
+ IN CONST VOID *BnA,\r
+ IN CONST VOID *BnB,\r
+ OUT VOID *BnRes\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Bn.Services.Mod, BigNumMod, (BnA, BnB, BnRes), FALSE);\r
+}\r
+\r
+/**\r
+ Compute BnA to the BnP-th power modulo BnM.\r
+ Please note, all "out" Big number arguments should be properly initialized.\r
+ by calling to BigNumInit() or BigNumFromBin() functions.\r
+\r
+ @param[in] BnA Big number.\r
+ @param[in] BnP Big number (power).\r
+ @param[in] BnM Big number (modulo).\r
+ @param[out] BnRes The result of (BnA ^ BnP) % BnM.\r
+\r
+ @retval TRUE On success.\r
+ @retval FALSE Otherwise.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceBigNumExpMod (\r
+ IN CONST VOID *BnA,\r
+ IN CONST VOID *BnP,\r
+ IN CONST VOID *BnM,\r
+ OUT VOID *BnRes\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Bn.Services.ExpMod, BigNumExpMod, (BnA, BnP, BnM, BnRes), FALSE);\r
+}\r
+\r
+/**\r
+ Compute BnA inverse modulo BnM.\r
+ Please note, all "out" Big number arguments should be properly initialized\r
+ by calling to BigNumInit() or BigNumFromBin() functions.\r
+\r
+ @param[in] BnA Big number.\r
+ @param[in] BnM Big number (modulo).\r
+ @param[out] BnRes The result, such that (BnA * BnRes) % BnM == 1.\r
+\r
+ @retval TRUE On success.\r
+ @retval FALSE Otherwise.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceBigNumInverseMod (\r
+ IN CONST VOID *BnA,\r
+ IN CONST VOID *BnM,\r
+ OUT VOID *BnRes\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Bn.Services.InverseMod, BigNumInverseMod, (BnA, BnM, BnRes), FALSE);\r
+}\r
+\r
+/**\r
+ Divide two Big Numbers.\r
+ Please note, all "out" Big number arguments should be properly initialized\r
+ by calling to BigNumInit() or BigNumFromBin() functions.\r
+\r
+ @param[in] BnA Big number.\r
+ @param[in] BnB Big number.\r
+ @param[out] BnRes The result, such that BnA / BnB.\r
+\r
+ @retval TRUE On success.\r
+ @retval FALSE Otherwise.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceBigNumDiv (\r
+ IN CONST VOID *BnA,\r
+ IN CONST VOID *BnB,\r
+ OUT VOID *BnRes\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Bn.Services.Div, BigNumDiv, (BnA, BnB, BnRes), FALSE);\r
+}\r
+\r
+/**\r
+ Multiply two Big Numbers modulo BnM.\r
+ Please note, all "out" Big number arguments should be properly initialized\r
+ by calling to BigNumInit() or BigNumFromBin() functions.\r
+\r
+ @param[in] BnA Big number.\r
+ @param[in] BnB Big number.\r
+ @param[in] BnM Big number (modulo).\r
+ @param[out] BnRes The result, such that (BnA * BnB) % BnM.\r
+\r
+ @retval TRUE On success.\r
+ @retval FALSE Otherwise.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceBigNumMulMod (\r
+ IN CONST VOID *BnA,\r
+ IN CONST VOID *BnB,\r
+ IN CONST VOID *BnM,\r
+ OUT VOID *BnRes\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Bn.Services.MulMod, BigNumMulMod, (BnA, BnB, BnM, BnRes), FALSE);\r
+}\r
+\r
+/**\r
+ Compare two Big Numbers.\r
+\r
+ @param[in] BnA Big number.\r
+ @param[in] BnB Big number.\r
+\r
+ @retval 0 BnA == BnB.\r
+ @retval 1 BnA > BnB.\r
+ @retval -1 BnA < BnB.\r
+**/\r
+INTN\r
+EFIAPI\r
+CryptoServiceBigNumCmp (\r
+ IN CONST VOID *BnA,\r
+ IN CONST VOID *BnB\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Bn.Services.Cmp, BigNumCmp, (BnA, BnB), 0);\r
+}\r
+\r
+/**\r
+ Get number of bits in Bn.\r
+\r
+ @param[in] Bn Big number.\r
+\r
+ @retval Number of bits.\r
+**/\r
+UINTN\r
+EFIAPI\r
+CryptoServiceBigNumBits (\r
+ IN CONST VOID *Bn\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Bn.Services.Bits, BigNumBits, (Bn), 0);\r
+}\r
+\r
+/**\r
+ Get number of bytes in Bn.\r
+\r
+ @param[in] Bn Big number.\r
+\r
+ @retval Number of bytes.\r
+**/\r
+UINTN\r
+EFIAPI\r
+CryptoServiceBigNumBytes (\r
+ IN CONST VOID *Bn\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Bn.Services.Bytes, BigNumBytes, (Bn), 0);\r
+}\r
+\r
+/**\r
+ Checks if Big Number equals to the given Num.\r
+\r
+ @param[in] Bn Big number.\r
+ @param[in] Num Number.\r
+\r
+ @retval TRUE iff Bn == Num.\r
+ @retval FALSE otherwise.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceBigNumIsWord (\r
+ IN CONST VOID *Bn,\r
+ IN UINTN Num\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Bn.Services.IsWord, BigNumIsWord, (Bn, Num), FALSE);\r
+}\r
+\r
+/**\r
+ Checks if Big Number is odd.\r
+\r
+ @param[in] Bn Big number.\r
+\r
+ @retval TRUE Bn is odd (Bn % 2 == 1).\r
+ @retval FALSE otherwise.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceBigNumIsOdd (\r
+ IN CONST VOID *Bn\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Bn.Services.IsOdd, BigNumIsOdd, (Bn), FALSE);\r
+}\r
+\r
+/**\r
+ Copy Big number.\r
+\r
+ @param[out] BnDst Destination.\r
+ @param[in] BnSrc Source.\r
+\r
+ @retval BnDst on success.\r
+ @retval NULL otherwise.\r
+**/\r
+VOID *\r
+EFIAPI\r
+CryptoServiceBigNumCopy (\r
+ OUT VOID *BnDst,\r
+ IN CONST VOID *BnSrc\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Bn.Services.Copy, BigNumCopy, (BnDst, BnSrc), NULL);\r
+}\r
+\r
+/**\r
+ Get constant Big number with value of "1".\r
+ This may be used to save expensive allocations.\r
+\r
+ @retval Big Number with value of 1.\r
+**/\r
+CONST VOID *\r
+EFIAPI\r
+CryptoServiceBigNumValueOne (\r
+ VOID\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Bn.Services.ValueOne, BigNumValueOne, (), NULL);\r
+}\r
+\r
+/**\r
+ Shift right Big Number.\r
+ Please note, all "out" Big number arguments should be properly initialized\r
+ by calling to BigNumInit() or BigNumFromBin() functions.\r
+\r
+ @param[in] Bn Big number.\r
+ @param[in] N Number of bits to shift.\r
+ @param[out] BnRes The result.\r
+\r
+ @retval TRUE On success.\r
+ @retval FALSE Otherwise.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceBigNumRShift (\r
+ IN CONST VOID *Bn,\r
+ IN UINTN N,\r
+ OUT VOID *BnRes\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Bn.Services.RShift, BigNumRShift, (Bn, N, BnRes), FALSE);\r
+}\r
+\r
+/**\r
+ Mark Big Number for constant time computations.\r
+ This function should be called before any constant time computations are\r
+ performed on the given Big number.\r
+\r
+ @param[in] Bn Big number.\r
+**/\r
+VOID\r
+EFIAPI\r
+CryptoServiceBigNumConstTime (\r
+ IN VOID *Bn\r
+ )\r
+{\r
+ CALL_VOID_BASECRYPTLIB (Bn.Services.ConstTime, BigNumConstTime, (Bn));\r
+}\r
+\r
+/**\r
+ Calculate square modulo.\r
+ Please note, all "out" Big number arguments should be properly initialized\r
+ by calling to BigNumInit() or BigNumFromBin() functions.\r
+\r
+ @param[in] BnA Big number.\r
+ @param[in] BnM Big number (modulo).\r
+ @param[out] BnRes The result, such that (BnA ^ 2) % BnM.\r
+\r
+ @retval TRUE On success.\r
+ @retval FALSE Otherwise.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceBigNumSqrMod (\r
+ IN CONST VOID *BnA,\r
+ IN CONST VOID *BnM,\r
+ OUT VOID *BnRes\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Bn.Services.SqrMod, BigNumSqrMod, (BnA, BnM, BnRes), FALSE);\r
+}\r
+\r
+/**\r
+ Create new Big Number computation context. This is an opaque structure\r
+ which should be passed to any function that requires it. The BN context is\r
+ needed to optimize calculations and expensive allocations.\r
+\r
+ @retval Big Number context struct or NULL on failure.\r
+**/\r
+VOID *\r
+EFIAPI\r
+CryptoServiceBigNumNewContext (\r
+ VOID\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Bn.Services.NewContext, BigNumNewContext, (), NULL);\r
+}\r
+\r
+/**\r
+ Free Big Number context that was allocated with BigNumNewContext().\r
+\r
+ @param[in] BnCtx Big number context to free.\r
+**/\r
+VOID\r
+EFIAPI\r
+CryptoServiceBigNumContextFree (\r
+ IN VOID *BnCtx\r
+ )\r
+{\r
+ CALL_VOID_BASECRYPTLIB (Bn.Services.ContextFree, BigNumContextFree, (BnCtx));\r
+}\r
+\r
+/**\r
+ Set Big Number to a given value.\r
+\r
+ @param[in] Bn Big number to set.\r
+ @param[in] Val Value to set.\r
+\r
+ @retval TRUE On success.\r
+ @retval FALSE Otherwise.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceBigNumSetUint (\r
+ IN VOID *Bn,\r
+ IN UINTN Val\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Bn.Services.SetUint, BigNumSetUint, (Bn, Val), FALSE);\r
+}\r
+\r
+/**\r
+ Add two Big Numbers modulo BnM.\r
+\r
+ @param[in] BnA Big number.\r
+ @param[in] BnB Big number.\r
+ @param[in] BnM Big number (modulo).\r
+ @param[out] BnRes The result, such that (BnA + BnB) % BnM.\r
+\r
+ @retval TRUE On success.\r
+ @retval FALSE Otherwise.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+CryptoServiceBigNumAddMod (\r
+ IN CONST VOID *BnA,\r
+ IN CONST VOID *BnB,\r
+ IN CONST VOID *BnM,\r
+ OUT VOID *BnRes\r
+ )\r
+{\r
+ return CALL_BASECRYPTLIB (Bn.Services.AddMod, BigNumAddMod, (BnA, BnB, BnM, BnRes), FALSE);\r
+}\r
+\r
+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 SHA1\r
- CryptoServiceHmacSha1New,\r
- CryptoServiceHmacSha1Free,\r
- CryptoServiceHmacSha1SetKey,\r
- CryptoServiceHmacSha1Duplicate,\r
- CryptoServiceHmacSha1Update,\r
- CryptoServiceHmacSha1Final,\r
+ /// HMAC MD5 - deprecated and unsupported\r
+ DeprecatedCryptoServiceHmacMd5New,\r
+ DeprecatedCryptoServiceHmacMd5Free,\r
+ DeprecatedCryptoServiceHmacMd5SetKey,\r
+ DeprecatedCryptoServiceHmacMd5Duplicate,\r
+ DeprecatedCryptoServiceHmacMd5Update,\r
+ DeprecatedCryptoServiceHmacMd5Final,\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
CryptoServiceHmacSha256Duplicate,\r
CryptoServiceHmacSha256Update,\r
CryptoServiceHmacSha256Final,\r
- /// Md4\r
- CryptoServiceMd4GetContextSize,\r
- CryptoServiceMd4Init,\r
- CryptoServiceMd4Duplicate,\r
- CryptoServiceMd4Update,\r
- CryptoServiceMd4Final,\r
- CryptoServiceMd4HashAll,\r
+ /// Md4 - deprecated and unsupported\r
+ DeprecatedCryptoServiceMd4GetContextSize,\r
+ DeprecatedCryptoServiceMd4Init,\r
+ DeprecatedCryptoServiceMd4Duplicate,\r
+ DeprecatedCryptoServiceMd4Update,\r
+ DeprecatedCryptoServiceMd4Final,\r
+ DeprecatedCryptoServiceMd4HashAll,\r
+ #ifndef ENABLE_MD5_DEPRECATED_INTERFACES\r
+ /// Md5 - deprecated and unsupported\r
+ DeprecatedCryptoServiceMd5GetContextSize,\r
+ DeprecatedCryptoServiceMd5Init,\r
+ DeprecatedCryptoServiceMd5Duplicate,\r
+ DeprecatedCryptoServiceMd5Update,\r
+ DeprecatedCryptoServiceMd5Final,\r
+ DeprecatedCryptoServiceMd5HashAll,\r
+ #else\r
/// Md5\r
CryptoServiceMd5GetContextSize,\r
CryptoServiceMd5Init,\r
CryptoServiceMd5Update,\r
CryptoServiceMd5Final,\r
CryptoServiceMd5HashAll,\r
+ #endif\r
/// Pkcs\r
CryptoServicePkcs1v2Encrypt,\r
CryptoServicePkcs5HashPassword,\r
CryptoServiceRsaPkcs1Verify,\r
CryptoServiceRsaGetPrivateKeyFromPem,\r
CryptoServiceRsaGetPublicKeyFromX509,\r
+ #ifdef DISABLE_SHA1_DEPRECATED_INTERFACES\r
+ /// Sha1 - deprecated and unsupported\r
+ DeprecatedCryptoServiceSha1GetContextSize,\r
+ DeprecatedCryptoServiceSha1Init,\r
+ DeprecatedCryptoServiceSha1Duplicate,\r
+ DeprecatedCryptoServiceSha1Update,\r
+ DeprecatedCryptoServiceSha1Final,\r
+ DeprecatedCryptoServiceSha1HashAll,\r
+ #else\r
/// Sha1\r
CryptoServiceSha1GetContextSize,\r
CryptoServiceSha1Init,\r
CryptoServiceSha1Update,\r
CryptoServiceSha1Final,\r
CryptoServiceSha1HashAll,\r
+ #endif\r
/// Sha256\r
CryptoServiceSha256GetContextSize,\r
CryptoServiceSha256Init,\r
CryptoServiceX509Free,\r
CryptoServiceX509StackFree,\r
CryptoServiceX509GetTBSCert,\r
- /// TDES\r
- CryptoServiceTdesGetContextSize,\r
- CryptoServiceTdesInit,\r
- CryptoServiceTdesEcbEncrypt,\r
- CryptoServiceTdesEcbDecrypt,\r
- CryptoServiceTdesCbcEncrypt,\r
- CryptoServiceTdesCbcDecrypt,\r
- /// AES\r
+ /// TDES - deprecated and unsupported\r
+ DeprecatedCryptoServiceTdesGetContextSize,\r
+ DeprecatedCryptoServiceTdesInit,\r
+ DeprecatedCryptoServiceTdesEcbEncrypt,\r
+ DeprecatedCryptoServiceTdesEcbDecrypt,\r
+ DeprecatedCryptoServiceTdesCbcEncrypt,\r
+ DeprecatedCryptoServiceTdesCbcDecrypt,\r
+ /// AES - ECB mode is deprecated and unsupported\r
CryptoServiceAesGetContextSize,\r
CryptoServiceAesInit,\r
- CryptoServiceAesEcbEncrypt,\r
- CryptoServiceAesEcbDecrypt,\r
+ DeprecatedCryptoServiceAesEcbEncrypt,\r
+ DeprecatedCryptoServiceAesEcbDecrypt,\r
CryptoServiceAesCbcEncrypt,\r
CryptoServiceAesCbcDecrypt,\r
- /// Arc4\r
- CryptoServiceArc4GetContextSize,\r
- CryptoServiceArc4Init,\r
- CryptoServiceArc4Encrypt,\r
- CryptoServiceArc4Decrypt,\r
- CryptoServiceArc4Reset,\r
+ /// Arc4 - deprecated and unsupported\r
+ DeprecatedCryptoServiceArc4GetContextSize,\r
+ DeprecatedCryptoServiceArc4Init,\r
+ DeprecatedCryptoServiceArc4Encrypt,\r
+ DeprecatedCryptoServiceArc4Decrypt,\r
+ DeprecatedCryptoServiceArc4Reset,\r
/// SM3\r
CryptoServiceSm3GetContextSize,\r
CryptoServiceSm3Init,\r
CryptoServiceTlsGetCaCertificate,\r
CryptoServiceTlsGetHostPublicCert,\r
CryptoServiceTlsGetHostPrivateKey,\r
- CryptoServiceTlsGetCertRevocationList\r
+ CryptoServiceTlsGetCertRevocationList,\r
+ /// RSA PSS\r
+ CryptoServiceRsaPssSign,\r
+ CryptoServiceRsaPssVerify,\r
+ /// Parallel hash\r
+ CryptoServiceParallelHash256HashAll,\r
+ /// HMAC SHA256 (continued)\r
+ CryptoServiceHmacSha256All,\r
+ /// HMAC SHA384\r
+ CryptoServiceHmacSha384New,\r
+ CryptoServiceHmacSha384Free,\r
+ CryptoServiceHmacSha384SetKey,\r
+ CryptoServiceHmacSha384Duplicate,\r
+ CryptoServiceHmacSha384Update,\r
+ CryptoServiceHmacSha384Final,\r
+ CryptoServiceHmacSha384All,\r
+ /// HKDF (continued)\r
+ CryptoServiceHkdfSha256Extract,\r
+ CryptoServiceHkdfSha256Expand,\r
+ CryptoServiceHkdfSha384ExtractAndExpand,\r
+ CryptoServiceHkdfSha384Extract,\r
+ CryptoServiceHkdfSha384Expand,\r
+ /// Aead Aes GCM\r
+ CryptoServiceAeadAesGcmEncrypt,\r
+ CryptoServiceAeadAesGcmDecrypt,\r
+ /// Big Numbers\r
+ CryptoServiceBigNumInit,\r
+ CryptoServiceBigNumFromBin,\r
+ CryptoServiceBigNumToBin,\r
+ CryptoServiceBigNumFree,\r
+ CryptoServiceBigNumAdd,\r
+ CryptoServiceBigNumSub,\r
+ CryptoServiceBigNumMod,\r
+ CryptoServiceBigNumExpMod,\r
+ CryptoServiceBigNumInverseMod,\r
+ CryptoServiceBigNumDiv,\r
+ CryptoServiceBigNumMulMod,\r
+ CryptoServiceBigNumCmp,\r
+ CryptoServiceBigNumBits,\r
+ CryptoServiceBigNumBytes,\r
+ CryptoServiceBigNumIsWord,\r
+ CryptoServiceBigNumIsOdd,\r
+ CryptoServiceBigNumCopy,\r
+ CryptoServiceBigNumValueOne,\r
+ CryptoServiceBigNumRShift,\r
+ CryptoServiceBigNumConstTime,\r
+ CryptoServiceBigNumSqrMod,\r
+ CryptoServiceBigNumNewContext,\r
+ CryptoServiceBigNumContextFree,\r
+ CryptoServiceBigNumSetUint,\r
+ CryptoServiceBigNumAddMod,\r
};\r
projects / mirror_edk2.git / blobdiff