primitives (Hash Serials, HMAC, RSA, Diffie-Hellman, etc) for UEFI security\r
functionality enabling.\r
\r
-Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2009 - 2020, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
\r
#include <Uefi/UefiBaseType.h>\r
\r
-///\r
-/// MD4 digest size in bytes\r
-///\r
-#define MD4_DIGEST_SIZE 16\r
-\r
///\r
/// MD5 digest size in bytes\r
///\r
-#define MD5_DIGEST_SIZE 16\r
+#define MD5_DIGEST_SIZE 16\r
\r
///\r
/// SHA-1 digest size in bytes.\r
///\r
-#define SHA1_DIGEST_SIZE 20\r
+#define SHA1_DIGEST_SIZE 20\r
\r
///\r
/// SHA-256 digest size in bytes\r
///\r
#define SHA512_DIGEST_SIZE 64\r
\r
+///\r
+/// SM3 digest size in bytes\r
+///\r
+#define SM3_256_DIGEST_SIZE 32\r
+\r
///\r
/// TDES block size in bytes\r
///\r
-#define TDES_BLOCK_SIZE 8\r
+#define TDES_BLOCK_SIZE 8\r
\r
///\r
/// AES block size in bytes\r
///\r
-#define AES_BLOCK_SIZE 16\r
+#define AES_BLOCK_SIZE 16\r
\r
///\r
/// RSA Key Tags Definition used in RsaSetKey() function for key component identification.\r
RsaKeyQInv ///< The CRT coefficient (== 1/q mod p)\r
} RSA_KEY_TAG;\r
\r
-//=====================================================================================\r
+// =====================================================================================\r
// One-Way Cryptographic Hash Primitives\r
-//=====================================================================================\r
-\r
-/**\r
- Retrieves the size, in bytes, of the context buffer required for MD4 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
-Md4GetContextSize (\r
- VOID\r
- );\r
-\r
-/**\r
- Initializes user-supplied memory pointed by Md4Context as MD4 hash context for\r
- subsequent use.\r
-\r
- If Md4Context 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
-\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
-Md4Init (\r
- OUT VOID *Md4Context\r
- );\r
-\r
-/**\r
- Makes a copy of an existing MD4 context.\r
-\r
- If Md4Context is NULL, then return FALSE.\r
- If NewMd4Context 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
-\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
-Md4Duplicate (\r
- IN CONST VOID *Md4Context,\r
- OUT VOID *NewMd4Context\r
- );\r
-\r
-/**\r
- Digests the input data and updates MD4 context.\r
-\r
- This function performs MD4 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 intialized by Md4Init(), and should not be finalized\r
- by Md4Final(). Behavior with invalid context is undefined.\r
-\r
- If Md4Context 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] 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
-Md4Update (\r
- IN OUT VOID *Md4Context,\r
- IN CONST VOID *Data,\r
- IN UINTN DataSize\r
- );\r
-\r
-/**\r
- Completes computation of the MD4 digest value.\r
+// =====================================================================================\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
- be used again.\r
- MD4 context should be already correctly intialized by Md4Init(), and should not be\r
- finalized by Md4Final(). Behavior with invalid MD4 context is undefined.\r
-\r
- If Md4Context 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
- 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
-Md4Final (\r
- IN OUT VOID *Md4Context,\r
- OUT UINT8 *HashValue\r
- );\r
-\r
-/**\r
- Computes the MD4 message digest of a input data buffer.\r
-\r
- This function performs the MD4 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
- 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
-Md4HashAll (\r
- IN CONST VOID *Data,\r
- IN UINTN DataSize,\r
- OUT UINT8 *HashValue\r
- );\r
+#ifdef ENABLE_MD5_DEPRECATED_INTERFACES\r
\r
/**\r
Retrieves the size, in bytes, of the context buffer required for MD5 hash operations.\r
\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
- MD5 context should be already correctly intialized by Md5Init(), and should not be finalized\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 Md5Context is NULL, then return FALSE.\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
- MD5 context should be already correctly intialized by Md5Init(), and should not be\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 Md5Context is NULL, then return FALSE.\r
OUT UINT8 *HashValue\r
);\r
\r
+#endif\r
+\r
+#ifndef DISABLE_SHA1_DEPRECATED_INTERFACES\r
+\r
/**\r
Retrieves the size, in bytes, of the context buffer required for SHA-1 hash operations.\r
\r
\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-1 context should be already correctly intialized by Sha1Init(), and should not be finalized\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 Sha1Context is NULL, then return FALSE.\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-1 context should be already correctly intialized by Sha1Init(), and should not be\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 Sha1Context is NULL, then return FALSE.\r
OUT UINT8 *HashValue\r
);\r
\r
+#endif\r
+\r
/**\r
Retrieves the size, in bytes, of the context buffer required for SHA-256 hash operations.\r
\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 intialized by Sha256Init(), and should not be finalized\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
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 intialized by Sha256Init(), and should not be\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
\r
This function performs SHA-384 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-384 context should be already correctly intialized by Sha384Init(), and should not be finalized\r
+ SHA-384 context should be already correctly initialized by Sha384Init(), and should not be finalized\r
by Sha384Final(). Behavior with invalid context is undefined.\r
\r
If Sha384Context is NULL, then return FALSE.\r
This function completes SHA-384 hash computation and retrieves the digest value into\r
the specified memory. After this function has been called, the SHA-384 context cannot\r
be used again.\r
- SHA-384 context should be already correctly intialized by Sha384Init(), and should not be\r
+ SHA-384 context should be already correctly initialized by Sha384Init(), and should not be\r
finalized by Sha384Final(). Behavior with invalid SHA-384 context is undefined.\r
\r
If Sha384Context is NULL, then return FALSE.\r
\r
This function performs SHA-512 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-512 context should be already correctly intialized by Sha512Init(), and should not be finalized\r
+ SHA-512 context should be already correctly initialized by Sha512Init(), and should not be finalized\r
by Sha512Final(). Behavior with invalid context is undefined.\r
\r
If Sha512Context is NULL, then return FALSE.\r
This function completes SHA-512 hash computation and retrieves the digest value into\r
the specified memory. After this function has been called, the SHA-512 context cannot\r
be used again.\r
- SHA-512 context should be already correctly intialized by Sha512Init(), and should not be\r
+ SHA-512 context should be already correctly initialized by Sha512Init(), and should not be\r
finalized by Sha512Final(). Behavior with invalid SHA-512 context is undefined.\r
\r
If Sha512Context is NULL, then return FALSE.\r
OUT UINT8 *HashValue\r
);\r
\r
-//=====================================================================================\r
-// MAC (Message Authentication Code) Primitive\r
-//=====================================================================================\r
-\r
/**\r
- Retrieves the size, in bytes, of the context buffer required for HMAC-MD5 operations.\r
-\r
- If this interface is not supported, then return zero.\r
+ Retrieves the size, in bytes, of the context buffer required for SM3 hash operations.\r
\r
- @return The size, in bytes, of the context buffer required for HMAC-MD5 operations.\r
- @retval 0 This interface is not supported.\r
+ @return The size, in bytes, of the context buffer required for SM3 hash operations.\r
\r
**/\r
UINTN\r
EFIAPI\r
-HmacMd5GetContextSize (\r
+Sm3GetContextSize (\r
VOID\r
);\r
\r
/**\r
- Initializes user-supplied memory pointed by HmacMd5Context as HMAC-MD5 context for\r
+ Initializes user-supplied memory pointed by Sm3Context as SM3 hash context for\r
subsequent use.\r
\r
- If HmacMd5Context is NULL, then return FALSE.\r
- If this interface is not supported, then return FALSE.\r
+ If Sm3Context is NULL, then return FALSE.\r
\r
- @param[out] HmacMd5Context Pointer to HMAC-MD5 context being initialized.\r
- @param[in] Key Pointer to the user-supplied key.\r
- @param[in] KeySize Key size in bytes.\r
+ @param[out] Sm3Context Pointer to SM3 context being initialized.\r
\r
- @retval TRUE HMAC-MD5 context initialization succeeded.\r
- @retval FALSE HMAC-MD5 context initialization failed.\r
- @retval FALSE This interface is not supported.\r
+ @retval TRUE SM3 context initialization succeeded.\r
+ @retval FALSE SM3 context initialization failed.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-HmacMd5Init (\r
- OUT VOID *HmacMd5Context,\r
- IN CONST UINT8 *Key,\r
- IN UINTN KeySize\r
+Sm3Init (\r
+ OUT VOID *Sm3Context\r
);\r
\r
/**\r
- Makes a copy of an existing HMAC-MD5 context.\r
+ Makes a copy of an existing SM3 context.\r
\r
- If HmacMd5Context is NULL, then return FALSE.\r
- If NewHmacMd5Context is NULL, then return FALSE.\r
+ If Sm3Context is NULL, then return FALSE.\r
+ If NewSm3Context is NULL, then return FALSE.\r
If this interface is not supported, then return FALSE.\r
\r
- @param[in] HmacMd5Context Pointer to HMAC-MD5 context being copied.\r
- @param[out] NewHmacMd5Context Pointer to new HMAC-MD5 context.\r
+ @param[in] Sm3Context Pointer to SM3 context being copied.\r
+ @param[out] NewSm3Context Pointer to new SM3 context.\r
\r
- @retval TRUE HMAC-MD5 context copy succeeded.\r
- @retval FALSE HMAC-MD5 context copy failed.\r
+ @retval TRUE SM3 context copy succeeded.\r
+ @retval FALSE SM3 context copy failed.\r
@retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-HmacMd5Duplicate (\r
- IN CONST VOID *HmacMd5Context,\r
- OUT VOID *NewHmacMd5Context\r
+Sm3Duplicate (\r
+ IN CONST VOID *Sm3Context,\r
+ OUT VOID *NewSm3Context\r
);\r
\r
/**\r
- Digests the input data and updates HMAC-MD5 context.\r
+ Digests the input data and updates SM3 context.\r
\r
- This function performs HMAC-MD5 digest on a data buffer of the specified size.\r
+ This function performs SM3 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 already correctly intialized by HmacMd5Init(), and should not be\r
- finalized by HmacMd5Final(). Behavior with invalid context is undefined.\r
+ SM3 context should be already correctly initialized by Sm3Init(), and should not be finalized\r
+ by Sm3Final(). 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
+ If Sm3Context is NULL, then return FALSE.\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
+ @param[in, out] Sm3Context Pointer to the SM3 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 HMAC-MD5 data digest succeeded.\r
- @retval FALSE HMAC-MD5 data digest failed.\r
- @retval FALSE This interface is not supported.\r
+ @retval TRUE SM3 data digest succeeded.\r
+ @retval FALSE SM3 data digest failed.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-HmacMd5Update (\r
- IN OUT VOID *HmacMd5Context,\r
+Sm3Update (\r
+ IN OUT VOID *Sm3Context,\r
IN CONST VOID *Data,\r
IN UINTN DataSize\r
);\r
\r
/**\r
- Completes computation of the HMAC-MD5 digest value.\r
+ Completes computation of the SM3 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
+ This function completes SM3 hash computation and retrieves the digest value into\r
+ the specified memory. After this function has been called, the SM3 context cannot\r
be used again.\r
- HMAC-MD5 context should be already correctly intialized by HmacMd5Init(), and should not be\r
- finalized by HmacMd5Final(). Behavior with invalid HMAC-MD5 context is undefined.\r
+ SM3 context should be already correctly initialized by Sm3Init(), and should not be\r
+ finalized by Sm3Final(). Behavior with invalid SM3 context is undefined.\r
\r
- If HmacMd5Context is NULL, then return FALSE.\r
+ If Sm3Context 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] HmacMd5Context Pointer to the HMAC-MD5 context.\r
- @param[out] HashValue Pointer to a buffer that receives the HMAC-MD5 digest\r
- value (16 bytes).\r
+ @param[in, out] Sm3Context Pointer to the SM3 context.\r
+ @param[out] HashValue Pointer to a buffer that receives the SM3 digest\r
+ value (32 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
+ @retval TRUE SM3 digest computation succeeded.\r
+ @retval FALSE SM3 digest computation failed.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-HmacMd5Final (\r
- IN OUT VOID *HmacMd5Context,\r
- OUT UINT8 *HmacValue\r
- );\r
-\r
-/**\r
- Retrieves the size, in bytes, of the context buffer required for HMAC-SHA1 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 HMAC-SHA1 operations.\r
- @retval 0 This interface is not supported.\r
-\r
-**/\r
-UINTN\r
-EFIAPI\r
-HmacSha1GetContextSize (\r
- VOID\r
+Sm3Final (\r
+ IN OUT VOID *Sm3Context,\r
+ OUT UINT8 *HashValue\r
);\r
\r
/**\r
- Initializes user-supplied memory pointed by HmacSha1Context as HMAC-SHA1 context for\r
- subsequent use.\r
-\r
- If HmacSha1Context is NULL, then return FALSE.\r
- If this interface is not supported, then return FALSE.\r
-\r
- @param[out] HmacSha1Context Pointer to HMAC-SHA1 context being initialized.\r
- @param[in] Key Pointer to the user-supplied key.\r
- @param[in] KeySize Key size in bytes.\r
-\r
- @retval TRUE HMAC-SHA1 context initialization succeeded.\r
- @retval FALSE HMAC-SHA1 context initialization failed.\r
- @retval FALSE This interface is not supported.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-HmacSha1Init (\r
- OUT VOID *HmacSha1Context,\r
- IN CONST UINT8 *Key,\r
- IN UINTN KeySize\r
- );\r
+ Computes the SM3 message digest of a input data buffer.\r
\r
-/**\r
- Makes a copy of an existing HMAC-SHA1 context.\r
+ This function performs the SM3 message digest of a given data buffer, and places\r
+ the digest value into the specified memory.\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
\r
- @param[in] HmacSha1Context Pointer to HMAC-SHA1 context being copied.\r
- @param[out] NewHmacSha1Context Pointer to new HMAC-SHA1 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[out] HashValue Pointer to a buffer that receives the SM3 digest\r
+ value (32 bytes).\r
\r
- @retval TRUE HMAC-SHA1 context copy succeeded.\r
- @retval FALSE HMAC-SHA1 context copy failed.\r
+ @retval TRUE SM3 digest computation succeeded.\r
+ @retval FALSE SM3 digest computation failed.\r
@retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-HmacSha1Duplicate (\r
- IN CONST VOID *HmacSha1Context,\r
- OUT VOID *NewHmacSha1Context\r
+Sm3HashAll (\r
+ IN CONST VOID *Data,\r
+ IN UINTN DataSize,\r
+ OUT UINT8 *HashValue\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 already correctly intialized by HmacSha1Init(), and should not\r
- be finalized by 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
-\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
-HmacSha1Update (\r
- IN OUT VOID *HmacSha1Context,\r
- IN CONST VOID *Data,\r
- IN UINTN DataSize\r
- );\r
+// =====================================================================================\r
+// MAC (Message Authentication Code) Primitive\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 already correctly intialized by HmacSha1Init(), and should\r
- not be finalized by HmacSha1Final(). Behavior with invalid HMAC-SHA1 context is undefined.\r
-\r
- If HmacSha1Context 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] HmacSha1Context Pointer to the HMAC-SHA1 context.\r
- @param[out] HashValue Pointer to a buffer that receives the HMAC-SHA1 digest\r
- value (20 bytes).\r
+ Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA256 use.\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
+ @return Pointer to the HMAC_CTX context that has been initialized.\r
+ If the allocations fails, HmacSha256New() returns NULL.\r
\r
**/\r
-BOOLEAN\r
+VOID *\r
EFIAPI\r
-HmacSha1Final (\r
- IN OUT VOID *HmacSha1Context,\r
- OUT UINT8 *HmacValue\r
+HmacSha256New (\r
+ VOID\r
);\r
\r
/**\r
- Retrieves the size, in bytes, of the context buffer required for HMAC-SHA256 operations.\r
-\r
- If this interface is not supported, then return zero.\r
+ Release the specified HMAC_CTX context.\r
\r
- @return The size, in bytes, of the context buffer required for HMAC-SHA256 operations.\r
- @retval 0 This interface is not supported.\r
+ @param[in] HmacSha256Ctx Pointer to the HMAC_CTX context to be released.\r
\r
**/\r
-UINTN\r
+VOID\r
EFIAPI\r
-HmacSha256GetContextSize (\r
- VOID\r
+HmacSha256Free (\r
+ IN VOID *HmacSha256Ctx\r
);\r
\r
/**\r
- Initializes user-supplied memory pointed by HmacSha256Context as HMAC-SHA256 context for\r
- subsequent use.\r
+ Set user-supplied key for subsequent use. It must be done before any\r
+ calling to HmacSha256Update().\r
\r
If HmacSha256Context is NULL, then return FALSE.\r
If this interface is not supported, then return FALSE.\r
\r
- @param[out] HmacSha256Context Pointer to HMAC-SHA256 context being initialized.\r
+ @param[out] HmacSha256Context Pointer to HMAC-SHA256 context.\r
@param[in] Key Pointer to the user-supplied key.\r
@param[in] KeySize Key size in bytes.\r
\r
- @retval TRUE HMAC-SHA256 context initialization succeeded.\r
- @retval FALSE HMAC-SHA256 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
-HmacSha256Init (\r
+HmacSha256SetKey (\r
OUT VOID *HmacSha256Context,\r
IN CONST UINT8 *Key,\r
IN UINTN KeySize\r
\r
This function performs HMAC-SHA256 digest on a data buffer of the specified size.\r
It can be called multiple times to compute the digest of long or discontinuous data streams.\r
- HMAC-SHA256 context should be already correctly initialized by HmacSha256Init(), and should not\r
- be finalized by HmacSha256Final(). Behavior with invalid context is undefined.\r
+ HMAC-SHA256 context should be initialized by HmacSha256New(), and should not be finalized\r
+ by HmacSha256Final(). Behavior with invalid context is undefined.\r
\r
If HmacSha256Context is NULL, then return FALSE.\r
If this interface is not supported, then return FALSE.\r
This function completes HMAC-SHA256 hash computation and retrieves the digest value into\r
the specified memory. After this function has been called, the HMAC-SHA256 context cannot\r
be used again.\r
- HMAC-SHA256 context should be already correctly initialized by HmacSha256Init(), and should\r
- not be finalized by HmacSha256Final(). Behavior with invalid HMAC-SHA256 context is undefined.\r
+ HMAC-SHA256 context should be initialized by HmacSha256New(), and should not be finalized\r
+ by HmacSha256Final(). Behavior with invalid HMAC-SHA256 context is undefined.\r
\r
If HmacSha256Context is NULL, then return FALSE.\r
- If HashValue 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] HmacSha256Context Pointer to the HMAC-SHA256 context.\r
- @param[out] HashValue Pointer to a buffer that receives the HMAC-SHA256 digest\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
OUT UINT8 *HmacValue\r
);\r
\r
-//=====================================================================================\r
+// =====================================================================================\r
// Symmetric Cryptography Primitive\r
-//=====================================================================================\r
+// =====================================================================================\r
\r
/**\r
- Retrieves the size, in bytes, of the context buffer required for TDES operations.\r
+ Retrieves the size, in bytes, of the context buffer required for AES 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 TDES operations.\r
+ @return The size, in bytes, of the context buffer required for AES operations.\r
@retval 0 This interface is not supported.\r
\r
**/\r
UINTN\r
EFIAPI\r
-TdesGetContextSize (\r
+AesGetContextSize (\r
VOID\r
);\r
\r
/**\r
- Initializes user-supplied memory as TDES context for subsequent use.\r
+ Initializes user-supplied memory as AES context for subsequent use.\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
+ This function initializes user-supplied memory pointed by AesContext as AES context.\r
+ In addition, it sets up all AES 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
+ There are 3 options for key length, 128 bits, 192 bits, and 256 bits.\r
\r
- If TdesContext is NULL, then return FALSE.\r
+ If AesContext is NULL, then return FALSE.\r
If Key is NULL, then return FALSE.\r
If KeyLength is not valid, 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] AesContext Pointer to AES context being initialized.\r
+ @param[in] Key Pointer to the user-supplied AES key.\r
+ @param[in] KeyLength Length of AES key in bits.\r
\r
- @retval TRUE TDES context initialization succeeded.\r
- @retval FALSE TDES context initialization failed.\r
+ @retval TRUE AES context initialization succeeded.\r
+ @retval FALSE AES context initialization failed.\r
@retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-TdesInit (\r
- OUT VOID *TdesContext,\r
+AesInit (\r
+ OUT VOID *AesContext,\r
IN CONST UINT8 *Key,\r
IN UINTN KeyLength\r
);\r
\r
/**\r
- Performs TDES encryption on a data buffer of the specified size in ECB mode.\r
+ Performs AES encryption on a data buffer of the specified size in CBC 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
+ This function performs AES encryption on data buffer pointed by Input, of specified\r
+ size of InputSize, in CBC 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
- TdesContext should be already correctly initialized by TdesInit(). Behavior with\r
- invalid TDES context is undefined.\r
+ Initialization vector should be one block size (16 bytes).\r
+ AesContext should be already correctly initialized by AesInit(). Behavior with\r
+ invalid AES context is undefined.\r
\r
- If TdesContext is NULL, then return FALSE.\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 (8 bytes), then return FALSE.\r
+ If InputSize is not multiple of block size (16 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
\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] 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[in] Ivec Pointer to initialization vector.\r
+ @param[out] Output Pointer to a buffer that receives the AES encryption output.\r
\r
- @retval TRUE TDES encryption succeeded.\r
- @retval FALSE TDES encryption failed.\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
-TdesEcbEncrypt (\r
- IN VOID *TdesContext,\r
+AesCbcEncrypt (\r
+ IN VOID *AesContext,\r
IN CONST UINT8 *Input,\r
IN UINTN InputSize,\r
+ IN CONST UINT8 *Ivec,\r
OUT UINT8 *Output\r
);\r
\r
/**\r
- Performs TDES decryption on a data buffer of the specified size in ECB mode.\r
+ Performs AES 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 ECB mode.\r
- InputSize must be multiple of block size (8 bytes). This function does not perform\r
+ This function performs AES decryption on data buffer pointed by Input, of specified\r
+ size of InputSize, in CBC 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
- TdesContext should be already correctly initialized by TdesInit(). Behavior with\r
- invalid TDES context is undefined.\r
+ Initialization vector should be one block size (16 bytes).\r
+ AesContext should be already correctly initialized by AesInit(). Behavior with\r
+ invalid AES context is undefined.\r
\r
- If TdesContext is NULL, then return FALSE.\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 (8 bytes), then return FALSE.\r
+ If InputSize is not multiple of block size (16 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
\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
+ @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[in] Ivec Pointer to initialization vector.\r
+ @param[out] Output Pointer to a buffer that receives the AES encryption output.\r
\r
- @retval TRUE TDES decryption succeeded.\r
- @retval FALSE TDES decryption failed.\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
-TdesEcbDecrypt (\r
- IN VOID *TdesContext,\r
+AesCbcDecrypt (\r
+ IN VOID *AesContext,\r
IN CONST UINT8 *Input,\r
IN UINTN InputSize,\r
+ IN CONST UINT8 *Ivec,\r
OUT UINT8 *Output\r
);\r
\r
-/**\r
- Performs TDES encryption on a data buffer of the specified size in CBC mode.\r
+// =====================================================================================\r
+// Asymmetric Cryptography Primitive\r
+// =====================================================================================\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
+/**\r
+ Allocates and initializes one RSA context for subsequent use.\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
-\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[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
-TdesCbcEncrypt (\r
- IN VOID *TdesContext,\r
- IN CONST UINT8 *Input,\r
- IN UINTN InputSize,\r
- IN CONST UINT8 *Ivec,\r
- OUT UINT8 *Output\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
-\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[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
-TdesCbcDecrypt (\r
- IN VOID *TdesContext,\r
- IN CONST UINT8 *Input,\r
- IN UINTN InputSize,\r
- IN CONST UINT8 *Ivec,\r
- OUT UINT8 *Output\r
- );\r
-\r
-/**\r
- Retrieves the size, in bytes, of the context buffer required for AES 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 AES operations.\r
- @retval 0 This interface is not supported.\r
-\r
-**/\r
-UINTN\r
-EFIAPI\r
-AesGetContextSize (\r
- VOID\r
- );\r
-\r
-/**\r
- Initializes user-supplied memory as AES context for subsequent use.\r
-\r
- This function initializes user-supplied memory pointed by AesContext as AES context.\r
- In addition, it sets up all AES key materials for subsequent encryption and decryption\r
- operations.\r
- There are 3 options for key length, 128 bits, 192 bits, and 256 bits.\r
-\r
- If AesContext is NULL, then return FALSE.\r
- If Key is NULL, then return FALSE.\r
- If KeyLength is not valid, then return FALSE.\r
- If this interface is not supported, then return FALSE.\r
-\r
- @param[out] AesContext Pointer to AES context being initialized.\r
- @param[in] Key Pointer to the user-supplied AES key.\r
- @param[in] KeyLength Length of AES key in bits.\r
-\r
- @retval TRUE AES context initialization succeeded.\r
- @retval FALSE AES context initialization failed.\r
- @retval FALSE This interface is not supported.\r
-\r
-**/\r
-BOOLEAN\r
-EFIAPI\r
-AesInit (\r
- OUT VOID *AesContext,\r
- IN CONST UINT8 *Key,\r
- IN UINTN KeyLength\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
-\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
-AesEcbEncrypt (\r
- IN VOID *AesContext,\r
- IN CONST UINT8 *Input,\r
- IN UINTN InputSize,\r
- OUT UINT8 *Output\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
-\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
-AesEcbDecrypt (\r
- IN VOID *AesContext,\r
- IN CONST UINT8 *Input,\r
- IN UINTN InputSize,\r
- OUT UINT8 *Output\r
- );\r
-\r
-/**\r
- Performs AES encryption on a data buffer of the specified size in CBC mode.\r
-\r
- This function performs AES encryption on data buffer pointed by Input, of specified\r
- size of InputSize, in CBC 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
- Initialization vector should be one block size (16 bytes).\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 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
-\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[in] Ivec Pointer to initialization vector.\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
-AesCbcEncrypt (\r
- IN VOID *AesContext,\r
- IN CONST UINT8 *Input,\r
- IN UINTN InputSize,\r
- IN CONST UINT8 *Ivec,\r
- OUT UINT8 *Output\r
- );\r
-\r
-/**\r
- Performs AES decryption on a data buffer of the specified size in CBC mode.\r
-\r
- This function performs AES decryption on data buffer pointed by Input, of specified\r
- size of InputSize, in CBC 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
- Initialization vector should be one block size (16 bytes).\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 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
-\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[in] Ivec Pointer to initialization vector.\r
- @param[out] Output Pointer to a buffer that receives the AES encryption 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
-AesCbcDecrypt (\r
- IN VOID *AesContext,\r
- IN CONST UINT8 *Input,\r
- IN UINTN InputSize,\r
- IN CONST UINT8 *Ivec,\r
- OUT UINT8 *Output\r
- );\r
-\r
-/**\r
- Retrieves the size, in bytes, of the context buffer required for ARC4 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 ARC4 operations.\r
- @retval 0 This interface is not supported.\r
-\r
-**/\r
-UINTN\r
-EFIAPI\r
-Arc4GetContextSize (\r
- VOID\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
-\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
-Arc4Init (\r
- OUT VOID *Arc4Context,\r
- IN CONST UINT8 *Key,\r
- IN UINTN KeySize\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
-\r
- @param[in] 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
-Arc4Encrypt (\r
- IN OUT VOID *Arc4Context,\r
- IN CONST UINT8 *Input,\r
- IN UINTN InputSize,\r
- OUT UINT8 *Output\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
-\r
- @param[in] 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
-Arc4Decrypt (\r
- IN OUT VOID *Arc4Context,\r
- IN UINT8 *Input,\r
- IN UINTN InputSize,\r
- OUT UINT8 *Output\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
-\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
-Arc4Reset (\r
- IN OUT VOID *Arc4Context\r
- );\r
-\r
-//=====================================================================================\r
-// Asymmetric Cryptography Primitive\r
-//=====================================================================================\r
-\r
-/**\r
- Allocates and initializes one RSA context for subsequent use.\r
-\r
- @return Pointer to the RSA context that has been initialized.\r
- If the allocations fails, RsaNew() returns NULL.\r
+ @return Pointer to the RSA context that has been initialized.\r
+ If the allocations fails, RsaNew() returns NULL.\r
\r
**/\r
VOID *\r
This function sets the tag-designated RSA key component into the established\r
RSA context from the user-specified non-negative integer (octet string format\r
represented in RSA PKCS#1).\r
- If BigNumber is NULL, then the specified key componenet in RSA context is cleared.\r
+ If BigNumber is NULL, then the specified key component in RSA context is cleared.\r
\r
If RsaContext is NULL, then return FALSE.\r
\r
@param[in, out] RsaContext Pointer to RSA context being set.\r
@param[in] KeyTag Tag of RSA key component being set.\r
@param[in] BigNumber Pointer to octet integer buffer.\r
- If NULL, then the specified key componenet in RSA\r
+ If NULL, then the specified key component in RSA\r
context is cleared.\r
@param[in] BnSize Size of big number buffer in bytes.\r
If BigNumber is NULL, then it is ignored.\r
NOTE: This function performs integrity checks on all the RSA key material, so\r
the RSA key structure must contain all the private key data.\r
\r
- This function validates key compoents of RSA context in following aspects:\r
+ This function validates key components of RSA context in following aspects:\r
- Whether p is a prime\r
- Whether q is a prime\r
- Whether n = p * q\r
IN UINTN SigSize\r
);\r
\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
+RsaPssSign (\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
+/**\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
+RsaPssVerify (\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
/**\r
Retrieve the RSA Private Key from the password-protected PEM key data.\r
\r
IN OUT UINTN *SubjectSize\r
);\r
\r
+/**\r
+ Retrieve the common name (CN) string from one X.509 certificate.\r
+\r
+ @param[in] Cert Pointer to the DER-encoded X509 certificate.\r
+ @param[in] CertSize Size of the X509 certificate in bytes.\r
+ @param[out] CommonName Buffer to contain the retrieved certificate common\r
+ name string (UTF8). At most CommonNameSize bytes will be\r
+ written and the string will be null terminated. May be\r
+ NULL in order to determine the size buffer needed.\r
+ @param[in,out] CommonNameSize The size in bytes of the CommonName buffer on input,\r
+ and the size of buffer returned CommonName on output.\r
+ If CommonName is NULL then the amount of space needed\r
+ in buffer (including the final null) is returned.\r
+\r
+ @retval RETURN_SUCCESS The certificate CommonName retrieved successfully.\r
+ @retval RETURN_INVALID_PARAMETER If Cert is NULL.\r
+ If CommonNameSize is NULL.\r
+ If CommonName is not NULL and *CommonNameSize is 0.\r
+ If Certificate is invalid.\r
+ @retval RETURN_NOT_FOUND If no CommonName entry exists.\r
+ @retval RETURN_BUFFER_TOO_SMALL If the CommonName is NULL. The required buffer size\r
+ (including the final null) is returned in the\r
+ CommonNameSize parameter.\r
+ @retval RETURN_UNSUPPORTED The operation is not supported.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+X509GetCommonName (\r
+ IN CONST UINT8 *Cert,\r
+ IN UINTN CertSize,\r
+ OUT CHAR8 *CommonName OPTIONAL,\r
+ IN OUT UINTN *CommonNameSize\r
+ );\r
+\r
+/**\r
+ Retrieve the organization name (O) string from one X.509 certificate.\r
+\r
+ @param[in] Cert Pointer to the DER-encoded X509 certificate.\r
+ @param[in] CertSize Size of the X509 certificate in bytes.\r
+ @param[out] NameBuffer Buffer to contain the retrieved certificate organization\r
+ name string. At most NameBufferSize bytes will be\r
+ written and the string will be null terminated. May be\r
+ NULL in order to determine the size buffer needed.\r
+ @param[in,out] NameBufferSize The size in bytes of the Name buffer on input,\r
+ and the size of buffer returned Name on output.\r
+ If NameBuffer is NULL then the amount of space needed\r
+ in buffer (including the final null) is returned.\r
+\r
+ @retval RETURN_SUCCESS The certificate Organization Name retrieved successfully.\r
+ @retval RETURN_INVALID_PARAMETER If Cert is NULL.\r
+ If NameBufferSize is NULL.\r
+ If NameBuffer is not NULL and *CommonNameSize is 0.\r
+ If Certificate is invalid.\r
+ @retval RETURN_NOT_FOUND If no Organization Name entry exists.\r
+ @retval RETURN_BUFFER_TOO_SMALL If the NameBuffer is NULL. The required buffer size\r
+ (including the final null) is returned in the\r
+ CommonNameSize parameter.\r
+ @retval RETURN_UNSUPPORTED The operation is not supported.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+X509GetOrganizationName (\r
+ IN CONST UINT8 *Cert,\r
+ IN UINTN CertSize,\r
+ OUT CHAR8 *NameBuffer OPTIONAL,\r
+ IN OUT UINTN *NameBufferSize\r
+ );\r
+\r
/**\r
Verify one X509 certificate was issued by the trusted CA.\r
\r
OUT UINT8 **SingleX509Cert\r
);\r
\r
+/**\r
+ Construct a X509 stack object from a list of DER-encoded certificate data.\r
+\r
+ If X509Stack is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
+\r
+ @param[in, out] X509Stack On input, pointer to an existing or NULL X509 stack object.\r
+ On output, pointer to the X509 stack object with new\r
+ inserted X509 certificate.\r
+ @param[in] Args VA_LIST marker for the variable argument list.\r
+ A list of DER-encoded single certificate data followed\r
+ by certificate size. A NULL terminates the list. The\r
+ pairs are the arguments to X509ConstructCertificate().\r
+\r
+ @retval TRUE The X509 stack construction succeeded.\r
+ @retval FALSE The construction operation failed.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+X509ConstructCertificateStackV (\r
+ IN OUT UINT8 **X509Stack,\r
+ IN VA_LIST Args\r
+ );\r
+\r
/**\r
Construct a X509 stack object from a list of DER-encoded certificate data.\r
\r
OUT UINTN *TBSCertSize\r
);\r
\r
+/**\r
+ Derives a key from a password using a salt and iteration count, based on PKCS#5 v2.0\r
+ password based encryption key derivation function PBKDF2, as specified in RFC 2898.\r
+\r
+ If Password or Salt or OutKey is NULL, then return FALSE.\r
+ If the hash algorithm could not be determined, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
+\r
+ @param[in] PasswordLength Length of input password in bytes.\r
+ @param[in] Password Pointer to the array for the password.\r
+ @param[in] SaltLength Size of the Salt in bytes.\r
+ @param[in] Salt Pointer to the Salt.\r
+ @param[in] IterationCount Number of iterations to perform. Its value should be\r
+ greater than or equal to 1.\r
+ @param[in] DigestSize Size of the message digest to be used (eg. SHA256_DIGEST_SIZE).\r
+ NOTE: DigestSize will be used to determine the hash algorithm.\r
+ Only SHA1_DIGEST_SIZE or SHA256_DIGEST_SIZE is supported.\r
+ @param[in] KeyLength Size of the derived key buffer in bytes.\r
+ @param[out] OutKey Pointer to the output derived key buffer.\r
+\r
+ @retval TRUE A key was derived successfully.\r
+ @retval FALSE One of the pointers was NULL or one of the sizes was too large.\r
+ @retval FALSE The hash algorithm could not be determined from the digest size.\r
+ @retval FALSE The key derivation operation failed.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+Pkcs5HashPassword (\r
+ IN UINTN PasswordLength,\r
+ IN CONST CHAR8 *Password,\r
+ IN UINTN SaltLength,\r
+ IN CONST UINT8 *Salt,\r
+ IN UINTN IterationCount,\r
+ IN UINTN DigestSize,\r
+ IN UINTN KeyLength,\r
+ OUT UINT8 *OutKey\r
+ );\r
+\r
+/**\r
+ Encrypts a blob using PKCS1v2 (RSAES-OAEP) schema. On success, will return the\r
+ encrypted message in a newly allocated buffer.\r
+\r
+ Things that can cause a failure include:\r
+ - X509 key size does not match any known key size.\r
+ - Fail to parse X509 certificate.\r
+ - Fail to allocate an intermediate buffer.\r
+ - Null pointer provided for a non-optional parameter.\r
+ - Data size is too large for the provided key size (max size is a function of key size\r
+ and hash digest size).\r
+\r
+ @param[in] PublicKey A pointer to the DER-encoded X509 certificate that\r
+ will be used to encrypt the data.\r
+ @param[in] PublicKeySize Size of the X509 cert buffer.\r
+ @param[in] InData Data to be encrypted.\r
+ @param[in] InDataSize Size of the data buffer.\r
+ @param[in] PrngSeed [Optional] If provided, a pointer to a random seed buffer\r
+ to be used when initializing the PRNG. NULL otherwise.\r
+ @param[in] PrngSeedSize [Optional] If provided, size of the random seed buffer.\r
+ 0 otherwise.\r
+ @param[out] EncryptedData Pointer to an allocated buffer containing the encrypted\r
+ message.\r
+ @param[out] EncryptedDataSize Size of the encrypted message buffer.\r
+\r
+ @retval TRUE Encryption was successful.\r
+ @retval FALSE Encryption failed.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+Pkcs1v2Encrypt (\r
+ IN CONST UINT8 *PublicKey,\r
+ IN UINTN PublicKeySize,\r
+ IN UINT8 *InData,\r
+ IN UINTN InDataSize,\r
+ IN CONST UINT8 *PrngSeed OPTIONAL,\r
+ IN UINTN PrngSeedSize OPTIONAL,\r
+ OUT UINT8 **EncryptedData,\r
+ OUT UINTN *EncryptedDataSize\r
+ );\r
+\r
+/**\r
+ The 3rd parameter of Pkcs7GetSigners will return all embedded\r
+ X.509 certificate in one given PKCS7 signature. The format is:\r
+ //\r
+ // UINT8 CertNumber;\r
+ // UINT32 Cert1Length;\r
+ // UINT8 Cert1[];\r
+ // UINT32 Cert2Length;\r
+ // UINT8 Cert2[];\r
+ // ...\r
+ // UINT32 CertnLength;\r
+ // UINT8 Certn[];\r
+ //\r
+\r
+ The two following C-structure are used for parsing CertStack more clearly.\r
+**/\r
+#pragma pack(1)\r
+\r
+typedef struct {\r
+ UINT32 CertDataLength; // The length in bytes of X.509 certificate.\r
+ UINT8 CertDataBuffer[0]; // The X.509 certificate content (DER).\r
+} EFI_CERT_DATA;\r
+\r
+typedef struct {\r
+ UINT8 CertNumber; // Number of X.509 certificate.\r
+ // EFI_CERT_DATA CertArray[]; // An array of X.509 certificate.\r
+} EFI_CERT_STACK;\r
+\r
+#pragma pack()\r
+\r
/**\r
Get the signer's certificates from PKCS#7 signed data as described in "PKCS #7:\r
Cryptographic Message Syntax Standard". The input signed data could be wrapped\r
in a ContentInfo structure.\r
\r
If P7Data, CertStack, StackLength, TrustedCert or CertLength is NULL, then\r
- return FALSE. If P7Length overflow, then return FAlSE.\r
+ return FALSE. If P7Length overflow, then return FALSE.\r
If this interface is not supported, then return FALSE.\r
\r
@param[in] P7Data Pointer to the PKCS#7 message to verify.\r
@param[in] P7Length Length of the PKCS#7 message in bytes.\r
@param[out] CertStack Pointer to Signer's certificates retrieved from P7Data.\r
- It's caller's responsiblity to free the buffer.\r
+ It's caller's responsibility to free the buffer with\r
+ Pkcs7FreeSigners().\r
+ This data structure is EFI_CERT_STACK type.\r
@param[out] StackLength Length of signer's certificates in bytes.\r
@param[out] TrustedCert Pointer to a trusted certificate from Signer's certificates.\r
- It's caller's responsiblity to free the buffer.\r
+ It's caller's responsibility to free the buffer with\r
+ Pkcs7FreeSigners().\r
@param[out] CertLength Length of the trusted certificate in bytes.\r
\r
@retval TRUE The operation is finished successfully.\r
VOID\r
EFIAPI\r
Pkcs7FreeSigners (\r
- IN UINT8 *Certs\r
+ IN UINT8 *Certs\r
);\r
\r
/**\r
@param[in] P7Data Pointer to the PKCS#7 message.\r
@param[in] P7Length Length of the PKCS#7 message in bytes.\r
@param[out] SignerChainCerts Pointer to the certificates list chained to signer's\r
- certificate. It's caller's responsiblity to free the buffer.\r
+ certificate. It's caller's responsibility to free the buffer\r
+ with Pkcs7FreeSigners().\r
+ This data structure is EFI_CERT_STACK type.\r
@param[out] ChainLength Length of the chained certificates list buffer in bytes.\r
@param[out] UnchainCerts Pointer to the unchained certificates lists. It's caller's\r
- responsiblity to free the buffer.\r
+ responsibility to free the buffer with Pkcs7FreeSigners().\r
+ This data structure is EFI_CERT_STACK type.\r
@param[out] UnchainLength Length of the unchained certificates list buffer in bytes.\r
\r
@retval TRUE The operation is finished successfully.\r
@param[in] OtherCerts Pointer to an optional additional set of certificates to\r
include in the PKCS#7 signedData (e.g. any intermediate\r
CAs in the chain).\r
- @param[out] SignedData Pointer to output PKCS#7 signedData.\r
+ @param[out] SignedData Pointer to output PKCS#7 signedData. It's caller's\r
+ responsibility to free the buffer with FreePool().\r
@param[out] SignedDataSize Size of SignedData in bytes.\r
\r
@retval TRUE PKCS#7 data signing succeeded.\r
);\r
\r
/**\r
- Verifies the validility of a PKCS#7 signed data as described in "PKCS #7:\r
+ Verifies the validity of a PKCS#7 signed data as described in "PKCS #7:\r
Cryptographic Message Syntax Standard". The input signed data could be wrapped\r
in a ContentInfo structure.\r
\r
If P7Data, TrustedCert or InData is NULL, then return FALSE.\r
- If P7Length, CertLength or DataLength overflow, then return FAlSE.\r
+ If P7Length, CertLength or DataLength overflow, then return FALSE.\r
If this interface is not supported, then return FALSE.\r
\r
@param[in] P7Data Pointer to the PKCS#7 message to verify.\r
IN UINTN DataLength\r
);\r
\r
+/**\r
+ This function receives a PKCS7 formatted signature, and then verifies that\r
+ the specified Enhanced or Extended Key Usages (EKU's) are present in the end-entity\r
+ leaf signing certificate.\r
+ Note that this function does not validate the certificate chain.\r
+\r
+ Applications for custom EKU's are quite flexible. For example, a policy EKU\r
+ may be present in an Issuing Certificate Authority (CA), and any sub-ordinate\r
+ certificate issued might also contain this EKU, thus constraining the\r
+ sub-ordinate certificate. Other applications might allow a certificate\r
+ embedded in a device to specify that other Object Identifiers (OIDs) are\r
+ present which contains binary data specifying custom capabilities that\r
+ the device is able to do.\r
+\r
+ @param[in] Pkcs7Signature The PKCS#7 signed information content block. An array\r
+ containing the content block with both the signature,\r
+ the signer's certificate, and any necessary intermediate\r
+ certificates.\r
+ @param[in] Pkcs7SignatureSize Number of bytes in Pkcs7Signature.\r
+ @param[in] RequiredEKUs Array of null-terminated strings listing OIDs of\r
+ required EKUs that must be present in the signature.\r
+ @param[in] RequiredEKUsSize Number of elements in the RequiredEKUs string array.\r
+ @param[in] RequireAllPresent If this is TRUE, then all of the specified EKU's\r
+ must be present in the leaf signer. If it is\r
+ FALSE, then we will succeed if we find any\r
+ of the specified EKU's.\r
+\r
+ @retval EFI_SUCCESS The required EKUs were found in the signature.\r
+ @retval EFI_INVALID_PARAMETER A parameter was invalid.\r
+ @retval EFI_NOT_FOUND One or more EKU's were not found in the signature.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+VerifyEKUsInPkcs7Signature (\r
+ IN CONST UINT8 *Pkcs7Signature,\r
+ IN CONST UINT32 SignatureSize,\r
+ IN CONST CHAR8 *RequiredEKUs[],\r
+ IN CONST UINT32 RequiredEKUsSize,\r
+ IN BOOLEAN RequireAllPresent\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
\r
If P7Data, Content, or ContentSize is NULL, then return FALSE. If P7Length overflow,\r
- then return FAlSE. If the P7Data is not correctly formatted, then return FALSE.\r
+ then return FALSE. If the P7Data is not correctly formatted, then return FALSE.\r
\r
Caution: This function may receive untrusted input. So this function will do\r
basic check for PKCS#7 data structure.\r
@param[in] P7Data Pointer to the PKCS#7 signed data to process.\r
@param[in] P7Length Length of the PKCS#7 signed data in bytes.\r
@param[out] Content Pointer to the extracted content from the PKCS#7 signedData.\r
- It's caller's responsiblity to free the buffer.\r
+ It's caller's responsibility to free the buffer with FreePool().\r
@param[out] ContentSize The size of the extracted content in bytes.\r
\r
@retval TRUE The P7Data was correctly formatted for processing.\r
@retval FALSE The P7Data was not correctly formatted for processing.\r
\r
-*/\r
+**/\r
BOOLEAN\r
EFIAPI\r
Pkcs7GetAttachedContent (\r
);\r
\r
/**\r
- Verifies the validility of a PE/COFF Authenticode Signature as described in "Windows\r
+ Verifies the validity of a PE/COFF Authenticode Signature as described in "Windows\r
Authenticode Portable Executable Signature Format".\r
\r
If AuthData is NULL, then return FALSE.\r
@param[in] TrustedCert Pointer to a trusted/root certificate encoded in DER, which\r
is used for certificate chain verification.\r
@param[in] CertSize Size of the trusted certificate in bytes.\r
- @param[in] ImageHash Pointer to the original image file hash value. The procudure\r
+ @param[in] ImageHash Pointer to the original image file hash value. The procedure\r
for calculating the image hash value is described in Authenticode\r
specification.\r
@param[in] HashSize Size of Image hash value in bytes.\r
);\r
\r
/**\r
- Verifies the validility of a RFC3161 Timestamp CounterSignature embedded in PE/COFF Authenticode\r
+ Verifies the validity of a RFC3161 Timestamp CounterSignature embedded in PE/COFF Authenticode\r
signature.\r
\r
If AuthData is NULL, then return FALSE.\r
OUT EFI_TIME *SigningTime\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
@param[in] PrimeLength Length in bits of prime to be generated.\r
@param[out] Prime Pointer to the buffer to receive the generated prime number.\r
\r
- @retval TRUE DH pamameter generation succeeded.\r
+ @retval TRUE DH parameter generation succeeded.\r
@retval FALSE Value of Generator is not supported.\r
@retval FALSE PRNG fails to generate random prime number with PrimeLength.\r
@retval FALSE This interface is not supported.\r
@param[in] PrimeLength Length in bits of prime to be generated.\r
@param[in] Prime Pointer to the prime number.\r
\r
- @retval TRUE DH pamameter setting succeeded.\r
+ @retval TRUE DH parameter setting succeeded.\r
@retval FALSE Value of Generator is not supported.\r
@retval FALSE Value of Generator is not suitable for the Prime.\r
@retval FALSE Value of Prime is not a prime number.\r
IN OUT UINTN *KeySize\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
If this interface is not supported, then return FALSE.\r
\r
@param[out] Output Pointer to buffer to receive random value.\r
- @param[in] Size Size of randome bytes to generate.\r
+ @param[in] Size Size of random bytes to generate.\r
\r
@retval TRUE Pseudorandom byte stream generated successfully.\r
@retval FALSE Pseudorandom number generator fails to generate due to lack of entropy.\r
IN UINTN Size\r
);\r
\r
+// =====================================================================================\r
+// Key Derivation Function Primitive\r
+// =====================================================================================\r
+\r
+/**\r
+ Derive key data using HMAC-SHA256 based KDF.\r
+\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
+ @retval TRUE Hkdf generated successfully.\r
+ @retval FALSE Hkdf generation failed.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+HkdfSha256ExtractAndExpand (\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
#endif // __BASE_CRYPT_LIB_H__\r