[edk2-devel] [Patch 2/5] CryptoPkg: Add EDK II Crypto Protocols/PPIs/PCDs
Wang, Jian J
jian.j.wang at intel.com
Tue Feb 4 07:59:24 UTC 2020
Mike,
> -----Original Message-----
> From: Kinney, Michael D <michael.d.kinney at intel.com>
> Sent: Thursday, January 30, 2020 3:01 PM
> To: devel at edk2.groups.io
> Cc: Wang, Jian J <jian.j.wang at intel.com>; Lu, XiaoyuX <xiaoyux.lu at intel.com>
> Subject: [Patch 2/5] CryptoPkg: Add EDK II Crypto Protocols/PPIs/PCDs
>
> https://bugzilla.tianocore.org/show_bug.cgi?id=2420
>
> Based on the following package with changes to merge into
> CryptoPkg.
>
> https://github.com/microsoft/mu_plus/tree/dev/201908/SharedCryptoPkg
>
> Add the EDK II Crypto Protocol, EDK II SMM Crypto Protocol
> and EDK II Crypto PPI that provide the same services as the
> BaseCryptLib. One additional GetVersion() services is provided
> to support backward compatible extensions to these new
> Protocols/PPIs if new services are added to BaseCryptLib in the
> future. The EDK II Crypto Protocols/PPIs are located in a
> private directory so they are only available CryptoPkg components.
>
> In order to optimize the size of modules that produce the
> EDK II Crypto Protocols/PPIs define a FixedAtBuild PCD
> gEfiCryptoPkgTokenSpaceGuid.PcdCryptoServiceFamilyEnable.
> This PCD is type VOID* and is associated with the structure
> PCD_CRYPTO_SERVICE_FAMILY_ENABLE. This structure contains
> bitfields and unions that allow a platform DSC files to
> enable/disable entire families of services or enable/disable
> individual services in the produced EDK II Crypto
> Protocols/PPIs.
>
> Cc: Jian J Wang <jian.j.wang at intel.com>
> Cc: Xiaoyu Lu <xiaoyux.lu at intel.com>
> Signed-off-by: Michael D Kinney <michael.d.kinney at intel.com>
> ---
> CryptoPkg/CryptoPkg.dec | 34 +-
> CryptoPkg/CryptoPkg.uni | 3 +-
> .../Pcd/PcdCryptoServiceFamilyEnable.h | 288 ++
> CryptoPkg/Private/Ppi/Crypto.h | 21 +
> CryptoPkg/Private/Protocol/Crypto.h | 4171 +++++++++++++++++
> CryptoPkg/Private/Protocol/SmmCrypto.h | 21 +
> 6 files changed, 4536 insertions(+), 2 deletions(-)
> create mode 100644 CryptoPkg/Include/Pcd/PcdCryptoServiceFamilyEnable.h
> create mode 100644 CryptoPkg/Private/Ppi/Crypto.h
> create mode 100644 CryptoPkg/Private/Protocol/Crypto.h
> create mode 100644 CryptoPkg/Private/Protocol/SmmCrypto.h
>
> diff --git a/CryptoPkg/CryptoPkg.dec b/CryptoPkg/CryptoPkg.dec
> index 08bedd57da..6287f178d3 100644
> --- a/CryptoPkg/CryptoPkg.dec
> +++ b/CryptoPkg/CryptoPkg.dec
> @@ -4,7 +4,7 @@
> # This Package provides cryptographic-related libraries for UEFI security
> modules.
> # It also provides a test application to test libraries.
> #
> -# Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>
> +# Copyright (c) 2009 - 2020, Intel Corporation. All rights reserved.<BR>
> # SPDX-License-Identifier: BSD-2-Clause-Patent
> #
> ##
> @@ -20,6 +20,7 @@ [Includes]
> Include
>
> [Includes.Common.Private]
> + Private
> Library/Include
> Library/OpensslLib/openssl/include
> Library/OpensslLib/openssl/crypto/include
> @@ -33,5 +34,36 @@ [LibraryClasses]
> ##
> TlsLib|Include/Library/TlsLib.h
>
> +[Protocols]
> + ## EDK II Crypto DXE protocol
> + # 2C2275C9-3A7B-426F-BE54-2D22BD9D1092
> + gEdkiiCryptoProtocolGuid = { 0x2C2275C9, 0x3A7B, 0x426F, { 0xBE, 0x54,
> 0x2D, 0x22, 0xBD, 0x9D, 0x10, 0x92 }}
> +
> + ## EDK II Crypto SMM protocol
> + # F46B2EB2-E0D7-4C96-A3B1-CB7C572EB300
> + gEdkiiSmmCryptoProtocolGuid = { 0xF46B2EB2, 0xE0D7, 0x4C96, { 0xA3,
> 0xB1, 0xc, 0x61, 0xbb, 0x24, 0x5c, 0x42 }}
> +
> +[Ppis]
> + ## EDK II Crypto PPI
> + # 7DCE671B-C223-446A-A705-ED637AAF6771
> + gEdkiiCryptoPpiGuid = { 0x7DCE671B, 0xC223, 0x446A, { 0xA7, 0x05, 0xED,
> 0x63, 0x7A, 0xAF, 0x67, 0x71 }}
> +
> +[Guids]
> + ## Crypto package token space guid.
> + gEfiCryptoPkgTokenSpaceGuid = { 0xd3fb176, 0x9569, 0x4d51, { 0xa3, 0xef,
> 0x7d, 0x61, 0xc6, 0x4f, 0xea, 0xba }}
> +
This GUID has been defined in commit 2c061de06336d31dcc24d0765b702c975c6f06a9
> +[PcdsFixedAtBuild]
> + ## Enables/Disables the families and individual services produced by the
> + # EDK II Crypto Protocols/PPIs. The default is all services disabled.
> + # This Structured PCD is associated with
> PCD_CRYPTO_SERVICE_FAMILY_ENABLE
> + # structure that is defined in Include/Pcd/PcdCryptoServiceFamilyEnable.h.
> + # @Prompt Enable/Disable EDK II Crypto Protocol/PPI services
> +
> gEfiCryptoPkgTokenSpaceGuid.PcdCryptoServiceFamilyEnable|{0x00}|PCD_CRY
> PTO_SERVICE_FAMILY_ENABLE|0x00000002 {
> + <Packages>
> + CryptoPkg/CryptoPkg.dec
> + <HeaderFiles>
> + Pcd/PcdCryptoServiceFamilyEnable.h
> + }
> +
> [UserExtensions.TianoCore."ExtraFiles"]
> CryptoPkgExtra.uni
> diff --git a/CryptoPkg/CryptoPkg.uni b/CryptoPkg/CryptoPkg.uni
> index beb0036ef5..6004bf4bca 100644
> --- a/CryptoPkg/CryptoPkg.uni
> +++ b/CryptoPkg/CryptoPkg.uni
> @@ -15,5 +15,6 @@
>
The copyright year of CryptoPkg.uni was not updated.
> #string STR_PACKAGE_DESCRIPTION #language en-US "This Package
> provides cryptographic-related libraries for UEFI security modules."
>
> +#string
> STR_gEfiCryptoPkgTokenSpaceGuid_PcdCryptoServiceFamilyEnable_PROMPT
> #language en-US "Enable/Disable EDK II Crypto Protocol/PPI services"
>
> -
> +#string
> STR_gEfiCryptoPkgTokenSpaceGuid_PcdCryptoServiceFamilyEnable_HELP
> #language en-US "Enables/Disables the families and individual services produced
> by the EDK II Crypto Protocols/PPIs. The default is all services disabled. This
> Structured PCD is associated with PCD_CRYPTO_SERVICE_FAMILY_ENABLE
> structure that is defined in Include/Pcd/PcdCryptoServiceFamilyEnable.h."
The 'PROMPT' string uses 'Enable/Disable' but 'HELP' string uses 'Enables/Disables'.
What's the differences? Or just typo?
> diff --git a/CryptoPkg/Include/Pcd/PcdCryptoServiceFamilyEnable.h
> b/CryptoPkg/Include/Pcd/PcdCryptoServiceFamilyEnable.h
> new file mode 100644
> index 0000000000..031b03b9f8
> --- /dev/null
> +++ b/CryptoPkg/Include/Pcd/PcdCryptoServiceFamilyEnable.h
> @@ -0,0 +1,288 @@
> +/** @file
> + Defines the PCD_CRYPTO_SERVICE_FAMILY_ENABLE structure associated
> with
> + gEfiCryptoPkgTokenSpaceGuid.PcdCryptoServiceFamilyEnable.
> +
> + Copyright (c) 2019 - 2020, Intel Corporation. All rights reserved.<BR>
> + SPDX-License-Identifier: BSD-2-Clause-Patent
> +
> +**/
> +
There's no #ifndef...#define...#endif to avoid duplicate inclusion for this header.
Regards,
Jian
> +///
> +/// Define used to enable all the crypto services in a family
> +///
> +#define PCD_CRYPTO_SERVICE_ENABLE_FAMILY 0xFFFFFFFF
> +
> +///
> +/// PCD_CRYPTO_SERVICE_FAMILY_ENABLE structure. Each field in this
> structure
> +/// is associated with a service in the EDK II Crypto Protocol/PPI. This allows
> +/// each individual service to be enabled/disabled in a DSC file. Services are
> +/// also grouped into families. Unions are used to support enabling or
> +/// disabling an entire family in a single DSC statement.
> +///
> +typedef struct {
> + union {
> + struct {
> + UINT8 New:1;
> + UINT8 Free:1;
> + UINT8 SetKey:1;
> + UINT8 Duplicate:1;
> + UINT8 Update:1;
> + UINT8 Final:1;
> + } Services;
> + UINT32 Family;
> + } HmacMd5;
> + union {
> + struct {
> + UINT8 New:1;
> + UINT8 Free:1;
> + UINT8 SetKey:1;
> + UINT8 Duplicate:1;
> + UINT8 Update:1;
> + UINT8 Final:1;
> + } Services;
> + UINT32 Family;
> + } HmacSha1;
> + union {
> + struct {
> + UINT8 New:1;
> + UINT8 Free:1;
> + UINT8 SetKey:1;
> + UINT8 Duplicate:1;
> + UINT8 Update:1;
> + UINT8 Final:1;
> + } Services;
> + UINT32 Family;
> + } HmacSha256;
> + union {
> + struct {
> + UINT8 GetContextSize:1;
> + UINT8 Init:1;
> + UINT8 Duplicate:1;
> + UINT8 Update:1;
> + UINT8 Final:1;
> + UINT8 HashAll:1;
> + } Services;
> + UINT32 Family;
> + } Md4;
> + union {
> + struct {
> + UINT8 GetContextSize:1;
> + UINT8 Init:1;
> + UINT8 Duplicate:1;
> + UINT8 Update:1;
> + UINT8 Final:1;
> + UINT8 HashAll:1;
> + } Services;
> + UINT32 Family;
> + } Md5;
> + union {
> + struct {
> + UINT8 Pkcs1v2Encrypt:1;
> + UINT8 Pkcs5HashPassword:1;
> + UINT8 Pkcs7Verify:1;
> + UINT8 VerifyEKUsInPkcs7Signature:1;
> + UINT8 Pkcs7GetSigners:1;
> + UINT8 Pkcs7FreeSigners:1;
> + UINT8 Pkcs7Sign:1;
> + UINT8 Pkcs7GetAttachedContent:1;
> + UINT8 Pkcs7GetCertificatesList:1;
> + UINT8 AuthenticodeVerify:1;
> + UINT8 ImageTimestampVerify:1;
> + } Services;
> + UINT32 Family;
> + } Pkcs;
> + union {
> + struct {
> + UINT8 New:1;
> + UINT8 Free:1;
> + UINT8 GenerateParameter:1;
> + UINT8 SetParameter:1;
> + UINT8 GenerateKey:1;
> + UINT8 ComputeKey:1;
> + } Services;
> + UINT32 Family;
> + } Dh;
> + union {
> + struct {
> + UINT8 Seed:1;
> + UINT8 Bytes:1;
> + } Services;
> + UINT32 Family;
> + } Random;
> + union {
> + struct {
> + UINT8 VerifyPkcs1:1;
> + UINT8 New:1;
> + UINT8 Free:1;
> + UINT8 SetKey:1;
> + UINT8 GetKey:1;
> + UINT8 GenerateKey:1;
> + UINT8 CheckKey:1;
> + UINT8 Pkcs1Sign:1;
> + UINT8 Pkcs1Verify:1;
> + UINT8 GetPrivateKeyFromPem:1;
> + UINT8 GetPublicKeyFromX509:1;
> + } Services;
> + UINT32 Family;
> + } Rsa;
> + union {
> + struct {
> + UINT8 GetContextSize:1;
> + UINT8 Init:1;
> + UINT8 Duplicate:1;
> + UINT8 Update:1;
> + UINT8 Final:1;
> + UINT8 HashAll:1;
> + } Services;
> + UINT32 Family;
> + } Sha1;
> + union {
> + struct {
> + UINT8 GetContextSize:1;
> + UINT8 Init:1;
> + UINT8 Duplicate:1;
> + UINT8 Update:1;
> + UINT8 Final:1;
> + UINT8 HashAll:1;
> + } Services;
> + UINT32 Family;
> + } Sha256;
> + union {
> + struct {
> + UINT8 GetContextSize:1;
> + UINT8 Init:1;
> + UINT8 Duplicate:1;
> + UINT8 Update:1;
> + UINT8 Final:1;
> + UINT8 HashAll:1;
> + } Services;
> + UINT32 Family;
> + } Sha384;
> + union {
> + struct {
> + UINT8 GetContextSize:1;
> + UINT8 Init:1;
> + UINT8 Duplicate:1;
> + UINT8 Update:1;
> + UINT8 Final:1;
> + UINT8 HashAll:1;
> + } Services;
> + UINT32 Family;
> + } Sha512;
> + union {
> + struct {
> + UINT8 GetSubjectName:1;
> + UINT8 GetCommonName:1;
> + UINT8 GetOrganizationName:1;
> + UINT8 VerifyCert:1;
> + UINT8 ConstructCertificate:1;
> + UINT8 ConstructCertificateStack:1;
> + UINT8 ConstructCertificateStackV:1;
> + UINT8 Free:1;
> + UINT8 StackFree:1;
> + UINT8 GetTBSCert:1;
> + } Services;
> + UINT32 Family;
> + } X509;
> + union {
> + struct {
> + UINT8 GetContextSize:1;
> + UINT8 Init:1;
> + UINT8 EcbEncrypt:1;
> + UINT8 EcbDecrypt:1;
> + UINT8 CbcEncrypt:1;
> + UINT8 CbcDecrypt:1;
> + } Services;
> + UINT32 Family;
> + } Tdes;
> + union {
> + struct {
> + UINT8 GetContextSize:1;
> + UINT8 Init:1;
> + UINT8 EcbEncrypt:1;
> + UINT8 EcbDecrypt:1;
> + UINT8 CbcEncrypt:1;
> + UINT8 CbcDecrypt:1;
> + } Services;
> + UINT32 Family;
> + } Aes;
> + union {
> + struct {
> + UINT8 GetContextSize:1;
> + UINT8 Init:1;
> + UINT8 Encrypt:1;
> + UINT8 Decrypt:1;
> + UINT8 Reset:1;
> + } Services;
> + UINT32 Family;
> + } Arc4;
> + union {
> + struct {
> + UINT8 GetContextSize:1;
> + UINT8 Init:1;
> + UINT8 Duplicate:1;
> + UINT8 Update:1;
> + UINT8 Final:1;
> + UINT8 HashAll:1;
> + } Services;
> + UINT32 Family;
> + } Sm3;
> + union {
> + struct {
> + UINT8 Sha256ExtractAndExpand;
> + } Services;
> + UINT32 Family;
> + } Hkdf;
> + union {
> + struct {
> + UINT8 Initialize:1;
> + UINT8 CtxFree:1;
> + UINT8 CtxNew:1;
> + UINT8 Free:1;
> + UINT8 New:1;
> + UINT8 InHandshake:1;
> + UINT8 DoHandshake:1;
> + UINT8 HandleAlert:1;
> + UINT8 CloseNotify:1;
> + UINT8 CtrlTrafficOut:1;
> + UINT8 CtrlTrafficIn:1;
> + UINT8 Read:1;
> + UINT8 Write:1;
> + } Services;
> + UINT32 Family;
> + } Tls;
> + union {
> + struct {
> + UINT8 Version:1;
> + UINT8 ConnectionEnd:1;
> + UINT8 CipherList:1;
> + UINT8 CompressionMethod:1;
> + UINT8 Verify:1;
> + UINT8 VerifyHost:1;
> + UINT8 SessionId:1;
> + UINT8 CaCertificate:1;
> + UINT8 HostPublicCert:1;
> + UINT8 HostPrivateKey:1;
> + UINT8 CertRevocationList:1;
> + } Services;
> + UINT32 Family;
> + } TlsSet;
> + union {
> + struct {
> + UINT8 Version:1;
> + UINT8 ConnectionEnd:1;
> + UINT8 CurrentCipher:1;
> + UINT8 CurrentCompressionId:1;
> + UINT8 Verify:1;
> + UINT8 SessionId:1;
> + UINT8 ClientRandom:1;
> + UINT8 ServerRandom:1;
> + UINT8 KeyMaterial:1;
> + UINT8 CaCertificate:1;
> + UINT8 HostPublicCert:1;
> + UINT8 HostPrivateKey:1;
> + UINT8 CertRevocationList:1;
> + } Services;
> + UINT32 Family;
> + } TlsGet;
> +} PCD_CRYPTO_SERVICE_FAMILY_ENABLE;
> diff --git a/CryptoPkg/Private/Ppi/Crypto.h b/CryptoPkg/Private/Ppi/Crypto.h
> new file mode 100644
> index 0000000000..5241cf9ab2
> --- /dev/null
> +++ b/CryptoPkg/Private/Ppi/Crypto.h
> @@ -0,0 +1,21 @@
> +/** @file
> + This PPI provides Crypto services to PEIMs
> +
> + Copyright (C) Microsoft Corporation. All rights reserved.
> + SPDX-License-Identifier: BSD-2-Clause-Patent
> +
> +**/
> +
> +#ifndef __EDKII_CRYPTO_PPI_H__
> +#define __EDKII_CRYPTO_PPI_H__
> +
> +#include <Protocol/Crypto.h>
> +
> +///
> +/// EDK II Crypto PPI is identical to EDK II Crypto Protocol
> +///
> +typedef EDKII_CRYPTO_PROTOCOL EDKII_CRYPTO_PPI;
> +
> +extern GUID gEdkiiCryptoPpiGuid;
> +
> +#endif
> diff --git a/CryptoPkg/Private/Protocol/Crypto.h
> b/CryptoPkg/Private/Protocol/Crypto.h
> new file mode 100644
> index 0000000000..40c387e002
> --- /dev/null
> +++ b/CryptoPkg/Private/Protocol/Crypto.h
> @@ -0,0 +1,4171 @@
> +/** @file
> + This Protocol provides Crypto services to DXE modules
> +
> + Copyright (C) Microsoft Corporation. All rights reserved.
> + SPDX-License-Identifier: BSD-2-Clause-Patent
> +
> +**/
> +
> +#ifndef __EDKII_CRYPTO_PROTOCOL_H__
> +#define __EDKII_CRYPTO_PROTOCOL_H__
> +
> +#include <Base.h>
> +#include <Library/BaseCryptLib.h>
> +#include <Library/PcdLib.h>
> +
> +///
> +/// The version of the EDK II Crypto Protocol.
> +/// As APIs are added to BaseCryptLib, the EDK II Crypto Protocol is extended
> +/// with new APIs at the end of the EDK II Crypto Protocol structure. Each time
> +/// the EDK II Crypto Protocol is extended, this version define must be
> +/// increased.
> +///
> +#define EDKII_CRYPTO_VERSION 6
> +
> +///
> +/// EDK II Crypto Protocol forward declaration
> +///
> +typedef struct _EDKII_CRYPTO_PROTOCOL EDKII_CRYPTO_PROTOCOL;
> +
> +/**
> + Returns the version of the EDK II Crypto Protocol.
> +
> + @return The version of the EDK II Crypto Protocol.
> +
> +**/
> +typedef
> +UINTN
> +(EFIAPI *EDKII_CRYPTO_GET_VERSION) (
> + VOID
> + );
> +
> +//==============================================================
> =======================
> +// MAC (Message Authentication Code) Primitive
> +//==============================================================
> =======================
> +/**
> + Allocates and initializes one HMAC_CTX context for subsequent HMAC-MD5
> use.
> +
> + If this interface is not supported, then return NULL.
> +
> + @return Pointer to the HMAC_CTX context that has been initialized.
> + If the allocations fails, HmacMd5New() returns NULL.
> + @retval NULL This interface is not supported.
> +
> +**/
> +typedef
> +VOID*
> +(EFIAPI *EDKII_CRYPTO_HMAC_MD5_NEW) (
> + VOID
> + );
> +
> +/**
> + Release the specified HMAC_CTX context.
> +
> + If this interface is not supported, then do nothing.
> +
> + @param[in] HmacMd5Ctx Pointer to the HMAC_CTX context to be released.
> +
> +**/
> +typedef
> +VOID
> +(EFIAPI *EDKII_CRYPTO_HMAC_MD5_FREE) (
> + IN VOID *HmacMd5Ctx
> + );
> +
> +/**
> + Set user-supplied key for subsequent use. It must be done before any
> + calling to HmacMd5Update().
> +
> + If HmacMd5Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[out] HmacMd5Context Pointer to HMAC-MD5 context.
> + @param[in] Key Pointer to the user-supplied key.
> + @param[in] KeySize Key size in bytes.
> +
> + @retval TRUE HMAC-MD5 context initialization succeeded.
> + @retval FALSE HMAC-MD5 context initialization failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_HMAC_MD5_SET_KEY) (
> + OUT VOID *HmacMd5Context,
> + IN CONST UINT8 *Key,
> + IN UINTN KeySize
> + );
> +
> +/**
> + Makes a copy of an existing HMAC-MD5 context.
> +
> + If HmacMd5Context is NULL, then return FALSE.
> + If NewHmacMd5Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] HmacMd5Context Pointer to HMAC-MD5 context being copied.
> + @param[out] NewHmacMd5Context Pointer to new HMAC-MD5 context.
> +
> + @retval TRUE HMAC-MD5 context copy succeeded.
> + @retval FALSE HMAC-MD5 context copy failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_HMAC_MD5_DUPLICATE) (
> + IN CONST VOID *HmacMd5Context,
> + OUT VOID *NewHmacMd5Context
> + );
> +
> +/**
> + Digests the input data and updates HMAC-MD5 context.
> +
> + This function performs HMAC-MD5 digest on a data buffer of the specified
> size.
> + It can be called multiple times to compute the digest of long or discontinuous
> data streams.
> + HMAC-MD5 context should be initialized by HmacMd5New(), and should not
> be finalized by
> + HmacMd5Final(). Behavior with invalid context is undefined.
> +
> + If HmacMd5Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] HmacMd5Context Pointer to the HMAC-MD5 context.
> + @param[in] Data Pointer to the buffer containing the data to be
> digested.
> + @param[in] DataSize Size of Data buffer in bytes.
> +
> + @retval TRUE HMAC-MD5 data digest succeeded.
> + @retval FALSE HMAC-MD5 data digest failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_HMAC_MD5_UPDATE) (
> + IN OUT VOID *HmacMd5Context,
> + IN CONST VOID *Data,
> + IN UINTN DataSize
> + );
> +
> +
> +/**
> + Completes computation of the HMAC-MD5 digest value.
> +
> + This function completes HMAC-MD5 hash computation and retrieves the
> digest value into
> + the specified memory. After this function has been called, the HMAC-MD5
> context cannot
> + be used again.
> + HMAC-MD5 context should be initialized by HmacMd5New(), and should not
> be finalized by
> + HmacMd5Final(). Behavior with invalid HMAC-MD5 context is undefined.
> +
> + If HmacMd5Context is NULL, then return FALSE.
> + If HmacValue is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] HmacMd5Context Pointer to the HMAC-MD5 context.
> + @param[out] HmacValue Pointer to a buffer that receives the HMAC-
> MD5 digest
> + value (16 bytes).
> +
> + @retval TRUE HMAC-MD5 digest computation succeeded.
> + @retval FALSE HMAC-MD5 digest computation failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_HMAC_MD5_FINAL) (
> + IN OUT VOID *HmacMd5Context,
> + OUT UINT8 *HmacValue
> + );
> +
> +
> +/**
> + Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA1
> use.
> +
> + If this interface is not supported, then return NULL.
> +
> + @return Pointer to the HMAC_CTX context that has been initialized.
> + If the allocations fails, HmacSha1New() returns NULL.
> + @return NULL This interface is not supported.
> +
> +**/
> +typedef
> +VOID*
> +(EFIAPI *EDKII_CRYPTO_HMAC_SHA1_NEW) (
> + VOID
> + );
> +
> +/**
> + Release the specified HMAC_CTX context.
> +
> + If this interface is not supported, then do nothing.
> +
> + @param[in] HmacSha1Ctx Pointer to the HMAC_CTX context to be released.
> +
> +**/
> +typedef
> +VOID
> +(EFIAPI *EDKII_CRYPTO_HMAC_SHA1_FREE) (
> + IN VOID *HmacSha1Ctx
> + );
> +
> +
> +/**
> + Set user-supplied key for subsequent use. It must be done before any
> + calling to HmacSha1Update().
> +
> + If HmacSha1Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[out] HmacSha1Context Pointer to HMAC-SHA1 context.
> + @param[in] Key Pointer to the user-supplied key.
> + @param[in] KeySize Key size in bytes.
> +
> + @retval TRUE The Key is set successfully.
> + @retval FALSE The Key is set unsuccessfully.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_HMAC_SHA1_SET_KEY) (
> + OUT VOID *HmacSha1Context,
> + IN CONST UINT8 *Key,
> + IN UINTN KeySize
> + );
> +
> +
> +/**
> + Makes a copy of an existing HMAC-SHA1 context.
> +
> + If HmacSha1Context is NULL, then return FALSE.
> + If NewHmacSha1Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] HmacSha1Context Pointer to HMAC-SHA1 context being
> copied.
> + @param[out] NewHmacSha1Context Pointer to new HMAC-SHA1 context.
> +
> + @retval TRUE HMAC-SHA1 context copy succeeded.
> + @retval FALSE HMAC-SHA1 context copy failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_HMAC_SHA1_DUPLICATE) (
> + IN CONST VOID *HmacSha1Context,
> + OUT VOID *NewHmacSha1Context
> + );
> +
> +
> +/**
> + Digests the input data and updates HMAC-SHA1 context.
> +
> + This function performs HMAC-SHA1 digest on a data buffer of the specified
> size.
> + It can be called multiple times to compute the digest of long or discontinuous
> data streams.
> + HMAC-SHA1 context should be initialized by HmacSha1New(), and should not
> be finalized by
> + HmacSha1Final(). Behavior with invalid context is undefined.
> +
> + If HmacSha1Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] HmacSha1Context Pointer to the HMAC-SHA1 context.
> + @param[in] Data Pointer to the buffer containing the data to be
> digested.
> + @param[in] DataSize Size of Data buffer in bytes.
> +
> + @retval TRUE HMAC-SHA1 data digest succeeded.
> + @retval FALSE HMAC-SHA1 data digest failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_HMAC_SHA1_UPDATE) (
> + IN OUT VOID *HmacSha1Context,
> + IN CONST VOID *Data,
> + IN UINTN DataSize
> + );
> +
> +
> +/**
> + Completes computation of the HMAC-SHA1 digest value.
> +
> + This function completes HMAC-SHA1 hash computation and retrieves the
> digest value into
> + the specified memory. After this function has been called, the HMAC-SHA1
> context cannot
> + be used again.
> + HMAC-SHA1 context should be initialized by HmacSha1New(), and should not
> be finalized
> + by HmacSha1Final(). Behavior with invalid HMAC-SHA1 context is undefined.
> +
> + If HmacSha1Context is NULL, then return FALSE.
> + If HmacValue is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] HmacSha1Context Pointer to the HMAC-SHA1 context.
> + @param[out] HmacValue Pointer to a buffer that receives the HMAC-
> SHA1 digest
> + value (20 bytes).
> +
> + @retval TRUE HMAC-SHA1 digest computation succeeded.
> + @retval FALSE HMAC-SHA1 digest computation failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_HMAC_SHA1_FINAL) (
> + IN OUT VOID *HmacSha1Context,
> + OUT UINT8 *HmacValue
> + );
> +
> +
> +/**
> + Allocates and initializes one HMAC_CTX context for subsequent HMAC-
> SHA256 use.
> +
> + @return Pointer to the HMAC_CTX context that has been initialized.
> + If the allocations fails, HmacSha256New() returns NULL.
> +
> +**/
> +typedef
> +VOID *
> +(EFIAPI *EDKII_CRYPTO_HMAC_SHA256_NEW) (
> + VOID
> + );
> +
> +/**
> + Release the specified HMAC_CTX context.
> +
> + @param[in] HmacSha256Ctx Pointer to the HMAC_CTX context to be
> released.
> +
> +**/
> +typedef
> +VOID
> +(EFIAPI *EDKII_CRYPTO_HMAC_SHA256_FREE) (
> + IN VOID *HmacSha256Ctx
> + );
> +
> +
> +/**
> + Set user-supplied key for subsequent use. It must be done before any
> + calling to HmacSha256Update().
> +
> + If HmacSha256Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[out] HmacSha256Context Pointer to HMAC-SHA256 context.
> + @param[in] Key Pointer to the user-supplied key.
> + @param[in] KeySize Key size in bytes.
> +
> + @retval TRUE The Key is set successfully.
> + @retval FALSE The Key is set unsuccessfully.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_HMAC_SHA256_SET_KEY) (
> + OUT VOID *HmacSha256Context,
> + IN CONST UINT8 *Key,
> + IN UINTN KeySize
> + );
> +
> +/**
> + Makes a copy of an existing HMAC-SHA256 context.
> +
> + If HmacSha256Context is NULL, then return FALSE.
> + If NewHmacSha256Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] HmacSha256Context Pointer to HMAC-SHA256 context being
> copied.
> + @param[out] NewHmacSha256Context Pointer to new HMAC-SHA256
> context.
> +
> + @retval TRUE HMAC-SHA256 context copy succeeded.
> + @retval FALSE HMAC-SHA256 context copy failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_HMAC_SHA256_DUPLICATE) (
> + IN CONST VOID *HmacSha256Context,
> + OUT VOID *NewHmacSha256Context
> + );
> +
> +
> +/**
> + Digests the input data and updates HMAC-SHA256 context.
> +
> + This function performs HMAC-SHA256 digest on a data buffer of the specified
> size.
> + It can be called multiple times to compute the digest of long or discontinuous
> data streams.
> + HMAC-SHA256 context should be initialized by HmacSha256New(), and should
> not be finalized
> + by HmacSha256Final(). Behavior with invalid context is undefined.
> +
> + If HmacSha256Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] HmacSha256Context Pointer to the HMAC-SHA256 context.
> + @param[in] Data Pointer to the buffer containing the data to be
> digested.
> + @param[in] DataSize Size of Data buffer in bytes.
> +
> + @retval TRUE HMAC-SHA256 data digest succeeded.
> + @retval FALSE HMAC-SHA256 data digest failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_HMAC_SHA256_UPDATE) (
> + IN OUT VOID *HmacSha256Context,
> + IN CONST VOID *Data,
> + IN UINTN DataSize
> + );
> +
> +/**
> + Completes computation of the HMAC-SHA256 digest value.
> +
> + This function completes HMAC-SHA256 hash computation and retrieves the
> digest value into
> + the specified memory. After this function has been called, the HMAC-SHA256
> context cannot
> + be used again.
> + HMAC-SHA256 context should be initialized by HmacSha256New(), and should
> not be finalized
> + by HmacSha256Final(). Behavior with invalid HMAC-SHA256 context is
> undefined.
> +
> + If HmacSha256Context is NULL, then return FALSE.
> + If HmacValue is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] HmacSha256Context Pointer to the HMAC-SHA256 context.
> + @param[out] HmacValue Pointer to a buffer that receives the HMAC-
> SHA256 digest
> + value (32 bytes).
> +
> + @retval TRUE HMAC-SHA256 digest computation succeeded.
> + @retval FALSE HMAC-SHA256 digest computation failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_HMAC_SHA256_FINAL) (
> + IN OUT VOID *HmacSha256Context,
> + OUT UINT8 *HmacValue
> + );
> +
> +
> +//==============================================================
> =======================
> +// One-Way Cryptographic Hash Primitives
> +//==============================================================
> =======================
> +
> +/**
> + Retrieves the size, in bytes, of the context buffer required for MD4 hash
> operations.
> +
> + If this interface is not supported, then return zero.
> +
> + @return The size, in bytes, of the context buffer required for MD4 hash
> operations.
> + @retval 0 This interface is not supported.
> +
> +**/
> +typedef
> +UINTN
> +(EFIAPI *EDKII_CRYPTO_MD4_GET_CONTEXT_SIZE) (
> + VOID
> + );
> +
> +
> +/**
> + Initializes user-supplied memory pointed by Md4Context as MD4 hash context
> for
> + subsequent use.
> +
> + If Md4Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[out] Md4Context Pointer to MD4 context being initialized.
> +
> + @retval TRUE MD4 context initialization succeeded.
> + @retval FALSE MD4 context initialization failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_MD4_INIT) (
> + OUT VOID *Md4Context
> + );
> +
> +
> +/**
> + Makes a copy of an existing MD4 context.
> +
> + If Md4Context is NULL, then return FALSE.
> + If NewMd4Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] Md4Context Pointer to MD4 context being copied.
> + @param[out] NewMd4Context Pointer to new MD4 context.
> +
> + @retval TRUE MD4 context copy succeeded.
> + @retval FALSE MD4 context copy failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_MD4_DUPLICATE) (
> + IN CONST VOID *Md4Context,
> + OUT VOID *NewMd4Context
> + );
> +
> +
> +/**
> + Digests the input data and updates MD4 context.
> +
> + This function performs MD4 digest on a data buffer of the specified size.
> + It can be called multiple times to compute the digest of long or discontinuous
> data streams.
> + MD4 context should be already correctly initialized by Md4Init(), and should
> not be finalized
> + by Md4Final(). Behavior with invalid context is undefined.
> +
> + If Md4Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] Md4Context Pointer to the MD4 context.
> + @param[in] Data Pointer to the buffer containing the data to be
> hashed.
> + @param[in] DataSize Size of Data buffer in bytes.
> +
> + @retval TRUE MD4 data digest succeeded.
> + @retval FALSE MD4 data digest failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_MD4_UPDATE) (
> + IN OUT VOID *Md4Context,
> + IN CONST VOID *Data,
> + IN UINTN DataSize
> + );
> +
> +
> +/**
> + Completes computation of the MD4 digest value.
> +
> + This function completes MD4 hash computation and retrieves the digest value
> into
> + the specified memory. After this function has been called, the MD4 context
> cannot
> + be used again.
> + MD4 context should be already correctly initialized by Md4Init(), and should
> not be
> + finalized by Md4Final(). Behavior with invalid MD4 context is undefined.
> +
> + If Md4Context is NULL, then return FALSE.
> + If HashValue is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] Md4Context Pointer to the MD4 context.
> + @param[out] HashValue Pointer to a buffer that receives the MD4 digest
> + value (16 bytes).
> +
> + @retval TRUE MD4 digest computation succeeded.
> + @retval FALSE MD4 digest computation failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_MD4_FINAL) (
> + IN OUT VOID *Md4Context,
> + OUT UINT8 *HashValue
> + );
> +
> +
> +/**
> + Computes the MD4 message digest of a input data buffer.
> +
> + This function performs the MD4 message digest of a given data buffer, and
> places
> + the digest value into the specified memory.
> +
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] Data Pointer to the buffer containing the data to be hashed.
> + @param[in] DataSize Size of Data buffer in bytes.
> + @param[out] HashValue Pointer to a buffer that receives the MD4 digest
> + value (16 bytes).
> +
> + @retval TRUE MD4 digest computation succeeded.
> + @retval FALSE MD4 digest computation failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_MD4_HASH_ALL) (
> + IN CONST VOID *Data,
> + IN UINTN DataSize,
> + OUT UINT8 *HashValue
> + );
> +
> +// ----------------------------------------------------------------------------
> +
> +/**
> + Retrieves the size, in bytes, of the context buffer required for MD5 hash
> operations.
> +
> + If this interface is not supported, then return zero.
> +
> + @return The size, in bytes, of the context buffer required for MD5 hash
> operations.
> + @retval 0 This interface is not supported.
> +
> +**/
> +typedef
> +UINTN
> +(EFIAPI* EDKII_CRYPTO_MD5_GET_CONTEXT_SIZE)(
> + VOID
> + );
> +
> +/**
> + Initializes user-supplied memory pointed by Md5Context as MD5 hash context
> for
> + subsequent use.
> +
> + If Md5Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[out] Md5Context Pointer to MD5 context being initialized.
> +
> + @retval TRUE MD5 context initialization succeeded.
> + @retval FALSE MD5 context initialization failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI* EDKII_CRYPTO_MD5_INIT)(
> + OUT VOID *Md5Context);
> +
> +/**
> + Makes a copy of an existing MD5 context.
> +
> + If Md5Context is NULL, then return FALSE.
> + If NewMd5Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] Md5Context Pointer to MD5 context being copied.
> + @param[out] NewMd5Context Pointer to new MD5 context.
> +
> + @retval TRUE MD5 context copy succeeded.
> + @retval FALSE MD5 context copy failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI* EDKII_CRYPTO_MD5_DUPLICATE) (
> + IN CONST VOID *Md5Context,
> + OUT VOID *NewMd5Context);
> +
> +
> +/**
> + Digests the input data and updates MD5 context.
> +
> + This function performs MD5 digest on a data buffer of the specified size.
> + It can be called multiple times to compute the digest of long or discontinuous
> data streams.
> + MD5 context should be already correctly initialized by Md5Init(), and should
> not be finalized
> + by Md5Final(). Behavior with invalid context is undefined.
> +
> + If Md5Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] Md5Context Pointer to the MD5 context.
> + @param[in] Data Pointer to the buffer containing the data to be
> hashed.
> + @param[in] DataSize Size of Data buffer in bytes.
> +
> + @retval TRUE MD5 data digest succeeded.
> + @retval FALSE MD5 data digest failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI* EDKII_CRYPTO_MD5_UPDATE)(
> + IN OUT VOID *Md5Context,
> + IN CONST VOID *Data,
> + IN UINTN DataSize);
> +
> +
> +/**
> + Completes computation of the MD5 digest value.
> +
> + This function completes MD5 hash computation and retrieves the digest value
> into
> + the specified memory. After this function has been called, the MD5 context
> cannot
> + be used again.
> + MD5 context should be already correctly initialized by Md5Init(), and should
> not be
> + finalized by Md5Final(). Behavior with invalid MD5 context is undefined.
> +
> + If Md5Context is NULL, then return FALSE.
> + If HashValue is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] Md5Context Pointer to the MD5 context.
> + @param[out] HashValue Pointer to a buffer that receives the MD5 digest
> + value (16 bytes).
> +
> + @retval TRUE MD5 digest computation succeeded.
> + @retval FALSE MD5 digest computation failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI* EDKII_CRYPTO_MD5_FINAL)(
> + IN OUT VOID *Md5Context,
> + OUT UINT8 *HashValue);
> +
> +
> +/**
> + Computes the MD5 message digest of a input data buffer.
> +
> + This function performs the MD5 message digest of a given data buffer, and
> places
> + the digest value into the specified memory.
> +
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] Data Pointer to the buffer containing the data to be hashed.
> + @param[in] DataSize Size of Data buffer in bytes.
> + @param[out] HashValue Pointer to a buffer that receives the MD5 digest
> + value (16 bytes).
> +
> + @retval TRUE MD5 digest computation succeeded.
> + @retval FALSE MD5 digest computation failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI* EDKII_CRYPTO_MD5_HASH_ALL)(
> + IN CONST VOID *Data,
> + IN UINTN DataSize,
> + OUT UINT8 *HashValue);
> +
> +
> +//==============================================================
> =======================
> +// PKCS
> +//==============================================================
> =======================
> +
> +
> +/**
> + Encrypts a blob using PKCS1v2 (RSAES-OAEP) schema. On success, will return
> the encrypted message in
> + in a newly allocated buffer.
> +
> + Things that can cause a failure include:
> + - X509 key size does not match any known key size.
> + - Fail to parse X509 certificate.
> + - Fail to allocate an intermediate buffer.
> + - NULL pointer provided for a non-optional parameter.
> + - Data size is too large for the provided key size (max size is a function of key
> size and hash digest size).
> +
> + @param[in] PublicKey A pointer to the DER-encoded X509 certificate that
> will be used to encrypt the data.
> + @param[in] PublicKeySize Size of the X509 cert buffer.
> + @param[in] InData Data to be encrypted.
> + @param[in] InDataSize Size of the data buffer.
> + @param[in] PrngSeed [Optional] If provided, a pointer to a random seed
> buffer to be used when initializing the PRNG. NULL otherwise.
> + @param[in] PrngSeedSize [Optional] If provided, size of the random seed
> buffer. 0 otherwise.
> + @param[out] EncryptedData Pointer to an allocated buffer containing the
> encrypted message.
> + @param[out] EncryptedDataSize Size of the encrypted message buffer.
> +
> + @retval TRUE Encryption was successful.
> + @retval FALSE Encryption failed.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_PKCS1_ENCRYPT_V2) (
> +IN CONST UINT8 *PublicKey,
> +IN UINTN PublicKeySize,
> +IN UINT8 *InData,
> +IN UINTN InDataSize,
> +IN CONST UINT8 *PrngSeed OPTIONAL,
> +IN UINTN PrngSeedSize OPTIONAL,
> +OUT UINT8 **EncryptedData,
> +OUT UINTN *EncryptedDataSize
> +);
> +
> +
> +
> +
> +// ---------------------------------------------
> +// PKCS5
> +
> +/**
> + Derives a key from a password using a salt and iteration count, based on
> PKCS#5 v2.0
> + password based encryption key derivation function PBKDF2, as specified in
> RFC 2898.
> +
> + If Password or Salt or OutKey is NULL, then return FALSE.
> + If the hash algorithm could not be determined, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] PasswordLength Length of input password in bytes.
> + @param[in] Password Pointer to the array for the password.
> + @param[in] SaltLength Size of the Salt in bytes.
> + @param[in] Salt Pointer to the Salt.
> + @param[in] IterationCount Number of iterations to perform. Its value should
> be
> + greater than or equal to 1.
> + @param[in] DigestSize Size of the message digest to be used (eg.
> SHA256_DIGEST_SIZE).
> + NOTE: DigestSize will be used to determine the hash algorithm.
> + Only SHA1_DIGEST_SIZE or SHA256_DIGEST_SIZE is
> supported.
> + @param[in] KeyLength Size of the derived key buffer in bytes.
> + @param[out] OutKey Pointer to the output derived key buffer.
> +
> + @retval TRUE A key was derived successfully.
> + @retval FALSE One of the pointers was NULL or one of the sizes was too
> large.
> + @retval FALSE The hash algorithm could not be determined from the digest
> size.
> + @retval FALSE The key derivation operation failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_PKCS5_PW_HASH) (
> + IN UINTN PasswordSize,
> + IN CONST CHAR8 *Password,
> + IN UINTN SaltSize,
> + IN CONST UINT8 *Salt,
> + IN UINTN IterationCount,
> + IN UINTN DigestSize,
> + IN UINTN OutputSize,
> + OUT UINT8 *Output
> + );
> +
> +
> +
> +// ---------------------------------------------
> +// PKCS7
> +
> +/**
> + Verifies the validity of a PKCS#7 signed data as described in "PKCS #7:
> + Cryptographic Message Syntax Standard". The input signed data could be
> wrapped
> + in a ContentInfo structure.
> +
> + If P7Data, TrustedCert or InData is NULL, then return FALSE.
> + If P7Length, CertLength or DataLength overflow, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] P7Data Pointer to the PKCS#7 message to verify.
> + @param[in] P7Length Length of the PKCS#7 message in bytes.
> + @param[in] TrustedCert Pointer to a trusted/root certificate encoded in DER,
> which
> + is used for certificate chain verification.
> + @param[in] CertLength Length of the trusted certificate in bytes.
> + @param[in] InData Pointer to the content to be verified.
> + @param[in] DataLength Length of InData in bytes.
> +
> + @retval TRUE The specified PKCS#7 signed data is valid.
> + @retval FALSE Invalid PKCS#7 signed data.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_PKCS7_VERIFY) (
> +IN CONST UINT8 *P7Data,
> +IN UINTN P7DataLength,
> +IN CONST UINT8 *TrustedCert,
> +IN UINTN TrustedCertLength,
> +IN CONST UINT8 *Data,
> +IN UINTN DataLength
> +);
> +
> +/**
> + VerifyEKUsInPkcs7Signature()
> +
> + This function receives a PKCS7 formatted signature, and then verifies that
> + the specified Enhanced or Extended Key Usages (EKU's) are present in the end-
> entity
> + leaf signing certificate.
> +
> + Note that this function does not validate the certificate chain.
> +
> + Applications for custom EKU's are quite flexible. For example, a policy EKU
> + may be present in an Issuing Certificate Authority (CA), and any sub-ordinate
> + certificate issued might also contain this EKU, thus constraining the
> + sub-ordinate certificate. Other applications might allow a certificate
> + embedded in a device to specify that other Object Identifiers (OIDs) are
> + present which contains binary data specifying custom capabilities that
> + the device is able to do.
> +
> + @param[in] Pkcs7Signature - The PKCS#7 signed information content block.
> An array
> + containing the content block with both the signature,
> + the signer's certificate, and any necessary intermediate
> + certificates.
> +
> + @param[in] Pkcs7SignatureSize - Number of bytes in Pkcs7Signature.
> +
> + @param[in] RequiredEKUs - Array of null-terminated strings listing OIDs of
> + required EKUs that must be present in the signature.
> +
> + @param[in] RequiredEKUsSize - Number of elements in the RequiredEKUs
> string array.
> +
> + @param[in] RequireAllPresent - If this is TRUE, then all of the specified EKU's
> + must be present in the leaf signer. If it is
> + FALSE, then we will succeed if we find any
> + of the specified EKU's.
> +
> + @retval EFI_SUCCESS - The required EKUs were found in the signature.
> + @retval EFI_INVALID_PARAMETER - A parameter was invalid.
> + @retval EFI_NOT_FOUND - One or more EKU's were not found in the
> signature.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI *EDKII_CRYPTO_PKCS7_VERIFY_EKU) (
> +IN CONST UINT8 *Pkcs7Signature,
> +IN CONST UINT32 SignatureSize,
> +IN CONST CHAR8 *RequiredEKUs[],
> +IN CONST UINT32 RequiredEKUsSize,
> +IN BOOLEAN RequireAllPresent
> +);
> +
> +/**
> + Get the signer's certificates from PKCS#7 signed data as described in "PKCS #7:
> + Cryptographic Message Syntax Standard". The input signed data could be
> wrapped
> + in a ContentInfo structure.
> +
> + If P7Data, CertStack, StackLength, TrustedCert or CertLength is NULL, then
> + return FALSE. If P7Length overflow, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] P7Data Pointer to the PKCS#7 message to verify.
> + @param[in] P7Length Length of the PKCS#7 message in bytes.
> + @param[out] CertStack Pointer to Signer's certificates retrieved from
> P7Data.
> + It's caller's responsibility to free the buffer with
> + Pkcs7FreeSigners().
> + This data structure is EFI_CERT_STACK type.
> + @param[out] StackLength Length of signer's certificates in bytes.
> + @param[out] TrustedCert Pointer to a trusted certificate from Signer's
> certificates.
> + It's caller's responsibility to free the buffer with
> + Pkcs7FreeSigners().
> + @param[out] CertLength Length of the trusted certificate in bytes.
> +
> + @retval TRUE The operation is finished successfully.
> + @retval FALSE Error occurs during the operation.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_PKCS7_GET_SIGNERS) (
> + IN CONST UINT8 *P7Data,
> + IN UINTN P7Length,
> + OUT UINT8 **CertStack,
> + OUT UINTN *StackLength,
> + OUT UINT8 **TrustedCert,
> + OUT UINTN *CertLength
> + );
> +
> +/**
> + Wrap function to use free() to free allocated memory for certificates.
> +
> + If this interface is not supported, then ASSERT().
> +
> + @param[in] Certs Pointer to the certificates to be freed.
> +
> +**/
> +typedef
> +VOID
> +(EFIAPI *EDKII_CRYPTO_PKCS7_FREE_SIGNERS) (
> + IN UINT8 *Certs
> + );
> +
> +/**
> + Creates a PKCS#7 signedData as described in "PKCS #7: Cryptographic
> Message
> + Syntax Standard, version 1.5". This interface is only intended to be used for
> + application to perform PKCS#7 functionality validation.
> +
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] PrivateKey Pointer to the PEM-formatted private key data for
> + data signing.
> + @param[in] PrivateKeySize Size of the PEM private key data in bytes.
> + @param[in] KeyPassword NULL-terminated passphrase used for encrypted
> PEM
> + key data.
> + @param[in] InData Pointer to the content to be signed.
> + @param[in] InDataSize Size of InData in bytes.
> + @param[in] SignCert Pointer to signer's DER-encoded certificate to sign
> with.
> + @param[in] OtherCerts Pointer to an optional additional set of
> certificates to
> + include in the PKCS#7 signedData (e.g. any intermediate
> + CAs in the chain).
> + @param[out] SignedData Pointer to output PKCS#7 signedData. It's caller's
> + responsibility to free the buffer with FreePool().
> + @param[out] SignedDataSize Size of SignedData in bytes.
> +
> + @retval TRUE PKCS#7 data signing succeeded.
> + @retval FALSE PKCS#7 data signing failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_PKCS7_SIGN) (
> + IN CONST UINT8 *PrivateKey,
> + IN UINTN PrivateKeySize,
> + IN CONST UINT8 *KeyPassword,
> + IN UINT8 *InData,
> + IN UINTN InDataSize,
> + IN UINT8 *SignCert,
> + IN UINT8 *OtherCerts OPTIONAL,
> + OUT UINT8 **SignedData,
> + OUT UINTN *SignedDataSize
> + );
> +
> +/**
> + Extracts the attached content from a PKCS#7 signed data if existed. The input
> signed
> + data could be wrapped in a ContentInfo structure.
> +
> + If P7Data, Content, or ContentSize is NULL, then return FALSE. If P7Length
> overflow,
> + then return FALSE. If the P7Data is not correctly formatted, then return FALSE.
> +
> + Caution: This function may receive untrusted input. So this function will do
> + basic check for PKCS#7 data structure.
> +
> + @param[in] P7Data Pointer to the PKCS#7 signed data to process.
> + @param[in] P7Length Length of the PKCS#7 signed data in bytes.
> + @param[out] Content Pointer to the extracted content from the PKCS#7
> signedData.
> + It's caller's responsibility to free the buffer with FreePool().
> + @param[out] ContentSize The size of the extracted content in bytes.
> +
> + @retval TRUE The P7Data was correctly formatted for processing.
> + @retval FALSE The P7Data was not correctly formatted for processing.
> +
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_PKCS7_GET_ATTACHED_CONTENT) (
> + IN CONST UINT8 *P7Data,
> + IN UINTN P7Length,
> + OUT VOID **Content,
> + OUT UINTN *ContentSize
> + );
> +
> +/**
> + Retrieves all embedded certificates from PKCS#7 signed data as described in
> "PKCS #7:
> + Cryptographic Message Syntax Standard", and outputs two certificate lists
> chained and
> + unchained to the signer's certificates.
> + The input signed data could be wrapped in a ContentInfo structure.
> +
> + @param[in] P7Data Pointer to the PKCS#7 message.
> + @param[in] P7Length Length of the PKCS#7 message in bytes.
> + @param[out] SignerChainCerts Pointer to the certificates list chained to
> signer's
> + certificate. It's caller's responsibility to free the buffer
> + with Pkcs7FreeSigners().
> + This data structure is EFI_CERT_STACK type.
> + @param[out] ChainLength Length of the chained certificates list buffer in
> bytes.
> + @param[out] UnchainCerts Pointer to the unchained certificates lists. It's
> caller's
> + responsibility to free the buffer with Pkcs7FreeSigners().
> + This data structure is EFI_CERT_STACK type.
> + @param[out] UnchainLength Length of the unchained certificates list buffer
> in bytes.
> +
> + @retval TRUE The operation is finished successfully.
> + @retval FALSE Error occurs during the operation.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_PKCS7_GET_CERTIFICATES_LIST) (
> + IN CONST UINT8 *P7Data,
> + IN UINTN P7Length,
> + OUT UINT8 **SignerChainCerts,
> + OUT UINTN *ChainLength,
> + OUT UINT8 **UnchainCerts,
> + OUT UINTN *UnchainLength
> + );
> +
> +/**
> + Verifies the validity of a PE/COFF Authenticode Signature as described in
> "Windows
> + Authenticode Portable Executable Signature Format".
> +
> + If AuthData is NULL, then return FALSE.
> + If ImageHash is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] AuthData Pointer to the Authenticode Signature retrieved from
> signed
> + PE/COFF image to be verified.
> + @param[in] DataSize Size of the Authenticode Signature in bytes.
> + @param[in] TrustedCert Pointer to a trusted/root certificate encoded in DER,
> which
> + is used for certificate chain verification.
> + @param[in] CertSize Size of the trusted certificate in bytes.
> + @param[in] ImageHash Pointer to the original image file hash value. The
> procedure
> + for calculating the image hash value is described in Authenticode
> + specification.
> + @param[in] HashSize Size of Image hash value in bytes.
> +
> + @retval TRUE The specified Authenticode Signature is valid.
> + @retval FALSE Invalid Authenticode Signature.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_AUTHENTICODE_VERIFY) (
> + IN CONST UINT8 *AuthData,
> + IN UINTN DataSize,
> + IN CONST UINT8 *TrustedCert,
> + IN UINTN CertSize,
> + IN CONST UINT8 *ImageHash,
> + IN UINTN HashSize
> + );
> +
> +/**
> + Verifies the validity of a RFC3161 Timestamp CounterSignature embedded in
> PE/COFF Authenticode
> + signature.
> +
> + If AuthData is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] AuthData Pointer to the Authenticode Signature retrieved from
> signed
> + PE/COFF image to be verified.
> + @param[in] DataSize Size of the Authenticode Signature in bytes.
> + @param[in] TsaCert Pointer to a trusted/root TSA certificate encoded in
> DER, which
> + is used for TSA certificate chain verification.
> + @param[in] CertSize Size of the trusted certificate in bytes.
> + @param[out] SigningTime Return the time of timestamp generation time if
> the timestamp
> + signature is valid.
> +
> + @retval TRUE The specified Authenticode includes a valid RFC3161
> Timestamp CounterSignature.
> + @retval FALSE No valid RFC3161 Timestamp CounterSignature in the
> specified Authenticode data.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_IMAGE_TIMESTAMP_VERIFY) (
> + IN CONST UINT8 *AuthData,
> + IN UINTN DataSize,
> + IN CONST UINT8 *TsaCert,
> + IN UINTN CertSize,
> + OUT EFI_TIME *SigningTime
> + );
> +
> +
> +//==============================================================
> =======================
> +// DH Key Exchange Primitive
> +//==============================================================
> =======================
> +
> +/**
> + Allocates and Initializes one Diffie-Hellman Context for subsequent use.
> +
> + @return Pointer to the Diffie-Hellman Context that has been initialized.
> + If the allocations fails, DhNew() returns NULL.
> + If the interface is not supported, DhNew() returns NULL.
> +
> +**/
> +typedef
> +VOID*
> +(EFIAPI *EDKII_CRYPTO_DH_NEW) (
> + VOID
> + );
> +
> +/**
> + Release the specified DH context.
> +
> + If the interface is not supported, then ASSERT().
> +
> + @param[in] DhContext Pointer to the DH context to be released.
> +
> +**/
> +typedef
> +VOID
> +(EFIAPI *EDKII_CRYPTO_DH_FREE) (
> + IN VOID *DhContext
> + );
> +
> +/**
> + Generates DH parameter.
> +
> + Given generator g, and length of prime number p in bits, this function
> generates p,
> + and sets DH context according to value of g and p.
> +
> + Before this function can be invoked, pseudorandom number generator must
> be correctly
> + initialized by RandomSeed().
> +
> + If DhContext is NULL, then return FALSE.
> + If Prime is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] DhContext Pointer to the DH context.
> + @param[in] Generator Value of generator.
> + @param[in] PrimeLength Length in bits of prime to be generated.
> + @param[out] Prime Pointer to the buffer to receive the generated
> prime number.
> +
> + @retval TRUE DH parameter generation succeeded.
> + @retval FALSE Value of Generator is not supported.
> + @retval FALSE PRNG fails to generate random prime number with
> PrimeLength.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_DH_GENERATE_PARAMETER) (
> + IN OUT VOID *DhContext,
> + IN UINTN Generator,
> + IN UINTN PrimeLength,
> + OUT UINT8 *Prime
> + );
> +
> +/**
> + Sets generator and prime parameters for DH.
> +
> + Given generator g, and prime number p, this function and sets DH
> + context accordingly.
> +
> + If DhContext is NULL, then return FALSE.
> + If Prime is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] DhContext Pointer to the DH context.
> + @param[in] Generator Value of generator.
> + @param[in] PrimeLength Length in bits of prime to be generated.
> + @param[in] Prime Pointer to the prime number.
> +
> + @retval TRUE DH parameter setting succeeded.
> + @retval FALSE Value of Generator is not supported.
> + @retval FALSE Value of Generator is not suitable for the Prime.
> + @retval FALSE Value of Prime is not a prime number.
> + @retval FALSE Value of Prime is not a safe prime number.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_DH_SET_PARAMETER) (
> + IN OUT VOID *DhContext,
> + IN UINTN Generator,
> + IN UINTN PrimeLength,
> + IN CONST UINT8 *Prime
> + );
> +
> +/**
> + Generates DH public key.
> +
> + This function generates random secret exponent, and computes the public key,
> which is
> + returned via parameter PublicKey and PublicKeySize. DH context is updated
> accordingly.
> + If the PublicKey buffer is too small to hold the public key, FALSE is returned
> and
> + PublicKeySize is set to the required buffer size to obtain the public key.
> +
> + If DhContext is NULL, then return FALSE.
> + If PublicKeySize is NULL, then return FALSE.
> + If PublicKeySize is large enough but PublicKey is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] DhContext Pointer to the DH context.
> + @param[out] PublicKey Pointer to the buffer to receive generated public
> key.
> + @param[in, out] PublicKeySize On input, the size of PublicKey buffer in bytes.
> + On output, the size of data returned in PublicKey buffer in
> bytes.
> +
> + @retval TRUE DH public key generation succeeded.
> + @retval FALSE DH public key generation failed.
> + @retval FALSE PublicKeySize is not large enough.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_DH_GENERATE_KEY) (
> + IN OUT VOID *DhContext,
> + OUT UINT8 *PublicKey,
> + IN OUT UINTN *PublicKeySize
> + );
> +
> +/**
> + Computes exchanged common key.
> +
> + Given peer's public key, this function computes the exchanged common key,
> based on its own
> + context including value of prime modulus and random secret exponent.
> +
> + If DhContext is NULL, then return FALSE.
> + If PeerPublicKey is NULL, then return FALSE.
> + If KeySize is NULL, then return FALSE.
> + If Key is NULL, then return FALSE.
> + If KeySize is not large enough, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] DhContext Pointer to the DH context.
> + @param[in] PeerPublicKey Pointer to the peer's public key.
> + @param[in] PeerPublicKeySize Size of peer's public key in bytes.
> + @param[out] Key Pointer to the buffer to receive generated key.
> + @param[in, out] KeySize On input, the size of Key buffer in bytes.
> + On output, the size of data returned in Key buffer in bytes.
> +
> + @retval TRUE DH exchanged key generation succeeded.
> + @retval FALSE DH exchanged key generation failed.
> + @retval FALSE KeySize is not large enough.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_DH_COMPUTE_KEY) (
> + IN OUT VOID *DhContext,
> + IN CONST UINT8 *PeerPublicKey,
> + IN UINTN PeerPublicKeySize,
> + OUT UINT8 *Key,
> + IN OUT UINTN *KeySize
> + );
> +
> +//==============================================================
> =======================
> +// Pseudo-Random Generation Primitive
> +//==============================================================
> =======================
> +
> +/**
> + Sets up the seed value for the pseudorandom number generator.
> +
> + This function sets up the seed value for the pseudorandom number generator.
> + If Seed is not NULL, then the seed passed in is used.
> + If Seed is NULL, then default seed is used.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] Seed Pointer to seed value.
> + If NULL, default seed is used.
> + @param[in] SeedSize Size of seed value.
> + If Seed is NULL, this parameter is ignored.
> +
> + @retval TRUE Pseudorandom number generator has enough entropy for
> random generation.
> + @retval FALSE Pseudorandom number generator does not have enough
> entropy for random generation.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_RANDOM_SEED) (
> + IN CONST UINT8 *Seed OPTIONAL,
> + IN UINTN SeedSize
> + );
> +
> +/**
> + Generates a pseudorandom byte stream of the specified size.
> +
> + If Output is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[out] Output Pointer to buffer to receive random value.
> + @param[in] Size Size of random bytes to generate.
> +
> + @retval TRUE Pseudorandom byte stream generated successfully.
> + @retval FALSE Pseudorandom number generator fails to generate due to lack
> of entropy.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_RANDOM_BYTES) (
> + OUT UINT8 *Output,
> + IN UINTN Size
> + );
> +
> +/**
> + Verifies the RSA-SSA signature with EMSA-PKCS1-v1_5 encoding scheme
> defined in
> + RSA PKCS#1.
> +
> + If RsaContext is NULL, then return FALSE.
> + If MessageHash is NULL, then return FALSE.
> + If Signature is NULL, then return FALSE.
> + If HashSize is not equal to the size of MD5, SHA-1, SHA-256 digest, then return
> FALSE.
> +
> + @param[in] RsaContext Pointer to RSA context for signature verification.
> + @param[in] MessageHash Pointer to octet message hash to be checked.
> + @param[in] HashSize Size of the message hash in bytes.
> + @param[in] Signature Pointer to RSA PKCS1-v1_5 signature to be verified.
> + @param[in] SigSize Size of signature in bytes.
> +
> + @retval TRUE Valid signature encoded in PKCS1-v1_5.
> + @retval FALSE Invalid signature or invalid RSA context.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_RSA_VERIFY_PKCS1) (
> + IN VOID *RsaContext,
> + IN CONST UINT8 *MessageHash,
> + IN UINTN HashSize,
> + IN CONST UINT8 *Signature,
> + IN UINTN SigSize
> + );
> +
> +/**
> + Retrieve the RSA Public Key from one DER-encoded X509 certificate.
> +
> + If Cert is NULL, then return FALSE.
> + If RsaContext is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] Cert Pointer to the DER-encoded X509 certificate.
> + @param[in] CertSize Size of the X509 certificate in bytes.
> + @param[out] RsaContext Pointer to new-generated RSA context which
> contain the retrieved
> + RSA public key component. Use RsaFree() function to free the
> + resource.
> +
> + @retval TRUE RSA Public Key was retrieved successfully.
> + @retval FALSE Fail to retrieve RSA public key from X509 certificate.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_RSA_GET_PUBLIC_KEY_FROM_X509) (
> + IN CONST UINT8 *Cert,
> + IN UINTN CertSize,
> + OUT VOID **RsaContext
> + );
> +
> +/**
> + Allocates and initializes one RSA context for subsequent use.
> +
> + @return Pointer to the RSA context that has been initialized.
> + If the allocations fails, RsaNew() returns NULL.
> +
> +**/
> +typedef
> +VOID*
> +(EFIAPI *EDKII_CRYPTO_RSA_NEW) (
> + VOID
> + );
> +
> +/**
> + Release the specified RSA context.
> +
> + If RsaContext is NULL, then return FALSE.
> +
> + @param[in] RsaContext Pointer to the RSA context to be released.
> +
> +**/
> +typedef
> +VOID
> +(EFIAPI *EDKII_CRYPTO_RSA_FREE) (
> + IN VOID *RsaContext
> + );
> +
> +/**
> + Sets the tag-designated key component into the established RSA context.
> +
> + This function sets the tag-designated RSA key component into the established
> + RSA context from the user-specified non-negative integer (octet string format
> + represented in RSA PKCS#1).
> + If BigNumber is NULL, then the specified key component in RSA context is
> cleared.
> +
> + If RsaContext is NULL, then return FALSE.
> +
> + @param[in, out] RsaContext Pointer to RSA context being set.
> + @param[in] KeyTag Tag of RSA key component being set.
> + @param[in] BigNumber Pointer to octet integer buffer.
> + If NULL, then the specified key component in RSA
> + context is cleared.
> + @param[in] BnSize Size of big number buffer in bytes.
> + If BigNumber is NULL, then it is ignored.
> +
> + @retval TRUE RSA key component was set successfully.
> + @retval FALSE Invalid RSA key component tag.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_RSA_SET_KEY) (
> + IN OUT VOID *RsaContext,
> + IN RSA_KEY_TAG KeyTag,
> + IN CONST UINT8 *BigNumber,
> + IN UINTN BnSize
> + );
> +
> +/**
> + Gets the tag-designated RSA key component from the established RSA context.
> +
> + This function retrieves the tag-designated RSA key component from the
> + established RSA context as a non-negative integer (octet string format
> + represented in RSA PKCS#1).
> + If specified key component has not been set or has been cleared, then
> returned
> + BnSize is set to 0.
> + If the BigNumber buffer is too small to hold the contents of the key, FALSE
> + is returned and BnSize is set to the required buffer size to obtain the key.
> +
> + If RsaContext is NULL, then return FALSE.
> + If BnSize is NULL, then return FALSE.
> + If BnSize is large enough but BigNumber is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] RsaContext Pointer to RSA context being set.
> + @param[in] KeyTag Tag of RSA key component being set.
> + @param[out] BigNumber Pointer to octet integer buffer.
> + @param[in, out] BnSize On input, the size of big number buffer in bytes.
> + On output, the size of data returned in big number buffer in
> bytes.
> +
> + @retval TRUE RSA key component was retrieved successfully.
> + @retval FALSE Invalid RSA key component tag.
> + @retval FALSE BnSize is too small.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_RSA_GET_KEY) (
> + IN OUT VOID *RsaContext,
> + IN RSA_KEY_TAG KeyTag,
> + OUT UINT8 *BigNumber,
> + IN OUT UINTN *BnSize
> + );
> +
> +/**
> + Generates RSA key components.
> +
> + This function generates RSA key components. It takes RSA public exponent E
> and
> + length in bits of RSA modulus N as input, and generates all key components.
> + If PublicExponent is NULL, the default RSA public exponent (0x10001) will be
> used.
> +
> + Before this function can be invoked, pseudorandom number generator must
> be correctly
> + initialized by RandomSeed().
> +
> + If RsaContext is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] RsaContext Pointer to RSA context being set.
> + @param[in] ModulusLength Length of RSA modulus N in bits.
> + @param[in] PublicExponent Pointer to RSA public exponent.
> + @param[in] PublicExponentSize Size of RSA public exponent buffer in
> bytes.
> +
> + @retval TRUE RSA key component was generated successfully.
> + @retval FALSE Invalid RSA key component tag.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_RSA_GENERATE_KEY) (
> + IN OUT VOID *RsaContext,
> + IN UINTN ModulusLength,
> + IN CONST UINT8 *PublicExponent,
> + IN UINTN PublicExponentSize
> + );
> +
> +/**
> + Validates key components of RSA context.
> + NOTE: This function performs integrity checks on all the RSA key material, so
> + the RSA key structure must contain all the private key data.
> +
> + This function validates key components of RSA context in following aspects:
> + - Whether p is a prime
> + - Whether q is a prime
> + - Whether n = p * q
> + - Whether d*e = 1 mod lcm(p-1,q-1)
> +
> + If RsaContext is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] RsaContext Pointer to RSA context to check.
> +
> + @retval TRUE RSA key components are valid.
> + @retval FALSE RSA key components are not valid.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_RSA_CHECK_KEY) (
> + IN VOID *RsaContext
> + );
> +
> +/**
> + Carries out the RSA-SSA signature generation with EMSA-PKCS1-v1_5
> encoding scheme.
> +
> + This function carries out the RSA-SSA signature generation with EMSA-PKCS1-
> v1_5 encoding scheme defined in
> + RSA PKCS#1.
> + If the Signature buffer is too small to hold the contents of signature, FALSE
> + is returned and SigSize is set to the required buffer size to obtain the signature.
> +
> + If RsaContext is NULL, then return FALSE.
> + If MessageHash is NULL, then return FALSE.
> + If HashSize is not equal to the size of MD5, SHA-1 or SHA-256 digest, then
> return FALSE.
> + If SigSize is large enough but Signature is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] RsaContext Pointer to RSA context for signature generation.
> + @param[in] MessageHash Pointer to octet message hash to be signed.
> + @param[in] HashSize Size of the message hash in bytes.
> + @param[out] Signature Pointer to buffer to receive RSA PKCS1-v1_5
> signature.
> + @param[in, out] SigSize On input, the size of Signature buffer in bytes.
> + On output, the size of data returned in Signature buffer in
> bytes.
> +
> + @retval TRUE Signature successfully generated in PKCS1-v1_5.
> + @retval FALSE Signature generation failed.
> + @retval FALSE SigSize is too small.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_RSA_PKCS1_SIGN) (
> + IN VOID *RsaContext,
> + IN CONST UINT8 *MessageHash,
> + IN UINTN HashSize,
> + OUT UINT8 *Signature,
> + IN OUT UINTN *SigSize
> + );
> +
> +/**
> + Verifies the RSA-SSA signature with EMSA-PKCS1-v1_5 encoding scheme
> defined in
> + RSA PKCS#1.
> +
> + If RsaContext is NULL, then return FALSE.
> + If MessageHash is NULL, then return FALSE.
> + If Signature is NULL, then return FALSE.
> + If HashSize is not equal to the size of MD5, SHA-1, SHA-256 digest, then return
> FALSE.
> +
> + @param[in] RsaContext Pointer to RSA context for signature verification.
> + @param[in] MessageHash Pointer to octet message hash to be checked.
> + @param[in] HashSize Size of the message hash in bytes.
> + @param[in] Signature Pointer to RSA PKCS1-v1_5 signature to be verified.
> + @param[in] SigSize Size of signature in bytes.
> +
> + @retval TRUE Valid signature encoded in PKCS1-v1_5.
> + @retval FALSE Invalid signature or invalid RSA context.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_RSA_PKCS1_VERIFY) (
> + IN VOID *RsaContext,
> + IN CONST UINT8 *MessageHash,
> + IN UINTN HashSize,
> + IN CONST UINT8 *Signature,
> + IN UINTN SigSize
> + );
> +
> +/**
> + Retrieve the RSA Private Key from the password-protected PEM key data.
> +
> + If PemData is NULL, then return FALSE.
> + If RsaContext is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] PemData Pointer to the PEM-encoded key data to be
> retrieved.
> + @param[in] PemSize Size of the PEM key data in bytes.
> + @param[in] Password NULL-terminated passphrase used for encrypted
> PEM key data.
> + @param[out] RsaContext Pointer to new-generated RSA context which
> contain the retrieved
> + RSA private key component. Use RsaFree() function to free the
> + resource.
> +
> + @retval TRUE RSA Private Key was retrieved successfully.
> + @retval FALSE Invalid PEM key data or incorrect password.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_RSA_GET_PRIVATE_KEY_FROM_PEM) (
> + IN CONST UINT8 *PemData,
> + IN UINTN PemSize,
> + IN CONST CHAR8 *Password,
> + OUT VOID **RsaContext
> + );
> +
> +/**
> + Retrieve the RSA Public Key from one DER-encoded X509 certificate.
> +
> + If Cert is NULL, then return FALSE.
> + If RsaContext is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] Cert Pointer to the DER-encoded X509 certificate.
> + @param[in] CertSize Size of the X509 certificate in bytes.
> + @param[out] RsaContext Pointer to new-generated RSA context which
> contain the retrieved
> + RSA public key component. Use RsaFree() function to free the
> + resource.
> +
> + @retval TRUE RSA Public Key was retrieved successfully.
> + @retval FALSE Fail to retrieve RSA public key from X509 certificate.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_RSA_GET_PUBLIC_KEY_FROM_X509) (
> + IN CONST UINT8 *Cert,
> + IN UINTN CertSize,
> + OUT VOID **RsaContext
> + );
> +
> +//----------------------------------------
> +// SHA
> +//----------------------------------------
> +
> +/**
> + Retrieves the size, in bytes, of the context buffer required for SHA-1 hash
> operations.
> +
> + If this interface is not supported, then return zero.
> +
> + @return The size, in bytes, of the context buffer required for SHA-1 hash
> operations.
> + @retval 0 This interface is not supported.
> +
> +**/
> +typedef
> +UINTN
> +(EFIAPI *EDKII_CRYPTO_SHA1_GET_CONTEXT_SIZE ) (
> + VOID
> + );
> +
> +/**
> + Initializes user-supplied memory pointed by Sha1Context as SHA-1 hash
> context for
> + subsequent use.
> +
> + If Sha1Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[out] Sha1Context Pointer to SHA-1 context being initialized.
> +
> + @retval TRUE SHA-1 context initialization succeeded.
> + @retval FALSE SHA-1 context initialization failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_SHA1_INIT ) (
> + OUT VOID *Sha1Context
> + );
> +
> +/**
> + Makes a copy of an existing SHA-1 context.
> +
> + If Sha1Context is NULL, then return FALSE.
> + If NewSha1Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] Sha1Context Pointer to SHA-1 context being copied.
> + @param[out] NewSha1Context Pointer to new SHA-1 context.
> +
> + @retval TRUE SHA-1 context copy succeeded.
> + @retval FALSE SHA-1 context copy failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_SHA1_DUPLICATE ) (
> + IN CONST VOID *Sha1Context,
> + OUT VOID *NewSha1Context
> + );
> +
> +/**
> + Digests the input data and updates SHA-1 context.
> +
> + This function performs SHA-1 digest on a data buffer of the specified size.
> + It can be called multiple times to compute the digest of long or discontinuous
> data streams.
> + SHA-1 context should be already correctly initialized by Sha1Init(), and should
> not be finalized
> + by Sha1Final(). Behavior with invalid context is undefined.
> +
> + If Sha1Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] Sha1Context Pointer to the SHA-1 context.
> + @param[in] Data Pointer to the buffer containing the data to be
> hashed.
> + @param[in] DataSize Size of Data buffer in bytes.
> +
> + @retval TRUE SHA-1 data digest succeeded.
> + @retval FALSE SHA-1 data digest failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_SHA1_UPDATE ) (
> + IN OUT VOID *Sha1Context,
> + IN CONST VOID *Data,
> + IN UINTN DataSize
> + );
> +
> +/**
> + Completes computation of the SHA-1 digest value.
> +
> + This function completes SHA-1 hash computation and retrieves the digest
> value into
> + the specified memory. After this function has been called, the SHA-1 context
> cannot
> + be used again.
> + SHA-1 context should be already correctly initialized by Sha1Init(), and should
> not be
> + finalized by Sha1Final(). Behavior with invalid SHA-1 context is undefined.
> +
> + If Sha1Context is NULL, then return FALSE.
> + If HashValue is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] Sha1Context Pointer to the SHA-1 context.
> + @param[out] HashValue Pointer to a buffer that receives the SHA-1
> digest
> + value (20 bytes).
> +
> + @retval TRUE SHA-1 digest computation succeeded.
> + @retval FALSE SHA-1 digest computation failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_SHA1_FINAL ) (
> + IN OUT VOID *Sha1Context,
> + OUT UINT8 *HashValue
> + );
> +
> +/**
> + Computes the SHA-1 message digest of a input data buffer.
> +
> + This function performs the SHA-1 message digest of a given data buffer, and
> places
> + the digest value into the specified memory.
> +
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] Data Pointer to the buffer containing the data to be hashed.
> + @param[in] DataSize Size of Data buffer in bytes.
> + @param[out] HashValue Pointer to a buffer that receives the SHA-1 digest
> + value (20 bytes).
> +
> + @retval TRUE SHA-1 digest computation succeeded.
> + @retval FALSE SHA-1 digest computation failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_SHA1_HASH_ALL ) (
> + IN CONST VOID *Data,
> + IN UINTN DataSize,
> + OUT UINT8 *HashValue
> + );
> +
> +/**
> + Retrieves the size, in bytes, of the context buffer required for SHA-256 hash
> operations.
> +
> + @return The size, in bytes, of the context buffer required for SHA-256 hash
> operations.
> +
> +**/
> +typedef
> +UINTN
> +(EFIAPI *EDKII_CRYPTO_SHA256_GET_CONTEXT_SIZE ) (
> + VOID
> +);
> +
> +/**
> + Initializes user-supplied memory pointed by Sha256Context as SHA-256 hash
> context for
> + subsequent use.
> +
> + If Sha256Context is NULL, then return FALSE.
> +
> + @param[out] Sha256Context Pointer to SHA-256 context being initialized.
> +
> + @retval TRUE SHA-256 context initialization succeeded.
> + @retval FALSE SHA-256 context initialization failed.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_SHA256_INIT ) (
> + OUT VOID *Sha256Context
> + );
> +
> +/**
> + Makes a copy of an existing SHA-256 context.
> +
> + If Sha256Context is NULL, then return FALSE.
> + If NewSha256Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] Sha256Context Pointer to SHA-256 context being copied.
> + @param[out] NewSha256Context Pointer to new SHA-256 context.
> +
> + @retval TRUE SHA-256 context copy succeeded.
> + @retval FALSE SHA-256 context copy failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_SHA256_DUPLICATE ) (
> + IN CONST VOID *Sha256Context,
> + OUT VOID *NewSha256Context
> + );
> +
> +/**
> + Digests the input data and updates SHA-256 context.
> +
> + This function performs SHA-256 digest on a data buffer of the specified size.
> + It can be called multiple times to compute the digest of long or discontinuous
> data streams.
> + SHA-256 context should be already correctly initialized by Sha256Init(), and
> should not be finalized
> + by Sha256Final(). Behavior with invalid context is undefined.
> +
> + If Sha256Context is NULL, then return FALSE.
> +
> + @param[in, out] Sha256Context Pointer to the SHA-256 context.
> + @param[in] Data Pointer to the buffer containing the data to be
> hashed.
> + @param[in] DataSize Size of Data buffer in bytes.
> +
> + @retval TRUE SHA-256 data digest succeeded.
> + @retval FALSE SHA-256 data digest failed.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_SHA256_UPDATE ) (
> + IN OUT VOID *Sha256Context,
> + IN CONST VOID *Data,
> + IN UINTN DataSize
> + );
> +
> +/**
> + Completes computation of the SHA-256 digest value.
> +
> + This function completes SHA-256 hash computation and retrieves the digest
> value into
> + the specified memory. After this function has been called, the SHA-256
> context cannot
> + be used again.
> + SHA-256 context should be already correctly initialized by Sha256Init(), and
> should not be
> + finalized by Sha256Final(). Behavior with invalid SHA-256 context is undefined.
> +
> + If Sha256Context is NULL, then return FALSE.
> + If HashValue is NULL, then return FALSE.
> +
> + @param[in, out] Sha256Context Pointer to the SHA-256 context.
> + @param[out] HashValue Pointer to a buffer that receives the SHA-256
> digest
> + value (32 bytes).
> +
> + @retval TRUE SHA-256 digest computation succeeded.
> + @retval FALSE SHA-256 digest computation failed.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_SHA256_FINAL ) (
> + IN OUT VOID *Sha256Context,
> + OUT UINT8 *HashValue
> + );
> +
> +/**
> + Computes the SHA-256 message digest of a input data buffer.
> +
> + This function performs the SHA-256 message digest of a given data buffer,
> and places
> + the digest value into the specified memory.
> +
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] Data Pointer to the buffer containing the data to be hashed.
> + @param[in] DataSize Size of Data buffer in bytes.
> + @param[out] HashValue Pointer to a buffer that receives the SHA-256
> digest
> + value (32 bytes).
> +
> + @retval TRUE SHA-256 digest computation succeeded.
> + @retval FALSE SHA-256 digest computation failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_SHA256_HASH_ALL ) (
> + IN CONST VOID *Data,
> + IN UINTN DataSize,
> + OUT UINT8 *HashValue
> + );
> +
> +
> +/**
> + Retrieves the size, in bytes, of the context buffer required for SHA-384 hash
> operations.
> + If this interface is not supported, then return zero.
> +
> + @return The size, in bytes, of the context buffer required for SHA-384 hash
> operations.
> + @retval 0 This interface is not supported.
> +
> +**/
> +typedef
> +UINTN
> +(EFIAPI *EDKII_CRYPTO_SHA384_GET_CONTEXT_SIZE) (
> + VOID
> + );
> +
> +
> +/**
> + Initializes user-supplied memory pointed by Sha384Context as SHA-384 hash
> context for
> + subsequent use.
> +
> + If Sha384Context is NULL, then return FALSE.
> +
> + @param[out] Sha384Context Pointer to SHA-384 context being initialized.
> +
> + @retval TRUE SHA-384 context initialization succeeded.
> + @retval FALSE SHA-384 context initialization failed.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_SHA384_INIT) (
> + OUT VOID *Sha384Context
> + );
> +
> +
> +/**
> + Makes a copy of an existing SHA-384 context.
> +
> + If Sha384Context is NULL, then return FALSE.
> + If NewSha384Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] Sha384Context Pointer to SHA-384 context being copied.
> + @param[out] NewSha384Context Pointer to new SHA-384 context.
> +
> + @retval TRUE SHA-384 context copy succeeded.
> + @retval FALSE SHA-384 context copy failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_SHA384_DUPLICATE) (
> + IN CONST VOID *Sha384Context,
> + OUT VOID *NewSha384Context
> + );
> +
> +
> +/**
> + Digests the input data and updates SHA-384 context.
> +
> + This function performs SHA-384 digest on a data buffer of the specified size.
> + It can be called multiple times to compute the digest of long or discontinuous
> data streams.
> + SHA-384 context should be already correctly initialized by Sha384Init(), and
> should not be finalized
> + by Sha384Final(). Behavior with invalid context is undefined.
> +
> + If Sha384Context is NULL, then return FALSE.
> +
> + @param[in, out] Sha384Context Pointer to the SHA-384 context.
> + @param[in] Data Pointer to the buffer containing the data to be
> hashed.
> + @param[in] DataSize Size of Data buffer in bytes.
> +
> + @retval TRUE SHA-384 data digest succeeded.
> + @retval FALSE SHA-384 data digest failed.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_SHA384_UPDATE) (
> + IN OUT VOID *Sha384Context,
> + IN CONST VOID *Data,
> + IN UINTN DataSize
> + );
> +
> +
> +/**
> + Completes computation of the SHA-384 digest value.
> +
> + This function completes SHA-384 hash computation and retrieves the digest
> value into
> + the specified memory. After this function has been called, the SHA-384
> context cannot
> + be used again.
> + SHA-384 context should be already correctly initialized by Sha384Init(), and
> should not be
> + finalized by Sha384Final(). Behavior with invalid SHA-384 context is undefined.
> +
> + If Sha384Context is NULL, then return FALSE.
> + If HashValue is NULL, then return FALSE.
> +
> + @param[in, out] Sha384Context Pointer to the SHA-384 context.
> + @param[out] HashValue Pointer to a buffer that receives the SHA-384
> digest
> + value (48 bytes).
> +
> + @retval TRUE SHA-384 digest computation succeeded.
> + @retval FALSE SHA-384 digest computation failed.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_SHA384_FINAL) (
> + IN OUT VOID *Sha384Context,
> + OUT UINT8 *HashValue
> + );
> +
> +
> +/**
> + Computes the SHA-384 message digest of a input data buffer.
> +
> + This function performs the SHA-384 message digest of a given data buffer,
> and places
> + the digest value into the specified memory.
> +
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] Data Pointer to the buffer containing the data to be hashed.
> + @param[in] DataSize Size of Data buffer in bytes.
> + @param[out] HashValue Pointer to a buffer that receives the SHA-384
> digest
> + value (48 bytes).
> +
> + @retval TRUE SHA-384 digest computation succeeded.
> + @retval FALSE SHA-384 digest computation failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_SHA384_HASH_ALL) (
> + IN CONST VOID *Data,
> + IN UINTN DataSize,
> + OUT UINT8 *HashValue
> + );
> +
> +/**
> + Retrieves the size, in bytes, of the context buffer required for SHA-512 hash
> operations.
> +
> + @return The size, in bytes, of the context buffer required for SHA-512 hash
> operations.
> +
> +**/
> +typedef
> +UINTN
> +(EFIAPI *EDKII_CRYPTO_SHA512_GET_CONTEXT_SIZE) (
> + VOID
> + );
> +
> +
> +/**
> + Initializes user-supplied memory pointed by Sha512Context as SHA-512 hash
> context for
> + subsequent use.
> +
> + If Sha512Context is NULL, then return FALSE.
> +
> + @param[out] Sha512Context Pointer to SHA-512 context being initialized.
> +
> + @retval TRUE SHA-512 context initialization succeeded.
> + @retval FALSE SHA-512 context initialization failed.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_SHA512_INIT) (
> + OUT VOID *Sha512Context
> + );
> +
> +
> +/**
> + Makes a copy of an existing SHA-512 context.
> +
> + If Sha512Context is NULL, then return FALSE.
> + If NewSha512Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] Sha512Context Pointer to SHA-512 context being copied.
> + @param[out] NewSha512Context Pointer to new SHA-512 context.
> +
> + @retval TRUE SHA-512 context copy succeeded.
> + @retval FALSE SHA-512 context copy failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_SHA512_DUPLICATE) (
> + IN CONST VOID *Sha512Context,
> + OUT VOID *NewSha512Context
> + );
> +
> +/**
> + Digests the input data and updates SHA-512 context.
> +
> + This function performs SHA-512 digest on a data buffer of the specified size.
> + It can be called multiple times to compute the digest of long or discontinuous
> data streams.
> + SHA-512 context should be already correctly initialized by Sha512Init(), and
> should not be finalized
> + by Sha512Final(). Behavior with invalid context is undefined.
> +
> + If Sha512Context is NULL, then return FALSE.
> +
> + @param[in, out] Sha512Context Pointer to the SHA-512 context.
> + @param[in] Data Pointer to the buffer containing the data to be
> hashed.
> + @param[in] DataSize Size of Data buffer in bytes.
> +
> + @retval TRUE SHA-512 data digest succeeded.
> + @retval FALSE SHA-512 data digest failed.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_SHA512_UPDATE) (
> + IN OUT VOID *Sha512Context,
> + IN CONST VOID *Data,
> + IN UINTN DataSize
> + );
> +
> +
> +/**
> + Completes computation of the SHA-512 digest value.
> +
> + This function completes SHA-512 hash computation and retrieves the digest
> value into
> + the specified memory. After this function has been called, the SHA-512
> context cannot
> + be used again.
> + SHA-512 context should be already correctly initialized by Sha512Init(), and
> should not be
> + finalized by Sha512Final(). Behavior with invalid SHA-512 context is undefined.
> +
> + If Sha512Context is NULL, then return FALSE.
> + If HashValue is NULL, then return FALSE.
> +
> + @param[in, out] Sha512Context Pointer to the SHA-512 context.
> + @param[out] HashValue Pointer to a buffer that receives the SHA-512
> digest
> + value (64 bytes).
> +
> + @retval TRUE SHA-512 digest computation succeeded.
> + @retval FALSE SHA-512 digest computation failed.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_SHA512_FINAL) (
> + IN OUT VOID *Sha512Context,
> + OUT UINT8 *HashValue
> + );
> +
> +/**
> + Computes the SHA-512 message digest of a input data buffer.
> +
> + This function performs the SHA-512 message digest of a given data buffer,
> and places
> + the digest value into the specified memory.
> +
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] Data Pointer to the buffer containing the data to be hashed.
> + @param[in] DataSize Size of Data buffer in bytes.
> + @param[out] HashValue Pointer to a buffer that receives the SHA-512
> digest
> + value (64 bytes).
> +
> + @retval TRUE SHA-512 digest computation succeeded.
> + @retval FALSE SHA-512 digest computation failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_SHA512_HASH_ALL) (
> + IN CONST VOID *Data,
> + IN UINTN DataSize,
> + OUT UINT8 *HashValue
> + );
> +
> +//----------------------------------------------------------------------------
> +// X509
> +//----------------------------------------------------------------------------
> +
> +/**
> + Retrieve the subject bytes from one X.509 certificate.
> +
> + If Cert is NULL, then return FALSE.
> + If SubjectSize is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] Cert Pointer to the DER-encoded X509 certificate.
> + @param[in] CertSize Size of the X509 certificate in bytes.
> + @param[out] CertSubject Pointer to the retrieved certificate subject bytes.
> + @param[in, out] SubjectSize The size in bytes of the CertSubject buffer on
> input,
> + and the size of buffer returned CertSubject on output.
> +
> + @retval TRUE The certificate subject retrieved successfully.
> + @retval FALSE Invalid certificate, or the SubjectSize is too small for the result.
> + The SubjectSize will be updated with the required size.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_X509_GET_SUBJECT_NAME) (
> + IN CONST UINT8 *Cert,
> + IN UINTN CertSize,
> + OUT UINT8 *CertSubject,
> + IN OUT UINTN *SubjectSize
> + );
> +
> +/**
> + Retrieve the common name (CN) string from one X.509 certificate.
> +
> + @param[in] Cert Pointer to the DER-encoded X509 certificate.
> + @param[in] CertSize Size of the X509 certificate in bytes.
> + @param[out] CommonName Buffer to contain the retrieved certificate
> common
> + name string (UTF8). At most CommonNameSize bytes will
> be
> + written and the string will be null terminated. May be
> + NULL in order to determine the size buffer needed.
> + @param[in,out] CommonNameSize The size in bytes of the CommonName
> buffer on input,
> + and the size of buffer returned CommonName on output.
> + If CommonName is NULL then the amount of space needed
> + in buffer (including the final null) is returned.
> +
> + @retval RETURN_SUCCESS The certificate CommonName retrieved
> successfully.
> + @retval RETURN_INVALID_PARAMETER If Cert is NULL.
> + If CommonNameSize is NULL.
> + If CommonName is not NULL and *CommonNameSize is 0.
> + If Certificate is invalid.
> + @retval RETURN_NOT_FOUND If no CommonName entry exists.
> + @retval RETURN_BUFFER_TOO_SMALL If the CommonName is NULL. The
> required buffer size
> + (including the final null) is returned in the
> + CommonNameSize parameter.
> + @retval RETURN_UNSUPPORTED The operation is not supported.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI *EDKII_CRYPTO_X509_GET_COMMON_NAME) (
> + IN CONST UINT8 *Cert,
> + IN UINTN CertSize,
> + OUT CHAR8 *CommonName, OPTIONAL
> + IN OUT UINTN *CommonNameSize
> + );
> +
> +/**
> + Retrieve the organization name (O) string from one X.509 certificate.
> +
> + @param[in] Cert Pointer to the DER-encoded X509 certificate.
> + @param[in] CertSize Size of the X509 certificate in bytes.
> + @param[out] NameBuffer Buffer to contain the retrieved certificate
> organization
> + name string. At most NameBufferSize bytes will be
> + written and the string will be null terminated. May be
> + NULL in order to determine the size buffer needed.
> + @param[in,out] NameBufferSiz e The size in bytes of the Name buffer on
> input,
> + and the size of buffer returned Name on output.
> + If NameBuffer is NULL then the amount of space needed
> + in buffer (including the final null) is returned.
> +
> + @retval RETURN_SUCCESS The certificate Organization Name retrieved
> successfully.
> + @retval RETURN_INVALID_PARAMETER If Cert is NULL.
> + If NameBufferSize is NULL.
> + If NameBuffer is not NULL and *CommonNameSize is 0.
> + If Certificate is invalid.
> + @retval RETURN_NOT_FOUND If no Organization Name entry exists.
> + @retval RETURN_BUFFER_TOO_SMALL If the NameBuffer is NULL. The
> required buffer size
> + (including the final null) is returned in the
> + CommonNameSize parameter.
> + @retval RETURN_UNSUPPORTED The operation is not supported.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI *EDKII_CRYPTO_X509_GET_ORGANIZATION_NAME) (
> + IN CONST UINT8 *Cert,
> + IN UINTN CertSize,
> + OUT CHAR8 *NameBuffer, OPTIONAL
> + IN OUT UINTN *NameBufferSize
> + );
> +
> +/**
> + Verify one X509 certificate was issued by the trusted CA.
> +
> + If Cert is NULL, then return FALSE.
> + If CACert is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] Cert Pointer to the DER-encoded X509 certificate to be
> verified.
> + @param[in] CertSize Size of the X509 certificate in bytes.
> + @param[in] CACert Pointer to the DER-encoded trusted CA certificate.
> + @param[in] CACertSize Size of the CA Certificate in bytes.
> +
> + @retval TRUE The certificate was issued by the trusted CA.
> + @retval FALSE Invalid certificate or the certificate was not issued by the
> given
> + trusted CA.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_X509_VERIFY_CERT) (
> + IN CONST UINT8 *Cert,
> + IN UINTN CertSize,
> + IN CONST UINT8 *CACert,
> + IN UINTN CACertSize
> + );
> +
> +/**
> + Construct a X509 object from DER-encoded certificate data.
> +
> + If Cert is NULL, then return FALSE.
> + If SingleX509Cert is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] Cert Pointer to the DER-encoded certificate data.
> + @param[in] CertSize The size of certificate data in bytes.
> + @param[out] SingleX509Cert The generated X509 object.
> +
> + @retval TRUE The X509 object generation succeeded.
> + @retval FALSE The operation failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_X509_CONSTRUCT_CERTIFICATE) (
> + IN CONST UINT8 *Cert,
> + IN UINTN CertSize,
> + OUT UINT8 **SingleX509Cert
> + );
> +
> +/**
> + Construct a X509 stack object from a list of DER-encoded certificate data.
> +
> + If X509Stack is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] X509Stack On input, pointer to an existing or NULL X509
> stack object.
> + On output, pointer to the X509 stack object with new
> + inserted X509 certificate.
> + @param ... A list of DER-encoded single certificate data followed
> + by certificate size. A NULL terminates the list. The
> + pairs are the arguments to X509ConstructCertificate().
> +
> + @retval TRUE The X509 stack construction succeeded.
> + @retval FALSE The construction operation failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_X509_CONSTRUCT_CERTIFICATE_STACK) (
> + IN OUT UINT8 **X509Stack,
> + ...
> + );
> +
> +/**
> + Construct a X509 stack object from a list of DER-encoded certificate data.
> +
> + If X509Stack is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] X509Stack On input, pointer to an existing or NULL X509
> stack object.
> + On output, pointer to the X509 stack object with new
> + inserted X509 certificate.
> + @param[in] Args VA_LIST marker for the variable argument list.
> + A list of DER-encoded single certificate data followed
> + by certificate size. A NULL terminates the list. The
> + pairs are the arguments to X509ConstructCertificate().
> +
> + @retval TRUE The X509 stack construction succeeded.
> + @retval FALSE The construction operation failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_X509_CONSTRUCT_CERTIFICATE_STACK_V) (
> + IN OUT UINT8 **X509Stack,
> + IN VA_LIST Args
> + );
> +
> +/**
> + Release the specified X509 object.
> +
> + If the interface is not supported, then ASSERT().
> +
> + @param[in] X509Cert Pointer to the X509 object to be released.
> +
> +**/
> +typedef
> +VOID
> +(EFIAPI *EDKII_CRYPTO_X509_FREE) (
> + IN VOID *X509Cert
> + );
> +
> +/**
> + Release the specified X509 stack object.
> +
> + If the interface is not supported, then ASSERT().
> +
> + @param[in] X509Stack Pointer to the X509 stack object to be released.
> +
> +**/
> +typedef
> +VOID
> +(EFIAPI *EDKII_CRYPTO_X509_STACK_FREE) (
> + IN VOID *X509Stack
> + );
> +
> +/**
> + Retrieve the TBSCertificate from one given X.509 certificate.
> +
> + @param[in] Cert Pointer to the given DER-encoded X509 certificate.
> + @param[in] CertSize Size of the X509 certificate in bytes.
> + @param[out] TBSCert DER-Encoded To-Be-Signed certificate.
> + @param[out] TBSCertSize Size of the TBS certificate in bytes.
> +
> + If Cert is NULL, then return FALSE.
> + If TBSCert is NULL, then return FALSE.
> + If TBSCertSize is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @retval TRUE The TBSCertificate was retrieved successfully.
> + @retval FALSE Invalid X.509 certificate.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_X509_GET_TBS_CERT) (
> + IN CONST UINT8 *Cert,
> + IN UINTN CertSize,
> + OUT UINT8 **TBSCert,
> + OUT UINTN *TBSCertSize
> + );
> +
> +
> +
> +//==============================================================
> =======================
> +// Symmetric Cryptography Primitive
> +//==============================================================
> =======================
> +
> +/**
> + Retrieves the size, in bytes, of the context buffer required for TDES operations.
> +
> + If this interface is not supported, then return zero.
> +
> + @return The size, in bytes, of the context buffer required for TDES operations.
> + @retval 0 This interface is not supported.
> +
> +**/
> +typedef
> +UINTN
> +(EFIAPI *EDKII_CRYPTO_TDES_GET_CONTEXT_SIZE) (
> + VOID
> + );
> +
> +/**
> + Initializes user-supplied memory as TDES context for subsequent use.
> +
> + This function initializes user-supplied memory pointed by TdesContext as TDES
> context.
> + In addition, it sets up all TDES key materials for subsequent encryption and
> decryption
> + operations.
> + There are 3 key options as follows:
> + KeyLength = 64, Keying option 1: K1 == K2 == K3 (Backward compatibility with
> DES)
> + KeyLength = 128, Keying option 2: K1 != K2 and K3 = K1 (Less Security)
> + KeyLength = 192 Keying option 3: K1 != K2 != K3 (Strongest)
> +
> + If TdesContext is NULL, then return FALSE.
> + If Key is NULL, then return FALSE.
> + If KeyLength is not valid, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[out] TdesContext Pointer to TDES context being initialized.
> + @param[in] Key Pointer to the user-supplied TDES key.
> + @param[in] KeyLength Length of TDES key in bits.
> +
> + @retval TRUE TDES context initialization succeeded.
> + @retval FALSE TDES context initialization failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_TDES_INIT) (
> + OUT VOID *TdesContext,
> + IN CONST UINT8 *Key,
> + IN UINTN KeyLength
> + );
> +
> +/**
> + Performs TDES encryption on a data buffer of the specified size in ECB mode.
> +
> + This function performs TDES encryption on data buffer pointed by Input, of
> specified
> + size of InputSize, in ECB mode.
> + InputSize must be multiple of block size (8 bytes). This function does not
> perform
> + padding. Caller must perform padding, if necessary, to ensure valid input data
> size.
> + TdesContext should be already correctly initialized by TdesInit(). Behavior with
> + invalid TDES context is undefined.
> +
> + If TdesContext is NULL, then return FALSE.
> + If Input is NULL, then return FALSE.
> + If InputSize is not multiple of block size (8 bytes), then return FALSE.
> + If Output is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] TdesContext Pointer to the TDES context.
> + @param[in] Input Pointer to the buffer containing the data to be
> encrypted.
> + @param[in] InputSize Size of the Input buffer in bytes.
> + @param[out] Output Pointer to a buffer that receives the TDES encryption
> output.
> +
> + @retval TRUE TDES encryption succeeded.
> + @retval FALSE TDES encryption failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_TDES_ECB_ENCRYPT) (
> + IN VOID *TdesContext,
> + IN CONST UINT8 *Input,
> + IN UINTN InputSize,
> + OUT UINT8 *Output
> + );
> +
> +/**
> + Performs TDES decryption on a data buffer of the specified size in ECB mode.
> +
> + This function performs TDES decryption on data buffer pointed by Input, of
> specified
> + size of InputSize, in ECB mode.
> + InputSize must be multiple of block size (8 bytes). This function does not
> perform
> + padding. Caller must perform padding, if necessary, to ensure valid input data
> size.
> + TdesContext should be already correctly initialized by TdesInit(). Behavior with
> + invalid TDES context is undefined.
> +
> + If TdesContext is NULL, then return FALSE.
> + If Input is NULL, then return FALSE.
> + If InputSize is not multiple of block size (8 bytes), then return FALSE.
> + If Output is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] TdesContext Pointer to the TDES context.
> + @param[in] Input Pointer to the buffer containing the data to be
> decrypted.
> + @param[in] InputSize Size of the Input buffer in bytes.
> + @param[out] Output Pointer to a buffer that receives the TDES decryption
> output.
> +
> + @retval TRUE TDES decryption succeeded.
> + @retval FALSE TDES decryption failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_TDES_ECB_DECRYPT) (
> + IN VOID *TdesContext,
> + IN CONST UINT8 *Input,
> + IN UINTN InputSize,
> + OUT UINT8 *Output
> + );
> +
> +/**
> + Performs TDES encryption on a data buffer of the specified size in CBC mode.
> +
> + This function performs TDES encryption on data buffer pointed by Input, of
> specified
> + size of InputSize, in CBC mode.
> + InputSize must be multiple of block size (8 bytes). This function does not
> perform
> + padding. Caller must perform padding, if necessary, to ensure valid input data
> size.
> + Initialization vector should be one block size (8 bytes).
> + TdesContext should be already correctly initialized by TdesInit(). Behavior with
> + invalid TDES context is undefined.
> +
> + If TdesContext is NULL, then return FALSE.
> + If Input is NULL, then return FALSE.
> + If InputSize is not multiple of block size (8 bytes), then return FALSE.
> + If Ivec is NULL, then return FALSE.
> + If Output is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] TdesContext Pointer to the TDES context.
> + @param[in] Input Pointer to the buffer containing the data to be
> encrypted.
> + @param[in] InputSize Size of the Input buffer in bytes.
> + @param[in] Ivec Pointer to initialization vector.
> + @param[out] Output Pointer to a buffer that receives the TDES encryption
> output.
> +
> + @retval TRUE TDES encryption succeeded.
> + @retval FALSE TDES encryption failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_TDES_CBC_ENCRYPT) (
> + IN VOID *TdesContext,
> + IN CONST UINT8 *Input,
> + IN UINTN InputSize,
> + IN CONST UINT8 *Ivec,
> + OUT UINT8 *Output
> + );
> +
> +/**
> + Performs TDES decryption on a data buffer of the specified size in CBC mode.
> +
> + This function performs TDES decryption on data buffer pointed by Input, of
> specified
> + size of InputSize, in CBC mode.
> + InputSize must be multiple of block size (8 bytes). This function does not
> perform
> + padding. Caller must perform padding, if necessary, to ensure valid input data
> size.
> + Initialization vector should be one block size (8 bytes).
> + TdesContext should be already correctly initialized by TdesInit(). Behavior with
> + invalid TDES context is undefined.
> +
> + If TdesContext is NULL, then return FALSE.
> + If Input is NULL, then return FALSE.
> + If InputSize is not multiple of block size (8 bytes), then return FALSE.
> + If Ivec is NULL, then return FALSE.
> + If Output is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] TdesContext Pointer to the TDES context.
> + @param[in] Input Pointer to the buffer containing the data to be
> encrypted.
> + @param[in] InputSize Size of the Input buffer in bytes.
> + @param[in] Ivec Pointer to initialization vector.
> + @param[out] Output Pointer to a buffer that receives the TDES encryption
> output.
> +
> + @retval TRUE TDES decryption succeeded.
> + @retval FALSE TDES decryption failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_TDES_CBC_DECRYPT) (
> + IN VOID *TdesContext,
> + IN CONST UINT8 *Input,
> + IN UINTN InputSize,
> + IN CONST UINT8 *Ivec,
> + OUT UINT8 *Output
> + );
> +
> +/**
> + Retrieves the size, in bytes, of the context buffer required for AES operations.
> +
> + If this interface is not supported, then return zero.
> +
> + @return The size, in bytes, of the context buffer required for AES operations.
> + @retval 0 This interface is not supported.
> +
> +**/
> +typedef
> +UINTN
> +(EFIAPI *EDKII_CRYPTO_AES_GET_CONTEXT_SIZE) (
> + VOID
> + );
> +
> +/**
> + Initializes user-supplied memory as AES context for subsequent use.
> +
> + This function initializes user-supplied memory pointed by AesContext as AES
> context.
> + In addition, it sets up all AES key materials for subsequent encryption and
> decryption
> + operations.
> + There are 3 options for key length, 128 bits, 192 bits, and 256 bits.
> +
> + If AesContext is NULL, then return FALSE.
> + If Key is NULL, then return FALSE.
> + If KeyLength is not valid, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[out] AesContext Pointer to AES context being initialized.
> + @param[in] Key Pointer to the user-supplied AES key.
> + @param[in] KeyLength Length of AES key in bits.
> +
> + @retval TRUE AES context initialization succeeded.
> + @retval FALSE AES context initialization failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_AES_INIT) (
> + OUT VOID *AesContext,
> + IN CONST UINT8 *Key,
> + IN UINTN KeyLength
> + );
> +
> +/**
> + Performs AES encryption on a data buffer of the specified size in ECB mode.
> +
> + This function performs AES encryption on data buffer pointed by Input, of
> specified
> + size of InputSize, in ECB mode.
> + InputSize must be multiple of block size (16 bytes). This function does not
> perform
> + padding. Caller must perform padding, if necessary, to ensure valid input data
> size.
> + AesContext should be already correctly initialized by AesInit(). Behavior with
> + invalid AES context is undefined.
> +
> + If AesContext is NULL, then return FALSE.
> + If Input is NULL, then return FALSE.
> + If InputSize is not multiple of block size (16 bytes), then return FALSE.
> + If Output is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] AesContext Pointer to the AES context.
> + @param[in] Input Pointer to the buffer containing the data to be
> encrypted.
> + @param[in] InputSize Size of the Input buffer in bytes.
> + @param[out] Output Pointer to a buffer that receives the AES encryption
> output.
> +
> + @retval TRUE AES encryption succeeded.
> + @retval FALSE AES encryption failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_AES_ECB_ENCRYPT) (
> + IN VOID *AesContext,
> + IN CONST UINT8 *Input,
> + IN UINTN InputSize,
> + OUT UINT8 *Output
> + );
> +
> +/**
> + Performs AES decryption on a data buffer of the specified size in ECB mode.
> +
> + This function performs AES decryption on data buffer pointed by Input, of
> specified
> + size of InputSize, in ECB mode.
> + InputSize must be multiple of block size (16 bytes). This function does not
> perform
> + padding. Caller must perform padding, if necessary, to ensure valid input data
> size.
> + AesContext should be already correctly initialized by AesInit(). Behavior with
> + invalid AES context is undefined.
> +
> + If AesContext is NULL, then return FALSE.
> + If Input is NULL, then return FALSE.
> + If InputSize is not multiple of block size (16 bytes), then return FALSE.
> + If Output is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] AesContext Pointer to the AES context.
> + @param[in] Input Pointer to the buffer containing the data to be
> decrypted.
> + @param[in] InputSize Size of the Input buffer in bytes.
> + @param[out] Output Pointer to a buffer that receives the AES decryption
> output.
> +
> + @retval TRUE AES decryption succeeded.
> + @retval FALSE AES decryption failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_AES_ECB_DECRYPT) (
> + IN VOID *AesContext,
> + IN CONST UINT8 *Input,
> + IN UINTN InputSize,
> + OUT UINT8 *Output
> + );
> +
> +/**
> + Performs AES encryption on a data buffer of the specified size in CBC mode.
> +
> + This function performs AES encryption on data buffer pointed by Input, of
> specified
> + size of InputSize, in CBC mode.
> + InputSize must be multiple of block size (16 bytes). This function does not
> perform
> + padding. Caller must perform padding, if necessary, to ensure valid input data
> size.
> + Initialization vector should be one block size (16 bytes).
> + AesContext should be already correctly initialized by AesInit(). Behavior with
> + invalid AES context is undefined.
> +
> + If AesContext is NULL, then return FALSE.
> + If Input is NULL, then return FALSE.
> + If InputSize is not multiple of block size (16 bytes), then return FALSE.
> + If Ivec is NULL, then return FALSE.
> + If Output is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] AesContext Pointer to the AES context.
> + @param[in] Input Pointer to the buffer containing the data to be
> encrypted.
> + @param[in] InputSize Size of the Input buffer in bytes.
> + @param[in] Ivec Pointer to initialization vector.
> + @param[out] Output Pointer to a buffer that receives the AES encryption
> output.
> +
> + @retval TRUE AES encryption succeeded.
> + @retval FALSE AES encryption failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_AES_CBC_ENCRYPT) (
> + IN VOID *AesContext,
> + IN CONST UINT8 *Input,
> + IN UINTN InputSize,
> + IN CONST UINT8 *Ivec,
> + OUT UINT8 *Output
> + );
> +
> +/**
> + Performs AES decryption on a data buffer of the specified size in CBC mode.
> +
> + This function performs AES decryption on data buffer pointed by Input, of
> specified
> + size of InputSize, in CBC mode.
> + InputSize must be multiple of block size (16 bytes). This function does not
> perform
> + padding. Caller must perform padding, if necessary, to ensure valid input data
> size.
> + Initialization vector should be one block size (16 bytes).
> + AesContext should be already correctly initialized by AesInit(). Behavior with
> + invalid AES context is undefined.
> +
> + If AesContext is NULL, then return FALSE.
> + If Input is NULL, then return FALSE.
> + If InputSize is not multiple of block size (16 bytes), then return FALSE.
> + If Ivec is NULL, then return FALSE.
> + If Output is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] AesContext Pointer to the AES context.
> + @param[in] Input Pointer to the buffer containing the data to be
> encrypted.
> + @param[in] InputSize Size of the Input buffer in bytes.
> + @param[in] Ivec Pointer to initialization vector.
> + @param[out] Output Pointer to a buffer that receives the AES encryption
> output.
> +
> + @retval TRUE AES decryption succeeded.
> + @retval FALSE AES decryption failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_AES_CBC_DECRYPT) (
> + IN VOID *AesContext,
> + IN CONST UINT8 *Input,
> + IN UINTN InputSize,
> + IN CONST UINT8 *Ivec,
> + OUT UINT8 *Output
> + );
> +
> +/**
> + Retrieves the size, in bytes, of the context buffer required for ARC4 operations.
> +
> + If this interface is not supported, then return zero.
> +
> + @return The size, in bytes, of the context buffer required for ARC4 operations.
> + @retval 0 This interface is not supported.
> +
> +**/
> +typedef
> +UINTN
> +(EFIAPI *EDKII_CRYPTO_ARC4_GET_CONTEXT_SIZE) (
> + VOID
> + );
> +
> +/**
> + Initializes user-supplied memory as ARC4 context for subsequent use.
> +
> + This function initializes user-supplied memory pointed by Arc4Context as ARC4
> context.
> + In addition, it sets up all ARC4 key materials for subsequent encryption and
> decryption
> + operations.
> +
> + If Arc4Context is NULL, then return FALSE.
> + If Key is NULL, then return FALSE.
> + If KeySize does not in the range of [5, 256] bytes, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[out] Arc4Context Pointer to ARC4 context being initialized.
> + @param[in] Key Pointer to the user-supplied ARC4 key.
> + @param[in] KeySize Size of ARC4 key in bytes.
> +
> + @retval TRUE ARC4 context initialization succeeded.
> + @retval FALSE ARC4 context initialization failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_ARC4_INIT) (
> + OUT VOID *Arc4Context,
> + IN CONST UINT8 *Key,
> + IN UINTN KeySize
> + );
> +
> +/**
> + Performs ARC4 encryption on a data buffer of the specified size.
> +
> + This function performs ARC4 encryption on data buffer pointed by Input, of
> specified
> + size of InputSize.
> + Arc4Context should be already correctly initialized by Arc4Init(). Behavior with
> + invalid ARC4 context is undefined.
> +
> + If Arc4Context is NULL, then return FALSE.
> + If Input is NULL, then return FALSE.
> + If Output is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] Arc4Context Pointer to the ARC4 context.
> + @param[in] Input Pointer to the buffer containing the data to be
> encrypted.
> + @param[in] InputSize Size of the Input buffer in bytes.
> + @param[out] Output Pointer to a buffer that receives the ARC4
> encryption output.
> +
> + @retval TRUE ARC4 encryption succeeded.
> + @retval FALSE ARC4 encryption failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_ARC4_ENCRYPT) (
> + IN OUT VOID *Arc4Context,
> + IN CONST UINT8 *Input,
> + IN UINTN InputSize,
> + OUT UINT8 *Output
> + );
> +
> +/**
> + Performs ARC4 decryption on a data buffer of the specified size.
> +
> + This function performs ARC4 decryption on data buffer pointed by Input, of
> specified
> + size of InputSize.
> + Arc4Context should be already correctly initialized by Arc4Init(). Behavior with
> + invalid ARC4 context is undefined.
> +
> + If Arc4Context is NULL, then return FALSE.
> + If Input is NULL, then return FALSE.
> + If Output is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] Arc4Context Pointer to the ARC4 context.
> + @param[in] Input Pointer to the buffer containing the data to be
> decrypted.
> + @param[in] InputSize Size of the Input buffer in bytes.
> + @param[out] Output Pointer to a buffer that receives the ARC4
> decryption output.
> +
> + @retval TRUE ARC4 decryption succeeded.
> + @retval FALSE ARC4 decryption failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_ARC4_DECRYPT) (
> + IN OUT VOID *Arc4Context,
> + IN UINT8 *Input,
> + IN UINTN InputSize,
> + OUT UINT8 *Output
> + );
> +
> +/**
> + Resets the ARC4 context to the initial state.
> +
> + The function resets the ARC4 context to the state it had immediately after the
> + ARC4Init() function call.
> + Contrary to ARC4Init(), Arc4Reset() requires no secret key as input, but ARC4
> context
> + should be already correctly initialized by ARC4Init().
> +
> + If Arc4Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] Arc4Context Pointer to the ARC4 context.
> +
> + @retval TRUE ARC4 reset succeeded.
> + @retval FALSE ARC4 reset failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI *EDKII_CRYPTO_ARC4_RESET) (
> + IN OUT VOID *Arc4Context
> + );
> +
> +
> +/**
> + Retrieves the size, in bytes, of the context buffer required for SM3 hash
> operations.
> +
> + If this interface is not supported, then return zero.
> +
> + @return The size, in bytes, of the context buffer required for SM3 hash
> operations.
> + @retval 0 This interface is not supported.
> +
> +**/
> +typedef
> +UINTN
> +(EFIAPI* EDKII_CRYPTO_SM3_GET_CONTEXT_SIZE)(
> + VOID
> + );
> +
> +/**
> + Initializes user-supplied memory pointed by Sm3Context as SM3 hash context
> for
> + subsequent use.
> +
> + If Sm3Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[out] Sm3Context Pointer to SM3 context being initialized.
> +
> + @retval TRUE SM3 context initialization succeeded.
> + @retval FALSE SM3 context initialization failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI* EDKII_CRYPTO_SM3_INIT)(
> + OUT VOID *Sm3Context);
> +
> +/**
> + Makes a copy of an existing SM3 context.
> +
> + If Sm3Context is NULL, then return FALSE.
> + If NewSm3Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] Sm3Context Pointer to SM3 context being copied.
> + @param[out] NewSm3Context Pointer to new SM3 context.
> +
> + @retval TRUE SM3 context copy succeeded.
> + @retval FALSE SM3 context copy failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI* EDKII_CRYPTO_SM3_DUPLICATE) (
> + IN CONST VOID *Sm3Context,
> + OUT VOID *NewSm3Context);
> +
> +
> +/**
> + Digests the input data and updates SM3 context.
> +
> + This function performs SM3 digest on a data buffer of the specified size.
> + It can be called multiple times to compute the digest of long or discontinuous
> data streams.
> + SM3 context should be already correctly initialized by Sm3Init(), and should
> not be finalized
> + by Sm3Final(). Behavior with invalid context is undefined.
> +
> + If Sm3Context is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] Sm3Context Pointer to the SM3 context.
> + @param[in] Data Pointer to the buffer containing the data to be
> hashed.
> + @param[in] DataSize Size of Data buffer in bytes.
> +
> + @retval TRUE SM3 data digest succeeded.
> + @retval FALSE SM3 data digest failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI* EDKII_CRYPTO_SM3_UPDATE)(
> + IN OUT VOID *Sm3Context,
> + IN CONST VOID *Data,
> + IN UINTN DataSize);
> +
> +
> +/**
> + Completes computation of the SM3 digest value.
> +
> + This function completes SM3 hash computation and retrieves the digest value
> into
> + the specified memory. After this function has been called, the SM3 context
> cannot
> + be used again.
> + SM3 context should be already correctly initialized by Sm3Init(), and should
> not be
> + finalized by Sm3Final(). Behavior with invalid SM3 context is undefined.
> +
> + If Sm3Context is NULL, then return FALSE.
> + If HashValue is NULL, then return FALSE.
> + If this interface is not supported, then return FALSE.
> +
> + @param[in, out] Sm3Context Pointer to the SM3 context.
> + @param[out] HashValue Pointer to a buffer that receives the SM3 digest
> + value (16 bytes).
> +
> + @retval TRUE SM3 digest computation succeeded.
> + @retval FALSE SM3 digest computation failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI* EDKII_CRYPTO_SM3_FINAL)(
> + IN OUT VOID *Sm3Context,
> + OUT UINT8 *HashValue);
> +
> +
> +/**
> + Computes the SM3 message digest of a input data buffer.
> +
> + This function performs the SM3 message digest of a given data buffer, and
> places
> + the digest value into the specified memory.
> +
> + If this interface is not supported, then return FALSE.
> +
> + @param[in] Data Pointer to the buffer containing the data to be hashed.
> + @param[in] DataSize Size of Data buffer in bytes.
> + @param[out] HashValue Pointer to a buffer that receives the SM3 digest
> + value (16 bytes).
> +
> + @retval TRUE SM3 digest computation succeeded.
> + @retval FALSE SM3 digest computation failed.
> + @retval FALSE This interface is not supported.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI* EDKII_CRYPTO_SM3_HASH_ALL)(
> + IN CONST VOID *Data,
> + IN UINTN DataSize,
> + OUT UINT8 *HashValue);
> +
> +
> +/**
> + Derive key data using HMAC-SHA256 based KDF.
> +
> + @param[in] Key Pointer to the user-supplied key.
> + @param[in] KeySize Key size in bytes.
> + @param[in] Salt Pointer to the salt(non-secret) value.
> + @param[in] SaltSize Salt size in bytes.
> + @param[in] Info Pointer to the application specific info.
> + @param[in] InfoSize Info size in bytes.
> + @param[out] Out Pointer to buffer to receive hkdf value.
> + @param[in] OutSize Size of hkdf bytes to generate.
> +
> + @retval TRUE Hkdf generated successfully.
> + @retval FALSE Hkdf generation failed.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI* EDKII_CRYPTO_HKDF_SHA_256_EXTRACT_AND_EXPAND)(
> + IN CONST UINT8 *Key,
> + IN UINTN KeySize,
> + IN CONST UINT8 *Salt,
> + IN UINTN SaltSize,
> + IN CONST UINT8 *Info,
> + IN UINTN InfoSize,
> + OUT UINT8 *Out,
> + IN UINTN OutSize
> + );
> +
> +/**
> + Initializes the OpenSSL library.
> +
> + This function registers ciphers and digests used directly and indirectly
> + by SSL/TLS, and initializes the readable error messages.
> + This function must be called before any other action takes places.
> +
> + @retval TRUE The OpenSSL library has been initialized.
> + @retval FALSE Failed to initialize the OpenSSL library.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI* EDKII_CRYPTO_TLS_INITIALIZE)(
> + VOID
> + );
> +
> +/**
> + Free an allocated SSL_CTX object.
> +
> + @param[in] TlsCtx Pointer to the SSL_CTX object to be released.
> +
> +**/
> +typedef
> +VOID
> +(EFIAPI* EDKII_CRYPTO_TLS_CTX_FREE)(
> + IN VOID *TlsCtx
> + );
> +
> +/**
> + Creates a new SSL_CTX object as framework to establish TLS/SSL enabled
> + connections.
> +
> + @param[in] MajorVer Major Version of TLS/SSL Protocol.
> + @param[in] MinorVer Minor Version of TLS/SSL Protocol.
> +
> + @return Pointer to an allocated SSL_CTX object.
> + If the creation failed, TlsCtxNew() returns NULL.
> +
> +**/
> +typedef
> +VOID *
> +(EFIAPI* EDKII_CRYPTO_TLS_CTX_NEW)(
> + IN UINT8 MajorVer,
> + IN UINT8 MinorVer
> + );
> +
> +/**
> + Free an allocated TLS object.
> +
> + This function removes the TLS object pointed to by Tls and frees up the
> + allocated memory. If Tls is NULL, nothing is done.
> +
> + @param[in] Tls Pointer to the TLS object to be freed.
> +
> +**/
> +typedef
> +VOID
> +(EFIAPI* EDKII_CRYPTO_TLS_FREE)(
> + IN VOID *Tls
> + );
> +
> +/**
> + Create a new TLS object for a connection.
> +
> + This function creates a new TLS object for a connection. The new object
> + inherits the setting of the underlying context TlsCtx: connection method,
> + options, verification setting.
> +
> + @param[in] TlsCtx Pointer to the SSL_CTX object.
> +
> + @return Pointer to an allocated SSL object.
> + If the creation failed, TlsNew() returns NULL.
> +
> +**/
> +typedef
> +VOID *
> +(EFIAPI* EDKII_CRYPTO_TLS_NEW)(
> + IN VOID *TlsCtx
> + );
> +
> +/**
> + Checks if the TLS handshake was done.
> +
> + This function will check if the specified TLS handshake was done.
> +
> + @param[in] Tls Pointer to the TLS object for handshake state checking.
> +
> + @retval TRUE The TLS handshake was done.
> + @retval FALSE The TLS handshake was not done.
> +
> +**/
> +typedef
> +BOOLEAN
> +(EFIAPI* EDKII_CRYPTO_TLS_IN_HANDSHAKE)(
> + IN VOID *Tls
> + );
> +
> +/**
> + Perform a TLS/SSL handshake.
> +
> + This function will perform a TLS/SSL handshake.
> +
> + @param[in] Tls Pointer to the TLS object for handshake operation.
> + @param[in] BufferIn Pointer to the most recently received TLS
> Handshake packet.
> + @param[in] BufferInSize Packet size in bytes for the most recently
> received TLS
> + Handshake packet.
> + @param[out] BufferOut Pointer to the buffer to hold the built packet.
> + @param[in, out] BufferOutSize Pointer to the buffer size in bytes. On input, it
> is
> + the buffer size provided by the caller. On output, it
> + is the buffer size in fact needed to contain the
> + packet.
> +
> + @retval EFI_SUCCESS The required TLS packet is built successfully.
> + @retval EFI_INVALID_PARAMETER One or more of the following conditions
> is TRUE:
> + Tls is NULL.
> + BufferIn is NULL but BufferInSize is NOT 0.
> + BufferInSize is 0 but BufferIn is NOT NULL.
> + BufferOutSize is NULL.
> + BufferOut is NULL if *BufferOutSize is not zero.
> + @retval EFI_BUFFER_TOO_SMALL BufferOutSize is too small to hold the
> response packet.
> + @retval EFI_ABORTED Something wrong during handshake.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI* EDKII_CRYPTO_TLS_DO_HANDSHAKE)(
> + IN VOID *Tls,
> + IN UINT8 *BufferIn, OPTIONAL
> + IN UINTN BufferInSize, OPTIONAL
> + OUT UINT8 *BufferOut, OPTIONAL
> + IN OUT UINTN *BufferOutSize
> + );
> +
> +/**
> + Handle Alert message recorded in BufferIn. If BufferIn is NULL and
> BufferInSize is zero,
> + TLS session has errors and the response packet needs to be Alert message
> based on error type.
> +
> + @param[in] Tls Pointer to the TLS object for state checking.
> + @param[in] BufferIn Pointer to the most recently received TLS Alert
> packet.
> + @param[in] BufferInSize Packet size in bytes for the most recently
> received TLS
> + Alert packet.
> + @param[out] BufferOut Pointer to the buffer to hold the built packet.
> + @param[in, out] BufferOutSize Pointer to the buffer size in bytes. On input, it
> is
> + the buffer size provided by the caller. On output, it
> + is the buffer size in fact needed to contain the
> + packet.
> +
> + @retval EFI_SUCCESS The required TLS packet is built successfully.
> + @retval EFI_INVALID_PARAMETER One or more of the following conditions
> is TRUE:
> + Tls is NULL.
> + BufferIn is NULL but BufferInSize is NOT 0.
> + BufferInSize is 0 but BufferIn is NOT NULL.
> + BufferOutSize is NULL.
> + BufferOut is NULL if *BufferOutSize is not zero.
> + @retval EFI_ABORTED An error occurred.
> + @retval EFI_BUFFER_TOO_SMALL BufferOutSize is too small to hold the
> response packet.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI* EDKII_CRYPTO_TLS_HANDLE_ALERT)(
> + IN VOID *Tls,
> + IN UINT8 *BufferIn, OPTIONAL
> + IN UINTN BufferInSize, OPTIONAL
> + OUT UINT8 *BufferOut, OPTIONAL
> + IN OUT UINTN *BufferOutSize
> + );
> +
> +/**
> + Build the CloseNotify packet.
> +
> + @param[in] Tls Pointer to the TLS object for state checking.
> + @param[in, out] Buffer Pointer to the buffer to hold the built packet.
> + @param[in, out] BufferSize Pointer to the buffer size in bytes. On input, it is
> + the buffer size provided by the caller. On output, it
> + is the buffer size in fact needed to contain the
> + packet.
> +
> + @retval EFI_SUCCESS The required TLS packet is built successfully.
> + @retval EFI_INVALID_PARAMETER One or more of the following conditions
> is TRUE:
> + Tls is NULL.
> + BufferSize is NULL.
> + Buffer is NULL if *BufferSize is not zero.
> + @retval EFI_BUFFER_TOO_SMALL BufferSize is too small to hold the
> response packet.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI* EDKII_CRYPTO_TLS_CLOSE_NOTIFY)(
> + IN VOID *Tls,
> + IN OUT UINT8 *Buffer,
> + IN OUT UINTN *BufferSize
> + );
> +
> +/**
> + Attempts to read bytes from one TLS object and places the data in Buffer.
> +
> + This function will attempt to read BufferSize bytes from the TLS object
> + and places the data in Buffer.
> +
> + @param[in] Tls Pointer to the TLS object.
> + @param[in,out] Buffer Pointer to the buffer to store the data.
> + @param[in] BufferSize The size of Buffer in bytes.
> +
> + @retval >0 The amount of data successfully read from the TLS object.
> + @retval <=0 No data was successfully read.
> +
> +**/
> +typedef
> +INTN
> +(EFIAPI* EDKII_CRYPTO_TLS_CTRL_TRAFFIC_OUT)(
> + IN VOID *Tls,
> + IN OUT VOID *Buffer,
> + IN UINTN BufferSize
> + );
> +
> +/**
> + Attempts to write data from the buffer to TLS object.
> +
> + This function will attempt to write BufferSize bytes data from the Buffer
> + to the TLS object.
> +
> + @param[in] Tls Pointer to the TLS object.
> + @param[in] Buffer Pointer to the data buffer.
> + @param[in] BufferSize The size of Buffer in bytes.
> +
> + @retval >0 The amount of data successfully written to the TLS object.
> + @retval <=0 No data was successfully written.
> +
> +**/
> +typedef
> +INTN
> +(EFIAPI* EDKII_CRYPTO_TLS_CTRL_TRAFFIC_IN)(
> + IN VOID *Tls,
> + IN VOID *Buffer,
> + IN UINTN BufferSize
> + );
> +
> +/**
> + Attempts to read bytes from the specified TLS connection into the buffer.
> +
> + This function tries to read BufferSize bytes data from the specified TLS
> + connection into the Buffer.
> +
> + @param[in] Tls Pointer to the TLS connection for data reading.
> + @param[in,out] Buffer Pointer to the data buffer.
> + @param[in] BufferSize The size of Buffer in bytes.
> +
> + @retval >0 The read operation was successful, and return value is the
> + number of bytes actually read from the TLS connection.
> + @retval <=0 The read operation was not successful.
> +
> +**/
> +typedef
> +INTN
> +(EFIAPI* EDKII_CRYPTO_TLS_READ)(
> + IN VOID *Tls,
> + IN OUT VOID *Buffer,
> + IN UINTN BufferSize
> + );
> +
> +/**
> + Attempts to write data to a TLS connection.
> +
> + This function tries to write BufferSize bytes data from the Buffer into the
> + specified TLS connection.
> +
> + @param[in] Tls Pointer to the TLS connection for data writing.
> + @param[in] Buffer Pointer to the data buffer.
> + @param[in] BufferSize The size of Buffer in bytes.
> +
> + @retval >0 The write operation was successful, and return value is the
> + number of bytes actually written to the TLS connection.
> + @retval <=0 The write operation was not successful.
> +
> +**/
> +typedef
> +INTN
> +(EFIAPI* EDKII_CRYPTO_TLS_WRITE)(
> + IN VOID *Tls,
> + IN VOID *Buffer,
> + IN UINTN BufferSize
> + );
> +
> +/**
> + Set a new TLS/SSL method for a particular TLS object.
> +
> + This function sets a new TLS/SSL method for a particular TLS object.
> +
> + @param[in] Tls Pointer to a TLS object.
> + @param[in] MajorVer Major Version of TLS/SSL Protocol.
> + @param[in] MinorVer Minor Version of TLS/SSL Protocol.
> +
> + @retval EFI_SUCCESS The TLS/SSL method was set successfully.
> + @retval EFI_INVALID_PARAMETER The parameter is invalid.
> + @retval EFI_UNSUPPORTED Unsupported TLS/SSL method.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI* EDKII_CRYPTO_TLS_SET_VERSION)(
> + IN VOID *Tls,
> + IN UINT8 MajorVer,
> + IN UINT8 MinorVer
> + );
> +
> +/**
> + Set TLS object to work in client or server mode.
> +
> + This function prepares a TLS object to work in client or server mode.
> +
> + @param[in] Tls Pointer to a TLS object.
> + @param[in] IsServer Work in server mode.
> +
> + @retval EFI_SUCCESS The TLS/SSL work mode was set successfully.
> + @retval EFI_INVALID_PARAMETER The parameter is invalid.
> + @retval EFI_UNSUPPORTED Unsupported TLS/SSL work mode.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI* EDKII_CRYPTO_TLS_SET_CONNECTION_END)(
> + IN VOID *Tls,
> + IN BOOLEAN IsServer
> + );
> +
> +/**
> + Set the ciphers list to be used by the TLS object.
> +
> + This function sets the ciphers for use by a specified TLS object.
> +
> + @param[in] Tls Pointer to a TLS object.
> + @param[in] CipherId Array of UINT16 cipher identifiers. Each UINT16
> + cipher identifier comes from the TLS Cipher Suite
> + Registry of the IANA, interpreting Byte1 and Byte2
> + in network (big endian) byte order.
> + @param[in] CipherNum The number of cipher in the list.
> +
> + @retval EFI_SUCCESS The ciphers list was set successfully.
> + @retval EFI_INVALID_PARAMETER The parameter is invalid.
> + @retval EFI_UNSUPPORTED No supported TLS cipher was found in
> CipherId.
> + @retval EFI_OUT_OF_RESOURCES Memory allocation failed.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI* EDKII_CRYPTO_TLS_SET_CIPHER_LIST)(
> + IN VOID *Tls,
> + IN UINT16 *CipherId,
> + IN UINTN CipherNum
> + );
> +
> +/**
> + Set the compression method for TLS/SSL operations.
> +
> + This function handles TLS/SSL integrated compression methods.
> +
> + @param[in] CompMethod The compression method ID.
> +
> + @retval EFI_SUCCESS The compression method for the communication
> was
> + set successfully.
> + @retval EFI_UNSUPPORTED Unsupported compression method.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI* EDKII_CRYPTO_TLS_SET_COMPRESSION_METHOD)(
> + IN UINT8 CompMethod
> + );
> +
> +/**
> + Set peer certificate verification mode for the TLS connection.
> +
> + This function sets the verification mode flags for the TLS connection.
> +
> + @param[in] Tls Pointer to the TLS object.
> + @param[in] VerifyMode A set of logically or'ed verification mode flags.
> +
> +**/
> +typedef
> +VOID
> +(EFIAPI* EDKII_CRYPTO_TLS_SET_VERIFY)(
> + IN VOID *Tls,
> + IN UINT32 VerifyMode
> + );
> +
> +/**
> + Set the specified host name to be verified.
> +
> + @param[in] Tls Pointer to the TLS object.
> + @param[in] Flags The setting flags during the validation.
> + @param[in] HostName The specified host name to be verified.
> +
> + @retval EFI_SUCCESS The HostName setting was set successfully.
> + @retval EFI_INVALID_PARAMETER The parameter is invalid.
> + @retval EFI_ABORTED Invalid HostName setting.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI* EDKII_CRYPTO_TLS_SET_VERIFY_HOST)(
> + IN VOID *Tls,
> + IN UINT32 Flags,
> + IN CHAR8 *HostName
> + );
> +
> +/**
> + Sets a TLS/SSL session ID to be used during TLS/SSL connect.
> +
> + This function sets a session ID to be used when the TLS/SSL connection is
> + to be established.
> +
> + @param[in] Tls Pointer to the TLS object.
> + @param[in] SessionId Session ID data used for session resumption.
> + @param[in] SessionIdLen Length of Session ID in bytes.
> +
> + @retval EFI_SUCCESS Session ID was set successfully.
> + @retval EFI_INVALID_PARAMETER The parameter is invalid.
> + @retval EFI_UNSUPPORTED No available session for ID setting.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI* EDKII_CRYPTO_TLS_SET_SESSIONID)(
> + IN VOID *Tls,
> + IN UINT8 *SessionId,
> + IN UINT16 SessionIdLen
> + );
> +
> +/**
> + Adds the CA to the cert store when requesting Server or Client authentication.
> +
> + This function adds the CA certificate to the list of CAs when requesting
> + Server or Client authentication for the chosen TLS connection.
> +
> + @param[in] Tls Pointer to the TLS object.
> + @param[in] Data Pointer to the data buffer of a DER-encoded binary
> + X.509 certificate or PEM-encoded X.509 certificate.
> + @param[in] DataSize The size of data buffer in bytes.
> +
> + @retval EFI_SUCCESS The operation succeeded.
> + @retval EFI_INVALID_PARAMETER The parameter is invalid.
> + @retval EFI_OUT_OF_RESOURCES Required resources could not be
> allocated.
> + @retval EFI_ABORTED Invalid X.509 certificate.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI* EDKII_CRYPTO_TLS_SET_CA_CERTIFICATE)(
> + IN VOID *Tls,
> + IN VOID *Data,
> + IN UINTN DataSize
> + );
> +
> +/**
> + Loads the local public certificate into the specified TLS object.
> +
> + This function loads the X.509 certificate into the specified TLS object
> + for TLS negotiation.
> +
> + @param[in] Tls Pointer to the TLS object.
> + @param[in] Data Pointer to the data buffer of a DER-encoded binary
> + X.509 certificate or PEM-encoded X.509 certificate.
> + @param[in] DataSize The size of data buffer in bytes.
> +
> + @retval EFI_SUCCESS The operation succeeded.
> + @retval EFI_INVALID_PARAMETER The parameter is invalid.
> + @retval EFI_OUT_OF_RESOURCES Required resources could not be
> allocated.
> + @retval EFI_ABORTED Invalid X.509 certificate.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI* EDKII_CRYPTO_TLS_SET_HOST_PUBLIC_CERT)(
> + IN VOID *Tls,
> + IN VOID *Data,
> + IN UINTN DataSize
> + );
> +
> +/**
> + Adds the local private key to the specified TLS object.
> +
> + This function adds the local private key (PEM-encoded RSA or PKCS#8 private
> + key) into the specified TLS object for TLS negotiation.
> +
> + @param[in] Tls Pointer to the TLS object.
> + @param[in] Data Pointer to the data buffer of a PEM-encoded RSA
> + or PKCS#8 private key.
> + @param[in] DataSize The size of data buffer in bytes.
> +
> + @retval EFI_SUCCESS The operation succeeded.
> + @retval EFI_UNSUPPORTED This function is not supported.
> + @retval EFI_ABORTED Invalid private key data.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI* EDKII_CRYPTO_TLS_SET_HOST_PRIVATE_KEY)(
> + IN VOID *Tls,
> + IN VOID *Data,
> + IN UINTN DataSize
> + );
> +
> +/**
> + Adds the CA-supplied certificate revocation list for certificate validation.
> +
> + This function adds the CA-supplied certificate revocation list data for
> + certificate validity checking.
> +
> + @param[in] Data Pointer to the data buffer of a DER-encoded CRL data.
> + @param[in] DataSize The size of data buffer in bytes.
> +
> + @retval EFI_SUCCESS The operation succeeded.
> + @retval EFI_UNSUPPORTED This function is not supported.
> + @retval EFI_ABORTED Invalid CRL data.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI* EDKII_CRYPTO_TLS_SET_CERT_REVOCATION_LIST)(
> + IN VOID *Data,
> + IN UINTN DataSize
> + );
> +
> +/**
> + Gets the protocol version used by the specified TLS connection.
> +
> + This function returns the protocol version used by the specified TLS
> + connection.
> +
> + If Tls is NULL, then ASSERT().
> +
> + @param[in] Tls Pointer to the TLS object.
> +
> + @return The protocol version of the specified TLS connection.
> +
> +**/
> +typedef
> +UINT16
> +(EFIAPI* EDKII_CRYPTO_TLS_GET_VERSION)(
> + IN VOID *Tls
> + );
> +
> +/**
> + Gets the connection end of the specified TLS connection.
> +
> + This function returns the connection end (as client or as server) used by
> + the specified TLS connection.
> +
> + If Tls is NULL, then ASSERT().
> +
> + @param[in] Tls Pointer to the TLS object.
> +
> + @return The connection end used by the specified TLS connection.
> +
> +**/
> +typedef
> +UINT8
> +(EFIAPI* EDKII_CRYPTO_TLS_GET_CONNECTION_END)(
> + IN VOID *Tls
> + );
> +
> +/**
> + Gets the cipher suite used by the specified TLS connection.
> +
> + This function returns current cipher suite used by the specified
> + TLS connection.
> +
> + @param[in] Tls Pointer to the TLS object.
> + @param[in,out] CipherId The cipher suite used by the TLS object.
> +
> + @retval EFI_SUCCESS The cipher suite was returned successfully.
> + @retval EFI_INVALID_PARAMETER The parameter is invalid.
> + @retval EFI_UNSUPPORTED Unsupported cipher suite.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI* EDKII_CRYPTO_TLS_GET_CURRENT_CIPHER)(
> + IN VOID *Tls,
> + IN OUT UINT16 *CipherId
> + );
> +
> +/**
> + Gets the compression methods used by the specified TLS connection.
> +
> + This function returns current integrated compression methods used by
> + the specified TLS connection.
> +
> + @param[in] Tls Pointer to the TLS object.
> + @param[in,out] CompressionId The current compression method used by
> + the TLS object.
> +
> + @retval EFI_SUCCESS The compression method was returned
> successfully.
> + @retval EFI_INVALID_PARAMETER The parameter is invalid.
> + @retval EFI_ABORTED Invalid Compression method.
> + @retval EFI_UNSUPPORTED This function is not supported.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI* EDKII_CRYPTO_TLS_GET_CURRENT_COMPRESSION_ID)(
> + IN VOID *Tls,
> + IN OUT UINT8 *CompressionId
> + );
> +
> +/**
> + Gets the verification mode currently set in the TLS connection.
> +
> + This function returns the peer verification mode currently set in the
> + specified TLS connection.
> +
> + If Tls is NULL, then ASSERT().
> +
> + @param[in] Tls Pointer to the TLS object.
> +
> + @return The verification mode set in the specified TLS connection.
> +
> +**/
> +typedef
> +UINT32
> +(EFIAPI* EDKII_CRYPTO_TLS_GET_VERIFY)(
> + IN VOID *Tls
> + );
> +
> +/**
> + Gets the session ID used by the specified TLS connection.
> +
> + This function returns the TLS/SSL session ID currently used by the
> + specified TLS connection.
> +
> + @param[in] Tls Pointer to the TLS object.
> + @param[in,out] SessionId Buffer to contain the returned session ID.
> + @param[in,out] SessionIdLen The length of Session ID in bytes.
> +
> + @retval EFI_SUCCESS The Session ID was returned successfully.
> + @retval EFI_INVALID_PARAMETER The parameter is invalid.
> + @retval EFI_UNSUPPORTED Invalid TLS/SSL session.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI* EDKII_CRYPTO_TLS_GET_SESSION_ID)(
> + IN VOID *Tls,
> + IN OUT UINT8 *SessionId,
> + IN OUT UINT16 *SessionIdLen
> + );
> +
> +/**
> + Gets the client random data used in the specified TLS connection.
> +
> + This function returns the TLS/SSL client random data currently used in
> + the specified TLS connection.
> +
> + @param[in] Tls Pointer to the TLS object.
> + @param[in,out] ClientRandom Buffer to contain the returned client
> + random data (32 bytes).
> +
> +**/
> +typedef
> +VOID
> +(EFIAPI* EDKII_CRYPTO_TLS_GET_CLIENT_RANDOM)(
> + IN VOID *Tls,
> + IN OUT UINT8 *ClientRandom
> + );
> +
> +/**
> + Gets the server random data used in the specified TLS connection.
> +
> + This function returns the TLS/SSL server random data currently used in
> + the specified TLS connection.
> +
> + @param[in] Tls Pointer to the TLS object.
> + @param[in,out] ServerRandom Buffer to contain the returned server
> + random data (32 bytes).
> +
> +**/
> +typedef
> +VOID
> +(EFIAPI* EDKII_CRYPTO_TLS_GET_SERVER_RANDOM)(
> + IN VOID *Tls,
> + IN OUT UINT8 *ServerRandom
> + );
> +
> +/**
> + Gets the master key data used in the specified TLS connection.
> +
> + This function returns the TLS/SSL master key material currently used in
> + the specified TLS connection.
> +
> + @param[in] Tls Pointer to the TLS object.
> + @param[in,out] KeyMaterial Buffer to contain the returned key material.
> +
> + @retval EFI_SUCCESS Key material was returned successfully.
> + @retval EFI_INVALID_PARAMETER The parameter is invalid.
> + @retval EFI_UNSUPPORTED Invalid TLS/SSL session.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI* EDKII_CRYPTO_TLS_GET_KEY_MATERIAL)(
> + IN VOID *Tls,
> + IN OUT UINT8 *KeyMaterial
> + );
> +
> +/**
> + Gets the CA Certificate from the cert store.
> +
> + This function returns the CA certificate for the chosen
> + TLS connection.
> +
> + @param[in] Tls Pointer to the TLS object.
> + @param[out] Data Pointer to the data buffer to receive the CA
> + certificate data sent to the client.
> + @param[in,out] DataSize The size of data buffer in bytes.
> +
> + @retval EFI_SUCCESS The operation succeeded.
> + @retval EFI_UNSUPPORTED This function is not supported.
> + @retval EFI_BUFFER_TOO_SMALL The Data is too small to hold the data.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI* EDKII_CRYPTO_TLS_GET_CA_CERTIFICATE)(
> + IN VOID *Tls,
> + OUT VOID *Data,
> + IN OUT UINTN *DataSize
> + );
> +
> +/**
> + Gets the local public Certificate set in the specified TLS object.
> +
> + This function returns the local public certificate which was currently set
> + in the specified TLS object.
> +
> + @param[in] Tls Pointer to the TLS object.
> + @param[out] Data Pointer to the data buffer to receive the local
> + public certificate.
> + @param[in,out] DataSize The size of data buffer in bytes.
> +
> + @retval EFI_SUCCESS The operation succeeded.
> + @retval EFI_INVALID_PARAMETER The parameter is invalid.
> + @retval EFI_NOT_FOUND The certificate is not found.
> + @retval EFI_BUFFER_TOO_SMALL The Data is too small to hold the data.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI* EDKII_CRYPTO_TLS_GET_HOST_PUBLIC_CERT)(
> + IN VOID *Tls,
> + OUT VOID *Data,
> + IN OUT UINTN *DataSize
> + );
> +
> +/**
> + Gets the local private key set in the specified TLS object.
> +
> + This function returns the local private key data which was currently set
> + in the specified TLS object.
> +
> + @param[in] Tls Pointer to the TLS object.
> + @param[out] Data Pointer to the data buffer to receive the local
> + private key data.
> + @param[in,out] DataSize The size of data buffer in bytes.
> +
> + @retval EFI_SUCCESS The operation succeeded.
> + @retval EFI_UNSUPPORTED This function is not supported.
> + @retval EFI_BUFFER_TOO_SMALL The Data is too small to hold the data.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI* EDKII_CRYPTO_TLS_GET_HOST_PRIVATE_KEY)(
> + IN VOID *Tls,
> + OUT VOID *Data,
> + IN OUT UINTN *DataSize
> + );
> +
> +/**
> + Gets the CA-supplied certificate revocation list data set in the specified
> + TLS object.
> +
> + This function returns the CA-supplied certificate revocation list data which
> + was currently set in the specified TLS object.
> +
> + @param[out] Data Pointer to the data buffer to receive the CRL data.
> + @param[in,out] DataSize The size of data buffer in bytes.
> +
> + @retval EFI_SUCCESS The operation succeeded.
> + @retval EFI_UNSUPPORTED This function is not supported.
> + @retval EFI_BUFFER_TOO_SMALL The Data is too small to hold the data.
> +
> +**/
> +typedef
> +EFI_STATUS
> +(EFIAPI* EDKII_CRYPTO_TLS_GET_CERT_REVOCATION_LIST)(
> + OUT VOID *DATA,
> + IN OUT UINTN *DataSize
> + );
> +
> +
> +///
> +/// EDK II Crypto Protocol
> +///
> +struct _EDKII_CRYPTO_PROTOCOL {
> + /// Version
> + EDKII_CRYPTO_GET_VERSION GetVersion;
> + /// HMAC MD5
> + EDKII_CRYPTO_HMAC_MD5_NEW HmacMd5New;
> + EDKII_CRYPTO_HMAC_MD5_FREE HmacMd5Free;
> + EDKII_CRYPTO_HMAC_MD5_SET_KEY HmacMd5SetKey;
> + EDKII_CRYPTO_HMAC_MD5_DUPLICATE HmacMd5Duplicate;
> + EDKII_CRYPTO_HMAC_MD5_UPDATE HmacMd5Update;
> + EDKII_CRYPTO_HMAC_MD5_FINAL HmacMd5Final;
> + /// HMAC SHA1
> + EDKII_CRYPTO_HMAC_SHA1_NEW HmacSha1New;
> + EDKII_CRYPTO_HMAC_SHA1_FREE HmacSha1Free;
> + EDKII_CRYPTO_HMAC_SHA1_SET_KEY HmacSha1SetKey;
> + EDKII_CRYPTO_HMAC_SHA1_DUPLICATE HmacSha1Duplicate;
> + EDKII_CRYPTO_HMAC_SHA1_UPDATE HmacSha1Update;
> + EDKII_CRYPTO_HMAC_SHA1_FINAL HmacSha1Final;
> + /// HMAC SHA256
> + EDKII_CRYPTO_HMAC_SHA256_NEW HmacSha256New;
> + EDKII_CRYPTO_HMAC_SHA256_FREE HmacSha256Free;
> + EDKII_CRYPTO_HMAC_SHA256_SET_KEY HmacSha256SetKey;
> + EDKII_CRYPTO_HMAC_SHA256_DUPLICATE HmacSha256Duplicate;
> + EDKII_CRYPTO_HMAC_SHA256_UPDATE HmacSha256Update;
> + EDKII_CRYPTO_HMAC_SHA256_FINAL HmacSha256Final;
> + /// Md4
> + EDKII_CRYPTO_MD4_GET_CONTEXT_SIZE Md4GetContextSize;
> + EDKII_CRYPTO_MD4_INIT Md4Init;
> + EDKII_CRYPTO_MD4_DUPLICATE Md4Duplicate;
> + EDKII_CRYPTO_MD4_UPDATE Md4Update;
> + EDKII_CRYPTO_MD4_FINAL Md4Final;
> + EDKII_CRYPTO_MD4_HASH_ALL Md4HashAll;
> + /// Md5
> + EDKII_CRYPTO_MD5_GET_CONTEXT_SIZE Md5GetContextSize;
> + EDKII_CRYPTO_MD5_INIT Md5Init;
> + EDKII_CRYPTO_MD5_DUPLICATE Md5Duplicate;
> + EDKII_CRYPTO_MD5_UPDATE Md5Update;
> + EDKII_CRYPTO_MD5_FINAL Md5Final;
> + EDKII_CRYPTO_MD5_HASH_ALL Md5HashAll;
> + /// Pkcs
> + EDKII_CRYPTO_PKCS1_ENCRYPT_V2 Pkcs1v2Encrypt;
> + EDKII_CRYPTO_PKCS5_PW_HASH Pkcs5HashPassword;
> + EDKII_CRYPTO_PKCS7_VERIFY Pkcs7Verify;
> + EDKII_CRYPTO_PKCS7_VERIFY_EKU VerifyEKUsInPkcs7Signature;
> + EDKII_CRYPTO_PKCS7_GET_SIGNERS Pkcs7GetSigners;
> + EDKII_CRYPTO_PKCS7_FREE_SIGNERS Pkcs7FreeSigners;
> + EDKII_CRYPTO_PKCS7_SIGN Pkcs7Sign;
> + EDKII_CRYPTO_PKCS7_GET_ATTACHED_CONTENT
> Pkcs7GetAttachedContent;
> + EDKII_CRYPTO_PKCS7_GET_CERTIFICATES_LIST Pkcs7GetCertificatesList;
> + EDKII_CRYPTO_AUTHENTICODE_VERIFY AuthenticodeVerify;
> + EDKII_CRYPTO_IMAGE_TIMESTAMP_VERIFY ImageTimestampVerify;
> + /// DH
> + EDKII_CRYPTO_DH_NEW DhNew;
> + EDKII_CRYPTO_DH_FREE DhFree;
> + EDKII_CRYPTO_DH_GENERATE_PARAMETER DhGenerateParameter;
> + EDKII_CRYPTO_DH_SET_PARAMETER DhSetParameter;
> + EDKII_CRYPTO_DH_GENERATE_KEY DhGenerateKey;
> + EDKII_CRYPTO_DH_COMPUTE_KEY DhComputeKey;
> + /// Random
> + EDKII_CRYPTO_RANDOM_SEED RandomSeed;
> + EDKII_CRYPTO_RANDOM_BYTES RandomBytes;
> + /// RSA
> + EDKII_CRYPTO_RSA_VERIFY_PKCS1 RsaVerifyPkcs1;
> + EDKII_CRYPTO_RSA_NEW RsaNew;
> + EDKII_CRYPTO_RSA_FREE RsaFree;
> + EDKII_CRYPTO_RSA_SET_KEY RsaSetKey;
> + EDKII_CRYPTO_RSA_GET_KEY RsaGetKey;
> + EDKII_CRYPTO_RSA_GENERATE_KEY RsaGenerateKey;
> + EDKII_CRYPTO_RSA_CHECK_KEY RsaCheckKey;
> + EDKII_CRYPTO_RSA_PKCS1_SIGN RsaPkcs1Sign;
> + EDKII_CRYPTO_RSA_PKCS1_VERIFY RsaPkcs1Verify;
> + EDKII_CRYPTO_RSA_GET_PRIVATE_KEY_FROM_PEM
> RsaGetPrivateKeyFromPem;
> + EDKII_CRYPTO_RSA_GET_PUBLIC_KEY_FROM_X509
> RsaGetPublicKeyFromX509;
> + /// Sha1
> + EDKII_CRYPTO_SHA1_GET_CONTEXT_SIZE Sha1GetContextSize;
> + EDKII_CRYPTO_SHA1_INIT Sha1Init;
> + EDKII_CRYPTO_SHA1_DUPLICATE Sha1Duplicate;
> + EDKII_CRYPTO_SHA1_UPDATE Sha1Update;
> + EDKII_CRYPTO_SHA1_FINAL Sha1Final;
> + EDKII_CRYPTO_SHA1_HASH_ALL Sha1HashAll;
> + /// Sha256
> + EDKII_CRYPTO_SHA256_GET_CONTEXT_SIZE Sha256GetContextSize;
> + EDKII_CRYPTO_SHA256_INIT Sha256Init;
> + EDKII_CRYPTO_SHA256_DUPLICATE Sha256Duplicate;
> + EDKII_CRYPTO_SHA256_UPDATE Sha256Update;
> + EDKII_CRYPTO_SHA256_FINAL Sha256Final;
> + EDKII_CRYPTO_SHA256_HASH_ALL Sha256HashAll;
> + /// Sha384
> + EDKII_CRYPTO_SHA384_GET_CONTEXT_SIZE Sha384GetContextSize;
> + EDKII_CRYPTO_SHA384_INIT Sha384Init;
> + EDKII_CRYPTO_SHA384_DUPLICATE Sha384Duplicate;
> + EDKII_CRYPTO_SHA384_UPDATE Sha384Update;
> + EDKII_CRYPTO_SHA384_FINAL Sha384Final;
> + EDKII_CRYPTO_SHA384_HASH_ALL Sha384HashAll;
> + /// Sha512
> + EDKII_CRYPTO_SHA512_GET_CONTEXT_SIZE Sha512GetContextSize;
> + EDKII_CRYPTO_SHA512_INIT Sha512Init;
> + EDKII_CRYPTO_SHA512_DUPLICATE Sha512Duplicate;
> + EDKII_CRYPTO_SHA512_UPDATE Sha512Update;
> + EDKII_CRYPTO_SHA512_FINAL Sha512Final;
> + EDKII_CRYPTO_SHA512_HASH_ALL Sha512HashAll;
> + /// X509
> + EDKII_CRYPTO_X509_GET_SUBJECT_NAME X509GetSubjectName;
> + EDKII_CRYPTO_X509_GET_COMMON_NAME X509GetCommonName;
> + EDKII_CRYPTO_X509_GET_ORGANIZATION_NAME
> X509GetOrganizationName;
> + EDKII_CRYPTO_X509_VERIFY_CERT X509VerifyCert;
> + EDKII_CRYPTO_X509_CONSTRUCT_CERTIFICATE
> X509ConstructCertificate;
> + EDKII_CRYPTO_X509_CONSTRUCT_CERTIFICATE_STACK
> X509ConstructCertificateStack;
> + EDKII_CRYPTO_X509_FREE X509Free;
> + EDKII_CRYPTO_X509_STACK_FREE X509StackFree;
> + EDKII_CRYPTO_X509_GET_TBS_CERT X509GetTBSCert;
> + /// TDES
> + EDKII_CRYPTO_TDES_GET_CONTEXT_SIZE TdesGetContextSize;
> + EDKII_CRYPTO_TDES_INIT TdesInit;
> + EDKII_CRYPTO_TDES_ECB_ENCRYPT TdesEcbEncrypt;
> + EDKII_CRYPTO_TDES_ECB_DECRYPT TdesEcbDecrypt;
> + EDKII_CRYPTO_TDES_CBC_ENCRYPT TdesCbcEncrypt;
> + EDKII_CRYPTO_TDES_CBC_DECRYPT TdesCbcDecrypt;
> + /// AES
> + EDKII_CRYPTO_AES_GET_CONTEXT_SIZE AesGetContextSize;
> + EDKII_CRYPTO_AES_INIT AesInit;
> + EDKII_CRYPTO_AES_ECB_ENCRYPT AesEcbEncrypt;
> + EDKII_CRYPTO_AES_ECB_DECRYPT AesEcbDecrypt;
> + EDKII_CRYPTO_AES_CBC_ENCRYPT AesCbcEncrypt;
> + EDKII_CRYPTO_AES_CBC_DECRYPT AesCbcDecrypt;
> + /// Arc4
> + EDKII_CRYPTO_ARC4_GET_CONTEXT_SIZE Arc4GetContextSize;
> + EDKII_CRYPTO_ARC4_INIT Arc4Init;
> + EDKII_CRYPTO_ARC4_ENCRYPT Arc4Encrypt;
> + EDKII_CRYPTO_ARC4_DECRYPT Arc4Decrypt;
> + EDKII_CRYPTO_ARC4_RESET Arc4Reset;
> + /// SM3
> + EDKII_CRYPTO_SM3_GET_CONTEXT_SIZE Sm3GetContextSize;
> + EDKII_CRYPTO_SM3_INIT Sm3Init;
> + EDKII_CRYPTO_SM3_DUPLICATE Sm3Duplicate;
> + EDKII_CRYPTO_SM3_UPDATE Sm3Update;
> + EDKII_CRYPTO_SM3_FINAL Sm3Final;
> + EDKII_CRYPTO_SM3_HASH_ALL Sm3HashAll;
> + /// HKDF
> + EDKII_CRYPTO_HKDF_SHA_256_EXTRACT_AND_EXPAND
> HkdfSha256ExtractAndExpand;
> + /// X509 (Continued)
> + EDKII_CRYPTO_X509_CONSTRUCT_CERTIFICATE_STACK_V
> X509ConstructCertificateStackV;
> + /// TLS
> + EDKII_CRYPTO_TLS_INITIALIZE TlsInitialize;
> + EDKII_CRYPTO_TLS_CTX_FREE TlsCtxFree;
> + EDKII_CRYPTO_TLS_CTX_NEW TlsCtxNew;
> + EDKII_CRYPTO_TLS_FREE TlsFree;
> + EDKII_CRYPTO_TLS_NEW TlsNew;
> + EDKII_CRYPTO_TLS_IN_HANDSHAKE TlsInHandshake;
> + EDKII_CRYPTO_TLS_DO_HANDSHAKE TlsDoHandshake;
> + EDKII_CRYPTO_TLS_HANDLE_ALERT TlsHandleAlert;
> + EDKII_CRYPTO_TLS_CLOSE_NOTIFY TlsCloseNotify;
> + EDKII_CRYPTO_TLS_CTRL_TRAFFIC_OUT TlsCtrlTrafficOut;
> + EDKII_CRYPTO_TLS_CTRL_TRAFFIC_IN TlsCtrlTrafficIn;
> + EDKII_CRYPTO_TLS_READ TlsRead;
> + EDKII_CRYPTO_TLS_WRITE TlsWrite;
> + /// TLS Set
> + EDKII_CRYPTO_TLS_SET_VERSION TlsSetVersion;
> + EDKII_CRYPTO_TLS_SET_CONNECTION_END TlsSetConnectionEnd;
> + EDKII_CRYPTO_TLS_SET_CIPHER_LIST TlsSetCipherList;
> + EDKII_CRYPTO_TLS_SET_COMPRESSION_METHOD
> TlsSetCompressionMethod;
> + EDKII_CRYPTO_TLS_SET_VERIFY TlsSetVerify;
> + EDKII_CRYPTO_TLS_SET_VERIFY_HOST TlsSetVerifyHost;
> + EDKII_CRYPTO_TLS_SET_SESSIONID TlsSetSessionId;
> + EDKII_CRYPTO_TLS_SET_CA_CERTIFICATE TlsSetCaCertificate;
> + EDKII_CRYPTO_TLS_SET_HOST_PUBLIC_CERT TlsSetHostPublicCert;
> + EDKII_CRYPTO_TLS_SET_HOST_PRIVATE_KEY TlsSetHostPrivateKey;
> + EDKII_CRYPTO_TLS_SET_CERT_REVOCATION_LIST
> TlsSetCertRevocationList;
> + /// TLS Get
> + EDKII_CRYPTO_TLS_GET_VERSION TlsGetVersion;
> + EDKII_CRYPTO_TLS_GET_CONNECTION_END TlsGetConnectionEnd;
> + EDKII_CRYPTO_TLS_GET_CURRENT_CIPHER TlsGetCurrentCipher;
> + EDKII_CRYPTO_TLS_GET_CURRENT_COMPRESSION_ID
> TlsGetCurrentCompressionId;
> + EDKII_CRYPTO_TLS_GET_VERIFY TlsGetVerify;
> + EDKII_CRYPTO_TLS_GET_SESSION_ID TlsGetSessionId;
> + EDKII_CRYPTO_TLS_GET_CLIENT_RANDOM TlsGetClientRandom;
> + EDKII_CRYPTO_TLS_GET_SERVER_RANDOM TlsGetServerRandom;
> + EDKII_CRYPTO_TLS_GET_KEY_MATERIAL TlsGetKeyMaterial;
> + EDKII_CRYPTO_TLS_GET_CA_CERTIFICATE TlsGetCaCertificate;
> + EDKII_CRYPTO_TLS_GET_HOST_PUBLIC_CERT TlsGetHostPublicCert;
> + EDKII_CRYPTO_TLS_GET_HOST_PRIVATE_KEY TlsGetHostPrivateKey;
> + EDKII_CRYPTO_TLS_GET_CERT_REVOCATION_LIST
> TlsGetCertRevocationList;
> +};
> +
> +extern GUID gEdkiiCryptoProtocolGuid;
> +
> +#endif
> diff --git a/CryptoPkg/Private/Protocol/SmmCrypto.h
> b/CryptoPkg/Private/Protocol/SmmCrypto.h
> new file mode 100644
> index 0000000000..defdeccfe5
> --- /dev/null
> +++ b/CryptoPkg/Private/Protocol/SmmCrypto.h
> @@ -0,0 +1,21 @@
> +/** @file
> + This Protocol provides Crypto services to SMM modules
> +
> + Copyright (C) Microsoft Corporation. All rights reserved.
> + SPDX-License-Identifier: BSD-2-Clause-Patent
> +
> +**/
> +
> +#ifndef __EDKII_SMM_CRYPTO_PROTOCOL_H__
> +#define __EDKII_SMM_CRYPTO_PROTOCOL_H__
> +
> +#include <Protocol/Crypto.h>
> +
> +///
> +/// EDK II SMM Crypto Protocol is identical to EDK II Crypto Protocol
> +///
> +typedef EDKII_CRYPTO_PROTOCOL EDKII_SMM_CRYPTO_PROTOCOL;
> +
> +extern GUID gEdkiiSmmCryptoProtocolGuid;
> +
> +#endif
> --
> 2.21.0.windows.1
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#53711): https://edk2.groups.io/g/devel/message/53711
Mute This Topic: https://groups.io/mt/70266460/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-
More information about the edk2-devel-archive
mailing list