/** @file\r
Defines base cryptographic library APIs.\r
The Base Cryptographic Library provides implementations of basic cryptography\r
- primitives (MD5, SHA-1, SHA-256, RSA, etc) for UEFI security functionality enabling.\r
+ primitives (Hash Serials, HMAC, RSA, Diffie-Hellman, etc) for UEFI security\r
+ functionality enabling.\r
\r
-Copyright (c) 2009 - 2010, 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 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __BASE_CRYPT_LIB_H__\r
#define __BASE_CRYPT_LIB_H__\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
///\r
#define SHA256_DIGEST_SIZE 32\r
\r
+///\r
+/// SHA-384 digest size in bytes\r
+///\r
+#define SHA384_DIGEST_SIZE 48\r
+\r
+///\r
+/// SHA-512 digest size in bytes\r
+///\r
+#define SHA512_DIGEST_SIZE 64\r
+\r
+///\r
+/// TDES block size in bytes\r
+///\r
+#define TDES_BLOCK_SIZE 8\r
+\r
+///\r
+/// AES block size in bytes\r
+///\r
+#define AES_BLOCK_SIZE 16\r
+\r
///\r
/// RSA Key Tags Definition used in RsaSetKey() function for key component identification.\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 initialized 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
+ 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 initialized 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
+\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 MD5 hash operations.\r
+ @retval 0 This interface is not supported.\r
\r
**/\r
UINTN\r
VOID\r
);\r
\r
-\r
/**\r
Initializes user-supplied memory pointed by Md5Context as MD5 hash context for\r
subsequent use.\r
\r
- If Md5Context is NULL, then ASSERT().\r
+ If Md5Context is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
\r
- @param[in, out] Md5Context Pointer to MD5 Context being initialized.\r
+ @param[out] Md5Context Pointer to MD5 context being initialized.\r
\r
@retval TRUE MD5 context initialization succeeded.\r
@retval FALSE MD5 context initialization failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
Md5Init (\r
- IN OUT VOID *Md5Context\r
+ OUT VOID *Md5Context\r
);\r
\r
+/**\r
+ Makes a copy of an existing MD5 context.\r
+\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] Md5Context Pointer to MD5 context being copied.\r
+ @param[out] NewMd5Context Pointer to new MD5 context.\r
+\r
+ @retval TRUE MD5 context copy succeeded.\r
+ @retval FALSE MD5 context copy failed.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+Md5Duplicate (\r
+ IN CONST VOID *Md5Context,\r
+ OUT VOID *NewMd5Context\r
+ );\r
\r
/**\r
- Performs MD5 digest on a data buffer of the specified length. This function can\r
- be called multiple times to compute the digest of long or discontinuous data streams.\r
+ Digests the input data and updates MD5 context.\r
\r
- If Md5Context is NULL, then ASSERT().\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 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
+ If this interface is not supported, then return FALSE.\r
\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] DataLength Length of Data buffer in bytes.\r
+ @param[in] DataSize Size of Data buffer in bytes.\r
\r
@retval TRUE MD5 data digest succeeded.\r
- @retval FALSE Invalid MD5 context. After Md5Final function has been called, the\r
- MD5 context cannot be reused.\r
+ @retval FALSE MD5 data digest failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
Md5Update (\r
IN OUT VOID *Md5Context,\r
IN CONST VOID *Data,\r
- IN UINTN DataLength\r
+ IN UINTN DataSize\r
);\r
\r
-\r
/**\r
- Completes MD5 hash computation and retrieves the digest value into the specified\r
- memory. After this function has been called, the MD5 context cannot be used again.\r
+ Completes computation of the MD5 digest value.\r
\r
- If Md5Context is NULL, then ASSERT().\r
- If HashValue is NULL, then ASSERT().\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 initialized by Md5Init(), and should not be\r
+ finalized by Md5Final(). Behavior with invalid MD5 context is undefined.\r
\r
- @param[in, out] Md5Context Pointer to the MD5 context\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] 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 MD5 digest computation succeeded.\r
@retval FALSE MD5 digest computation failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
OUT UINT8 *HashValue\r
);\r
\r
+/**\r
+ Computes the MD5 message digest of a input data buffer.\r
+\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 MD5 digest\r
+ value (16 bytes).\r
+\r
+ @retval TRUE MD5 digest computation succeeded.\r
+ @retval FALSE MD5 digest computation failed.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+Md5HashAll (\r
+ IN CONST VOID *Data,\r
+ IN UINTN DataSize,\r
+ OUT UINT8 *HashValue\r
+ );\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
VOID\r
);\r
\r
-\r
/**\r
- Initializes user-supplied memory pointed by Sha1Context as the SHA-1 hash context for\r
+ Initializes user-supplied memory pointed by Sha1Context as SHA-1 hash context for\r
subsequent use.\r
\r
- If Sha1Context is NULL, then ASSERT().\r
+ If Sha1Context 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 being initialized.\r
+ @param[out] Sha1Context Pointer to SHA-1 context being initialized.\r
\r
- @retval TRUE SHA-1 initialization succeeded.\r
- @retval FALSE SHA-1 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
Sha1Init (\r
- IN OUT VOID *Sha1Context\r
+ OUT VOID *Sha1Context\r
);\r
\r
+/**\r
+ Makes a copy of an existing SHA-1 context.\r
+\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] 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
+Sha1Duplicate (\r
+ IN CONST VOID *Sha1Context,\r
+ OUT VOID *NewSha1Context\r
+ );\r
\r
/**\r
- Performs SHA-1 digest on a data buffer of the specified length. This function can\r
- be called multiple times to compute the digest of long or discontinuous data streams.\r
+ Digests the input data and updates SHA-1 context.\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 initialized by Sha1Init(), and should not be finalized\r
+ by Sha1Final(). Behavior with invalid context is undefined.\r
\r
- If Sha1Context is NULL, then ASSERT().\r
+ If Sha1Context 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[in] Data Pointer to the buffer containing the data to be hashed.\r
- @param[in] DataLength Length of Data buffer in bytes.\r
+ @param[in] DataSize Size of Data buffer in bytes.\r
\r
@retval TRUE SHA-1 data digest succeeded.\r
- @retval FALSE Invalid SHA-1 context. After Sha1Final function has been called, the\r
- SHA-1 context cannot be reused.\r
+ @retval FALSE SHA-1 data digest failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
Sha1Update (\r
IN OUT VOID *Sha1Context,\r
IN CONST VOID *Data,\r
- IN UINTN DataLength\r
+ IN UINTN DataSize\r
);\r
\r
-\r
/**\r
- Completes SHA-1 hash computation and retrieves the digest value into the specified\r
- memory. After this function has been called, the SHA-1 context cannot be used again.\r
+ Completes computation of the SHA-1 digest value.\r
+\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 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 ASSERT().\r
- If HashValue is NULL, then ASSERT().\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[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
OUT UINT8 *HashValue\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
+Sha1HashAll (\r
+ IN CONST VOID *Data,\r
+ IN UINTN DataSize,\r
+ OUT UINT8 *HashValue\r
+ );\r
\r
/**\r
- Retrieves the size, in bytes, of the context buffer required for SHA-256 operations.\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 operations.\r
+ @return The size, in bytes, of the context buffer required for SHA-256 hash operations.\r
\r
**/\r
UINTN\r
VOID\r
);\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 ASSERT().\r
+ If Sha256Context is NULL, then return FALSE.\r
\r
- @param[in, out] Sha256Context Pointer to SHA-256 Context being initialized.\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
BOOLEAN\r
EFIAPI\r
Sha256Init (\r
- IN OUT VOID *Sha256Context\r
+ OUT VOID *Sha256Context\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
+Sha256Duplicate (\r
+ IN CONST VOID *Sha256Context,\r
+ OUT VOID *NewSha256Context\r
+ );\r
\r
/**\r
- Performs SHA-256 digest on a data buffer of the specified length. This function can\r
- be called multiple times to compute the digest of long or discontinuous data streams.\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 ASSERT().\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] DataLength Length of Data buffer in bytes.\r
+ @param[in] DataSize Size of Data buffer in bytes.\r
\r
@retval TRUE SHA-256 data digest succeeded.\r
- @retval FALSE Invalid SHA-256 context. After Sha256Final function has been called, the\r
- SHA-256 context cannot be reused.\r
+ @retval FALSE SHA-256 data digest failed.\r
\r
**/\r
BOOLEAN\r
Sha256Update (\r
IN OUT VOID *Sha256Context,\r
IN CONST VOID *Data,\r
- IN UINTN DataLength\r
+ IN UINTN DataSize\r
);\r
\r
-\r
/**\r
- Completes SHA-256 hash computation and retrieves the digest value into the specified\r
- memory. After this function has been called, the SHA-256 context cannot be used again.\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 ASSERT().\r
- If HashValue is NULL, then ASSERT().\r
+ If Sha256Context is NULL, then return FALSE.\r
+ If HashValue is NULL, then return FALSE.\r
\r
- @param[in, out] Sha256Context Pointer to SHA-256 context\r
+ @param[in, out] Sha256Context Pointer to the SHA-256 context.\r
@param[out] HashValue Pointer to a buffer that receives the SHA-256 digest\r
value (32 bytes).\r
\r
OUT UINT8 *HashValue\r
);\r
\r
+/**\r
+ Computes the SHA-256 message digest of a input data buffer.\r
\r
-//=====================================================================================\r
-// MAC (Message Authentication Code) Primitive\r
-//=====================================================================================\r
+ This function performs the SHA-256 message digest of a given data buffer, and places\r
+ the digest value into the specified memory.\r
\r
-///\r
-/// No MAC supports for minimum scope required by UEFI\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-256 digest\r
+ value (32 bytes).\r
\r
-//=====================================================================================\r
-// Symmetric Cryptography Primitive\r
-//=====================================================================================\r
+ @retval TRUE SHA-256 digest computation succeeded.\r
+ @retval FALSE SHA-256 digest computation failed.\r
+ @retval FALSE This interface is not supported.\r
\r
-///\r
-/// No symmetric cryptographic supports for minimum scope required by UEFI\r
-///\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+Sha256HashAll (\r
+ IN CONST VOID *Data,\r
+ IN UINTN DataSize,\r
+ OUT UINT8 *HashValue\r
+ );\r
\r
+/**\r
+ Retrieves the size, in bytes, of the context buffer required for SHA-384 hash operations.\r
\r
-//=====================================================================================\r
-// Asymmetric Cryptography Primitive\r
-//=====================================================================================\r
+ @return The size, in bytes, of the context buffer required for SHA-384 hash operations.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+Sha384GetContextSize (\r
+ VOID\r
+ );\r
\r
/**\r
- Allocates and Initializes one RSA Context for subsequent use.\r
+ Initializes user-supplied memory pointed by Sha384Context as SHA-384 hash context for\r
+ subsequent use.\r
\r
- @return Pointer to the RSA Context that has been initialized.\r
- If the allocations fails, RsaNew() returns NULL.\r
+ If Sha384Context is NULL, then return FALSE.\r
+\r
+ @param[out] Sha384Context Pointer to SHA-384 context being initialized.\r
+\r
+ @retval TRUE SHA-384 context initialization succeeded.\r
+ @retval FALSE SHA-384 context initialization failed.\r
\r
**/\r
-VOID *\r
+BOOLEAN\r
EFIAPI\r
-RsaNew (\r
- VOID\r
+Sha384Init (\r
+ OUT VOID *Sha384Context\r
);\r
\r
+/**\r
+ Makes a copy of an existing SHA-384 context.\r
+\r
+ If Sha384Context is NULL, then return FALSE.\r
+ If NewSha384Context is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
+\r
+ @param[in] Sha384Context Pointer to SHA-384 context being copied.\r
+ @param[out] NewSha384Context Pointer to new SHA-384 context.\r
+\r
+ @retval TRUE SHA-384 context copy succeeded.\r
+ @retval FALSE SHA-384 context copy failed.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+Sha384Duplicate (\r
+ IN CONST VOID *Sha384Context,\r
+ OUT VOID *NewSha384Context\r
+ );\r
\r
/**\r
- Release the specified RSA Context.\r
+ Digests the input data and updates SHA-384 context.\r
\r
- @param[in] RsaContext Pointer to the RSA context to be released.\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 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
+\r
+ @param[in, out] Sha384Context Pointer to the SHA-384 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-384 data digest succeeded.\r
+ @retval FALSE SHA-384 data digest failed.\r
\r
**/\r
-VOID\r
+BOOLEAN\r
EFIAPI\r
-RsaFree (\r
- IN VOID *RsaContext\r
+Sha384Update (\r
+ IN OUT VOID *Sha384Context,\r
+ IN CONST VOID *Data,\r
+ IN UINTN DataSize\r
);\r
\r
+/**\r
+ Completes computation of the SHA-384 digest value.\r
+\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 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
+ If HashValue is NULL, then return FALSE.\r
+\r
+ @param[in, out] Sha384Context Pointer to the SHA-384 context.\r
+ @param[out] HashValue Pointer to a buffer that receives the SHA-384 digest\r
+ value (48 bytes).\r
+\r
+ @retval TRUE SHA-384 digest computation succeeded.\r
+ @retval FALSE SHA-384 digest computation failed.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+Sha384Final (\r
+ IN OUT VOID *Sha384Context,\r
+ OUT UINT8 *HashValue\r
+ );\r
\r
/**\r
- Sets the tag-designated RSA key component into the established RSA context from\r
- the user-specified nonnegative integer (octet string format represented in RSA\r
- PKCS#1).\r
+ Computes the SHA-384 message digest of a input data buffer.\r
\r
- If RsaContext is NULL, then ASSERT().\r
+ This function performs the SHA-384 message digest of a given data buffer, and places\r
+ the digest value into the specified memory.\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
- @param[in] BnLength Length of big number buffer in bytes.\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-384 digest\r
+ value (48 bytes).\r
\r
- @return TRUE RSA key component was set successfully.\r
- @return FALSE Invalid RSA key component tag.\r
+ @retval TRUE SHA-384 digest computation succeeded.\r
+ @retval FALSE SHA-384 digest computation failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-RsaSetKey (\r
- IN OUT VOID *RsaContext,\r
- IN RSA_KEY_TAG KeyTag,\r
- IN CONST UINT8 *BigNumber,\r
- IN UINTN BnLength\r
+Sha384HashAll (\r
+ IN CONST VOID *Data,\r
+ IN UINTN DataSize,\r
+ OUT UINT8 *HashValue\r
);\r
\r
+/**\r
+ Retrieves the size, in bytes, of the context buffer required for SHA-512 hash operations.\r
+\r
+ @return The size, in bytes, of the context buffer required for SHA-512 hash operations.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+Sha512GetContextSize (\r
+ VOID\r
+ );\r
\r
/**\r
- Verifies the RSA-SSA signature with EMSA-PKCS1-v1_5 encoding scheme defined in\r
- RSA PKCS#1.\r
+ Initializes user-supplied memory pointed by Sha512Context as SHA-512 hash context for\r
+ subsequent use.\r
\r
- If RsaContext is NULL, then ASSERT().\r
- If MessageHash is NULL, then ASSERT().\r
- If Signature is NULL, then ASSERT().\r
- If HashLength is not equal to the size of MD5, SHA-1 or SHA-256 digest, then ASSERT().\r
+ If Sha512Context is NULL, then return FALSE.\r
\r
- @param[in] RsaContext Pointer to RSA context for signature verification.\r
- @param[in] MessageHash Pointer to octet message hash to be checked.\r
- @param[in] HashLength Length of the message hash in bytes.\r
- @param[in] Signature Pointer to RSA PKCS1-v1_5 signature to be verified.\r
- @param[in] SigLength Length of signature in bytes.\r
+ @param[out] Sha512Context Pointer to SHA-512 context being initialized.\r
\r
- @return TRUE Valid signature encoded in PKCS1-v1_5.\r
- @return FALSE Invalid signature or invalid RSA context.\r
+ @retval TRUE SHA-512 context initialization succeeded.\r
+ @retval FALSE SHA-512 context initialization failed.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-RsaPkcs1Verify (\r
- IN VOID *RsaContext,\r
- IN CONST UINT8 *MessageHash,\r
- IN UINTN HashLength,\r
- IN UINT8 *Signature,\r
- IN UINTN SigLength\r
+Sha512Init (\r
+ OUT VOID *Sha512Context\r
);\r
\r
-\r
/**\r
- Verifies the validility of a PKCS#7 signed data as described in "PKCS #7: Cryptographic\r
- Message Syntax Standard".\r
+ Makes a copy of an existing SHA-512 context.\r
\r
- If P7Data is NULL, then ASSERT().\r
+ If Sha512Context is NULL, then return FALSE.\r
+ If NewSha512Context is NULL, 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[in] TrustedCert Pointer to a trusted/root certificate encoded in DER, which\r
- is used for certificate chain verification.\r
- @param[in] CertLength Length of the trusted certificate in bytes.\r
- @param[in] InData Pointer to the content to be verified.\r
- @param[in] DataLength Length of InData in bytes.\r
+ @param[in] Sha512Context Pointer to SHA-512 context being copied.\r
+ @param[out] NewSha512Context Pointer to new SHA-512 context.\r
\r
- @return TRUE The specified PKCS#7 signed data is valid.\r
- @return FALSE Invalid PKCS#7 signed data.\r
+ @retval TRUE SHA-512 context copy succeeded.\r
+ @retval FALSE SHA-512 context copy failed.\r
+ @retval FALSE This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
-Pkcs7Verify (\r
- IN CONST UINT8 *P7Data,\r
- IN UINTN P7Length,\r
- IN CONST UINT8 *TrustedCert,\r
- IN UINTN CertLength,\r
- IN CONST UINT8 *InData,\r
- IN UINTN DataLength\r
+Sha512Duplicate (\r
+ IN CONST VOID *Sha512Context,\r
+ OUT VOID *NewSha512Context\r
);\r
\r
+/**\r
+ Digests the input data and updates SHA-512 context.\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 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
+\r
+ @param[in, out] Sha512Context Pointer to the SHA-512 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-512 data digest succeeded.\r
+ @retval FALSE SHA-512 data digest failed.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+Sha512Update (\r
+ IN OUT VOID *Sha512Context,\r
+ IN CONST VOID *Data,\r
+ IN UINTN DataSize\r
+ );\r
+\r
+/**\r
+ Completes computation of the SHA-512 digest value.\r
+\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 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
+ If HashValue is NULL, then return FALSE.\r
+\r
+ @param[in, out] Sha512Context Pointer to the SHA-512 context.\r
+ @param[out] HashValue Pointer to a buffer that receives the SHA-512 digest\r
+ value (64 bytes).\r
+\r
+ @retval TRUE SHA-512 digest computation succeeded.\r
+ @retval FALSE SHA-512 digest computation failed.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+Sha512Final (\r
+ IN OUT VOID *Sha512Context,\r
+ OUT UINT8 *HashValue\r
+ );\r
+\r
+/**\r
+ Computes the SHA-512 message digest of a input data buffer.\r
+\r
+ This function performs the SHA-512 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-512 digest\r
+ value (64 bytes).\r
+\r
+ @retval TRUE SHA-512 digest computation succeeded.\r
+ @retval FALSE SHA-512 digest computation failed.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+Sha512HashAll (\r
+ IN CONST VOID *Data,\r
+ IN UINTN DataSize,\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
+ (NOTE: This API is deprecated.\r
+ Use HmacMd5New() / HmacMd5Free() for HMAC-MD5 Context 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-MD5 operations.\r
+ @retval 0 This interface is not supported.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+HmacMd5GetContextSize (\r
+ VOID\r
+ );\r
+\r
+/**\r
+ Allocates and initializes one HMAC_CTX context for subsequent HMAC-MD5 use.\r
+\r
+ If this interface is not supported, then return NULL.\r
+\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
+HmacMd5New (\r
+ VOID\r
+ );\r
+\r
+/**\r
+ Release the specified HMAC_CTX context.\r
+\r
+ If this interface is not supported, then do nothing.\r
+\r
+ @param[in] HmacMd5Ctx Pointer to the HMAC_CTX context to be released.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+HmacMd5Free (\r
+ IN VOID *HmacMd5Ctx\r
+ );\r
+\r
+/**\r
+ Initializes user-supplied memory pointed by HmacMd5Context as HMAC-MD5 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
+\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
+\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
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+HmacMd5Init (\r
+ OUT VOID *HmacMd5Context,\r
+ IN CONST UINT8 *Key,\r
+ IN UINTN KeySize\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
+\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
+HmacMd5Duplicate (\r
+ IN CONST VOID *HmacMd5Context,\r
+ OUT VOID *NewHmacMd5Context\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 already correctly initialized by HmacMd5Init(), and should not be\r
+ finalized by 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
+\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
+HmacMd5Update (\r
+ IN OUT VOID *HmacMd5Context,\r
+ IN CONST VOID *Data,\r
+ IN UINTN DataSize\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 already correctly initialized by HmacMd5Init(), and should not be\r
+ finalized by 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
+\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
+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
+ (NOTE: This API is deprecated.\r
+ Use HmacSha1New() / HmacSha1Free() for HMAC-SHA1 Context 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
+ );\r
+\r
+/**\r
+ Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA1 use.\r
+\r
+ If this interface is not supported, then return NULL.\r
+\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
+HmacSha1New (\r
+ VOID\r
+ );\r
+\r
+/**\r
+ Release the specified HMAC_CTX context.\r
+\r
+ If this interface is not supported, then do nothing.\r
+\r
+ @param[in] HmacSha1Ctx Pointer to the HMAC_CTX context to be released.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+HmacSha1Free (\r
+ IN VOID *HmacSha1Ctx\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
+\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
+\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
+HmacSha1Duplicate (\r
+ IN CONST VOID *HmacSha1Context,\r
+ OUT VOID *NewHmacSha1Context\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 initialized 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
+/**\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 initialized 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 HmacValue 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] 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
+HmacSha1Final (\r
+ IN OUT VOID *HmacSha1Context,\r
+ OUT UINT8 *HmacValue\r
+ );\r
+\r
+/**\r
+ Retrieves the size, in bytes, of the context buffer required for HMAC-SHA256 operations.\r
+ (NOTE: This API is deprecated.\r
+ Use HmacSha256New() / HmacSha256Free() for HMAC-SHA256 Context 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-SHA256 operations.\r
+ @retval 0 This interface is not supported.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+HmacSha256GetContextSize (\r
+ VOID\r
+ );\r
+\r
+/**\r
+ Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA256 use.\r
+\r
+ @return Pointer to the HMAC_CTX context that has been initialized.\r
+ If the allocations fails, HmacSha256New() returns NULL.\r
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+HmacSha256New (\r
+ VOID\r
+ );\r
+\r
+/**\r
+ Release the specified HMAC_CTX context.\r
+\r
+ @param[in] HmacSha256Ctx Pointer to the HMAC_CTX context to be released.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+HmacSha256Free (\r
+ IN VOID *HmacSha256Ctx\r
+ );\r
+\r
+/**\r
+ Initializes user-supplied memory pointed by HmacSha256Context as HMAC-SHA256 context for\r
+ subsequent use.\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[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 FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+HmacSha256Init (\r
+ OUT VOID *HmacSha256Context,\r
+ IN CONST UINT8 *Key,\r
+ IN UINTN KeySize\r
+ );\r
+\r
+/**\r
+ Makes a copy of an existing HMAC-SHA256 context.\r
+\r
+ If HmacSha256Context is NULL, then return FALSE.\r
+ If NewHmacSha256Context is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
+\r
+ @param[in] HmacSha256Context Pointer to HMAC-SHA256 context being copied.\r
+ @param[out] NewHmacSha256Context Pointer to new HMAC-SHA256 context.\r
+\r
+ @retval TRUE HMAC-SHA256 context copy succeeded.\r
+ @retval FALSE HMAC-SHA256 context copy failed.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+HmacSha256Duplicate (\r
+ IN CONST VOID *HmacSha256Context,\r
+ OUT VOID *NewHmacSha256Context\r
+ );\r
+\r
+/**\r
+ Digests the input data and updates HMAC-SHA256 context.\r
+\r
+ This function performs HMAC-SHA256 digest on a data buffer of the specified size.\r
+ It can be called multiple times to compute the digest of long or discontinuous data streams.\r
+ HMAC-SHA256 context should be already correctly initialized by HmacSha256Init(), and should not\r
+ be finalized 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
+\r
+ @param[in, out] HmacSha256Context Pointer to the HMAC-SHA256 context.\r
+ @param[in] Data Pointer to the buffer containing the data to be digested.\r
+ @param[in] DataSize Size of Data buffer in bytes.\r
+\r
+ @retval TRUE HMAC-SHA256 data digest succeeded.\r
+ @retval FALSE HMAC-SHA256 data digest failed.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+HmacSha256Update (\r
+ IN OUT VOID *HmacSha256Context,\r
+ IN CONST VOID *Data,\r
+ IN UINTN DataSize\r
+ );\r
+\r
+/**\r
+ Completes computation of the HMAC-SHA256 digest value.\r
+\r
+ This function completes HMAC-SHA256 hash computation and retrieves the digest value into\r
+ the specified memory. After this function has been called, the HMAC-SHA256 context cannot\r
+ be used again.\r
+ HMAC-SHA256 context should be already correctly initialized by HmacSha256Init(), and should\r
+ not be finalized by HmacSha256Final(). Behavior with invalid HMAC-SHA256 context is undefined.\r
+\r
+ If HmacSha256Context is NULL, then return FALSE.\r
+ If HmacValue is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
+\r
+ @param[in, out] HmacSha256Context Pointer to the HMAC-SHA256 context.\r
+ @param[out] HmacValue Pointer to a buffer that receives the HMAC-SHA256 digest\r
+ value (32 bytes).\r
+\r
+ @retval TRUE HMAC-SHA256 digest computation succeeded.\r
+ @retval FALSE HMAC-SHA256 digest computation failed.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+HmacSha256Final (\r
+ IN OUT VOID *HmacSha256Context,\r
+ OUT UINT8 *HmacValue\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
+\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
+ @retval 0 This interface is not supported.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+TdesGetContextSize (\r
+ VOID\r
+ );\r
+\r
+/**\r
+ Initializes user-supplied memory as TDES 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
+ 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
+\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
+ 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
+\r
+ @retval TRUE TDES context initialization succeeded.\r
+ @retval FALSE TDES context initialization failed.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+TdesInit (\r
+ OUT VOID *TdesContext,\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
+\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
+\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] 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
+\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
+TdesEcbEncrypt (\r
+ IN VOID *TdesContext,\r
+ IN CONST UINT8 *Input,\r
+ IN UINTN InputSize,\r
+ OUT UINT8 *Output\r
+ );\r
+\r
+/**\r
+ Performs TDES decryption on a data buffer of the specified size in ECB 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
+ 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
+\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] 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
+ @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
+TdesEcbDecrypt (\r
+ IN VOID *TdesContext,\r
+ IN CONST UINT8 *Input,\r
+ IN UINTN InputSize,\r
+ OUT UINT8 *Output\r
+ );\r
+\r
+/**\r
+ Performs TDES 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 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 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, 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
+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, 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
+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
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+RsaNew (\r
+ VOID\r
+ );\r
+\r
+/**\r
+ Release the specified RSA context.\r
+\r
+ If RsaContext is NULL, then return FALSE.\r
+\r
+ @param[in] RsaContext Pointer to the RSA context to be released.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+RsaFree (\r
+ IN VOID *RsaContext\r
+ );\r
+\r
+/**\r
+ Sets the tag-designated key component into the established RSA context.\r
+\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 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 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
+\r
+ @retval TRUE RSA key component was set successfully.\r
+ @retval FALSE Invalid RSA key component tag.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+RsaSetKey (\r
+ IN OUT VOID *RsaContext,\r
+ IN RSA_KEY_TAG KeyTag,\r
+ IN CONST UINT8 *BigNumber,\r
+ IN UINTN BnSize\r
+ );\r
+\r
+/**\r
+ Gets the tag-designated RSA key component from the established RSA context.\r
+\r
+ This function retrieves the tag-designated RSA key component from the\r
+ established RSA context as a non-negative integer (octet string format\r
+ represented in RSA PKCS#1).\r
+ If specified key component has not been set or has been cleared, then returned\r
+ BnSize is set to 0.\r
+ If the BigNumber buffer is too small to hold the contents of the key, FALSE\r
+ is returned and BnSize is set to the required buffer size to obtain the key.\r
+\r
+ If RsaContext is NULL, then return FALSE.\r
+ If BnSize is NULL, then return FALSE.\r
+ If BnSize is large enough but BigNumber is NULL, then return FALSE.\r
+ If this interface is not supported, 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[out] BigNumber Pointer to octet integer buffer.\r
+ @param[in, out] BnSize On input, the size of big number buffer in bytes.\r
+ On output, the size of data returned in big number buffer in bytes.\r
+\r
+ @retval TRUE RSA key component was retrieved successfully.\r
+ @retval FALSE Invalid RSA key component tag.\r
+ @retval FALSE BnSize is too small.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+RsaGetKey (\r
+ IN OUT VOID *RsaContext,\r
+ IN RSA_KEY_TAG KeyTag,\r
+ OUT UINT8 *BigNumber,\r
+ IN OUT UINTN *BnSize\r
+ );\r
+\r
+/**\r
+ Generates RSA key components.\r
+\r
+ This function generates RSA key components. It takes RSA public exponent E and\r
+ length in bits of RSA modulus N as input, and generates all key components.\r
+ If PublicExponent is NULL, the default RSA public exponent (0x10001) will be used.\r
+\r
+ Before this function can be invoked, pseudorandom number generator must be correctly\r
+ initialized by RandomSeed().\r
+\r
+ If RsaContext is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
+\r
+ @param[in, out] RsaContext Pointer to RSA context being set.\r
+ @param[in] ModulusLength Length of RSA modulus N in bits.\r
+ @param[in] PublicExponent Pointer to RSA public exponent.\r
+ @param[in] PublicExponentSize Size of RSA public exponent buffer in bytes.\r
+\r
+ @retval TRUE RSA key component was generated successfully.\r
+ @retval FALSE Invalid RSA key component tag.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+RsaGenerateKey (\r
+ IN OUT VOID *RsaContext,\r
+ IN UINTN ModulusLength,\r
+ IN CONST UINT8 *PublicExponent,\r
+ IN UINTN PublicExponentSize\r
+ );\r
+\r
+/**\r
+ Validates key components of RSA context.\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 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
+ - Whether d*e = 1 mod lcm(p-1,q-1)\r
+\r
+ If RsaContext is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
+\r
+ @param[in] RsaContext Pointer to RSA context to check.\r
+\r
+ @retval TRUE RSA key components are valid.\r
+ @retval FALSE RSA key components are not valid.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+RsaCheckKey (\r
+ IN VOID *RsaContext\r
+ );\r
+\r
+/**\r
+ Carries out the RSA-SSA signature generation with EMSA-PKCS1-v1_5 encoding scheme.\r
+\r
+ This function carries out the RSA-SSA signature generation with EMSA-PKCS1-v1_5 encoding scheme defined in\r
+ RSA PKCS#1.\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 MessageHash is NULL, then return FALSE.\r
+ If HashSize is not equal to the size of MD5, SHA-1 or SHA-256 digest, 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] MessageHash Pointer to octet message hash to be signed.\r
+ @param[in] HashSize Size of the message hash in bytes.\r
+ @param[out] Signature Pointer to buffer to receive RSA PKCS1-v1_5 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 PKCS1-v1_5.\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
+RsaPkcs1Sign (\r
+ IN VOID *RsaContext,\r
+ IN CONST UINT8 *MessageHash,\r
+ IN UINTN HashSize,\r
+ OUT UINT8 *Signature,\r
+ IN OUT UINTN *SigSize\r
+ );\r
+\r
+/**\r
+ Verifies the RSA-SSA signature with EMSA-PKCS1-v1_5 encoding scheme defined in\r
+ RSA PKCS#1.\r
+\r
+ If RsaContext is NULL, then return FALSE.\r
+ If MessageHash is NULL, then return FALSE.\r
+ If Signature is NULL, then return FALSE.\r
+ If HashSize is not equal to the size of MD5, SHA-1, SHA-256 digest, then return FALSE.\r
+\r
+ @param[in] RsaContext Pointer to RSA context for signature verification.\r
+ @param[in] MessageHash Pointer to octet message hash to be checked.\r
+ @param[in] HashSize Size of the message hash in bytes.\r
+ @param[in] Signature Pointer to RSA PKCS1-v1_5 signature to be verified.\r
+ @param[in] SigSize Size of signature in bytes.\r
+\r
+ @retval TRUE Valid signature encoded in PKCS1-v1_5.\r
+ @retval FALSE Invalid signature or invalid RSA context.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+RsaPkcs1Verify (\r
+ IN VOID *RsaContext,\r
+ IN CONST UINT8 *MessageHash,\r
+ IN UINTN HashSize,\r
+ IN CONST UINT8 *Signature,\r
+ IN UINTN SigSize\r
+ );\r
+\r
+/**\r
+ Retrieve the RSA Private Key from the password-protected PEM key data.\r
+\r
+ If PemData is NULL, then return FALSE.\r
+ If RsaContext is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
+\r
+ @param[in] PemData Pointer to the PEM-encoded key data to be retrieved.\r
+ @param[in] PemSize Size of the PEM key data in bytes.\r
+ @param[in] Password NULL-terminated passphrase used for encrypted PEM key data.\r
+ @param[out] RsaContext Pointer to new-generated RSA context which contain the retrieved\r
+ RSA private key component. Use RsaFree() function to free the\r
+ resource.\r
+\r
+ @retval TRUE RSA Private Key was retrieved successfully.\r
+ @retval FALSE Invalid PEM key data or incorrect password.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+RsaGetPrivateKeyFromPem (\r
+ IN CONST UINT8 *PemData,\r
+ IN UINTN PemSize,\r
+ IN CONST CHAR8 *Password,\r
+ OUT VOID **RsaContext\r
+ );\r
+\r
+/**\r
+ Retrieve the RSA Public Key from one DER-encoded X509 certificate.\r
+\r
+ If Cert is NULL, then return FALSE.\r
+ If RsaContext is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\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] RsaContext Pointer to new-generated RSA context which contain the retrieved\r
+ RSA public key component. Use RsaFree() function to free the\r
+ resource.\r
+\r
+ @retval TRUE RSA Public Key was retrieved successfully.\r
+ @retval FALSE Fail to retrieve RSA public key from X509 certificate.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+RsaGetPublicKeyFromX509 (\r
+ IN CONST UINT8 *Cert,\r
+ IN UINTN CertSize,\r
+ OUT VOID **RsaContext\r
+ );\r
+\r
+/**\r
+ Retrieve the subject bytes from one X.509 certificate.\r
+\r
+ If Cert is NULL, then return FALSE.\r
+ If SubjectSize is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\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] CertSubject Pointer to the retrieved certificate subject bytes.\r
+ @param[in, out] SubjectSize The size in bytes of the CertSubject buffer on input,\r
+ and the size of buffer returned CertSubject on output.\r
+\r
+ @retval TRUE The certificate subject retrieved successfully.\r
+ @retval FALSE Invalid certificate, or the SubjectSize is too small for the result.\r
+ The SubjectSize will be updated with the required size.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+X509GetSubjectName (\r
+ IN CONST UINT8 *Cert,\r
+ IN UINTN CertSize,\r
+ OUT UINT8 *CertSubject,\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
+ If Cert is NULL, then return FALSE.\r
+ If CACert is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
+\r
+ @param[in] Cert Pointer to the DER-encoded X509 certificate to be verified.\r
+ @param[in] CertSize Size of the X509 certificate in bytes.\r
+ @param[in] CACert Pointer to the DER-encoded trusted CA certificate.\r
+ @param[in] CACertSize Size of the CA Certificate in bytes.\r
+\r
+ @retval TRUE The certificate was issued by the trusted CA.\r
+ @retval FALSE Invalid certificate or the certificate was not issued by the given\r
+ trusted CA.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+X509VerifyCert (\r
+ IN CONST UINT8 *Cert,\r
+ IN UINTN CertSize,\r
+ IN CONST UINT8 *CACert,\r
+ IN UINTN CACertSize\r
+ );\r
+\r
+/**\r
+ Construct a X509 object from DER-encoded certificate data.\r
+\r
+ If Cert is NULL, then return FALSE.\r
+ If SingleX509Cert is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
+\r
+ @param[in] Cert Pointer to the DER-encoded certificate data.\r
+ @param[in] CertSize The size of certificate data in bytes.\r
+ @param[out] SingleX509Cert The generated X509 object.\r
+\r
+ @retval TRUE The X509 object generation succeeded.\r
+ @retval FALSE The operation failed.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+X509ConstructCertificate (\r
+ IN CONST UINT8 *Cert,\r
+ IN UINTN CertSize,\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 ... 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
+X509ConstructCertificateStack (\r
+ IN OUT UINT8 **X509Stack,\r
+ ...\r
+ );\r
+\r
+/**\r
+ Release the specified X509 object.\r
+\r
+ If the interface is not supported, then ASSERT().\r
+\r
+ @param[in] X509Cert Pointer to the X509 object to be released.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+X509Free (\r
+ IN VOID *X509Cert\r
+ );\r
+\r
+/**\r
+ Release the specified X509 stack object.\r
+\r
+ If the interface is not supported, then ASSERT().\r
+\r
+ @param[in] X509Stack Pointer to the X509 stack object to be released.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+X509StackFree (\r
+ IN VOID *X509Stack\r
+ );\r
+\r
+/**\r
+ Retrieve the TBSCertificate from one given X.509 certificate.\r
+\r
+ @param[in] Cert Pointer to the given DER-encoded X509 certificate.\r
+ @param[in] CertSize Size of the X509 certificate in bytes.\r
+ @param[out] TBSCert DER-Encoded To-Be-Signed certificate.\r
+ @param[out] TBSCertSize Size of the TBS certificate in bytes.\r
+\r
+ If Cert is NULL, then return FALSE.\r
+ If TBSCert is NULL, then return FALSE.\r
+ If TBSCertSize is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
+\r
+ @retval TRUE The TBSCertificate was retrieved successfully.\r
+ @retval FALSE Invalid X.509 certificate.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+X509GetTBSCert (\r
+ IN CONST UINT8 *Cert,\r
+ IN UINTN CertSize,\r
+ OUT UINT8 **TBSCert,\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
+ 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
+ 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 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 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
+ @retval FALSE Error occurs during the operation.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+Pkcs7GetSigners (\r
+ IN CONST UINT8 *P7Data,\r
+ IN UINTN P7Length,\r
+ OUT UINT8 **CertStack,\r
+ OUT UINTN *StackLength,\r
+ OUT UINT8 **TrustedCert,\r
+ OUT UINTN *CertLength\r
+ );\r
+\r
+/**\r
+ Wrap function to use free() to free allocated memory for certificates.\r
+\r
+ If this interface is not supported, then ASSERT().\r
+\r
+ @param[in] Certs Pointer to the certificates to be freed.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+Pkcs7FreeSigners (\r
+ IN UINT8 *Certs\r
+ );\r
+\r
+/**\r
+ Retrieves all embedded certificates from PKCS#7 signed data as described in "PKCS #7:\r
+ Cryptographic Message Syntax Standard", and outputs two certificate lists chained and\r
+ unchained to the signer's certificates.\r
+ The input signed data could be wrapped in a ContentInfo structure.\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 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
+ 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
+ @retval FALSE Error occurs during the operation.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+Pkcs7GetCertificatesList (\r
+ IN CONST UINT8 *P7Data,\r
+ IN UINTN P7Length,\r
+ OUT UINT8 **SignerChainCerts,\r
+ OUT UINTN *ChainLength,\r
+ OUT UINT8 **UnchainCerts,\r
+ OUT UINTN *UnchainLength\r
+ );\r
+\r
+/**\r
+ Creates a PKCS#7 signedData as described in "PKCS #7: Cryptographic Message\r
+ Syntax Standard, version 1.5". This interface is only intended to be used for\r
+ application to perform PKCS#7 functionality validation.\r
+\r
+ If this interface is not supported, then return FALSE.\r
+\r
+ @param[in] PrivateKey Pointer to the PEM-formatted private key data for\r
+ data signing.\r
+ @param[in] PrivateKeySize Size of the PEM private key data in bytes.\r
+ @param[in] KeyPassword NULL-terminated passphrase used for encrypted PEM\r
+ key data.\r
+ @param[in] InData Pointer to the content to be signed.\r
+ @param[in] InDataSize Size of InData in bytes.\r
+ @param[in] SignCert Pointer to signer's DER-encoded certificate to sign with.\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. 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
+ @retval FALSE PKCS#7 data signing failed.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+Pkcs7Sign (\r
+ IN CONST UINT8 *PrivateKey,\r
+ IN UINTN PrivateKeySize,\r
+ IN CONST UINT8 *KeyPassword,\r
+ IN UINT8 *InData,\r
+ IN UINTN InDataSize,\r
+ IN UINT8 *SignCert,\r
+ IN UINT8 *OtherCerts OPTIONAL,\r
+ OUT UINT8 **SignedData,\r
+ OUT UINTN *SignedDataSize\r
+ );\r
+\r
+/**\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 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[in] TrustedCert Pointer to a trusted/root certificate encoded in DER, which\r
+ is used for certificate chain verification.\r
+ @param[in] CertLength Length of the trusted certificate in bytes.\r
+ @param[in] InData Pointer to the content to be verified.\r
+ @param[in] DataLength Length of InData in bytes.\r
+\r
+ @retval TRUE The specified PKCS#7 signed data is valid.\r
+ @retval FALSE Invalid PKCS#7 signed data.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+Pkcs7Verify (\r
+ IN CONST UINT8 *P7Data,\r
+ IN UINTN P7Length,\r
+ IN CONST UINT8 *TrustedCert,\r
+ IN UINTN CertLength,\r
+ IN CONST UINT8 *InData,\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
+\r
+ Caution: This function may receive untrusted input. So this function will do\r
+ basic check for PKCS#7 data structure.\r
+\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 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
+BOOLEAN\r
+EFIAPI\r
+Pkcs7GetAttachedContent (\r
+ IN CONST UINT8 *P7Data,\r
+ IN UINTN P7Length,\r
+ OUT VOID **Content,\r
+ OUT UINTN *ContentSize\r
+ );\r
+\r
+/**\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
+ If ImageHash is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
+\r
+ @param[in] AuthData Pointer to the Authenticode Signature retrieved from signed\r
+ PE/COFF image to be verified.\r
+ @param[in] DataSize Size of the Authenticode Signature in bytes.\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 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
+ @retval TRUE The specified Authenticode Signature is valid.\r
+ @retval FALSE Invalid Authenticode Signature.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+AuthenticodeVerify (\r
+ IN CONST UINT8 *AuthData,\r
+ IN UINTN DataSize,\r
+ IN CONST UINT8 *TrustedCert,\r
+ IN UINTN CertSize,\r
+ IN CONST UINT8 *ImageHash,\r
+ IN UINTN HashSize\r
+ );\r
+\r
+/**\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
+ If this interface is not supported, then return FALSE.\r
+\r
+ @param[in] AuthData Pointer to the Authenticode Signature retrieved from signed\r
+ PE/COFF image to be verified.\r
+ @param[in] DataSize Size of the Authenticode Signature in bytes.\r
+ @param[in] TsaCert Pointer to a trusted/root TSA certificate encoded in DER, which\r
+ is used for TSA certificate chain verification.\r
+ @param[in] CertSize Size of the trusted certificate in bytes.\r
+ @param[out] SigningTime Return the time of timestamp generation time if the timestamp\r
+ signature is valid.\r
+\r
+ @retval TRUE The specified Authenticode includes a valid RFC3161 Timestamp CounterSignature.\r
+ @retval FALSE No valid RFC3161 Timestamp CounterSignature in the specified Authenticode data.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+ImageTimestampVerify (\r
+ IN CONST UINT8 *AuthData,\r
+ IN UINTN DataSize,\r
+ IN CONST UINT8 *TsaCert,\r
+ IN UINTN CertSize,\r
+ OUT EFI_TIME *SigningTime\r
+ );\r
+\r
+//=====================================================================================\r
+// DH Key Exchange Primitive\r
+//=====================================================================================\r
+\r
+/**\r
+ Allocates and Initializes one Diffie-Hellman Context for subsequent use.\r
+\r
+ @return Pointer to the Diffie-Hellman Context that has been initialized.\r
+ If the allocations fails, DhNew() returns NULL.\r
+ If the interface is not supported, DhNew() returns NULL.\r
+\r
+**/\r
+VOID *\r
+EFIAPI\r
+DhNew (\r
+ VOID\r
+ );\r
+\r
+/**\r
+ Release the specified DH context.\r
+\r
+ If the interface is not supported, then ASSERT().\r
+\r
+ @param[in] DhContext Pointer to the DH context to be released.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+DhFree (\r
+ IN VOID *DhContext\r
+ );\r
+\r
+/**\r
+ Generates DH parameter.\r
+\r
+ Given generator g, and length of prime number p in bits, this function generates p,\r
+ and sets DH context according to value of g and p.\r
+\r
+ Before this function can be invoked, pseudorandom number generator must be correctly\r
+ initialized by RandomSeed().\r
+\r
+ If DhContext is NULL, then return FALSE.\r
+ If Prime is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
+\r
+ @param[in, out] DhContext Pointer to the DH context.\r
+ @param[in] Generator Value of generator.\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 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
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+DhGenerateParameter (\r
+ IN OUT VOID *DhContext,\r
+ IN UINTN Generator,\r
+ IN UINTN PrimeLength,\r
+ OUT UINT8 *Prime\r
+ );\r
+\r
+/**\r
+ Sets generator and prime parameters for DH.\r
+\r
+ Given generator g, and prime number p, this function and sets DH\r
+ context accordingly.\r
+\r
+ If DhContext is NULL, then return FALSE.\r
+ If Prime is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
+\r
+ @param[in, out] DhContext Pointer to the DH context.\r
+ @param[in] Generator Value of generator.\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 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
+ @retval FALSE Value of Prime is not a safe prime number.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+DhSetParameter (\r
+ IN OUT VOID *DhContext,\r
+ IN UINTN Generator,\r
+ IN UINTN PrimeLength,\r
+ IN CONST UINT8 *Prime\r
+ );\r
+\r
+/**\r
+ Generates DH public key.\r
+\r
+ This function generates random secret exponent, and computes the public key, which is\r
+ returned via parameter PublicKey and PublicKeySize. DH context is updated accordingly.\r
+ If the PublicKey buffer is too small to hold the public key, FALSE is returned and\r
+ PublicKeySize is set to the required buffer size to obtain the public key.\r
+\r
+ If DhContext is NULL, then return FALSE.\r
+ If PublicKeySize is NULL, then return FALSE.\r
+ If PublicKeySize is large enough but PublicKey is NULL, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
+\r
+ @param[in, out] DhContext Pointer to the DH context.\r
+ @param[out] PublicKey Pointer to the buffer to receive generated public key.\r
+ @param[in, out] PublicKeySize On input, the size of PublicKey buffer in bytes.\r
+ On output, the size of data returned in PublicKey buffer in bytes.\r
+\r
+ @retval TRUE DH public key generation succeeded.\r
+ @retval FALSE DH public key generation failed.\r
+ @retval FALSE PublicKeySize is not large enough.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+DhGenerateKey (\r
+ IN OUT VOID *DhContext,\r
+ OUT UINT8 *PublicKey,\r
+ IN OUT UINTN *PublicKeySize\r
+ );\r
+\r
+/**\r
+ Computes exchanged common key.\r
+\r
+ Given peer's public key, this function computes the exchanged common key, based on its own\r
+ context including value of prime modulus and random secret exponent.\r
+\r
+ If DhContext is NULL, then return FALSE.\r
+ If PeerPublicKey is NULL, then return FALSE.\r
+ If KeySize is NULL, then return FALSE.\r
+ If Key is NULL, then return FALSE.\r
+ If KeySize is not large enough, then return FALSE.\r
+ If this interface is not supported, then return FALSE.\r
+\r
+ @param[in, out] DhContext Pointer to the DH context.\r
+ @param[in] PeerPublicKey Pointer to the peer's public key.\r
+ @param[in] PeerPublicKeySize Size of peer's public key in bytes.\r
+ @param[out] Key Pointer to the buffer to receive generated key.\r
+ @param[in, out] KeySize On input, the size of Key buffer in bytes.\r
+ On output, the size of data returned in Key buffer in bytes.\r
+\r
+ @retval TRUE DH exchanged key generation succeeded.\r
+ @retval FALSE DH exchanged key generation failed.\r
+ @retval FALSE KeySize is not large enough.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+DhComputeKey (\r
+ IN OUT VOID *DhContext,\r
+ IN CONST UINT8 *PeerPublicKey,\r
+ IN UINTN PeerPublicKeySize,\r
+ OUT UINT8 *Key,\r
+ IN OUT UINTN *KeySize\r
+ );\r
+\r
+//=====================================================================================\r
+// Pseudo-Random Generation Primitive\r
+//=====================================================================================\r
+\r
+/**\r
+ Sets up the seed value for the pseudorandom number generator.\r
+\r
+ This function sets up the seed value for the pseudorandom number generator.\r
+ If Seed is not NULL, then the seed passed in is used.\r
+ If Seed is NULL, then default seed is used.\r
+ If this interface is not supported, then return FALSE.\r
+\r
+ @param[in] Seed Pointer to seed value.\r
+ If NULL, default seed is used.\r
+ @param[in] SeedSize Size of seed value.\r
+ If Seed is NULL, this parameter is ignored.\r
+\r
+ @retval TRUE Pseudorandom number generator has enough entropy for random generation.\r
+ @retval FALSE Pseudorandom number generator does not have enough entropy for random generation.\r
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+RandomSeed (\r
+ IN CONST UINT8 *Seed OPTIONAL,\r
+ IN UINTN SeedSize\r
+ );\r
+\r
+/**\r
+ Generates a pseudorandom byte stream of the specified size.\r
+\r
+ If Output is NULL, then return FALSE.\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 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
+ @retval FALSE This interface is not supported.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+RandomBytes (\r
+ OUT UINT8 *Output,\r
+ IN UINTN Size\r
+ );\r
\r
#endif // __BASE_CRYPT_LIB_H__\r
projects / mirror_edk2.git / blobdiff