#include <Uefi/UefiBaseType.h>

Data Structures
struct	EFI_CERT_DATA

struct	EFI_CERT_STACK

Macros
#define	CRYPTO_NID_NULL 0x0000

#define	CRYPTO_NID_SHA256 0x0001

#define	CRYPTO_NID_SHA384 0x0002

#define	CRYPTO_NID_SHA512 0x0003

#define	CRYPTO_NID_SECP256R1 0x0204

#define	CRYPTO_NID_SECP384R1 0x0205

#define	CRYPTO_NID_SECP521R1 0x0206

#define	CRYPTO_NID_BRAINPOOLP512R1 0x03A5

#define	MD5_DIGEST_SIZE 16

#define	SHA1_DIGEST_SIZE 20

#define	SHA256_DIGEST_SIZE 32

#define	SHA384_DIGEST_SIZE 48

#define	SHA512_DIGEST_SIZE 64

#define	SM3_256_DIGEST_SIZE 32

#define	TDES_BLOCK_SIZE 8

#define	AES_BLOCK_SIZE 16

Enumerations
enum	RSA_KEY_TAG { RsaKeyN , RsaKeyE , RsaKeyD , RsaKeyP , RsaKeyQ , RsaKeyDp , RsaKeyDq , RsaKeyQInv }

Functions
UINTN EFIAPI	Sha1GetContextSize (VOID)

BOOLEAN EFIAPI	Sha1Init (OUT VOID *Sha1Context)

BOOLEAN EFIAPI	Sha1Duplicate (IN CONST VOID Sha1Context, OUT VOID NewSha1Context)

BOOLEAN EFIAPI	Sha1Update (IN OUT VOID Sha1Context, IN CONST VOID Data, IN UINTN DataSize)

BOOLEAN EFIAPI	Sha1Final (IN OUT VOID Sha1Context, OUT UINT8 HashValue)

BOOLEAN EFIAPI	Sha1HashAll (IN CONST VOID Data, IN UINTN DataSize, OUT UINT8 HashValue)

UINTN EFIAPI	Sha256GetContextSize (VOID)

BOOLEAN EFIAPI	Sha256Init (OUT VOID *Sha256Context)

BOOLEAN EFIAPI	Sha256Duplicate (IN CONST VOID Sha256Context, OUT VOID NewSha256Context)

BOOLEAN EFIAPI	Sha256Update (IN OUT VOID Sha256Context, IN CONST VOID Data, IN UINTN DataSize)

BOOLEAN EFIAPI	Sha256Final (IN OUT VOID Sha256Context, OUT UINT8 HashValue)

BOOLEAN EFIAPI	Sha256HashAll (IN CONST VOID Data, IN UINTN DataSize, OUT UINT8 HashValue)

UINTN EFIAPI	Sha384GetContextSize (VOID)

BOOLEAN EFIAPI	Sha384Init (OUT VOID *Sha384Context)

BOOLEAN EFIAPI	Sha384Duplicate (IN CONST VOID Sha384Context, OUT VOID NewSha384Context)

BOOLEAN EFIAPI	Sha384Update (IN OUT VOID Sha384Context, IN CONST VOID Data, IN UINTN DataSize)

BOOLEAN EFIAPI	Sha384Final (IN OUT VOID Sha384Context, OUT UINT8 HashValue)

BOOLEAN EFIAPI	Sha384HashAll (IN CONST VOID Data, IN UINTN DataSize, OUT UINT8 HashValue)

UINTN EFIAPI	Sha512GetContextSize (VOID)

BOOLEAN EFIAPI	Sha512Init (OUT VOID *Sha512Context)

BOOLEAN EFIAPI	Sha512Duplicate (IN CONST VOID Sha512Context, OUT VOID NewSha512Context)

BOOLEAN EFIAPI	Sha512Update (IN OUT VOID Sha512Context, IN CONST VOID Data, IN UINTN DataSize)

BOOLEAN EFIAPI	Sha512Final (IN OUT VOID Sha512Context, OUT UINT8 HashValue)

BOOLEAN EFIAPI	Sha512HashAll (IN CONST VOID Data, IN UINTN DataSize, OUT UINT8 HashValue)

BOOLEAN EFIAPI	ParallelHash256HashAll (IN CONST VOID Input, IN UINTN InputByteLen, IN UINTN BlockSize, OUT VOID Output, IN UINTN OutputByteLen, IN CONST VOID *Customization, IN UINTN CustomByteLen)

UINTN EFIAPI	Sm3GetContextSize (VOID)

BOOLEAN EFIAPI	Sm3Init (OUT VOID *Sm3Context)

BOOLEAN EFIAPI	Sm3Duplicate (IN CONST VOID Sm3Context, OUT VOID NewSm3Context)

BOOLEAN EFIAPI	Sm3Update (IN OUT VOID Sm3Context, IN CONST VOID Data, IN UINTN DataSize)

BOOLEAN EFIAPI	Sm3Final (IN OUT VOID Sm3Context, OUT UINT8 HashValue)

BOOLEAN EFIAPI	Sm3HashAll (IN CONST VOID Data, IN UINTN DataSize, OUT UINT8 HashValue)

VOID *EFIAPI	HmacSha256New (VOID)

VOID EFIAPI	HmacSha256Free (IN VOID *HmacSha256Ctx)

BOOLEAN EFIAPI	HmacSha256SetKey (OUT VOID HmacSha256Context, IN CONST UINT8 Key, IN UINTN KeySize)

BOOLEAN EFIAPI	HmacSha256Duplicate (IN CONST VOID HmacSha256Context, OUT VOID NewHmacSha256Context)

BOOLEAN EFIAPI	HmacSha256Update (IN OUT VOID HmacSha256Context, IN CONST VOID Data, IN UINTN DataSize)

BOOLEAN EFIAPI	HmacSha256Final (IN OUT VOID HmacSha256Context, OUT UINT8 HmacValue)

BOOLEAN EFIAPI	HmacSha256All (IN CONST VOID Data, IN UINTN DataSize, IN CONST UINT8 Key, IN UINTN KeySize, OUT UINT8 *HmacValue)

VOID *EFIAPI	HmacSha384New (VOID)

VOID EFIAPI	HmacSha384Free (IN VOID *HmacSha384Ctx)

BOOLEAN EFIAPI	HmacSha384SetKey (OUT VOID HmacSha384Context, IN CONST UINT8 Key, IN UINTN KeySize)

BOOLEAN EFIAPI	HmacSha384Duplicate (IN CONST VOID HmacSha384Context, OUT VOID NewHmacSha384Context)

BOOLEAN EFIAPI	HmacSha384Update (IN OUT VOID HmacSha384Context, IN CONST VOID Data, IN UINTN DataSize)

BOOLEAN EFIAPI	HmacSha384Final (IN OUT VOID HmacSha384Context, OUT UINT8 HmacValue)

BOOLEAN EFIAPI	HmacSha384All (IN CONST VOID Data, IN UINTN DataSize, IN CONST UINT8 Key, IN UINTN KeySize, OUT UINT8 *HmacValue)

UINTN EFIAPI	AesGetContextSize (VOID)

BOOLEAN EFIAPI	AesInit (OUT VOID AesContext, IN CONST UINT8 Key, IN UINTN KeyLength)

BOOLEAN EFIAPI	AesCbcEncrypt (IN VOID AesContext, IN CONST UINT8 Input, IN UINTN InputSize, IN CONST UINT8 Ivec, OUT UINT8 Output)

BOOLEAN EFIAPI	AesCbcDecrypt (IN VOID AesContext, IN CONST UINT8 Input, IN UINTN InputSize, IN CONST UINT8 Ivec, OUT UINT8 Output)

BOOLEAN EFIAPI	AeadAesGcmEncrypt (IN CONST UINT8 Key, IN UINTN KeySize, IN CONST UINT8 Iv, IN UINTN IvSize, IN CONST UINT8 AData, IN UINTN ADataSize, IN CONST UINT8 DataIn, IN UINTN DataInSize, OUT UINT8 TagOut, IN UINTN TagSize, OUT UINT8 DataOut, OUT UINTN *DataOutSize)

BOOLEAN EFIAPI	AeadAesGcmDecrypt (IN CONST UINT8 Key, IN UINTN KeySize, IN CONST UINT8 Iv, IN UINTN IvSize, IN CONST UINT8 AData, IN UINTN ADataSize, IN CONST UINT8 DataIn, IN UINTN DataInSize, IN CONST UINT8 Tag, IN UINTN TagSize, OUT UINT8 DataOut, OUT UINTN *DataOutSize)

VOID *EFIAPI	RsaNew (VOID)

VOID EFIAPI	RsaFree (IN VOID *RsaContext)

BOOLEAN EFIAPI	RsaSetKey (IN OUT VOID RsaContext, IN RSA_KEY_TAG KeyTag, IN CONST UINT8 BigNumber, IN UINTN BnSize)

BOOLEAN EFIAPI	RsaGetKey (IN OUT VOID RsaContext, IN RSA_KEY_TAG KeyTag, OUT UINT8 BigNumber, IN OUT UINTN *BnSize)

BOOLEAN EFIAPI	RsaGenerateKey (IN OUT VOID RsaContext, IN UINTN ModulusLength, IN CONST UINT8 PublicExponent, IN UINTN PublicExponentSize)

BOOLEAN EFIAPI	RsaCheckKey (IN VOID *RsaContext)

BOOLEAN EFIAPI	RsaPkcs1Sign (IN VOID RsaContext, IN CONST UINT8 MessageHash, IN UINTN HashSize, OUT UINT8 Signature, IN OUT UINTN SigSize)

BOOLEAN EFIAPI	RsaPkcs1Verify (IN VOID RsaContext, IN CONST UINT8 MessageHash, IN UINTN HashSize, IN CONST UINT8 *Signature, IN UINTN SigSize)

BOOLEAN EFIAPI	RsaPssSign (IN VOID RsaContext, IN CONST UINT8 Message, IN UINTN MsgSize, IN UINT16 DigestLen, IN UINT16 SaltLen, OUT UINT8 Signature, IN OUT UINTN SigSize)

BOOLEAN EFIAPI	RsaPssVerify (IN VOID RsaContext, IN CONST UINT8 Message, IN UINTN MsgSize, IN CONST UINT8 *Signature, IN UINTN SigSize, IN UINT16 DigestLen, IN UINT16 SaltLen)

BOOLEAN EFIAPI	RsaGetPrivateKeyFromPem (IN CONST UINT8 PemData, IN UINTN PemSize, IN CONST CHAR8 Password, OUT VOID **RsaContext)

BOOLEAN EFIAPI	RsaGetPublicKeyFromX509 (IN CONST UINT8 Cert, IN UINTN CertSize, OUT VOID *RsaContext)

BOOLEAN EFIAPI	X509GetSubjectName (IN CONST UINT8 Cert, IN UINTN CertSize, OUT UINT8 CertSubject, IN OUT UINTN *SubjectSize)

RETURN_STATUS EFIAPI	X509GetCommonName (IN CONST UINT8 Cert, IN UINTN CertSize, OUT CHAR8 CommonName OPTIONAL, IN OUT UINTN *CommonNameSize)

RETURN_STATUS EFIAPI	X509GetOrganizationName (IN CONST UINT8 Cert, IN UINTN CertSize, OUT CHAR8 NameBuffer OPTIONAL, IN OUT UINTN *NameBufferSize)

BOOLEAN EFIAPI	X509VerifyCert (IN CONST UINT8 Cert, IN UINTN CertSize, IN CONST UINT8 CACert, IN UINTN CACertSize)

BOOLEAN EFIAPI	X509ConstructCertificate (IN CONST UINT8 Cert, IN UINTN CertSize, OUT UINT8 *SingleX509Cert)

BOOLEAN EFIAPI	X509ConstructCertificateStackV (IN OUT UINT8 **X509Stack, IN VA_LIST Args)

BOOLEAN EFIAPI	X509ConstructCertificateStack (IN OUT UINT8 **X509Stack,...)

VOID EFIAPI	X509Free (IN VOID *X509Cert)

VOID EFIAPI	X509StackFree (IN VOID *X509Stack)

BOOLEAN EFIAPI	X509GetTBSCert (IN CONST UINT8 Cert, IN UINTN CertSize, OUT UINT8 TBSCert, OUT UINTN TBSCertSize)

BOOLEAN EFIAPI	Pkcs5HashPassword (IN UINTN PasswordLength, IN CONST CHAR8 Password, IN UINTN SaltLength, IN CONST UINT8 Salt, IN UINTN IterationCount, IN UINTN DigestSize, IN UINTN KeyLength, OUT UINT8 *OutKey)

BOOLEAN EFIAPI	Pkcs1v2Encrypt (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)

BOOLEAN EFIAPI	RsaOaepEncrypt (IN VOID RsaContext, IN UINT8 InData, IN UINTN InDataSize, IN CONST UINT8 PrngSeed OPTIONAL, IN UINTN PrngSeedSize OPTIONAL, IN UINT16 DigestLen OPTIONAL, OUT UINT8 EncryptedData, OUT UINTN EncryptedDataSize)

BOOLEAN EFIAPI	Pkcs1v2Decrypt (IN CONST UINT8 PrivateKey, IN UINTN PrivateKeySize, IN UINT8 EncryptedData, IN UINTN EncryptedDataSize, OUT UINT8 *OutData, OUT UINTN OutDataSize)

BOOLEAN EFIAPI	RsaOaepDecrypt (IN VOID RsaContext, IN UINT8 EncryptedData, IN UINTN EncryptedDataSize, IN UINT16 DigestLen OPTIONAL, OUT UINT8 *OutData, OUT UINTN OutDataSize)

BOOLEAN EFIAPI	Pkcs7GetSigners (IN CONST UINT8 P7Data, IN UINTN P7Length, OUT UINT8 CertStack, OUT UINTN StackLength, OUT UINT8 *TrustedCert, OUT UINTN CertLength)

VOID EFIAPI	Pkcs7FreeSigners (IN UINT8 *Certs)

BOOLEAN EFIAPI	Pkcs7GetCertificatesList (IN CONST UINT8 P7Data, IN UINTN P7Length, OUT UINT8 SignerChainCerts, OUT UINTN ChainLength, OUT UINT8 *UnchainCerts, OUT UINTN UnchainLength)

BOOLEAN EFIAPI	Pkcs7Sign (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)

BOOLEAN EFIAPI	Pkcs7Verify (IN CONST UINT8 P7Data, IN UINTN P7Length, IN CONST UINT8 TrustedCert, IN UINTN CertLength, IN CONST UINT8 *InData, IN UINTN DataLength)

RETURN_STATUS EFIAPI	VerifyEKUsInPkcs7Signature (IN CONST UINT8 Pkcs7Signature, IN CONST UINT32 SignatureSize, IN CONST CHAR8 RequiredEKUs[], IN CONST UINT32 RequiredEKUsSize, IN BOOLEAN RequireAllPresent)

BOOLEAN EFIAPI	Pkcs7GetAttachedContent (IN CONST UINT8 P7Data, IN UINTN P7Length, OUT VOID Content, OUT UINTN ContentSize)

BOOLEAN EFIAPI	AuthenticodeVerify (IN CONST UINT8 AuthData, IN UINTN DataSize, IN CONST UINT8 TrustedCert, IN UINTN CertSize, IN CONST UINT8 *ImageHash, IN UINTN HashSize)

BOOLEAN EFIAPI	ImageTimestampVerify (IN CONST UINT8 AuthData, IN UINTN DataSize, IN CONST UINT8 TsaCert, IN UINTN CertSize, OUT EFI_TIME *SigningTime)

BOOLEAN EFIAPI	X509GetVersion (IN CONST UINT8 Cert, IN UINTN CertSize, OUT UINTN Version)

BOOLEAN EFIAPI	X509GetSerialNumber (IN CONST UINT8 Cert, IN UINTN CertSize, OUT UINT8 SerialNumber, OPTIONAL IN OUT UINTN *SerialNumberSize)

BOOLEAN EFIAPI	X509GetIssuerName (IN CONST UINT8 Cert, IN UINTN CertSize, OUT UINT8 CertIssuer, IN OUT UINTN *CertIssuerSize)

BOOLEAN EFIAPI	X509GetSignatureAlgorithm (IN CONST UINT8 Cert, IN UINTN CertSize, OUT UINT8 Oid, OPTIONAL IN OUT UINTN *OidSize)

BOOLEAN EFIAPI	X509GetExtensionData (IN CONST UINT8 Cert, IN UINTN CertSize, IN CONST UINT8 Oid, IN UINTN OidSize, OUT UINT8 ExtensionData, IN OUT UINTN ExtensionDataSize)

BOOLEAN EFIAPI	X509GetValidity (IN CONST UINT8 Cert, IN UINTN CertSize, IN UINT8 From, IN OUT UINTN FromSize, IN UINT8 To, IN OUT UINTN *ToSize)

BOOLEAN EFIAPI	X509FormatDateTime (IN CONST CHAR8 DateTimeStr, OUT VOID DateTime, IN OUT UINTN *DateTimeSize)

INT32 EFIAPI	X509CompareDateTime (IN CONST VOID DateTime1, IN CONST VOID DateTime2)

BOOLEAN EFIAPI	X509GetKeyUsage (IN CONST UINT8 Cert, IN UINTN CertSize, OUT UINTN Usage)

BOOLEAN EFIAPI	X509GetExtendedKeyUsage (IN CONST UINT8 Cert, IN UINTN CertSize, OUT UINT8 Usage, IN OUT UINTN *UsageSize)

BOOLEAN EFIAPI	X509VerifyCertChain (IN CONST UINT8 RootCert, IN UINTN RootCertLength, IN CONST UINT8 CertChain, IN UINTN CertChainLength)

BOOLEAN EFIAPI	X509GetCertFromCertChain (IN CONST UINT8 CertChain, IN UINTN CertChainLength, IN CONST INT32 CertIndex, OUT CONST UINT8 Cert, OUT UINTN CertLength)

BOOLEAN EFIAPI	Asn1GetTag (IN OUT UINT8 *Ptr, IN CONST UINT8 End, OUT UINTN *Length, IN UINT32 Tag)

BOOLEAN EFIAPI	X509GetExtendedBasicConstraints (CONST UINT8 Cert, UINTN CertSize, UINT8 BasicConstraints, UINTN *BasicConstraintsSize)

VOID *EFIAPI	DhNew (VOID)

VOID EFIAPI	DhFree (IN VOID *DhContext)

BOOLEAN EFIAPI	DhGenerateParameter (IN OUT VOID DhContext, IN UINTN Generator, IN UINTN PrimeLength, OUT UINT8 Prime)

BOOLEAN EFIAPI	DhSetParameter (IN OUT VOID DhContext, IN UINTN Generator, IN UINTN PrimeLength, IN CONST UINT8 Prime)

BOOLEAN EFIAPI	DhGenerateKey (IN OUT VOID DhContext, OUT UINT8 PublicKey, IN OUT UINTN *PublicKeySize)

BOOLEAN EFIAPI	DhComputeKey (IN OUT VOID DhContext, IN CONST UINT8 PeerPublicKey, IN UINTN PeerPublicKeySize, OUT UINT8 Key, IN OUT UINTN KeySize)

BOOLEAN EFIAPI	RandomSeed (IN CONST UINT8 *Seed OPTIONAL, IN UINTN SeedSize)

BOOLEAN EFIAPI	RandomBytes (OUT UINT8 *Output, IN UINTN Size)

BOOLEAN EFIAPI	HkdfSha256ExtractAndExpand (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)

BOOLEAN EFIAPI	HkdfSha256Extract (IN CONST UINT8 Key, IN UINTN KeySize, IN CONST UINT8 Salt, IN UINTN SaltSize, OUT UINT8 *PrkOut, UINTN PrkOutSize)

BOOLEAN EFIAPI	HkdfSha256Expand (IN CONST UINT8 Prk, IN UINTN PrkSize, IN CONST UINT8 Info, IN UINTN InfoSize, OUT UINT8 *Out, IN UINTN OutSize)

BOOLEAN EFIAPI	HkdfSha384ExtractAndExpand (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)

BOOLEAN EFIAPI	HkdfSha384Extract (IN CONST UINT8 Key, IN UINTN KeySize, IN CONST UINT8 Salt, IN UINTN SaltSize, OUT UINT8 *PrkOut, UINTN PrkOutSize)

BOOLEAN EFIAPI	HkdfSha384Expand (IN CONST UINT8 Prk, IN UINTN PrkSize, IN CONST UINT8 Info, IN UINTN InfoSize, OUT UINT8 *Out, IN UINTN OutSize)

VOID *EFIAPI	BigNumInit (VOID)

VOID *EFIAPI	BigNumFromBin (IN CONST UINT8 *Buf, IN UINTN Len)

INTN EFIAPI	BigNumToBin (IN CONST VOID Bn, OUT UINT8 Buf)

VOID EFIAPI	BigNumFree (IN VOID *Bn, IN BOOLEAN Clear)

BOOLEAN EFIAPI	BigNumAdd (IN CONST VOID BnA, IN CONST VOID BnB, OUT VOID *BnRes)

BOOLEAN EFIAPI	BigNumSub (IN CONST VOID BnA, IN CONST VOID BnB, OUT VOID *BnRes)

BOOLEAN EFIAPI	BigNumMod (IN CONST VOID BnA, IN CONST VOID BnB, OUT VOID *BnRes)

BOOLEAN EFIAPI	BigNumExpMod (IN CONST VOID BnA, IN CONST VOID BnP, IN CONST VOID BnM, OUT VOID BnRes)

BOOLEAN EFIAPI	BigNumInverseMod (IN CONST VOID BnA, IN CONST VOID BnM, OUT VOID *BnRes)

BOOLEAN EFIAPI	BigNumDiv (IN CONST VOID BnA, IN CONST VOID BnB, OUT VOID *BnRes)

BOOLEAN EFIAPI	BigNumMulMod (IN CONST VOID BnA, IN CONST VOID BnB, IN CONST VOID BnM, OUT VOID BnRes)

INTN EFIAPI	BigNumCmp (IN CONST VOID BnA, IN CONST VOID BnB)

UINTN EFIAPI	BigNumBits (IN CONST VOID *Bn)

UINTN EFIAPI	BigNumBytes (IN CONST VOID *Bn)

BOOLEAN EFIAPI	BigNumIsWord (IN CONST VOID *Bn, IN UINTN Num)

BOOLEAN EFIAPI	BigNumIsOdd (IN CONST VOID *Bn)

VOID *EFIAPI	BigNumCopy (OUT VOID BnDst, IN CONST VOID BnSrc)

CONST VOID *EFIAPI	BigNumValueOne (VOID)

BOOLEAN EFIAPI	BigNumRShift (IN CONST VOID Bn, IN UINTN N, OUT VOID BnRes)

VOID EFIAPI	BigNumConstTime (IN VOID *Bn)

BOOLEAN EFIAPI	BigNumSqrMod (IN CONST VOID BnA, IN CONST VOID BnM, OUT VOID *BnRes)

VOID *EFIAPI	BigNumNewContext (VOID)

VOID EFIAPI	BigNumContextFree (IN VOID *BnCtx)

BOOLEAN EFIAPI	BigNumSetUint (IN VOID *Bn, IN UINTN Val)

BOOLEAN EFIAPI	BigNumAddMod (IN CONST VOID BnA, IN CONST VOID BnB, IN CONST VOID BnM, OUT VOID BnRes)

VOID *EFIAPI	EcGroupInit (IN UINTN CryptoNid)

BOOLEAN EFIAPI	EcGroupGetCurve (IN CONST VOID EcGroup, OUT VOID BnPrime, OUT VOID BnA, OUT VOID BnB, IN VOID *BnCtx)

BOOLEAN EFIAPI	EcGroupGetOrder (IN VOID EcGroup, OUT VOID BnOrder)

VOID EFIAPI	EcGroupFree (IN VOID *EcGroup)

VOID *EFIAPI	EcPointInit (IN CONST VOID *EcGroup)

VOID EFIAPI	EcPointDeInit (IN VOID *EcPoint, IN BOOLEAN Clear)

BOOLEAN EFIAPI	EcPointGetAffineCoordinates (IN CONST VOID EcGroup, IN CONST VOID EcPoint, OUT VOID BnX, OUT VOID BnY, IN VOID *BnCtx)

BOOLEAN EFIAPI	EcPointSetAffineCoordinates (IN CONST VOID EcGroup, IN VOID EcPoint, IN CONST VOID BnX, IN CONST VOID BnY, IN VOID *BnCtx)

BOOLEAN EFIAPI	EcPointAdd (IN CONST VOID EcGroup, OUT VOID EcPointResult, IN CONST VOID EcPointA, IN CONST VOID EcPointB, IN VOID *BnCtx)

BOOLEAN EFIAPI	EcPointMul (IN CONST VOID EcGroup, OUT VOID EcPointResult, IN CONST VOID EcPoint, IN CONST VOID BnPScalar, IN VOID *BnCtx)

BOOLEAN EFIAPI	EcPointInvert (IN CONST VOID EcGroup, IN OUT VOID EcPoint, IN VOID *BnCtx)

BOOLEAN EFIAPI	EcPointIsOnCurve (IN CONST VOID EcGroup, IN CONST VOID EcPoint, IN VOID *BnCtx)

BOOLEAN EFIAPI	EcPointIsAtInfinity (IN CONST VOID EcGroup, IN CONST VOID EcPoint)

BOOLEAN EFIAPI	EcPointEqual (IN CONST VOID EcGroup, IN CONST VOID EcPointA, IN CONST VOID EcPointB, IN VOID BnCtx)

BOOLEAN EFIAPI	EcPointSetCompressedCoordinates (IN CONST VOID EcGroup, IN VOID EcPoint, IN CONST VOID BnX, IN UINT8 YBit, IN VOID BnCtx)

VOID *EFIAPI	EcNewByNid (IN UINTN Nid)

VOID EFIAPI	EcFree (IN VOID *EcContext)

BOOLEAN EFIAPI	EcGenerateKey (IN OUT VOID EcContext, OUT UINT8 PublicKey, IN OUT UINTN *PublicKeySize)

BOOLEAN EFIAPI	EcGetPubKey (IN OUT VOID EcContext, OUT UINT8 PublicKey, IN OUT UINTN *PublicKeySize)

BOOLEAN EFIAPI	EcDhComputeKey (IN OUT VOID EcContext, IN CONST UINT8 PeerPublic, IN UINTN PeerPublicSize, IN CONST INT32 CompressFlag, OUT UINT8 Key, IN OUT UINTN *KeySize)

BOOLEAN EFIAPI	EcGetPrivateKeyFromPem (IN CONST UINT8 PemData, IN UINTN PemSize, IN CONST CHAR8 Password, OUT VOID **EcContext)

BOOLEAN EFIAPI	EcGetPublicKeyFromX509 (IN CONST UINT8 Cert, IN UINTN CertSize, OUT VOID *EcContext)

BOOLEAN EFIAPI	EcDsaSign (IN VOID EcContext, IN UINTN HashNid, IN CONST UINT8 MessageHash, IN UINTN HashSize, OUT UINT8 Signature, IN OUT UINTN SigSize)

BOOLEAN EFIAPI	EcDsaVerify (IN VOID EcContext, IN UINTN HashNid, IN CONST UINT8 MessageHash, IN UINTN HashSize, IN CONST UINT8 *Signature, IN UINTN SigSize)

Detailed Description

Defines base cryptographic library APIs. The Base Cryptographic Library provides implementations of basic cryptography primitives (Hash Serials, HMAC, RSA, Diffie-Hellman, etc) for UEFI security functionality enabling.

Definition in file BaseCryptLib.h.

Macro Definition Documentation

◆ AES_BLOCK_SIZE

#define AES_BLOCK_SIZE 16

AES block size in bytes

Definition at line 69 of file BaseCryptLib.h.

◆ CRYPTO_NID_BRAINPOOLP512R1

#define CRYPTO_NID_BRAINPOOLP512R1 0x03A5

Definition at line 29 of file BaseCryptLib.h.

◆ CRYPTO_NID_NULL

#define CRYPTO_NID_NULL 0x0000

Definition at line 18 of file BaseCryptLib.h.

◆ CRYPTO_NID_SECP256R1

#define CRYPTO_NID_SECP256R1 0x0204

Definition at line 26 of file BaseCryptLib.h.

◆ CRYPTO_NID_SECP384R1

#define CRYPTO_NID_SECP384R1 0x0205

Definition at line 27 of file BaseCryptLib.h.

◆ CRYPTO_NID_SECP521R1

#define CRYPTO_NID_SECP521R1 0x0206

Definition at line 28 of file BaseCryptLib.h.

◆ CRYPTO_NID_SHA256

#define CRYPTO_NID_SHA256 0x0001

Definition at line 21 of file BaseCryptLib.h.

◆ CRYPTO_NID_SHA384

#define CRYPTO_NID_SHA384 0x0002

Definition at line 22 of file BaseCryptLib.h.

◆ CRYPTO_NID_SHA512

#define CRYPTO_NID_SHA512 0x0003

Definition at line 23 of file BaseCryptLib.h.

◆ MD5_DIGEST_SIZE

#define MD5_DIGEST_SIZE 16

MD5 digest size in bytes

Definition at line 34 of file BaseCryptLib.h.

◆ SHA1_DIGEST_SIZE

#define SHA1_DIGEST_SIZE 20

SHA-1 digest size in bytes.

Definition at line 39 of file BaseCryptLib.h.

◆ SHA256_DIGEST_SIZE

#define SHA256_DIGEST_SIZE 32

SHA-256 digest size in bytes

Definition at line 44 of file BaseCryptLib.h.

◆ SHA384_DIGEST_SIZE

#define SHA384_DIGEST_SIZE 48

SHA-384 digest size in bytes

Definition at line 49 of file BaseCryptLib.h.

◆ SHA512_DIGEST_SIZE

#define SHA512_DIGEST_SIZE 64

SHA-512 digest size in bytes

Definition at line 54 of file BaseCryptLib.h.

◆ SM3_256_DIGEST_SIZE

#define SM3_256_DIGEST_SIZE 32

SM3 digest size in bytes

Definition at line 59 of file BaseCryptLib.h.

◆ TDES_BLOCK_SIZE

#define TDES_BLOCK_SIZE 8

TDES block size in bytes

Definition at line 64 of file BaseCryptLib.h.

Enumeration Type Documentation

◆ RSA_KEY_TAG

enum RSA_KEY_TAG

RSA Key Tags Definition used in RsaSetKey() function for key component identification.

Enumerator
RsaKeyN	RSA public Modulus (N)
RsaKeyE	RSA Public exponent (e)
RsaKeyD	RSA Private exponent (d)
RsaKeyP	RSA secret prime factor of Modulus (p)
RsaKeyQ	RSA secret prime factor of Modules (q)
RsaKeyDp	p's CRT exponent (== d mod (p - 1))
RsaKeyDq	q's CRT exponent (== d mod (q - 1))
RsaKeyQInv	The CRT coefficient (== 1/q mod p)

Definition at line 74 of file BaseCryptLib.h.

Function Documentation

◆ AeadAesGcmDecrypt()

BOOLEAN EFIAPI AeadAesGcmDecrypt	(	IN CONST UINT8 *	Key,
		IN UINTN	KeySize,
		IN CONST UINT8 *	Iv,
		IN UINTN	IvSize,
		IN CONST UINT8 *	AData,
		IN UINTN	ADataSize,
		IN CONST UINT8 *	DataIn,
		IN UINTN	DataInSize,
		IN CONST UINT8 *	Tag,
		IN UINTN	TagSize,
		OUT UINT8 *	DataOut,
		OUT UINTN *	DataOutSize
	)

Performs AEAD AES-GCM authenticated decryption on a data buffer and additional authenticated data (AAD).

IvSize must be 12, otherwise FALSE is returned. KeySize must be 16, 24 or 32, otherwise FALSE is returned. TagSize must be 12, 13, 14, 15, 16, otherwise FALSE is returned. If additional authenticated data verification fails, FALSE is returned.

Parameters

[in]	Key	Pointer to the encryption key.
[in]	KeySize	Size of the encryption key in bytes.
[in]	Iv	Pointer to the IV value.
[in]	IvSize	Size of the IV value in bytes.
[in]	AData	Pointer to the additional authenticated data (AAD).
[in]	ADataSize	Size of the additional authenticated data (AAD) in bytes.
[in]	DataIn	Pointer to the input data buffer to be decrypted.
[in]	DataInSize	Size of the input data buffer in bytes.
[in]	Tag	Pointer to a buffer that contains the authentication tag.
[in]	TagSize	Size of the authentication tag in bytes.
[out]	DataOut	Pointer to a buffer that receives the decryption output.
[out]	DataOutSize	Size of the output data buffer in bytes.

Return values

TRUE	AEAD AES-GCM authenticated decryption succeeded.
FALSE	AEAD AES-GCM authenticated decryption failed.

Definition at line 175 of file CryptAeadAesGcm.c.

◆ AeadAesGcmEncrypt()

BOOLEAN EFIAPI AeadAesGcmEncrypt	(	IN CONST UINT8 *	Key,
		IN UINTN	KeySize,
		IN CONST UINT8 *	Iv,
		IN UINTN	IvSize,
		IN CONST UINT8 *	AData,
		IN UINTN	ADataSize,
		IN CONST UINT8 *	DataIn,
		IN UINTN	DataInSize,
		OUT UINT8 *	TagOut,
		IN UINTN	TagSize,
		OUT UINT8 *	DataOut,
		OUT UINTN *	DataOutSize
	)

Performs AEAD AES-GCM authenticated encryption on a data buffer and additional authenticated data (AAD).

IvSize must be 12, otherwise FALSE is returned. KeySize must be 16, 24 or 32, otherwise FALSE is returned. TagSize must be 12, 13, 14, 15, 16, otherwise FALSE is returned.

Parameters

[in]	Key	Pointer to the encryption key.
[in]	KeySize	Size of the encryption key in bytes.
[in]	Iv	Pointer to the IV value.
[in]	IvSize	Size of the IV value in bytes.
[in]	AData	Pointer to the additional authenticated data (AAD).
[in]	ADataSize	Size of the additional authenticated data (AAD) in bytes.
[in]	DataIn	Pointer to the input data buffer to be encrypted.
[in]	DataInSize	Size of the input data buffer in bytes.
[out]	TagOut	Pointer to a buffer that receives the authentication tag output.
[in]	TagSize	Size of the authentication tag in bytes.
[out]	DataOut	Pointer to a buffer that receives the encryption output.
[out]	DataOutSize	Size of the output data buffer in bytes.

Return values

TRUE	AEAD AES-GCM authenticated encryption succeeded.
FALSE	AEAD AES-GCM authenticated encryption failed.

Definition at line 42 of file CryptAeadAesGcm.c.

◆ AesCbcDecrypt()

BOOLEAN EFIAPI AesCbcDecrypt	(	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.

Parameters

[in]	AesContext	Pointer to the AES context.
[in]	Input	Pointer to the buffer containing the data to be encrypted.
[in]	InputSize	Size of the Input buffer in bytes.
[in]	Ivec	Pointer to initialization vector.
[out]	Output	Pointer to a buffer that receives the AES encryption output.

Return values

TRUE	AES decryption succeeded.
FALSE	AES decryption failed.
FALSE	This interface is not supported.

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.

Parameters

[in]	AesContext	Pointer to the AES context.
[in]	Input	Pointer to the buffer containing the data to be encrypted.
[in]	InputSize	Size of the Input buffer in bytes.
[in]	Ivec	Pointer to initialization vector.
[out]	Output	Pointer to a buffer that receives the AES encryption output.

Return values

TRUE	AES decryption succeeded.
FALSE	AES decryption failed.

Performs AES decryption on a data buffer of the specified size in CBC mode.

Return FALSE to indicate this interface is not supported.

Parameters

[in]	AesContext	Pointer to the AES context.
[in]	Input	Pointer to the buffer containing the data to be encrypted.
[in]	InputSize	Size of the Input buffer in bytes.
[in]	Ivec	Pointer to initialization vector.
[out]	Output	Pointer to a buffer that receives the AES encryption output.

Return values

FALSE This interface is not supported.

Definition at line 174 of file CryptAes.c.

◆ AesCbcEncrypt()

BOOLEAN EFIAPI AesCbcEncrypt	(	IN VOID *	AesContext,
		IN CONST UINT8 *	Input,
		IN UINTN	InputSize,
		IN CONST UINT8 *	Ivec,
		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.

Parameters

[in]	AesContext	Pointer to the AES context.
[in]	Input	Pointer to the buffer containing the data to be encrypted.
[in]	InputSize	Size of the Input buffer in bytes.
[in]	Ivec	Pointer to initialization vector.
[out]	Output	Pointer to a buffer that receives the AES encryption output.

Return values

TRUE	AES encryption succeeded.
FALSE	AES encryption failed.
FALSE	This interface is not supported.

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.

Parameters

[in]	AesContext	Pointer to the AES context.
[in]	Input	Pointer to the buffer containing the data to be encrypted.
[in]	InputSize	Size of the Input buffer in bytes.
[in]	Ivec	Pointer to initialization vector.
[out]	Output	Pointer to a buffer that receives the AES encryption output.

Return values

TRUE	AES encryption succeeded.
FALSE	AES encryption failed.

Performs AES encryption on a data buffer of the specified size in CBC mode.

Return FALSE to indicate this interface is not supported.

Parameters

[in]	AesContext	Pointer to the AES context.
[in]	Input	Pointer to the buffer containing the data to be encrypted.
[in]	InputSize	Size of the Input buffer in bytes.
[in]	Ivec	Pointer to initialization vector.
[out]	Output	Pointer to a buffer that receives the AES encryption output.

Return values

FALSE This interface is not supported.

Definition at line 112 of file CryptAes.c.

◆ AesGetContextSize()

UINTN EFIAPI AesGetContextSize ( VOID )

Retrieves the size, in bytes, of the context buffer required for AES operations.

If this interface is not supported, then return zero.

Returns: The size, in bytes, of the context buffer required for AES operations.

Return values

0	This interface is not supported.

Retrieves the size, in bytes, of the context buffer required for AES operations.

Returns: The size, in bytes, of the context buffer required for AES operations.

Retrieves the size, in bytes, of the context buffer required for AES operations.

Return zero to indicate this interface is not supported.

Return values

0	This interface is not supported.

Definition at line 20 of file CryptAes.c.

◆ AesInit()

BOOLEAN EFIAPI AesInit	(	OUT VOID *	AesContext,
		IN CONST UINT8 *	Key,
		IN UINTN	KeyLength
	)

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.

Parameters

[out]	AesContext	Pointer to AES context being initialized.
[in]	Key	Pointer to the user-supplied AES key.
[in]	KeyLength	Length of AES key in bits.

Return values

TRUE	AES context initialization succeeded.
FALSE	AES context initialization failed.
FALSE	This interface is not supported.

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.

Parameters

[out]	AesContext	Pointer to AES context being initialized.
[in]	Key	Pointer to the user-supplied AES key.
[in]	KeyLength	Length of AES key in bits.

Return values

TRUE	AES context initialization succeeded.
FALSE	AES context initialization failed.

Initializes user-supplied memory as AES context for subsequent use.

Return FALSE to indicate this interface is not supported.

Parameters

[out]	AesContext	Pointer to AES context being initialized.
[in]	Key	Pointer to the user-supplied AES key.
[in]	KeyLength	Length of AES key in bits.

Return values

FALSE This interface is not supported.

Definition at line 53 of file CryptAes.c.

◆ Asn1GetTag()

BOOLEAN EFIAPI Asn1GetTag	(	IN OUT UINT8 **	Ptr,
		IN CONST UINT8 *	End,
		OUT UINTN *	Length,
		IN UINT32	Tag
	)

Retrieve the tag and length of the tag.

Parameters

Ptr	The position in the ASN.1 data
End	End of data
Length	The variable that will receive the length
Tag	The expected tag

Return values

TRUE	Get tag successful
FALSe	Failed to get tag or tag not match

Definition at line 1884 of file CryptX509.c.

◆ AuthenticodeVerify()

BOOLEAN EFIAPI AuthenticodeVerify	(	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 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.

Parameters

[in]	AuthData	Pointer to the Authenticode Signature retrieved from signed PE/COFF image to be verified.
[in]	DataSize	Size of the Authenticode Signature in bytes.
[in]	TrustedCert	Pointer to a trusted/root certificate encoded in DER, which is used for certificate chain verification.
[in]	CertSize	Size of the trusted certificate in bytes.
[in]	ImageHash	Pointer to the original image file hash value. The procedure for calculating the image hash value is described in Authenticode specification.
[in]	HashSize	Size of Image hash value in bytes.

Return values

TRUE	The specified Authenticode Signature is valid.
FALSE	Invalid Authenticode Signature.
FALSE	This interface is not supported.

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.

Caution: This function may receive untrusted input. PE/COFF Authenticode is external input, so this function will do basic check for Authenticode data structure.

Parameters

[in]	AuthData	Pointer to the Authenticode Signature retrieved from signed PE/COFF image to be verified.
[in]	DataSize	Size of the Authenticode Signature in bytes.
[in]	TrustedCert	Pointer to a trusted/root certificate encoded in DER, which is used for certificate chain verification.
[in]	CertSize	Size of the trusted certificate in bytes.
[in]	ImageHash	Pointer to the original image file hash value. The procedure for calculating the image hash value is described in Authenticode specification.
[in]	HashSize	Size of Image hash value in bytes.

Return values

TRUE	The specified Authenticode Signature is valid.
FALSE	Invalid Authenticode Signature.

Verifies the validity of a PE/COFF Authenticode Signature as described in "Windows Authenticode Portable Executable Signature Format".

Return FALSE to indicate this interface is not supported.

Parameters

[in]	AuthData	Pointer to the Authenticode Signature retrieved from signed PE/COFF image to be verified.
[in]	DataSize	Size of the Authenticode Signature in bytes.
[in]	TrustedCert	Pointer to a trusted/root certificate encoded in DER, which is used for certificate chain verification.
[in]	CertSize	Size of the trusted certificate in bytes.
[in]	ImageHash	Pointer to the original image file hash value. The procedure for calculating the image hash value is described in Authenticode specification.
[in]	HashSize	Size of Image hash value in bytes.

Return values

FALSE This interface is not supported.

Definition at line 58 of file CryptAuthenticode.c.

◆ BigNumAdd()

BOOLEAN EFIAPI BigNumAdd	(	IN CONST VOID *	BnA,
		IN CONST VOID *	BnB,
		OUT VOID *	BnRes
	)

Calculate the sum of two Big Numbers. Please note, all "out" Big number arguments should be properly initialized by calling to BigNumInit() or BigNumFromBin() functions.

Parameters

[in]	BnA	Big number.
[in]	BnB	Big number.
[out]	BnRes	The result of BnA + BnB.

Return values

TRUE	On success.
FALSE	Otherwise.

Definition at line 96 of file CryptBn.c.

◆ BigNumAddMod()

BOOLEAN EFIAPI BigNumAddMod	(	IN CONST VOID *	BnA,
		IN CONST VOID *	BnB,
		IN CONST VOID *	BnM,
		OUT VOID *	BnRes
	)

Add two Big Numbers modulo BnM.

Parameters

[in]	BnA	Big number.
[in]	BnB	Big number.
[in]	BnM	Big number (modulo).
[out]	BnRes	The result, such that (BnA + BnB) % BnM.

Return values

TRUE	On success.
FALSE	Otherwise.

Definition at line 562 of file CryptBn.c.

◆ BigNumBits()

UINTN EFIAPI BigNumBits ( IN CONST VOID * Bn )

Get number of bits in Bn.

Parameters

[in] Bn Big number.

Return values

Number of bits.

Definition at line 334 of file CryptBn.c.

◆ BigNumBytes()

UINTN EFIAPI BigNumBytes ( IN CONST VOID * Bn )

Get number of bytes in Bn.

Parameters

[in] Bn Big number.

Return values

Number of bytes.

Definition at line 350 of file CryptBn.c.

◆ BigNumCmp()

INTN EFIAPI BigNumCmp	(	IN CONST VOID *	BnA,
		IN CONST VOID *	BnB
	)

Compare two Big Numbers.

Parameters

[in]	BnA	Big number.
[in]	BnB	Big number.

Return values

0	BnA == BnB.
1	BnA > BnB.
-1	BnA < BnB.

Definition at line 317 of file CryptBn.c.

◆ BigNumConstTime()

VOID EFIAPI BigNumConstTime ( IN VOID * Bn )

Mark Big Number for constant time computations. This function should be called before any constant time computations are performed on the given Big number.

Parameters

[in] Bn Big number.

Mark Big Number for constant time computations. This function should be called before any constant time computations are performed on the given Big number.

Parameters

[in] Bn Big number

Definition at line 459 of file CryptBn.c.

◆ BigNumContextFree()

VOID EFIAPI BigNumContextFree ( IN VOID * BnCtx )

Free Big Number context that was allocated with BigNumNewContext().

Parameters

[in] BnCtx Big number context to free.

Definition at line 523 of file CryptBn.c.

◆ BigNumCopy()

VOID *EFIAPI BigNumCopy	(	OUT VOID *	BnDst,
		IN CONST VOID *	BnSrc
	)

Copy Big number.

Parameters

[out]	BnDst	Destination.
[in]	BnSrc	Source.

Return values

BnDst	on success.
NULL	otherwise.

Definition at line 404 of file CryptBn.c.

◆ BigNumDiv()

BOOLEAN EFIAPI BigNumDiv	(	IN CONST VOID *	BnA,
		IN CONST VOID *	BnB,
		OUT VOID *	BnRes
	)

Divide two Big Numbers. Please note, all "out" Big number arguments should be properly initialized by calling to BigNumInit() or BigNumFromBin() functions.

Parameters

[in]	BnA	Big number.
[in]	BnB	Big number.
[out]	BnRes	The result, such that BnA / BnB.

Return values

TRUE	On success.
FALSE	Otherwise.

Definition at line 249 of file CryptBn.c.

◆ BigNumExpMod()

BOOLEAN EFIAPI BigNumExpMod	(	IN CONST VOID *	BnA,
		IN CONST VOID *	BnP,
		IN CONST VOID *	BnM,
		OUT VOID *	BnRes
	)

Compute BnA to the BnP-th power modulo BnM. Please note, all "out" Big number arguments should be properly initialized by calling to BigNumInit() or BigNumFromBin() functions.

Parameters

[in]	BnA	Big number.
[in]	BnP	Big number (power).
[in]	BnM	Big number (modulo).
[out]	BnRes	The result of (BnA ^ BnP) % BnM.

Return values

TRUE	On success.
FALSE	Otherwise.

Definition at line 177 of file CryptBn.c.

◆ BigNumFree()

VOID EFIAPI BigNumFree	(	IN VOID *	Bn,
		IN BOOLEAN	Clear
	)

Free the Big Number.

Parameters

[in]	Bn	Big number to free.
[in]	Clear	TRUE if the buffer should be cleared.

Definition at line 70 of file CryptBn.c.

◆ BigNumFromBin()

VOID *EFIAPI BigNumFromBin	(	IN CONST UINT8 *	Buf,
		IN UINTN	Len
	)

Allocate new Big Number and assign the provided value to it.

Parameters

[in]	Buf	Big endian encoded buffer.
[in]	Len	Buffer length.

Return values

New	BigNum opaque structure or NULL on failure.

Definition at line 35 of file CryptBn.c.

◆ BigNumInit()

VOID *EFIAPI BigNumInit ( VOID )

Allocate new Big Number.

Return values

New	BigNum opaque structure or NULL on failure.

Definition at line 18 of file CryptBn.c.

◆ BigNumInverseMod()

BOOLEAN EFIAPI BigNumInverseMod	(	IN CONST VOID *	BnA,
		IN CONST VOID *	BnM,
		OUT VOID *	BnRes
	)

Compute BnA inverse modulo BnM. Please note, all "out" Big number arguments should be properly initialized by calling to BigNumInit() or BigNumFromBin() functions.

Parameters

[in]	BnA	Big number.
[in]	BnM	Big number (modulo).
[out]	BnRes	The result, such that (BnA * BnRes) % BnM == 1.

Return values

TRUE	On success.
FALSE	Otherwise.

Definition at line 212 of file CryptBn.c.

◆ BigNumIsOdd()

BOOLEAN EFIAPI BigNumIsOdd ( IN CONST VOID * Bn )

Checks if Big Number is odd.

Parameters

[in] Bn Big number.

Return values

TRUE	Bn is odd (Bn % 2 == 1).
FALSE	otherwise.

Definition at line 386 of file CryptBn.c.

◆ BigNumIsWord()

BOOLEAN EFIAPI BigNumIsWord	(	IN CONST VOID *	Bn,
		IN UINTN	Num
	)

Checks if Big Number equals to the given Num.

Parameters

[in]	Bn	Big number.
[in]	Num	Number.

Return values

TRUE	iff Bn == Num.
FALSE	otherwise.

Definition at line 368 of file CryptBn.c.

◆ BigNumMod()

BOOLEAN EFIAPI BigNumMod	(	IN CONST VOID *	BnA,
		IN CONST VOID *	BnB,
		OUT VOID *	BnRes
	)

Calculate remainder: BnRes = BnA % BnB. Please note, all "out" Big number arguments should be properly initialized by calling to BigNumInit() or BigNumFromBin() functions.

Parameters

[in]	BnA	Big number.
[in]	BnB	Big number.
[out]	BnRes	The result of BnA % BnB.

Return values

TRUE	On success.
FALSE	Otherwise.

Calculate remainder: BnRes = BnA % BnB Please note, all "out" Big number arguments should be properly initialized by calling to BigNumInit() or BigNumFromBin() functions.

Parameters

[in]	BnA	Big number.
[in]	BnB	Big number.
[out]	BnRes	The result of BnA % BnB.

Return values

TRUE	On success.
FALSE	Otherwise.

Definition at line 142 of file CryptBn.c.

◆ BigNumMulMod()

BOOLEAN EFIAPI BigNumMulMod	(	IN CONST VOID *	BnA,
		IN CONST VOID *	BnB,
		IN CONST VOID *	BnM,
		OUT VOID *	BnRes
	)

Multiply two Big Numbers modulo BnM. Please note, all "out" Big number arguments should be properly initialized by calling to BigNumInit() or BigNumFromBin() functions.

Parameters

[in]	BnA	Big number.
[in]	BnB	Big number.
[in]	BnM	Big number (modulo).
[out]	BnRes	The result, such that (BnA * BnB) % BnM.

Return values

TRUE	On success.
FALSE	Otherwise.

Definition at line 284 of file CryptBn.c.

◆ BigNumNewContext()

VOID *EFIAPI BigNumNewContext ( VOID )

Create new Big Number computation context. This is an opaque structure which should be passed to any function that requires it. The BN context is needed to optimize calculations and expensive allocations.

Return values

Big	Number context struct or NULL on failure.

Definition at line 509 of file CryptBn.c.

◆ BigNumRShift()

BOOLEAN EFIAPI BigNumRShift	(	IN CONST VOID *	Bn,
		IN UINTN	N,
		OUT VOID *	BnRes
	)

Shift right Big Number. Please note, all "out" Big number arguments should be properly initialized by calling to BigNumInit() or BigNumFromBin() functions.

Parameters

[in]	Bn	Big number.
[in]	N	Number of bits to shift.
[out]	BnRes	The result.

Return values

TRUE	On success.
FALSE	Otherwise.

Definition at line 441 of file CryptBn.c.

◆ BigNumSetUint()

BOOLEAN EFIAPI BigNumSetUint	(	IN VOID *	Bn,
		IN UINTN	Val
	)

Set Big Number to a given value.

Parameters

[in]	Bn	Big number to set.
[in]	Val	Value to set.

Return values

TRUE	On success.
FALSE	Otherwise.

Definition at line 541 of file CryptBn.c.

◆ BigNumSqrMod()

BOOLEAN EFIAPI BigNumSqrMod	(	IN CONST VOID *	BnA,
		IN CONST VOID *	BnM,
		OUT VOID *	BnRes
	)

Calculate square modulo. Please note, all "out" Big number arguments should be properly initialized by calling to BigNumInit() or BigNumFromBin() functions.

Parameters

[in]	BnA	Big number.
[in]	BnM	Big number (modulo).
[out]	BnRes	The result, such that (BnA ^ 2) % BnM.

Return values

TRUE	On success.
FALSE	Otherwise.

Definition at line 480 of file CryptBn.c.

◆ BigNumSub()

BOOLEAN EFIAPI BigNumSub	(	IN CONST VOID *	BnA,
		IN CONST VOID *	BnB,
		OUT VOID *	BnRes
	)

Subtract two Big Numbers. Please note, all "out" Big number arguments should be properly initialized by calling to BigNumInit() or BigNumFromBin() functions.

Parameters

[in]	BnA	Big number.
[in]	BnB	Big number.
[out]	BnRes	The result of BnA - BnB.

Return values

TRUE	On success.
FALSE	Otherwise.

Definition at line 119 of file CryptBn.c.

◆ BigNumToBin()

INTN EFIAPI BigNumToBin	(	IN CONST VOID *	Bn,
		OUT UINT8 *	Buf
	)

Convert the absolute value of Bn into big-endian form and store it at Buf. The Buf array should have at least BigNumBytes() in it.

Parameters

[in]	Bn	Big number to convert.
[out]	Buf	Output buffer.

Return values

The	length of the big-endian number placed at Buf or -1 on error.

Definition at line 54 of file CryptBn.c.

◆ BigNumValueOne()

CONST VOID *EFIAPI BigNumValueOne ( VOID )

Get constant Big number with value of "1". This may be used to save expensive allocations.

Return values

Big	Number with value of 1.

Definition at line 420 of file CryptBn.c.

◆ DhComputeKey()

BOOLEAN EFIAPI DhComputeKey	(	IN OUT VOID *	DhContext,
		IN CONST UINT8 *	PeerPublicKey,
		IN UINTN	PeerPublicKeySize,
		OUT UINT8 *	Key,
		IN OUT UINTN *	KeySize
	)

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.

Parameters

[in,out]	DhContext	Pointer to the DH context.
[in]	PeerPublicKey	Pointer to the peer's public key.
[in]	PeerPublicKeySize	Size of peer's public key in bytes.
[out]	Key	Pointer to the buffer to receive generated key.
[in,out]	KeySize	On input, the size of Key buffer in bytes. On output, the size of data returned in Key buffer in bytes.

Return values

TRUE	DH exchanged key generation succeeded.
FALSE	DH exchanged key generation failed.
FALSE	KeySize is not large enough.
FALSE	This interface is not supported.

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.

Parameters

[in,out]	DhContext	Pointer to the DH context.
[in]	PeerPublicKey	Pointer to the peer's public key.
[in]	PeerPublicKeySize	Size of peer's public key in bytes.
[out]	Key	Pointer to the buffer to receive generated key.
[in,out]	KeySize	On input, the size of Key buffer in bytes. On output, the size of data returned in Key buffer in bytes.

Return values

TRUE	DH exchanged key generation succeeded.
FALSE	DH exchanged key generation failed.
FALSE	KeySize is not large enough.

Computes exchanged common key.

Return FALSE to indicate this interface is not supported.

Parameters

[in,out]	DhContext	Pointer to the DH context.
[in]	PeerPublicKey	Pointer to the peer's public key.
[in]	PeerPublicKeySize	Size of peer's public key in bytes.
[out]	Key	Pointer to the buffer to receive generated key.
[in,out]	KeySize	On input, the size of Key buffer in bytes. On output, the size of data returned in Key buffer in bytes.

Return values

FALSE This interface is not supported.

Definition at line 265 of file CryptDh.c.

◆ DhFree()

VOID EFIAPI DhFree ( IN VOID * DhContext )

Release the specified DH context.

If the interface is not supported, then ASSERT().

Parameters

[in] DhContext Pointer to the DH context to be released.

Release the specified DH context.

If DhContext is NULL, then return FALSE.

Parameters

[in] DhContext Pointer to the DH context to be released.

Definition at line 42 of file CryptDh.c.

◆ DhGenerateKey()

BOOLEAN EFIAPI DhGenerateKey	(	IN OUT VOID *	DhContext,
		OUT UINT8 *	PublicKey,
		IN OUT UINTN *	PublicKeySize
	)

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.

Parameters

[in,out]	DhContext	Pointer to the DH context.
[out]	PublicKey	Pointer to the buffer to receive generated public key.
[in,out]	PublicKeySize	On input, the size of PublicKey buffer in bytes. On output, the size of data returned in PublicKey buffer in bytes.

Return values

TRUE	DH public key generation succeeded.
FALSE	DH public key generation failed.
FALSE	PublicKeySize is not large enough.
FALSE	This interface is not supported.

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.

Parameters

[in,out]	DhContext	Pointer to the DH context.
[out]	PublicKey	Pointer to the buffer to receive generated public key.
[in,out]	PublicKeySize	On input, the size of PublicKey buffer in bytes. On output, the size of data returned in PublicKey buffer in bytes.

Return values

TRUE	DH public key generation succeeded.
FALSE	DH public key generation failed.
FALSE	PublicKeySize is not large enough.

Generates DH public key.

Return FALSE to indicate this interface is not supported.

Parameters

[in,out]	DhContext	Pointer to the DH context.
[out]	PublicKey	Pointer to the buffer to receive generated public key.
[in,out]	PublicKeySize	On input, the size of PublicKey buffer in bytes. On output, the size of data returned in PublicKey buffer in bytes.

Return values

FALSE This interface is not supported.

Definition at line 196 of file CryptDh.c.

◆ DhGenerateParameter()

BOOLEAN EFIAPI DhGenerateParameter	(	IN OUT VOID *	DhContext,
		IN UINTN	Generator,
		IN UINTN	PrimeLength,
		OUT UINT8 *	Prime
	)

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.

Parameters

[in,out]	DhContext	Pointer to the DH context.
[in]	Generator	Value of generator.
[in]	PrimeLength	Length in bits of prime to be generated.
[out]	Prime	Pointer to the buffer to receive the generated prime number.

Return values

TRUE	DH parameter generation succeeded.
FALSE	Value of Generator is not supported.
FALSE	PRNG fails to generate random prime number with PrimeLength.
FALSE	This interface is not supported.

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.

Parameters

[in,out]	DhContext	Pointer to the DH context.
[in]	Generator	Value of generator.
[in]	PrimeLength	Length in bits of prime to be generated.
[out]	Prime	Pointer to the buffer to receive the generated prime number.

Return values

TRUE	DH parameter generation succeeded.
FALSE	Value of Generator is not supported.
FALSE	PRNG fails to generate random prime number with PrimeLength.

Generates DH parameter.

Return FALSE to indicate this interface is not supported.

Parameters

[in,out]	DhContext	Pointer to the DH context.
[in]	Generator	Value of generator.
[in]	PrimeLength	Length in bits of prime to be generated.
[out]	Prime	Pointer to the buffer to receive the generated prime number.

Return values

FALSE This interface is not supported.

Definition at line 76 of file CryptDh.c.

◆ DhNew()

VOID *EFIAPI DhNew ( VOID )

Allocates and Initializes one Diffie-Hellman Context for subsequent use.

Returns: 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.

Allocates and Initializes one Diffie-Hellman Context for subsequent use.

Returns: Pointer to the Diffie-Hellman Context that has been initialized. If the allocations fails, DhNew() returns NULL.

Allocates and Initializes one Diffie-Hellman Context for subsequent use.

Returns: Pointer to the Diffie-Hellman Context that has been initialized. If the interface is not supported, DhNew() returns NULL.

Definition at line 22 of file CryptDh.c.

◆ DhSetParameter()

BOOLEAN EFIAPI DhSetParameter	(	IN OUT VOID *	DhContext,
		IN UINTN	Generator,
		IN UINTN	PrimeLength,
		IN CONST 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.

Parameters

[in,out]	DhContext	Pointer to the DH context.
[in]	Generator	Value of generator.
[in]	PrimeLength	Length in bits of prime to be generated.
[in]	Prime	Pointer to the prime number.

Return values

TRUE	DH parameter setting succeeded.
FALSE	Value of Generator is not supported.
FALSE	Value of Generator is not suitable for the Prime.
FALSE	Value of Prime is not a prime number.
FALSE	Value of Prime is not a safe prime number.
FALSE	This interface is not supported.

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.

Parameters

[in,out]	DhContext	Pointer to the DH context.
[in]	Generator	Value of generator.
[in]	PrimeLength	Length in bits of prime to be generated.
[in]	Prime	Pointer to the prime number.

Return values

TRUE	DH parameter setting succeeded.
FALSE	Value of Generator is not supported.
FALSE	Value of Generator is not suitable for the Prime.
FALSE	Value of Prime is not a prime number.
FALSE	Value of Prime is not a safe prime number.

Sets generator and prime parameters for DH.

Return FALSE to indicate this interface is not supported.

Parameters

[in,out]	DhContext	Pointer to the DH context.
[in]	Generator	Value of generator.
[in]	PrimeLength	Length in bits of prime to be generated.
[in]	Prime	Pointer to the prime number.

Return values

FALSE This interface is not supported.

Definition at line 131 of file CryptDh.c.

◆ EcDhComputeKey()

BOOLEAN EFIAPI EcDhComputeKey	(	IN OUT VOID *	EcContext,
		IN CONST UINT8 *	PeerPublic,
		IN UINTN	PeerPublicSize,
		IN CONST INT32 *	CompressFlag,
		OUT UINT8 *	Key,
		IN OUT UINTN *	KeySize
	)

Computes exchanged common key. Given peer's public key (X, Y), this function computes the exchanged common key, based on its own context including value of curve parameter and random secret. X is the first half of PeerPublic with size being PeerPublicSize / 2, Y is the second half of PeerPublic with size being PeerPublicSize / 2. If EcContext is NULL, then return FALSE. If PeerPublic is NULL, then return FALSE. If PeerPublicSize is 0, then return FALSE. If Key is NULL, then return FALSE. If KeySize is not large enough, then return FALSE. For P-256, the PeerPublicSize is 64. First 32-byte is X, Second 32-byte is Y. For P-384, the PeerPublicSize is 96. First 48-byte is X, Second 48-byte is Y. For P-521, the PeerPublicSize is 132. First 66-byte is X, Second 66-byte is Y.

Parameters

[in,out]	EcContext	Pointer to the EC context.
[in]	PeerPublic	Pointer to the peer's public X,Y.
[in]	PeerPublicSize	Size of peer's public X,Y in bytes.
[in]	CompressFlag	Flag of PeerPublic is compressed or not.
[out]	Key	Pointer to the buffer to receive generated key.
[in,out]	KeySize	On input, the size of Key buffer in bytes. On output, the size of data returned in Key buffer in bytes.

Return values

TRUE	EC exchanged key generation succeeded.
FALSE	EC exchanged key generation failed.
FALSE	KeySize is not large enough.

Computes exchanged common key. Given peer's public key (X, Y), this function computes the exchanged common key, based on its own context including value of curve parameter and random secret. X is the first half of PeerPublic with size being PeerPublicSize / 2, Y is the second half of PeerPublic with size being PeerPublicSize / 2. If public key is compressed, the PeerPublic will only contain half key (X). If EcContext is NULL, then return FALSE. If PeerPublic is NULL, then return FALSE. If PeerPublicSize is 0, then return FALSE. If Key is NULL, then return FALSE. If KeySize is not large enough, then return FALSE. For P-256, the PeerPublicSize is 64. First 32-byte is X, Second 32-byte is Y. For P-384, the PeerPublicSize is 96. First 48-byte is X, Second 48-byte is Y. For P-521, the PeerPublicSize is 132. First 66-byte is X, Second 66-byte is Y.

Parameters

[in,out]	EcContext	Pointer to the EC context.
[in]	PeerPublic	Pointer to the peer's public X,Y.
[in]	PeerPublicSize	Size of peer's public X,Y in bytes.
[in]	CompressFlag	Flag of PeerPublic is compressed or not.
[out]	Key	Pointer to the buffer to receive generated key.
[in,out]	KeySize	On input, the size of Key buffer in bytes. On output, the size of data returned in Key buffer in bytes.

Return values

TRUE	EC exchanged key generation succeeded.
FALSE	EC exchanged key generation failed.
FALSE	KeySize is not large enough.

Definition at line 667 of file CryptEc.c.

◆ EcDsaSign()

BOOLEAN EFIAPI EcDsaSign	(	IN VOID *	EcContext,
		IN UINTN	HashNid,
		IN CONST UINT8 *	MessageHash,
		IN UINTN	HashSize,
		OUT UINT8 *	Signature,
		IN OUT UINTN *	SigSize
	)

Carries out the EC-DSA signature.

This function carries out the EC-DSA signature. 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 EcContext is NULL, then return FALSE. If MessageHash is NULL, then return FALSE. If HashSize need match the HashNid. HashNid could be SHA256, SHA384, SHA512, SHA3_256, SHA3_384, SHA3_512. If SigSize is large enough but Signature is NULL, then return FALSE.

For P-256, the SigSize is 64. First 32-byte is R, Second 32-byte is S. For P-384, the SigSize is 96. First 48-byte is R, Second 48-byte is S. For P-521, the SigSize is 132. First 66-byte is R, Second 66-byte is S.

Parameters

[in]	EcContext	Pointer to EC context for signature generation.
[in]	HashNid	hash NID
[in]	MessageHash	Pointer to octet message hash to be signed.
[in]	HashSize	Size of the message hash in bytes.
[out]	Signature	Pointer to buffer to receive EC-DSA signature.
[in,out]	SigSize	On input, the size of Signature buffer in bytes. On output, the size of data returned in Signature buffer in bytes.

Return values

TRUE	Signature successfully generated in EC-DSA.
FALSE	Signature generation failed.
FALSE	SigSize is too small.

Definition at line 801 of file CryptEc.c.

◆ EcDsaVerify()

BOOLEAN EFIAPI EcDsaVerify	(	IN VOID *	EcContext,
		IN UINTN	HashNid,
		IN CONST UINT8 *	MessageHash,
		IN UINTN	HashSize,
		IN CONST UINT8 *	Signature,
		IN UINTN	SigSize
	)

Verifies the EC-DSA signature.

If EcContext is NULL, then return FALSE. If MessageHash is NULL, then return FALSE. If Signature is NULL, then return FALSE. If HashSize need match the HashNid. HashNid could be SHA256, SHA384, SHA512, SHA3_256, SHA3_384, SHA3_512.

For P-256, the SigSize is 64. First 32-byte is R, Second 32-byte is S. For P-384, the SigSize is 96. First 48-byte is R, Second 48-byte is S. For P-521, the SigSize is 132. First 66-byte is R, Second 66-byte is S.

Parameters

[in]	EcContext	Pointer to EC context for signature verification.
[in]	HashNid	hash NID
[in]	MessageHash	Pointer to octet message hash to be checked.
[in]	HashSize	Size of the message hash in bytes.
[in]	Signature	Pointer to EC-DSA signature to be verified.
[in]	SigSize	Size of signature in bytes.

Return values

TRUE	Valid signature encoded in EC-DSA.
FALSE	Invalid signature or invalid EC context.

Definition at line 933 of file CryptEc.c.

◆ EcFree()

VOID EFIAPI EcFree ( IN VOID * EcContext )

Release the specified EC context.

Parameters

[in] EcContext Pointer to the EC context to be released.

Definition at line 440 of file CryptEc.c.

◆ EcGenerateKey()

BOOLEAN EFIAPI EcGenerateKey	(	IN OUT VOID *	EcContext,
		OUT UINT8 *	PublicKey,
		IN OUT UINTN *	PublicKeySize
	)

Generates EC key and returns EC public key (X, Y), Please note, this function uses pseudo random number generator. The caller must make sure RandomSeed() function was properly called before. The Ec context should be correctly initialized by EcNewByNid. This function generates random secret, and computes the public key (X, Y), which is returned via parameter Public, PublicSize. X is the first half of Public with size being PublicSize / 2, Y is the second half of Public with size being PublicSize / 2. EC context is updated accordingly. If the Public buffer is too small to hold the public X, Y, FALSE is returned and PublicSize is set to the required buffer size to obtain the public X, Y. For P-256, the PublicSize is 64. First 32-byte is X, Second 32-byte is Y. For P-384, the PublicSize is 96. First 48-byte is X, Second 48-byte is Y. For P-521, the PublicSize is 132. First 66-byte is X, Second 66-byte is Y. If EcContext is NULL, then return FALSE. If PublicSize is NULL, then return FALSE. If PublicSize is large enough but Public is NULL, then return FALSE.

Parameters

[in,out]	EcContext	Pointer to the EC context.
[out]	PublicKey	Pointer to t buffer to receive generated public X,Y.
[in,out]	PublicKeySize	On input, the size of Public buffer in bytes. On output, the size of data returned in Public buffer in bytes.

Return values

TRUE	EC public X,Y generation succeeded.
FALSE	EC public X,Y generation failed.
FALSE	PublicKeySize is not large enough.

Generates EC key and returns EC public key (X, Y), Please note, this function uses pseudo random number generator. The caller must make sure RandomSeed() function was properly called before. The Ec context should be correctly initialized by EcNewByNid. This function generates random secret, and computes the public key (X, Y), which is returned via parameter Public, PublicSize. X is the first half of Public with size being PublicSize / 2, Y is the second half of Public with size being PublicSize / 2. EC context is updated accordingly. If the Public buffer is too small to hold the public X, Y, FALSE is returned and PublicSize is set to the required buffer size to obtain the public X, Y. For P-256, the PublicSize is 64. First 32-byte is X, Second 32-byte is Y. For P-384, the PublicSize is 96. First 48-byte is X, Second 48-byte is Y. For P-521, the PublicSize is 132. First 66-byte is X, Second 66-byte is Y. If EcContext is NULL, then return FALSE. If PublicSize is NULL, then return FALSE. If PublicSize is large enough but Public is NULL, then return FALSE.

Parameters

[in,out]	EcContext	Pointer to the EC context.
[out]	PublicKey	Pointer to the buffer to receive generated public X,Y.
[in,out]	PublicKeySize	On input, the size of Public buffer in bytes. On output, the size of data returned in Public buffer in bytes.

Return values

TRUE	EC public X,Y generation succeeded.
FALSE	EC public X,Y generation failed.
FALSE	PublicKeySize is not large enough.

Definition at line 475 of file CryptEc.c.

◆ EcGetPrivateKeyFromPem()

BOOLEAN EFIAPI EcGetPrivateKeyFromPem	(	IN CONST UINT8 *	PemData,
		IN UINTN	PemSize,
		IN CONST CHAR8 *	Password,
		OUT VOID **	EcContext
	)

Retrieve the EC Private Key from the password-protected PEM key data.

Parameters

[in]	PemData	Pointer to the PEM-encoded key data to be retrieved.
[in]	PemSize	Size of the PEM key data in bytes.
[in]	Password	NULL-terminated passphrase used for encrypted PEM key data.
[out]	EcContext	Pointer to new-generated EC DSA context which contain the retrieved EC private key component. Use EcFree() function to free the resource.

If PemData is NULL, then return FALSE. If EcContext is NULL, then return FALSE.

Return values

TRUE	EC Private Key was retrieved successfully.
FALSE	Invalid PEM key data or incorrect password.

Retrieve the EC Private Key from the password-protected PEM key data.

Return FALSE to indicate this interface is not supported.

Parameters

[in]	PemData	Pointer to the PEM-encoded key data to be retrieved.
[in]	PemSize	Size of the PEM key data in bytes.
[in]	Password	NULL-terminated passphrase used for encrypted PEM key data.
[out]	EcContext	Pointer to new-generated EC context which contain the retrieved EC private key component. Use EcFree() function to free the resource.

If PemData is NULL, then return FALSE. If EcContext is NULL, then return FALSE.

Return values

FALSE This interface is not supported.

Definition at line 149 of file CryptPem.c.

◆ EcGetPubKey()

BOOLEAN EFIAPI EcGetPubKey	(	IN OUT VOID *	EcContext,
		OUT UINT8 *	PublicKey,
		IN OUT UINTN *	PublicKeySize
	)

Gets the public key component from the established EC context. The Ec context should be correctly initialized by EcNewByNid, and successfully generate key pair from EcGenerateKey(). For P-256, the PublicSize is 64. First 32-byte is X, Second 32-byte is Y. For P-384, the PublicSize is 96. First 48-byte is X, Second 48-byte is Y. For P-521, the PublicSize is 132. First 66-byte is X, Second 66-byte is Y.

Parameters

[in,out]	EcContext	Pointer to EC context being set.
[out]	PublicKey	Pointer to t buffer to receive generated public X,Y.
[in,out]	PublicKeySize	On input, the size of Public buffer in bytes. On output, the size of data returned in Public buffer in bytes.

Return values

TRUE	EC key component was retrieved successfully.
FALSE	Invalid EC key component.

Definition at line 567 of file CryptEc.c.

◆ EcGetPublicKeyFromX509()

BOOLEAN EFIAPI EcGetPublicKeyFromX509	(	IN CONST UINT8 *	Cert,
		IN UINTN	CertSize,
		OUT VOID **	EcContext
	)

Retrieve the EC Public Key from one DER-encoded X509 certificate.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[out]	EcContext	Pointer to new-generated EC DSA context which contain the retrieved EC public key component. Use EcFree() function to free the resource.

If Cert is NULL, then return FALSE. If EcContext is NULL, then return FALSE.

Return values

TRUE	EC Public Key was retrieved successfully.
FALSE	Fail to retrieve EC public key from X509 certificate.

Definition at line 878 of file CryptX509.c.

◆ EcGroupFree()

VOID EFIAPI EcGroupFree ( IN VOID * EcGroup )

Free previously allocated EC group object using EcGroupInit().

Parameters

[in] EcGroup EC group object to free.

Definition at line 140 of file CryptEc.c.

◆ EcGroupGetCurve()

BOOLEAN EFIAPI EcGroupGetCurve	(	IN CONST VOID *	EcGroup,
		OUT VOID *	BnPrime,
		OUT VOID *	BnA,
		OUT VOID *	BnB,
		IN VOID *	BnCtx
	)

Get EC curve parameters. While elliptic curve equation is Y^2 mod P = (X^3 + AX + B) Mod P. This function will set the provided Big Number objects to the corresponding values. The caller needs to make sure all the "out" BigNumber parameters are properly initialized.

Parameters

[in]	EcGroup	EC group object.
[out]	BnPrime	Group prime number.
[out]	BnA	A coefficient.
[out]	BnB	B coefficient.
[in]	BnCtx	BN context.

Return values

TRUE	On success.
FALSE	Otherwise.

Get EC curve parameters. While elliptic curve equation is Y^2 mod P = (X^3 + AX + B) Mod P. This function will set the provided Big Number objects to the corresponding values. The caller needs to make sure all the "out" BigNumber parameters are properly initialized.

Parameters

[in]	EcGroup	EC group object.
[out]	BnPrime	Group prime number.
[out]	BnA	A coefficient.
[out]	BnB	B coefficient..
[in]	BnCtx	BN context.

Return values

TRUE	On success.
FALSE	Otherwise.

Definition at line 100 of file CryptEc.c.

◆ EcGroupGetOrder()

BOOLEAN EFIAPI EcGroupGetOrder	(	IN VOID *	EcGroup,
		OUT VOID *	BnOrder
	)

Get EC group order. This function will set the provided Big Number object to the corresponding value. The caller needs to make sure that the "out" BigNumber parameter is properly initialized.

Parameters

[in]	EcGroup	EC group object.
[out]	BnOrder	Group prime number.

Return values

TRUE	On success.
FALSE	Otherwise.

Definition at line 125 of file CryptEc.c.

◆ EcGroupInit()

VOID *EFIAPI EcGroupInit ( IN UINTN CryptoNid )

Initialize new opaque EcGroup object. This object represents an EC curve and and is used for calculation within this group. This object should be freed using EcGroupFree() function.

Parameters

[in] CryptoNid Identifying number for the ECC curve (Defined in BaseCryptLib.h).

Return values

EcGroup	object On success.
NULL	On failure.

Definition at line 68 of file CryptEc.c.

◆ EcNewByNid()

VOID *EFIAPI EcNewByNid ( IN UINTN Nid )

Allocates and Initializes one Elliptic Curve Context for subsequent use with the NID.

Parameters

[in] Nid cipher NID

Returns: Pointer to the Elliptic Curve Context that has been initialized. If the allocations fails, EcNewByNid() returns NULL.

Allocates and Initializes one Elliptic Curve Context for subsequent use with the NID.

Parameters

[in] Nid Identifying number for the ECC curve (Defined in BaseCryptLib.h).

Returns: Pointer to the Elliptic Curve Context that has been initialized. If the allocations fails, EcNewByNid() returns NULL.

Definition at line 419 of file CryptEc.c.

◆ EcPointAdd()

BOOLEAN EFIAPI EcPointAdd	(	IN CONST VOID *	EcGroup,
		OUT VOID *	EcPointResult,
		IN CONST VOID *	EcPointA,
		IN CONST VOID *	EcPointB,
		IN VOID *	BnCtx
	)

EC Point addition. EcPointResult = EcPointA + EcPointB.

Parameters

[in]	EcGroup	EC group object.
[out]	EcPointResult	EC point to hold the result. The point should be properly initialized.
[in]	EcPointA	EC Point.
[in]	EcPointB	EC Point.
[in]	BnCtx	BN context, created with BigNumNewContext().

Return values

TRUE	On success.
FALSE	Otherwise.

Definition at line 253 of file CryptEc.c.

◆ EcPointDeInit()

VOID EFIAPI EcPointDeInit	(	IN VOID *	EcPoint,
		IN BOOLEAN	Clear
	)

Free previously allocated EC Point object using EcPointInit().

Parameters

[in]	EcPoint	EC Point to free.
[in]	Clear	TRUE iff the memory should be cleared.

Definition at line 173 of file CryptEc.c.

◆ EcPointEqual()

BOOLEAN EFIAPI EcPointEqual	(	IN CONST VOID *	EcGroup,
		IN CONST VOID *	EcPointA,
		IN CONST VOID *	EcPointB,
		IN VOID *	BnCtx
	)

Check if EC points are equal.

Parameters

[in]	EcGroup	EC group object.
[in]	EcPointA	EC point A.
[in]	EcPointB	EC point B.
[in]	BnCtx	BN context, created with BigNumNewContext().

Return values

TRUE	A == B.
FALSE	Otherwise.

Definition at line 364 of file CryptEc.c.

◆ EcPointGetAffineCoordinates()

BOOLEAN EFIAPI EcPointGetAffineCoordinates	(	IN CONST VOID *	EcGroup,
		IN CONST VOID *	EcPoint,
		OUT VOID *	BnX,
		OUT VOID *	BnY,
		IN VOID *	BnCtx
	)

Get EC point affine (x,y) coordinates. This function will set the provided Big Number objects to the corresponding values. The caller needs to make sure all the "out" BigNumber parameters are properly initialized.

Parameters

[in]	EcGroup	EC group object.
[in]	EcPoint	EC point object.
[out]	BnX	X coordinate.
[out]	BnY	Y coordinate.
[in]	BnCtx	BN context, created with BigNumNewContext().

Return values

TRUE	On success.
FALSE	Otherwise.

Definition at line 202 of file CryptEc.c.

◆ EcPointInit()

VOID *EFIAPI EcPointInit ( IN CONST VOID * EcGroup )

Initialize new opaque EC Point object. This object represents an EC point within the given EC group (curve).

Parameters

[in] EC Group, properly initialized using EcGroupInit().

Return values

EC	Point object On success.
NULL	On failure.

Definition at line 158 of file CryptEc.c.

◆ EcPointInvert()

BOOLEAN EFIAPI EcPointInvert	(	IN CONST VOID *	EcGroup,
		IN OUT VOID *	EcPoint,
		IN VOID *	BnCtx
	)

Calculate the inverse of the supplied EC point.

Parameters

[in]	EcGroup	EC group object.
[in,out]	EcPoint	EC point to invert.
[in]	BnCtx	BN context, created with BigNumNewContext().

Return values

TRUE	On success.
FALSE	Otherwise.

Definition at line 302 of file CryptEc.c.

◆ EcPointIsAtInfinity()

BOOLEAN EFIAPI EcPointIsAtInfinity	(	IN CONST VOID *	EcGroup,
		IN CONST VOID *	EcPoint
	)

Check if the supplied point is at infinity.

Parameters

[in]	EcGroup	EC group object.
[in]	EcPoint	EC point to check.

Return values

TRUE	At infinity.
FALSE	Otherwise.

Definition at line 343 of file CryptEc.c.

◆ EcPointIsOnCurve()

BOOLEAN EFIAPI EcPointIsOnCurve	(	IN CONST VOID *	EcGroup,
		IN CONST VOID *	EcPoint,
		IN VOID *	BnCtx
	)

Check if the supplied point is on EC curve.

Parameters

[in]	EcGroup	EC group object.
[in]	EcPoint	EC point to check.
[in]	BnCtx	BN context, created with BigNumNewContext().

Return values

TRUE	On curve.
FALSE	Otherwise.

Definition at line 323 of file CryptEc.c.

◆ EcPointMul()

BOOLEAN EFIAPI EcPointMul	(	IN CONST VOID *	EcGroup,
		OUT VOID *	EcPointResult,
		IN CONST VOID *	EcPoint,
		IN CONST VOID *	BnPScalar,
		IN VOID *	BnCtx
	)

Variable EC point multiplication. EcPointResult = EcPoint * BnPScalar.

Parameters

[in]	EcGroup	EC group object.
[out]	EcPointResult	EC point to hold the result. The point should be properly initialized.
[in]	EcPoint	EC Point.
[in]	BnPScalar	P Scalar.
[in]	BnCtx	BN context, created with BigNumNewContext().

Return values

TRUE	On success.
FALSE	Otherwise.

Definition at line 279 of file CryptEc.c.

◆ EcPointSetAffineCoordinates()

BOOLEAN EFIAPI EcPointSetAffineCoordinates	(	IN CONST VOID *	EcGroup,
		IN VOID *	EcPoint,
		IN CONST VOID *	BnX,
		IN CONST VOID *	BnY,
		IN VOID *	BnCtx
	)

Set EC point affine (x,y) coordinates.

Parameters

[in]	EcGroup	EC group object.
[in]	EcPoint	EC point object.
[in]	BnX	X coordinate.
[in]	BnY	Y coordinate.
[in]	BnCtx	BN context, created with BigNumNewContext().

Return values

TRUE	On success.
FALSE	Otherwise.

Definition at line 227 of file CryptEc.c.

◆ EcPointSetCompressedCoordinates()

BOOLEAN EFIAPI EcPointSetCompressedCoordinates	(	IN CONST VOID *	EcGroup,
		IN VOID *	EcPoint,
		IN CONST VOID *	BnX,
		IN UINT8	YBit,
		IN VOID *	BnCtx
	)

Set EC point compressed coordinates. Points can be described in terms of their compressed coordinates. For a point (x, y), for any given value for x such that the point is on the curve there will only ever be two possible values for y. Therefore, a point can be set using this function where BnX is the x coordinate and YBit is a value 0 or 1 to identify which of the two possible values for y should be used.

Parameters

[in]	EcGroup	EC group object.
[in]	EcPoint	EC Point.
[in]	BnX	X coordinate.
[in]	YBit	0 or 1 to identify which Y value is used.
[in]	BnCtx	BN context, created with BigNumNewContext().

Return values

TRUE	On success.
FALSE	Otherwise.

Definition at line 393 of file CryptEc.c.

◆ HkdfSha256Expand()

BOOLEAN EFIAPI HkdfSha256Expand	(	IN CONST UINT8 *	Prk,
		IN UINTN	PrkSize,
		IN CONST UINT8 *	Info,
		IN UINTN	InfoSize,
		OUT UINT8 *	Out,
		IN UINTN	OutSize
	)

Derive SHA256 HMAC-based Expand Key Derivation Function (HKDF).

Parameters

[in]	Prk	Pointer to the user-supplied key.
[in]	PrkSize	Key size in bytes.
[in]	Info	Pointer to the application specific info.
[in]	InfoSize	Info size in bytes.
[out]	Out	Pointer to buffer to receive hkdf value.
[in]	OutSize	Size of hkdf bytes to generate.

Return values

TRUE	Hkdf generated successfully.
FALSE	Hkdf generation failed.

Definition at line 315 of file CryptHkdf.c.

◆ HkdfSha256Extract()

BOOLEAN EFIAPI HkdfSha256Extract	(	IN CONST UINT8 *	Key,
		IN UINTN	KeySize,
		IN CONST UINT8 *	Salt,
		IN UINTN	SaltSize,
		OUT UINT8 *	PrkOut,
		UINTN	PrkOutSize
	)

Derive SHA256 HMAC-based Extract key Derivation Function (HKDF).

Parameters

[in]	Key	Pointer to the user-supplied key.
[in]	KeySize	key size in bytes.
[in]	Salt	Pointer to the salt(non-secret) value.
[in]	SaltSize	salt size in bytes.
[out]	PrkOut	Pointer to buffer to receive hkdf value.
[in]	PrkOutSize	size of hkdf bytes to generate.

Return values

true	Hkdf generated successfully.
false	Hkdf generation failed.

Definition at line 279 of file CryptHkdf.c.

◆ HkdfSha256ExtractAndExpand()

BOOLEAN EFIAPI HkdfSha256ExtractAndExpand	(	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
	)

Derive key data using HMAC-SHA256 based KDF.

Parameters

[in]	Key	Pointer to the user-supplied key.
[in]	KeySize	Key size in bytes.
[in]	Salt	Pointer to the salt(non-secret) value.
[in]	SaltSize	Salt size in bytes.
[in]	Info	Pointer to the application specific info.
[in]	InfoSize	Info size in bytes.
[out]	Out	Pointer to buffer to receive hkdf value.
[in]	OutSize	Size of hkdf bytes to generate.

Return values

TRUE	Hkdf generated successfully.
FALSE	Hkdf generation failed.

Derive HMAC-based Extract-and-Expand Key Derivation Function (HKDF).

Parameters

[in]	Key	Pointer to the user-supplied key.
[in]	KeySize	Key size in bytes.
[in]	Salt	Pointer to the salt(non-secret) value.
[in]	SaltSize	Salt size in bytes.
[in]	Info	Pointer to the application specific info.
[in]	InfoSize	Info size in bytes.
[out]	Out	Pointer to buffer to receive hkdf value.
[in]	OutSize	Size of hkdf bytes to generate.

Return values

TRUE	Hkdf generated successfully.
FALSE	Hkdf generation failed.

Derive SHA256 HMAC-based Extract-and-Expand Key Derivation Function (HKDF).

Parameters

[in]	Key	Pointer to the user-supplied key.
[in]	KeySize	Key size in bytes.
[in]	Salt	Pointer to the salt(non-secret) value.
[in]	SaltSize	Salt size in bytes.
[in]	Info	Pointer to the application specific info.
[in]	InfoSize	Info size in bytes.
[out]	Out	Pointer to buffer to receive hkdf value.
[in]	OutSize	Size of hkdf bytes to generate.

Return values

TRUE	Hkdf generated successfully.
FALSE	Hkdf generation failed.

Definition at line 249 of file CryptHkdf.c.

◆ HkdfSha384Expand()

BOOLEAN EFIAPI HkdfSha384Expand	(	IN CONST UINT8 *	Prk,
		IN UINTN	PrkSize,
		IN CONST UINT8 *	Info,
		IN UINTN	InfoSize,
		OUT UINT8 *	Out,
		IN UINTN	OutSize
	)

Derive SHA384 HMAC-based Expand Key Derivation Function (HKDF).

Parameters

[in]	Prk	Pointer to the user-supplied key.
[in]	PrkSize	Key size in bytes.
[in]	Info	Pointer to the application specific info.
[in]	InfoSize	Info size in bytes.
[out]	Out	Pointer to buffer to receive hkdf value.
[in]	OutSize	Size of hkdf bytes to generate.

Return values

TRUE	Hkdf generated successfully.
FALSE	Hkdf generation failed.

Definition at line 411 of file CryptHkdf.c.

◆ HkdfSha384Extract()

BOOLEAN EFIAPI HkdfSha384Extract	(	IN CONST UINT8 *	Key,
		IN UINTN	KeySize,
		IN CONST UINT8 *	Salt,
		IN UINTN	SaltSize,
		OUT UINT8 *	PrkOut,
		UINTN	PrkOutSize
	)

Derive SHA384 HMAC-based Extract key Derivation Function (HKDF).

Parameters

[in]	Key	Pointer to the user-supplied key.
[in]	KeySize	key size in bytes.
[in]	Salt	Pointer to the salt(non-secret) value.
[in]	SaltSize	salt size in bytes.
[out]	PrkOut	Pointer to buffer to receive hkdf value.
[in]	PrkOutSize	size of hkdf bytes to generate.

Return values

true	Hkdf generated successfully.
false	Hkdf generation failed.

Definition at line 375 of file CryptHkdf.c.

◆ HkdfSha384ExtractAndExpand()

BOOLEAN EFIAPI HkdfSha384ExtractAndExpand	(	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
	)

Derive SHA384 HMAC-based Extract-and-Expand Key Derivation Function (HKDF).

Parameters

[in]	Key	Pointer to the user-supplied key.
[in]	KeySize	Key size in bytes.
[in]	Salt	Pointer to the salt(non-secret) value.
[in]	SaltSize	Salt size in bytes.
[in]	Info	Pointer to the application specific info.
[in]	InfoSize	Info size in bytes.
[out]	Out	Pointer to buffer to receive hkdf value.
[in]	OutSize	Size of hkdf bytes to generate.

Return values

TRUE	Hkdf generated successfully.
FALSE	Hkdf generation failed.

Definition at line 345 of file CryptHkdf.c.

◆ HmacSha256All()

BOOLEAN EFIAPI HmacSha256All	(	IN CONST VOID *	Data,
		IN UINTN	DataSize,
		IN CONST UINT8 *	Key,
		IN UINTN	KeySize,
		OUT UINT8 *	HmacValue
	)

Computes the HMAC-SHA256 digest of a input data buffer.

This function performs the HMAC-SHA256 digest of a given data buffer, and places the digest value into the specified memory.

If this interface is not supported, then return FALSE.

Parameters

[in]	Data	Pointer to the buffer containing the data to be digested.
[in]	DataSize	Size of Data buffer in bytes.
[in]	Key	Pointer to the user-supplied key.
[in]	KeySize	Key size in bytes.
[out]	HashValue	Pointer to a buffer that receives the HMAC-SHA256 digest value (32 bytes).

Return values

TRUE	HMAC-SHA256 digest computation succeeded.
FALSE	HMAC-SHA256 digest computation failed.
FALSE	This interface is not supported.

Computes the HMAC-SHA256 digest of a input data buffer.

This function performs the HMAC-SHA256 digest of a given data buffer, and places the digest value into the specified memory.

If this interface is not supported, then return FALSE.

Parameters

[in]	Data	Pointer to the buffer containing the data to be digested.
[in]	DataSize	Size of Data buffer in bytes.
[in]	Key	Pointer to the user-supplied key.
[in]	KeySize	Key size in bytes.
[out]	HmacValue	Pointer to a buffer that receives the HMAC-SHA256 digest value (32 bytes).

Return values

TRUE	HMAC-SHA256 digest computation succeeded.
FALSE	HMAC-SHA256 digest computation failed.
FALSE	This interface is not supported.

Definition at line 448 of file CryptHmac.c.

◆ HmacSha256Duplicate()

BOOLEAN EFIAPI HmacSha256Duplicate	(	IN CONST VOID *	HmacSha256Context,
		OUT VOID *	NewHmacSha256Context
	)

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.

Parameters

[in]	HmacSha256Context	Pointer to HMAC-SHA256 context being copied.
[out]	NewHmacSha256Context	Pointer to new HMAC-SHA256 context.

Return values

TRUE	HMAC-SHA256 context copy succeeded.
FALSE	HMAC-SHA256 context copy failed.
FALSE	This interface is not supported.

Makes a copy of an existing HMAC-SHA256 context.

If HmacSha256Context is NULL, then return FALSE. If NewHmacSha256Context is NULL, then return FALSE.

Parameters

[in]	HmacSha256Context	Pointer to HMAC-SHA256 context being copied.
[out]	NewHmacSha256Context	Pointer to new HMAC-SHA256 context.

Return values

TRUE	HMAC-SHA256 context copy succeeded.
FALSE	HMAC-SHA256 context copy failed.

Makes a copy of an existing HMAC-SHA256 context.

Return FALSE to indicate this interface is not supported.

Parameters

[in]	HmacSha256Context	Pointer to HMAC-SHA256 context being copied.
[out]	NewHmacSha256Context	Pointer to new HMAC-SHA256 context.

Return values

FALSE This interface is not supported.

Definition at line 359 of file CryptHmac.c.

◆ HmacSha256Final()

BOOLEAN EFIAPI HmacSha256Final	(	IN OUT VOID *	HmacSha256Context,
		OUT UINT8 *	HmacValue
	)

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.

Parameters

[in,out]	HmacSha256Context	Pointer to the HMAC-SHA256 context.
[out]	HmacValue	Pointer to a buffer that receives the HMAC-SHA256 digest value (32 bytes).

Return values

TRUE	HMAC-SHA256 digest computation succeeded.
FALSE	HMAC-SHA256 digest computation failed.
FALSE	This interface is not supported.

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.

Parameters

[in,out]	HmacSha256Context	Pointer to the HMAC-SHA256 context.
[out]	HmacValue	Pointer to a buffer that receives the HMAC-SHA256 digest value (32 bytes).

Return values

TRUE	HMAC-SHA256 digest computation succeeded.
FALSE	HMAC-SHA256 digest computation failed.

Completes computation of the HMAC-SHA256 digest value.

Return FALSE to indicate this interface is not supported.

Parameters

[in,out]	HmacSha256Context	Pointer to the HMAC-SHA256 context.
[out]	HmacValue	Pointer to a buffer that receives the HMAC-SHA256 digest value (32 bytes).

Return values

FALSE This interface is not supported.

Definition at line 418 of file CryptHmac.c.

◆ HmacSha256Free()

VOID EFIAPI HmacSha256Free ( IN VOID * HmacSha256Ctx )

Release the specified HMAC_CTX context.

Parameters

[in] HmacSha256Ctx Pointer to the HMAC_CTX context to be released.

Release the specified HMAC_CTX context.

This function will do nothing.

Parameters

[in] HmacSha256Ctx Pointer to the HMAC_CTX context to be released.

Definition at line 312 of file CryptHmac.c.

◆ HmacSha256New()

VOID *EFIAPI HmacSha256New ( VOID )

Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA256 use.

Returns: Pointer to the HMAC_CTX context that has been initialized. If the allocations fails, HmacSha256New() returns NULL.

Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA256 use.

Return NULL to indicate this interface is not supported.

Returns: NULL This interface is not supported..

Definition at line 297 of file CryptHmac.c.

◆ HmacSha256SetKey()

BOOLEAN EFIAPI HmacSha256SetKey	(	OUT VOID *	HmacSha256Context,
		IN CONST UINT8 *	Key,
		IN UINTN	KeySize
	)

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.

Parameters

[out]	HmacSha256Context	Pointer to HMAC-SHA256 context.
[in]	Key	Pointer to the user-supplied key.
[in]	KeySize	Key size in bytes.

Return values

TRUE	The Key is set successfully.
FALSE	The Key is set unsuccessfully.
FALSE	This interface is not supported.

Set user-supplied key for subsequent use. It must be done before any calling to HmacSha256Update().

If HmacSha256Context is NULL, then return FALSE.

Parameters

[out]	HmacSha256Context	Pointer to HMAC-SHA256 context.
[in]	Key	Pointer to the user-supplied key.
[in]	KeySize	Key size in bytes.

Return values

TRUE	The Key is set successfully.
FALSE	The Key is set unsuccessfully.

Set user-supplied key for subsequent use. It must be done before any calling to HmacSha256Update().

Return FALSE to indicate this interface is not supported.

Parameters

[out]	HmacSha256Context	Pointer to HMAC-SHA256 context.
[in]	Key	Pointer to the user-supplied key.
[in]	KeySize	Key size in bytes.

Return values

FALSE This interface is not supported.

Definition at line 335 of file CryptHmac.c.

◆ HmacSha256Update()

BOOLEAN EFIAPI HmacSha256Update	(	IN OUT VOID *	HmacSha256Context,
		IN CONST VOID *	Data,
		IN UINTN	DataSize
	)

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.

Parameters

[in,out]	HmacSha256Context	Pointer to the HMAC-SHA256 context.
[in]	Data	Pointer to the buffer containing the data to be digested.
[in]	DataSize	Size of Data buffer in bytes.

Return values

TRUE	HMAC-SHA256 data digest succeeded.
FALSE	HMAC-SHA256 data digest failed.
FALSE	This interface is not supported.

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.

Parameters

[in,out]	HmacSha256Context	Pointer to the HMAC-SHA256 context.
[in]	Data	Pointer to the buffer containing the data to be digested.
[in]	DataSize	Size of Data buffer in bytes.

Return values

TRUE	HMAC-SHA256 data digest succeeded.
FALSE	HMAC-SHA256 data digest failed.

Digests the input data and updates HMAC-SHA256 context.

Return FALSE to indicate this interface is not supported.

Parameters

[in,out]	HmacSha256Context	Pointer to the HMAC-SHA256 context.
[in]	Data	Pointer to the buffer containing the data to be digested.
[in]	DataSize	Size of Data buffer in bytes.

Return values

FALSE This interface is not supported.

Definition at line 387 of file CryptHmac.c.

◆ HmacSha384All()

BOOLEAN EFIAPI HmacSha384All	(	IN CONST VOID *	Data,
		IN UINTN	DataSize,
		IN CONST UINT8 *	Key,
		IN UINTN	KeySize,
		OUT UINT8 *	HmacValue
	)

Computes the HMAC-SHA384 digest of a input data buffer.

This function performs the HMAC-SHA384 digest of a given data buffer, and places the digest value into the specified memory.

If this interface is not supported, then return FALSE.

Parameters

[in]	Data	Pointer to the buffer containing the data to be digested.
[in]	DataSize	Size of Data buffer in bytes.
[in]	Key	Pointer to the user-supplied key.
[in]	KeySize	Key size in bytes.
[out]	HashValue	Pointer to a buffer that receives the HMAC-SHA384 digest value (48 bytes).

Return values

TRUE	HMAC-SHA384 digest computation succeeded.
FALSE	HMAC-SHA384 digest computation failed.
FALSE	This interface is not supported.

Computes the HMAC-SHA384 digest of a input data buffer.

This function performs the HMAC-SHA384 digest of a given data buffer, and places the digest value into the specified memory.

If this interface is not supported, then return FALSE.

Parameters

[in]	Data	Pointer to the buffer containing the data to be digested.
[in]	DataSize	Size of Data buffer in bytes.
[in]	Key	Pointer to the user-supplied key.
[in]	KeySize	Key size in bytes.
[out]	HmacValue	Pointer to a buffer that receives the HMAC-SHA384 digest value (48 bytes).

Return values

TRUE	HMAC-SHA384 digest computation succeeded.
FALSE	HMAC-SHA384 digest computation failed.
FALSE	This interface is not supported.

Definition at line 627 of file CryptHmac.c.

◆ HmacSha384Duplicate()

BOOLEAN EFIAPI HmacSha384Duplicate	(	IN CONST VOID *	HmacSha384Context,
		OUT VOID *	NewHmacSha384Context
	)

Makes a copy of an existing HMAC-SHA384 context.

If HmacSha384Context is NULL, then return FALSE. If NewHmacSha384Context is NULL, then return FALSE. If this interface is not supported, then return FALSE.

Parameters

[in]	HmacSha384Context	Pointer to HMAC-SHA384 context being copied.
[out]	NewHmacSha384Context	Pointer to new HMAC-SHA384 context.

Return values

TRUE	HMAC-SHA384 context copy succeeded.
FALSE	HMAC-SHA384 context copy failed.
FALSE	This interface is not supported.

Definition at line 534 of file CryptHmac.c.

◆ HmacSha384Final()

BOOLEAN EFIAPI HmacSha384Final	(	IN OUT VOID *	HmacSha384Context,
		OUT UINT8 *	HmacValue
	)

Completes computation of the HMAC-SHA384 digest value.

This function completes HMAC-SHA384 hash computation and retrieves the digest value into the specified memory. After this function has been called, the HMAC-SHA384 context cannot be used again. HMAC-SHA384 context should be initialized by HmacSha384New(), and should not be finalized by HmacSha384Final(). Behavior with invalid HMAC-SHA384 context is undefined.

If HmacSha384Context is NULL, then return FALSE. If HmacValue is NULL, then return FALSE. If this interface is not supported, then return FALSE.

Parameters

[in,out]	HmacSha384Context	Pointer to the HMAC-SHA384 context.
[out]	HmacValue	Pointer to a buffer that receives the HMAC-SHA384 digest value (48 bytes).

Return values

TRUE	HMAC-SHA384 digest computation succeeded.
FALSE	HMAC-SHA384 digest computation failed.
FALSE	This interface is not supported.

Definition at line 597 of file CryptHmac.c.

◆ HmacSha384Free()

VOID EFIAPI HmacSha384Free ( IN VOID * HmacSha384Ctx )

Release the specified HMAC_CTX context.

Parameters

[in] HmacSha384Ctx Pointer to the HMAC_CTX context to be released.

Definition at line 483 of file CryptHmac.c.

◆ HmacSha384New()

VOID *EFIAPI HmacSha384New ( VOID )

Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA384 use.

Returns: Pointer to the HMAC_CTX context that has been initialized. If the allocations fails, HmacSha384New() returns NULL.

Definition at line 468 of file CryptHmac.c.

◆ HmacSha384SetKey()

BOOLEAN EFIAPI HmacSha384SetKey	(	OUT VOID *	HmacSha384Context,
		IN CONST UINT8 *	Key,
		IN UINTN	KeySize
	)

Set user-supplied key for subsequent use. It must be done before any calling to HmacSha384Update().

If HmacSha384Context is NULL, then return FALSE. If this interface is not supported, then return FALSE.

Parameters

[out]	HmacSha384Context	Pointer to HMAC-SHA384 context.
[in]	Key	Pointer to the user-supplied key.
[in]	KeySize	Key size in bytes.

Return values

TRUE	The Key is set successfully.
FALSE	The Key is set unsuccessfully.
FALSE	This interface is not supported.

Definition at line 508 of file CryptHmac.c.

◆ HmacSha384Update()

BOOLEAN EFIAPI HmacSha384Update	(	IN OUT VOID *	HmacSha384Context,
		IN CONST VOID *	Data,
		IN UINTN	DataSize
	)

Digests the input data and updates HMAC-SHA384 context.

This function performs HMAC-SHA384 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-SHA384 context should be initialized by HmacSha384New(), and should not be finalized by HmacSha384Final(). Behavior with invalid context is undefined.

If HmacSha384Context is NULL, then return FALSE. If this interface is not supported, then return FALSE.

Parameters

[in,out]	HmacSha384Context	Pointer to the HMAC-SHA384 context.
[in]	Data	Pointer to the buffer containing the data to be digested.
[in]	DataSize	Size of Data buffer in bytes.

Return values

TRUE	HMAC-SHA384 data digest succeeded.
FALSE	HMAC-SHA384 data digest failed.
FALSE	This interface is not supported.

Definition at line 564 of file CryptHmac.c.

◆ ImageTimestampVerify()

BOOLEAN EFIAPI ImageTimestampVerify	(	IN CONST UINT8 *	AuthData,
		IN UINTN	DataSize,
		IN CONST UINT8 *	TsaCert,
		IN UINTN	CertSize,
		OUT EFI_TIME *	SigningTime
	)

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.

Parameters

[in]	AuthData	Pointer to the Authenticode Signature retrieved from signed PE/COFF image to be verified.
[in]	DataSize	Size of the Authenticode Signature in bytes.
[in]	TsaCert	Pointer to a trusted/root TSA certificate encoded in DER, which is used for TSA certificate chain verification.
[in]	CertSize	Size of the trusted certificate in bytes.
[out]	SigningTime	Return the time of timestamp generation time if the timestamp signature is valid.

Return values

TRUE	The specified Authenticode includes a valid RFC3161 Timestamp CounterSignature.
FALSE	No valid RFC3161 Timestamp CounterSignature in the specified Authenticode data.

Verifies the validity of a RFC3161 Timestamp CounterSignature embedded in PE/COFF Authenticode signature.

If AuthData is NULL, then return FALSE.

Parameters

[in]	AuthData	Pointer to the Authenticode Signature retrieved from signed PE/COFF image to be verified.
[in]	DataSize	Size of the Authenticode Signature in bytes.
[in]	TsaCert	Pointer to a trusted/root TSA certificate encoded in DER, which is used for TSA certificate chain verification.
[in]	CertSize	Size of the trusted certificate in bytes.
[out]	SigningTime	Return the time of timestamp generation time if the timestamp signature is valid.

Return values

TRUE	The specified Authenticode includes a valid RFC3161 Timestamp CounterSignature.
FALSE	No valid RFC3161 Timestamp CounterSignature in the specified Authenticode data.

Verifies the validity of a RFC3161 Timestamp CounterSignature embedded in PE/COFF Authenticode signature.

Return FALSE to indicate this interface is not supported.

Parameters

[in]	AuthData	Pointer to the Authenticode Signature retrieved from signed PE/COFF image to be verified.
[in]	DataSize	Size of the Authenticode Signature in bytes.
[in]	TsaCert	Pointer to a trusted/root TSA certificate encoded in DER, which is used for TSA certificate chain verification.
[in]	CertSize	Size of the trusted certificate in bytes.
[out]	SigningTime	Return the time of timestamp generation time if the timestamp signature is valid.

Return values

FALSE This interface is not supported.

Definition at line 555 of file CryptTs.c.

◆ ParallelHash256HashAll()

BOOLEAN EFIAPI ParallelHash256HashAll	(	IN CONST VOID *	Input,
		IN UINTN	InputByteLen,
		IN UINTN	BlockSize,
		OUT VOID *	Output,
		IN UINTN	OutputByteLen,
		IN CONST VOID *	Customization,
		IN UINTN	CustomByteLen
	)

Parallel hash function ParallelHash256, as defined in NIST's Special Publication 800-185, published December 2016.

Parameters

[in]	Input	Pointer to the input message (X).
[in]	InputByteLen	The number(>0) of input bytes provided for the input data.
[in]	BlockSize	The size of each block (B).
[out]	Output	Pointer to the output buffer.
[in]	OutputByteLen	The desired number of output bytes (L).
[in]	Customization	Pointer to the customization string (S).
[in]	CustomByteLen	The length of the customization string in bytes.

Return values

TRUE	ParallelHash256 digest computation succeeded.
FALSE	ParallelHash256 digest computation failed.
FALSE	This interface is not supported.

Parallel hash function ParallelHash256, as defined in NIST's Special Publication 800-185, published December 2016.

Parameters

[in]	Input	Pointer to the input message (X).
[in]	InputByteLen	The number(>0) of input bytes provided for the input data.
[in]	BlockSize	The size of each block (B).
[out]	Output	Pointer to the output buffer.
[in]	OutputByteLen	The desired number of output bytes (L).
[in]	Customization	Pointer to the customization string (S).
[in]	CustomByteLen	The length of the customization string in bytes.

Return values

FALSE This interface is not supported.

Definition at line 90 of file CryptParallelHash.c.

◆ Pkcs1v2Decrypt()

BOOLEAN EFIAPI Pkcs1v2Decrypt	(	IN CONST UINT8 *	PrivateKey,
		IN UINTN	PrivateKeySize,
		IN UINT8 *	EncryptedData,
		IN UINTN	EncryptedDataSize,
		OUT UINT8 **	OutData,
		OUT UINTN *	OutDataSize
	)

Decrypts a blob using PKCS1v2 (RSAES-OAEP) schema. On success, will return the decrypted message in a newly allocated buffer.

Things that can cause a failure include:

Fail to parse private key.
Fail to allocate an intermediate buffer.
Null pointer provided for a non-optional parameter.

Parameters

[in]	PrivateKey	A pointer to the DER-encoded private key.
[in]	PrivateKeySize	Size of the private key buffer.
[in]	EncryptedData	Data to be decrypted.
[in]	EncryptedDataSize	Size of the encrypted buffer.
[out]	OutData	Pointer to an allocated buffer containing the encrypted message.
[out]	OutDataSize	Size of the encrypted message buffer.

Return values

TRUE	Encryption was successful.
FALSE	Encryption failed.

Definition at line 591 of file CryptPkcs1Oaep.c.

◆ Pkcs1v2Encrypt()

BOOLEAN EFIAPI Pkcs1v2Encrypt	(	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
	)

Encrypts a blob using PKCS1v2 (RSAES-OAEP) schema. On success, will return the encrypted message 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).

Parameters

[in]	PublicKey	A pointer to the DER-encoded X509 certificate that will be used to encrypt the data.
[in]	PublicKeySize	Size of the X509 cert buffer.
[in]	InData	Data to be encrypted.
[in]	InDataSize	Size of the data buffer.
[in]	PrngSeed	[Optional] If provided, a pointer to a random seed buffer to be used when initializing the PRNG. NULL otherwise.
[in]	PrngSeedSize	[Optional] If provided, size of the random seed buffer. 0 otherwise.
[out]	EncryptedData	Pointer to an allocated buffer containing the encrypted message.
[out]	EncryptedDataSize	Size of the encrypted message buffer.

Return values

TRUE	Encryption was successful.
FALSE	Encryption failed.

Encrypts a blob using PKCS1v2 (RSAES-OAEP) schema. On success, will return the encrypted message in a newly allocated buffer.

Return FALSE to indicate this interface is not supported.

Parameters

[in]	PublicKey	A pointer to the DER-encoded X509 certificate that will be used to encrypt the data.
[in]	PublicKeySize	Size of the X509 cert buffer.
[in]	InData	Data to be encrypted.
[in]	InDataSize	Size of the data buffer.
[in]	PrngSeed	[Optional] If provided, a pointer to a random seed buffer to be used when initializing the PRNG. NULL otherwise.
[in]	PrngSeedSize	[Optional] If provided, size of the random seed buffer. 0 otherwise.
[out]	EncryptedData	Pointer to an allocated buffer containing the encrypted message.
[out]	EncryptedDataSize	Size of the encrypted message buffer.

Return values

FALSE This interface is not supported.

Definition at line 249 of file CryptPkcs1Oaep.c.

◆ Pkcs5HashPassword()

BOOLEAN EFIAPI Pkcs5HashPassword	(	IN UINTN	PasswordLength,
		IN CONST CHAR8 *	Password,
		IN UINTN	SaltLength,
		IN CONST UINT8 *	Salt,
		IN UINTN	IterationCount,
		IN UINTN	DigestSize,
		IN UINTN	KeyLength,
		OUT UINT8 *	OutKey
	)

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.

Parameters

[in]	PasswordLength	Length of input password in bytes.
[in]	Password	Pointer to the array for the password.
[in]	SaltLength	Size of the Salt in bytes.
[in]	Salt	Pointer to the Salt.
[in]	IterationCount	Number of iterations to perform. Its value should be greater than or equal to 1.
[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.
[in]	KeyLength	Size of the derived key buffer in bytes.
[out]	OutKey	Pointer to the output derived key buffer.

Return values

TRUE	A key was derived successfully.
FALSE	One of the pointers was NULL or one of the sizes was too large.
FALSE	The hash algorithm could not be determined from the digest size.
FALSE	The key derivation operation failed.
FALSE	This interface is not supported.

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.

Parameters

[in]	PasswordLength	Length of input password in bytes.
[in]	Password	Pointer to the array for the password.
[in]	SaltLength	Size of the Salt in bytes.
[in]	Salt	Pointer to the Salt.
[in]	IterationCount	Number of iterations to perform. Its value should be greater than or equal to 1.
[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.
[in]	KeyLength	Size of the derived key buffer in bytes.
[out]	OutKey	Pointer to the output derived key buffer.

Return values

TRUE	A key was derived successfully.
FALSE	One of the pointers was NULL or one of the sizes was too large.
FALSE	The hash algorithm could not be determined from the digest size.
FALSE	The key derivation operation failed.

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.

Return FALSE to indicate this interface is not supported.

Parameters

[in]	PasswordLength	Length of input password in bytes.
[in]	Password	Pointer to the array for the password.
[in]	SaltLength	Size of the Salt in bytes.
[in]	Salt	Pointer to the Salt.
[in]	IterationCount	Number of iterations to perform. Its value should be greater than or equal to 1.
[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.
[in]	KeyLength	Size of the derived key buffer in bytes.
[out]	OutKey	Pointer to the output derived key buffer.

Return values

FALSE This interface is not supported.

Definition at line 40 of file CryptPkcs5Pbkdf2.c.

◆ Pkcs7FreeSigners()

VOID EFIAPI Pkcs7FreeSigners ( IN UINT8 * Certs )

Wrap function to use free() to free allocated memory for certificates.

If this interface is not supported, then ASSERT().

Parameters

[in] Certs Pointer to the certificates to be freed.

Wrap function to use free() to free allocated memory for certificates.

Parameters

[in] Certs Pointer to the certificates to be freed.

Wrap function to use free() to free allocated memory for certificates.

If the interface is not supported, then ASSERT().

Parameters

[in] Certs Pointer to the certificates to be freed.

Definition at line 422 of file CryptPkcs7VerifyCommon.c.

◆ Pkcs7GetAttachedContent()

BOOLEAN EFIAPI Pkcs7GetAttachedContent	(	IN CONST UINT8 *	P7Data,
		IN UINTN	P7Length,
		OUT VOID **	Content,
		OUT UINTN *	ContentSize
	)

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.

Parameters

[in]	P7Data	Pointer to the PKCS#7 signed data to process.
[in]	P7Length	Length of the PKCS#7 signed data in bytes.
[out]	Content	Pointer to the extracted content from the PKCS#7 signedData. It's caller's responsibility to free the buffer with FreePool().
[out]	ContentSize	The size of the extracted content in bytes.

Return values

TRUE	The P7Data was correctly formatted for processing.
FALSE	The P7Data was not correctly formatted for processing.

Extracts the attached content from a PKCS#7 signed data if existed. The input signed data could be wrapped in a ContentInfo structure.

Return FALSE to indicate this interface is not supported.

Parameters

[in]	P7Data	Pointer to the PKCS#7 signed data to process.
[in]	P7Length	Length of the PKCS#7 signed data in bytes.
[out]	Content	Pointer to the extracted content from the PKCS#7 signedData. It's caller's responsibility to free the buffer with FreePool().
[out]	ContentSize	The size of the extracted content in bytes.

Return values

TRUE	The P7Data was correctly formatted for processing.
FALSE	The P7Data was not correctly formatted for processing.

Definition at line 100 of file CryptPkcs7VerifyBase.c.

◆ Pkcs7GetCertificatesList()

BOOLEAN EFIAPI Pkcs7GetCertificatesList	(	IN CONST UINT8 *	P7Data,
		IN UINTN	P7Length,
		OUT UINT8 **	SignerChainCerts,
		OUT UINTN *	ChainLength,
		OUT UINT8 **	UnchainCerts,
		OUT UINTN *	UnchainLength
	)

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.

Pkcs7GetCertificatesList has not been implemented in BaseCryptoLibMbedTls.

Parameters

[in]	P7Data	Pointer to the PKCS#7 message.
[in]	P7Length	Length of the PKCS#7 message in bytes.
[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.
[out]	ChainLength	Length of the chained certificates list buffer in bytes.
[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.
[out]	UnchainLength	Length of the unchained certificates list buffer in bytes.

Return values

TRUE	The operation is finished successfully.
FALSE	Error occurs during the operation.

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.

Parameters

[in]	P7Data	Pointer to the PKCS#7 message.
[in]	P7Length	Length of the PKCS#7 message in bytes.
[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.
[out]	ChainLength	Length of the chained certificates list buffer in bytes.
[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.
[out]	UnchainLength	Length of the unchained certificates list buffer in bytes.

Return values

TRUE	The operation is finished successfully.
FALSE	Error occurs during the operation.

Definition at line 457 of file CryptPkcs7VerifyCommon.c.

◆ Pkcs7GetSigners()

BOOLEAN EFIAPI Pkcs7GetSigners	(	IN CONST UINT8 *	P7Data,
		IN UINTN	P7Length,
		OUT UINT8 **	CertStack,
		OUT UINTN *	StackLength,
		OUT UINT8 **	TrustedCert,
		OUT UINTN *	CertLength
	)

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.

Parameters

[in]	P7Data	Pointer to the PKCS#7 message to verify.
[in]	P7Length	Length of the PKCS#7 message in bytes.
[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.
[out]	StackLength	Length of signer's certificates in bytes.
[out]	TrustedCert	Pointer to a trusted certificate from Signer's certificates. It's caller's responsibility to free the buffer with Pkcs7FreeSigners().
[out]	CertLength	Length of the trusted certificate in bytes.

Return values

TRUE	The operation is finished successfully.
FALSE	Error occurs during the operation.
FALSE	This interface is not supported.

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.

Caution: This function may receive untrusted input. UEFI Authenticated Variable is external input, so this function will do basic check for PKCS#7 data structure.

Parameters

[in]	P7Data	Pointer to the PKCS#7 message to verify.
[in]	P7Length	Length of the PKCS#7 message in bytes.
[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.
[out]	StackLength	Length of signer's certificates in bytes.
[out]	TrustedCert	Pointer to a trusted certificate from Signer's certificates. It's caller's responsibility to free the buffer with Pkcs7FreeSigners().
[out]	CertLength	Length of the trusted certificate in bytes.

Return values

TRUE	The operation is finished successfully.
FALSE	Error occurs during the operation.

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.

Return FALSE to indicate this interface is not supported.

Parameters

[in]	P7Data	Pointer to the PKCS#7 message to verify.
[in]	P7Length	Length of the PKCS#7 message in bytes.
[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.
[out]	StackLength	Length of signer's certificates in bytes.
[out]	TrustedCert	Pointer to a trusted certificate from Signer's certificates. It's caller's responsibility to free the buffer with Pkcs7FreeSigners().
[out]	CertLength	Length of the trusted certificate in bytes.

Return values

FALSE This interface is not supported.

Definition at line 254 of file CryptPkcs7VerifyCommon.c.

◆ Pkcs7Sign()

BOOLEAN EFIAPI Pkcs7Sign	(	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
	)

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.

Parameters

[in]	PrivateKey	Pointer to the PEM-formatted private key data for data signing.
[in]	PrivateKeySize	Size of the PEM private key data in bytes.
[in]	KeyPassword	NULL-terminated passphrase used for encrypted PEM key data.
[in]	InData	Pointer to the content to be signed.
[in]	InDataSize	Size of InData in bytes.
[in]	SignCert	Pointer to signer's DER-encoded certificate to sign with.
[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).
[out]	SignedData	Pointer to output PKCS#7 signedData. It's caller's responsibility to free the buffer with FreePool().
[out]	SignedDataSize	Size of SignedData in bytes.

Return values

TRUE	PKCS#7 data signing succeeded.
FALSE	PKCS#7 data signing failed.
FALSE	This interface is not supported.

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.

Parameters

[in]	PrivateKey	Pointer to the PEM-formatted private key data for data signing.
[in]	PrivateKeySize	Size of the PEM private key data in bytes.
[in]	KeyPassword	NULL-terminated passphrase used for encrypted PEM key data.
[in]	InData	Pointer to the content to be signed.
[in]	InDataSize	Size of InData in bytes.
[in]	SignCert	Pointer to signer's DER-encoded certificate to sign with.
[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).
[out]	SignedData	Pointer to output PKCS#7 signedData. It's caller's responsibility to free the buffer with FreePool().
[out]	SignedDataSize	Size of SignedData in bytes.

Return values

TRUE	PKCS#7 data signing succeeded.
FALSE	PKCS#7 data signing failed.

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.

Return FALSE to indicate this interface is not supported.

Parameters

[in]	PrivateKey	Pointer to the PEM-formatted private key data for data signing.
[in]	PrivateKeySize	Size of the PEM private key data in bytes.
[in]	KeyPassword	NULL-terminated passphrase used for encrypted PEM key data.
[in]	InData	Pointer to the content to be signed.
[in]	InDataSize	Size of InData in bytes.
[in]	SignCert	Pointer to signer's DER-encoded certificate to sign with.
[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).
[out]	SignedData	Pointer to output PKCS#7 signedData. It's caller's responsibility to free the buffer with FreePool().
[out]	SignedDataSize	Size of SignedData in bytes.

Return values

FALSE This interface is not supported.

Calculate InData Digest

Pk Sign

Enlarge buffer if buffer is too small

Definition at line 41 of file CryptPkcs7Sign.c.

◆ Pkcs7Verify()

BOOLEAN EFIAPI Pkcs7Verify	(	IN CONST UINT8 *	P7Data,
		IN UINTN	P7Length,
		IN CONST UINT8 *	TrustedCert,
		IN UINTN	CertLength,
		IN CONST UINT8 *	InData,
		IN UINTN	DataLength
	)

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.

Parameters

[in]	P7Data	Pointer to the PKCS#7 message to verify.
[in]	P7Length	Length of the PKCS#7 message in bytes.
[in]	TrustedCert	Pointer to a trusted/root certificate encoded in DER, which is used for certificate chain verification.
[in]	CertLength	Length of the trusted certificate in bytes.
[in]	InData	Pointer to the content to be verified.
[in]	DataLength	Length of InData in bytes.

Return values

TRUE	The specified PKCS#7 signed data is valid.
FALSE	Invalid PKCS#7 signed data.
FALSE	This interface is not supported.

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.

Caution: This function may receive untrusted input. UEFI Authenticated Variable is external input, so this function will do basic check for PKCS#7 data structure.

Parameters

[in]	P7Data	Pointer to the PKCS#7 message to verify.
[in]	P7Length	Length of the PKCS#7 message in bytes.
[in]	TrustedCert	Pointer to a trusted/root certificate encoded in DER, which is used for certificate chain verification.
[in]	CertLength	Length of the trusted certificate in bytes.
[in]	InData	Pointer to the content to be verified.
[in]	DataLength	Length of InData in bytes.

Return values

TRUE	The specified PKCS#7 signed data is valid.
FALSE	Invalid PKCS#7 signed data.

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.

Return FALSE to indicate this interface is not supported.

Parameters

[in]	P7Data	Pointer to the PKCS#7 message to verify.
[in]	P7Length	Length of the PKCS#7 message in bytes.
[in]	TrustedCert	Pointer to a trusted/root certificate encoded in DER, which is used for certificate chain verification.
[in]	CertLength	Length of the trusted certificate in bytes.
[in]	InData	Pointer to the content to be verified.
[in]	DataLength	Length of InData in bytes.

Return values

FALSE This interface is not supported.

Definition at line 776 of file CryptPkcs7VerifyCommon.c.

◆ RandomBytes()

BOOLEAN EFIAPI RandomBytes	(	OUT UINT8 *	Output,
		IN UINTN	Size
	)

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.

Parameters

[out]	Output	Pointer to buffer to receive random value.
[in]	Size	Size of random bytes to generate.

Return values

TRUE	Pseudorandom byte stream generated successfully.
FALSE	Pseudorandom number generator fails to generate due to lack of entropy.
FALSE	This interface is not supported.

Generates a pseudorandom byte stream of the specified size.

If Output is NULL, then return FALSE.

Parameters

[out]	Output	Pointer to buffer to receive random value.
[in]	Size	Size of random bytes to generate.

Return values

TRUE	Pseudorandom byte stream generated successfully.
FALSE	Pseudorandom number generator fails to generate due to lack of entropy.

Generates a pseudorandom byte stream of the specified size.

Return FALSE to indicate this interface is not supported.

Parameters

[out]	Output	Pointer to buffer to receive random value.
[in]	Size	Size of random bytes to generate.

Return values

FALSE This interface is not supported.

Definition at line 76 of file CryptRand.c.

◆ RandomSeed()

BOOLEAN EFIAPI RandomSeed	(	IN CONST UINT8 *Seed	OPTIONAL,
		IN UINTN	SeedSize
	)

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.

RandomSeed has not been implemented in BaseCryptoLibMbedTls.

Parameters

[in]	Seed	Pointer to seed value. If NULL, default seed is used.
[in]	SeedSize	Size of seed value. If Seed is NULL, this parameter is ignored.

Return values

TRUE	Pseudorandom number generator has enough entropy for random generation.
FALSE	Pseudorandom number generator does not have enough entropy for random generation.
FALSE	This interface is not supported.

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.

Parameters

[in]	Seed	Pointer to seed value. If NULL, default seed is used.
[in]	SeedSize	Size of seed value. If Seed is NULL, this parameter is ignored.

Return values

TRUE	Pseudorandom number generator has enough entropy for random generation.
FALSE	Pseudorandom number generator does not have enough entropy for random generation.

Sets up the seed value for the pseudorandom number generator.

Return FALSE to indicate this interface is not supported.

Parameters

[in]	Seed	Pointer to seed value. If NULL, default seed is used.
[in]	SeedSize	Size of seed value. If Seed is NULL, this parameter is ignored.

Return values

FALSE This interface is not supported.

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.

Parameters

[in]	Seed	Pointer to seed value. If NULL, default seed is used.
[in]	SeedSize	Size of seed value. If Seed is NULL, this parameter is ignored.

Return values

TRUE	Pseudorandom number generator has enough entropy for random generation.
FALSE	Pseudorandom number generator does not have enough entropy for random generation.
FALSE	This interface is not supported.

Definition at line 36 of file CryptRand.c.

◆ RsaCheckKey()

BOOLEAN EFIAPI RsaCheckKey ( IN VOID * RsaContext )

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.

Parameters

[in] RsaContext Pointer to RSA context to check.

Return values

TRUE	RSA key components are valid.
FALSE	RSA key components are not valid.
FALSE	This interface is not supported.

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.

Parameters

[in] RsaContext Pointer to RSA context to check.

Return values

TRUE	RSA key components are valid.
FALSE	RSA key components are not valid.

Validates key components of RSA context.

Return FALSE to indicate this interface is not supported.

Parameters

[in] RsaContext Pointer to RSA context to check.

Return values

FALSE This interface is not supported.

Definition at line 243 of file CryptRsaExt.c.

◆ RsaFree()

VOID EFIAPI RsaFree ( IN VOID * RsaContext )

Release the specified RSA context.

If RsaContext is NULL, then return FALSE.

Parameters

[in] RsaContext Pointer to the RSA context to be released.

Release the specified RSA context.

Parameters

[in] RsaContext Pointer to the RSA context to be released.

Definition at line 48 of file CryptRsaBasic.c.

◆ RsaGenerateKey()

BOOLEAN EFIAPI RsaGenerateKey	(	IN OUT VOID *	RsaContext,
		IN UINTN	ModulusLength,
		IN CONST UINT8 *	PublicExponent,
		IN UINTN	PublicExponentSize
	)

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.

Parameters

[in,out]	RsaContext	Pointer to RSA context being set.
[in]	ModulusLength	Length of RSA modulus N in bits.
[in]	PublicExponent	Pointer to RSA public exponent.
[in]	PublicExponentSize	Size of RSA public exponent buffer in bytes.

Return values

TRUE	RSA key component was generated successfully.
FALSE	Invalid RSA key component tag.
FALSE	This interface is not supported.

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.

Parameters

[in,out]	RsaContext	Pointer to RSA context being set.
[in]	ModulusLength	Length of RSA modulus N in bits.
[in]	PublicExponent	Pointer to RSA public exponent.
[in]	PublicExponentSize	Size of RSA public exponent buffer in bytes.

Return values

TRUE	RSA key component was generated successfully.
FALSE	Invalid RSA key component tag.

Generates RSA key components.

Return FALSE to indicate this interface is not supported.

Parameters

[in,out]	RsaContext	Pointer to RSA context being set.
[in]	ModulusLength	Length of RSA modulus N in bits.
[in]	PublicExponent	Pointer to RSA public exponent.
[in]	PublicExponentSize	Size of RSA public exponent buffer in bytes.

Return values

FALSE This interface is not supported.

Generates RSA key components.

This function generates RSA key components. It takes RSA public exponent Pe 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.

Parameters

[in,out]	RsaContext	Pointer to RSA context being set.
[in]	ModulusLength	Length of RSA modulus N in bits.
[in]	PublicExponent	Pointer to RSA public exponent.
[in]	PublicExponentSize	Size of RSA public exponent buffer in bytes.

Return values

TRUE	RSA key component was generated successfully.
FALSE	Invalid RSA key component tag.

Definition at line 179 of file CryptRsaExt.c.

◆ RsaGetKey()

BOOLEAN EFIAPI RsaGetKey	(	IN OUT VOID *	RsaContext,
		IN RSA_KEY_TAG	KeyTag,
		OUT UINT8 *	BigNumber,
		IN OUT 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.

Parameters

[in,out]	RsaContext	Pointer to RSA context being set.
[in]	KeyTag	Tag of RSA key component being set.
[out]	BigNumber	Pointer to octet integer buffer.
[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.

Return values

TRUE	RSA key component was retrieved successfully.
FALSE	Invalid RSA key component tag.
FALSE	BnSize is too small.
FALSE	This interface is not supported.

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.

Parameters

[in,out]	RsaContext	Pointer to RSA context being set.
[in]	KeyTag	Tag of RSA key component being set.
[out]	BigNumber	Pointer to octet integer buffer.
[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.

Return values

TRUE	RSA key component was retrieved successfully.
FALSE	Invalid RSA key component tag.
FALSE	BnSize is too small.

Gets the tag-designated RSA key component from the established RSA context.

Return FALSE to indicate this interface is not supported.

Parameters

[in,out]	RsaContext	Pointer to RSA context being set.
[in]	KeyTag	Tag of RSA key component being set.
[out]	BigNumber	Pointer to octet integer buffer.
[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.

Return values

FALSE This interface is not supported.

Definition at line 50 of file CryptRsaExt.c.

◆ RsaGetPrivateKeyFromPem()

BOOLEAN EFIAPI RsaGetPrivateKeyFromPem	(	IN CONST UINT8 *	PemData,
		IN UINTN	PemSize,
		IN CONST CHAR8 *	Password,
		OUT VOID **	RsaContext
	)

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.

Parameters

[in]	PemData	Pointer to the PEM-encoded key data to be retrieved.
[in]	PemSize	Size of the PEM key data in bytes.
[in]	Password	NULL-terminated passphrase used for encrypted PEM key data.
[out]	RsaContext	Pointer to new-generated RSA context which contain the retrieved RSA private key component. Use RsaFree() function to free the resource.

Return values

TRUE	RSA Private Key was retrieved successfully.
FALSE	Invalid PEM key data or incorrect password.
FALSE	This interface is not supported.

Retrieve the RSA Private Key from the password-protected PEM key data.

Parameters

[in]	PemData	Pointer to the PEM-encoded key data to be retrieved.
[in]	PemSize	Size of the PEM key data in bytes.
[in]	Password	NULL-terminated passphrase used for encrypted PEM key data.
[out]	RsaContext	Pointer to new-generated RSA context which contain the retrieved RSA private key component. Use RsaFree() function to free the resource.

If PemData is NULL, then return FALSE. If RsaContext is NULL, then return FALSE.

Return values

TRUE	RSA Private Key was retrieved successfully.
FALSE	Invalid PEM key data or incorrect password.

Retrieve the RSA Private Key from the password-protected PEM key data.

Return FALSE to indicate this interface is not supported.

Parameters

[in]	PemData	Pointer to the PEM-encoded key data to be retrieved.
[in]	PemSize	Size of the PEM key data in bytes.
[in]	Password	NULL-terminated passphrase used for encrypted PEM key data.
[out]	RsaContext	Pointer to new-generated RSA context which contain the retrieved RSA private key component. Use RsaFree() function to free the resource.

Return values

FALSE This interface is not supported.

Definition at line 66 of file CryptPem.c.

◆ RsaGetPublicKeyFromX509()

BOOLEAN EFIAPI RsaGetPublicKeyFromX509	(	IN CONST UINT8 *	Cert,
		IN UINTN	CertSize,
		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.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[out]	RsaContext	Pointer to new-generated RSA context which contain the retrieved RSA public key component. Use RsaFree() function to free the resource.

Return values

TRUE	RSA Public Key was retrieved successfully.
FALSE	Fail to retrieve RSA public key from X509 certificate.
FALSE	This interface is not supported.

Retrieve the RSA Public Key from one DER-encoded X509 certificate.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[out]	RsaContext	Pointer to new-generated RSA context which contain the retrieved RSA public key component. Use RsaFree() function to free the resource.

If Cert is NULL, then return FALSE. If RsaContext is NULL, then return FALSE.

Return values

TRUE	RSA Public Key was retrieved successfully.
FALSE	Fail to retrieve RSA public key from X509 certificate.

Retrieve the RSA Public Key from one DER-encoded X509 certificate.

Return FALSE to indicate this interface is not supported.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[out]	RsaContext	Pointer to new-generated RSA context which contain the retrieved RSA public key component. Use RsaFree() function to free the resource.

Return values

FALSE This interface is not supported.

Definition at line 580 of file CryptX509.c.

◆ RsaNew()

VOID *EFIAPI RsaNew ( VOID )

Allocates and initializes one RSA context for subsequent use.

Returns: Pointer to the RSA context that has been initialized. If the allocations fails, RsaNew() returns NULL.

Definition at line 30 of file CryptRsaBasic.c.

◆ RsaOaepDecrypt()

BOOLEAN EFIAPI RsaOaepDecrypt	(	IN VOID *	RsaContext,
		IN UINT8 *	EncryptedData,
		IN UINTN	EncryptedDataSize,
		IN UINT16 DigestLen	OPTIONAL,
		OUT UINT8 **	OutData,
		OUT UINTN *	OutDataSize
	)

Decrypts a blob using PKCS1v2 (RSAES-OAEP) schema. On success, will return the decrypted message in a newly allocated buffer.

Things that can cause a failure include:

Fail to parse private key.
Fail to allocate an intermediate buffer.
Null pointer provided for a non-optional parameter.

Parameters

[in]	RsaContext	A pointer to an RSA context created by RsaNew() and provisioned with a private key using RsaSetKey().
[in]	EncryptedData	Data to be decrypted.
[in]	EncryptedDataSize	Size of the encrypted buffer.
[in]	DigestLen	[Optional] If provided, size of the hash used: SHA1_DIGEST_SIZE SHA256_DIGEST_SIZE SHA384_DIGEST_SIZE SHA512_DIGEST_SIZE 0 to use default (SHA1)
[out]	OutData	Pointer to an allocated buffer containing the encrypted message.
[out]	OutDataSize	Size of the encrypted message buffer.

Return values

TRUE	Encryption was successful.
FALSE	Encryption failed.

Definition at line 669 of file CryptPkcs1Oaep.c.

◆ RsaOaepEncrypt()

BOOLEAN EFIAPI RsaOaepEncrypt	(	IN VOID *	RsaContext,
		IN UINT8 *	InData,
		IN UINTN	InDataSize,
		IN CONST UINT8 *PrngSeed	OPTIONAL,
		IN UINTN PrngSeedSize	OPTIONAL,
		IN UINT16 DigestLen	OPTIONAL,
		OUT UINT8 **	EncryptedData,
		OUT UINTN *	EncryptedDataSize
	)

Encrypts a blob using PKCS1v2 (RSAES-OAEP) schema. On success, will return the encrypted message in a newly allocated buffer.

Things that can cause a failure include:

X509 key size does not match any known key size.
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).

Parameters

[in]	RsaContext	A pointer to an RSA context created by RsaNew() and provisioned with a public key using RsaSetKey().
[in]	InData	Data to be encrypted.
[in]	InDataSize	Size of the data buffer.
[in]	PrngSeed	[Optional] If provided, a pointer to a random seed buffer to be used when initializing the PRNG. NULL otherwise.
[in]	PrngSeedSize	[Optional] If provided, size of the random seed buffer. 0 otherwise.
[in]	DigestLen	[Optional] If provided, size of the hash used: SHA1_DIGEST_SIZE SHA256_DIGEST_SIZE SHA384_DIGEST_SIZE SHA512_DIGEST_SIZE 0 to use default (SHA1)
[out]	EncryptedData	Pointer to an allocated buffer containing the encrypted message.
[out]	EncryptedDataSize	Size of the encrypted message buffer.

Return values

TRUE	Encryption was successful.
FALSE	Encryption failed.

Encrypts a blob using PKCS1v2 (RSAES-OAEP) schema. On success, will return the encrypted message in a newly allocated buffer.

Things that can cause a failure include:

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).

Parameters

[in]	RsaContext	A pointer to an RSA context created by RsaNew() and provisioned with a public key using RsaSetKey().
[in]	InData	Data to be encrypted.
[in]	InDataSize	Size of the data buffer.
[in]	PrngSeed	[Optional] If provided, a pointer to a random seed buffer to be used when initializing the PRNG. NULL otherwise.
[in]	PrngSeedSize	[Optional] If provided, size of the random seed buffer. 0 otherwise.
[in]	DigestLen	[Optional] If provided, size of the hash used: SHA1_DIGEST_SIZE SHA256_DIGEST_SIZE SHA384_DIGEST_SIZE SHA512_DIGEST_SIZE 0 to use default (SHA1)
[out]	EncryptedData	Pointer to an allocated buffer containing the encrypted message.
[out]	EncryptedDataSize	Size of the encrypted message buffer.

Return values

TRUE	Encryption was successful.
FALSE	Encryption failed.

Definition at line 366 of file CryptPkcs1Oaep.c.

◆ RsaPkcs1Sign()

BOOLEAN EFIAPI RsaPkcs1Sign	(	IN VOID *	RsaContext,
		IN CONST UINT8 *	MessageHash,
		IN UINTN	HashSize,
		OUT UINT8 *	Signature,
		IN OUT UINTN *	SigSize
	)

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.

Parameters

[in]	RsaContext	Pointer to RSA context for signature generation.
[in]	MessageHash	Pointer to octet message hash to be signed.
[in]	HashSize	Size of the message hash in bytes.
[out]	Signature	Pointer to buffer to receive RSA PKCS1-v1_5 signature.
[in,out]	SigSize	On input, the size of Signature buffer in bytes. On output, the size of data returned in Signature buffer in bytes.

Return values

TRUE	Signature successfully generated in PKCS1-v1_5.
FALSE	Signature generation failed.
FALSE	SigSize is too small.
FALSE	This interface is not supported.

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, SHA-256, SHA-384 or SHA-512 digest, then return FALSE. If SigSize is large enough but Signature is NULL, then return FALSE.

Parameters

[in]	RsaContext	Pointer to RSA context for signature generation.
[in]	MessageHash	Pointer to octet message hash to be signed.
[in]	HashSize	Size of the message hash in bytes.
[out]	Signature	Pointer to buffer to receive RSA PKCS1-v1_5 signature.
[in,out]	SigSize	On input, the size of Signature buffer in bytes. On output, the size of data returned in Signature buffer in bytes.

Return values

TRUE	Signature successfully generated in PKCS1-v1_5.
FALSE	Signature generation failed.
FALSE	SigSize is too small.

Carries out the RSA-SSA signature generation with EMSA-PKCS1-v1_5 encoding scheme.

Return FALSE to indicate this interface is not supported.

Parameters

[in]	RsaContext	Pointer to RSA context for signature generation.
[in]	MessageHash	Pointer to octet message hash to be signed.
[in]	HashSize	Size of the message hash in bytes.
[out]	Signature	Pointer to buffer to receive RSA PKCS1-v1_5 signature.
[in,out]	SigSize	On input, the size of Signature buffer in bytes. On output, the size of data returned in Signature buffer in bytes.

Return values

FALSE This interface is not supported.

Definition at line 297 of file CryptRsaExt.c.

◆ RsaPkcs1Verify()

BOOLEAN EFIAPI RsaPkcs1Verify	(	IN VOID *	RsaContext,
		IN CONST UINT8 *	MessageHash,
		IN UINTN	HashSize,
		IN CONST UINT8 *	Signature,
		IN 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.

Parameters

[in]	RsaContext	Pointer to RSA context for signature verification.
[in]	MessageHash	Pointer to octet message hash to be checked.
[in]	HashSize	Size of the message hash in bytes.
[in]	Signature	Pointer to RSA PKCS1-v1_5 signature to be verified.
[in]	SigSize	Size of signature in bytes.

Return values

TRUE	Valid signature encoded in PKCS1-v1_5.
FALSE	Invalid signature or invalid RSA context.

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, SHA-384 or SHA-512 digest, then return FALSE.

Parameters

[in]	RsaContext	Pointer to RSA context for signature verification.
[in]	MessageHash	Pointer to octet message hash to be checked.
[in]	HashSize	Size of the message hash in bytes.
[in]	Signature	Pointer to RSA PKCS1-v1_5 signature to be verified.
[in]	SigSize	Size of signature in bytes.

Return values

TRUE	Valid signature encoded in PKCS1-v1_5.
FALSE	Invalid signature or invalid RSA context.

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 or SHA-256 digest, then return FALSE.

Parameters

[in]	RsaContext	Pointer to RSA context for signature verification.
[in]	MessageHash	Pointer to octet message hash to be checked.
[in]	HashSize	Size of the message hash in bytes.
[in]	Signature	Pointer to RSA PKCS1-v1_5 signature to be verified.
[in]	SigSize	Size of signature in bytes.

Return values

TRUE	Valid signature encoded in PKCS1-v1_5.
FALSE	Invalid signature or invalid RSA context.

Definition at line 276 of file CryptRsaBasic.c.

◆ RsaPssSign()

BOOLEAN EFIAPI RsaPssSign	(	IN VOID *	RsaContext,
		IN CONST UINT8 *	Message,
		IN UINTN	MsgSize,
		IN UINT16	DigestLen,
		IN UINT16	SaltLen,
		OUT UINT8 *	Signature,
		IN OUT UINTN *	SigSize
	)

Carries out the RSA-SSA signature generation with EMSA-PSS encoding scheme.

This function carries out the RSA-SSA signature generation with EMSA-PSS encoding scheme defined in RFC 8017. Mask generation function is the same as the message digest algorithm. 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 Message is NULL, then return FALSE. If MsgSize is zero or > INT_MAX, then return FALSE. If DigestLen is NOT 32, 48 or 64, return FALSE. If SaltLen is not equal to DigestLen, then return FALSE. If SigSize is large enough but Signature is NULL, then return FALSE. If this interface is not supported, then return FALSE.

Parameters

[in]	RsaContext	Pointer to RSA context for signature generation.
[in]	Message	Pointer to octet message to be signed.
[in]	MsgSize	Size of the message in bytes.
[in]	DigestLen	Length of the digest in bytes to be used for RSA signature operation.
[in]	SaltLen	Length of the salt in bytes to be used for PSS encoding.
[out]	Signature	Pointer to buffer to receive RSA PSS signature.
[in,out]	SigSize	On input, the size of Signature buffer in bytes. On output, the size of data returned in Signature buffer in bytes.

Return values

TRUE	Signature successfully generated in RSASSA-PSS.
FALSE	Signature generation failed.
FALSE	SigSize is too small.
FALSE	This interface is not supported.

This function carries out the RSA-SSA signature generation with EMSA-PSS encoding scheme defined in RFC 8017. Mask generation function is the same as the message digest algorithm. 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 Message is NULL, then return FALSE. If MsgSize is zero or > INT_MAX, then return FALSE. If DigestLen is NOT 32, 48 or 64, return FALSE. If SaltLen is not equal to DigestLen, then return FALSE. If SigSize is large enough but Signature is NULL, then return FALSE. If this interface is not supported, then return FALSE.

Parameters

[in]	RsaContext	Pointer to RSA context for signature generation.
[in]	Message	Pointer to octet message to be signed.
[in]	MsgSize	Size of the message in bytes.
[in]	DigestLen	Length of the digest in bytes to be used for RSA signature operation.
[in]	SaltLen	Length of the salt in bytes to be used for PSS encoding.
[out]	Signature	Pointer to buffer to receive RSA PSS signature.
[in,out]	SigSize	On input, the size of Signature buffer in bytes. On output, the size of data returned in Signature buffer in bytes.

Return values

TRUE	Signature successfully generated in RSASSA-PSS.
FALSE	Signature generation failed.
FALSE	SigSize is too small.
FALSE	This interface is not supported.

Definition at line 81 of file CryptRsaPssSign.c.

◆ RsaPssVerify()

BOOLEAN EFIAPI RsaPssVerify	(	IN VOID *	RsaContext,
		IN CONST UINT8 *	Message,
		IN UINTN	MsgSize,
		IN CONST UINT8 *	Signature,
		IN UINTN	SigSize,
		IN UINT16	DigestLen,
		IN UINT16	SaltLen
	)

Verifies the RSA signature with RSASSA-PSS signature scheme defined in RFC 8017. Implementation determines salt length automatically from the signature encoding. Mask generation function is the same as the message digest algorithm. Salt length should be equal to digest length.

Parameters

[in]	RsaContext	Pointer to RSA context for signature verification.
[in]	Message	Pointer to octet message to be verified.
[in]	MsgSize	Size of the message in bytes.
[in]	Signature	Pointer to RSASSA-PSS signature to be verified.
[in]	SigSize	Size of signature in bytes.
[in]	DigestLen	Length of digest for RSA operation.
[in]	SaltLen	Salt length for PSS encoding.

Return values

TRUE	Valid signature encoded in RSASSA-PSS.
FALSE	Invalid signature or invalid RSA context.

Definition at line 67 of file CryptRsaPss.c.

◆ RsaSetKey()

BOOLEAN EFIAPI RsaSetKey	(	IN OUT VOID *	RsaContext,
		IN RSA_KEY_TAG	KeyTag,
		IN CONST UINT8 *	BigNumber,
		IN UINTN	BnSize
	)

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.

Parameters

[in,out]	RsaContext	Pointer to RSA context being set.
[in]	KeyTag	Tag of RSA key component being set.
[in]	BigNumber	Pointer to octet integer buffer. If NULL, then the specified key component in RSA context is cleared.
[in]	BnSize	Size of big number buffer in bytes. If BigNumber is NULL, then it is ignored.

Return values

TRUE	RSA key component was set successfully.
FALSE	Invalid RSA key component tag.

Definition at line 82 of file CryptRsaBasic.c.

◆ Sha1Duplicate()

BOOLEAN EFIAPI Sha1Duplicate	(	IN CONST VOID *	Sha1Context,
		OUT VOID *	NewSha1Context
	)

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.

Parameters

[in]	Sha1Context	Pointer to SHA-1 context being copied.
[out]	NewSha1Context	Pointer to new SHA-1 context.

Return values

TRUE	SHA-1 context copy succeeded.
FALSE	SHA-1 context copy failed.
FALSE	This interface is not supported.

Makes a copy of an existing SHA-1 context.

If Sha1Context is NULL, then return FALSE. If NewSha1Context is NULL, then return FALSE.

Parameters

[in]	Sha1Context	Pointer to SHA-1 context being copied.
[out]	NewSha1Context	Pointer to new SHA-1 context.

Return values

TRUE	SHA-1 context copy succeeded.
FALSE	SHA-1 context copy failed.

Definition at line 78 of file CryptSha1.c.

◆ Sha1Final()

BOOLEAN EFIAPI Sha1Final	(	IN OUT VOID *	Sha1Context,
		OUT UINT8 *	HashValue
	)

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.

Parameters

[in,out]	Sha1Context	Pointer to the SHA-1 context.
[out]	HashValue	Pointer to a buffer that receives the SHA-1 digest value (20 bytes).

Return values

TRUE	SHA-1 digest computation succeeded.
FALSE	SHA-1 digest computation failed.
FALSE	This interface is not supported.

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.

Parameters

[in,out]	Sha1Context	Pointer to the SHA-1 context.
[out]	HashValue	Pointer to a buffer that receives the SHA-1 digest value (20 bytes).

Return values

TRUE	SHA-1 digest computation succeeded.
FALSE	SHA-1 digest computation failed.

Definition at line 163 of file CryptSha1.c.

◆ Sha1GetContextSize()

UINTN EFIAPI Sha1GetContextSize ( VOID )

Retrieves the size, in bytes, of the context buffer required for SHA-1 hash operations.

If this interface is not supported, then return zero.

Returns: The size, in bytes, of the context buffer required for SHA-1 hash operations.

Return values

0	This interface is not supported.

Retrieves the size, in bytes, of the context buffer required for SHA-1 hash operations.

Returns: The size, in bytes, of the context buffer required for SHA-1 hash operations.

Definition at line 22 of file CryptSha1.c.

◆ Sha1HashAll()

BOOLEAN EFIAPI Sha1HashAll	(	IN CONST VOID *	Data,
		IN UINTN	DataSize,
		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.

Parameters

[in]	Data	Pointer to the buffer containing the data to be hashed.
[in]	DataSize	Size of Data buffer in bytes.
[out]	HashValue	Pointer to a buffer that receives the SHA-1 digest value (20 bytes).

Return values

TRUE	SHA-1 digest computation succeeded.
FALSE	SHA-1 digest computation failed.
FALSE	This interface is not supported.

Definition at line 201 of file CryptSha1.c.

◆ Sha1Init()

BOOLEAN EFIAPI Sha1Init ( OUT VOID * Sha1Context )

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.

Parameters

[out] Sha1Context Pointer to SHA-1 context being initialized.

Return values

TRUE	SHA-1 context initialization succeeded.
FALSE	SHA-1 context initialization failed.
FALSE	This interface is not supported.

Initializes user-supplied memory pointed by Sha1Context as SHA-1 hash context for subsequent use.

If Sha1Context is NULL, then return FALSE.

Parameters

[out] Sha1Context Pointer to SHA-1 context being initialized.

Return values

TRUE	SHA-1 context initialization succeeded.
FALSE	SHA-1 context initialization failed.

Definition at line 46 of file CryptSha1.c.

◆ Sha1Update()

BOOLEAN EFIAPI Sha1Update	(	IN OUT VOID *	Sha1Context,
		IN CONST VOID *	Data,
		IN UINTN	DataSize
	)

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.

Parameters

[in,out]	Sha1Context	Pointer to the SHA-1 context.
[in]	Data	Pointer to the buffer containing the data to be hashed.
[in]	DataSize	Size of Data buffer in bytes.

Return values

TRUE	SHA-1 data digest succeeded.
FALSE	SHA-1 data digest failed.
FALSE	This interface is not supported.

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.

Parameters

[in,out]	Sha1Context	Pointer to the SHA-1 context.
[in]	Data	Pointer to the buffer containing the data to be hashed.
[in]	DataSize	Size of Data buffer in bytes.

Return values

TRUE	SHA-1 data digest succeeded.
FALSE	SHA-1 data digest failed.

Definition at line 115 of file CryptSha1.c.

◆ Sha256Duplicate()

BOOLEAN EFIAPI Sha256Duplicate	(	IN CONST VOID *	Sha256Context,
		OUT VOID *	NewSha256Context
	)

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.

Parameters

[in]	Sha256Context	Pointer to SHA-256 context being copied.
[out]	NewSha256Context	Pointer to new SHA-256 context.

Return values

TRUE	SHA-256 context copy succeeded.
FALSE	SHA-256 context copy failed.
FALSE	This interface is not supported.

Makes a copy of an existing SHA-256 context.

If Sha256Context is NULL, then return FALSE. If NewSha256Context is NULL, then return FALSE.

Parameters

[in]	Sha256Context	Pointer to SHA-256 context being copied.
[out]	NewSha256Context	Pointer to new SHA-256 context.

Return values

TRUE	SHA-256 context copy succeeded.
FALSE	SHA-256 context copy failed.

Definition at line 76 of file CryptSha256.c.

◆ Sha256Final()

BOOLEAN EFIAPI Sha256Final	(	IN OUT VOID *	Sha256Context,
		OUT UINT8 *	HashValue
	)

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.

Parameters

[in,out]	Sha256Context	Pointer to the SHA-256 context.
[out]	HashValue	Pointer to a buffer that receives the SHA-256 digest value (32 bytes).

Return values

TRUE	SHA-256 digest computation succeeded.
FALSE	SHA-256 digest computation failed.

Definition at line 161 of file CryptSha256.c.

◆ Sha256GetContextSize()

UINTN EFIAPI Sha256GetContextSize ( VOID )

Retrieves the size, in bytes, of the context buffer required for SHA-256 hash operations.

Returns: The size, in bytes, of the context buffer required for SHA-256 hash operations.

Definition at line 20 of file CryptSha256.c.

◆ Sha256HashAll()

BOOLEAN EFIAPI Sha256HashAll	(	IN CONST VOID *	Data,
		IN UINTN	DataSize,
		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.

Parameters

[in]	Data	Pointer to the buffer containing the data to be hashed.
[in]	DataSize	Size of Data buffer in bytes.
[out]	HashValue	Pointer to a buffer that receives the SHA-256 digest value (32 bytes).

Return values

TRUE	SHA-256 digest computation succeeded.
FALSE	SHA-256 digest computation failed.
FALSE	This interface is not supported.

Definition at line 199 of file CryptSha256.c.

◆ Sha256Init()

BOOLEAN EFIAPI Sha256Init ( OUT VOID * Sha256Context )

Initializes user-supplied memory pointed by Sha256Context as SHA-256 hash context for subsequent use.

If Sha256Context is NULL, then return FALSE.

Parameters

[out] Sha256Context Pointer to SHA-256 context being initialized.

Return values

TRUE	SHA-256 context initialization succeeded.
FALSE	SHA-256 context initialization failed.

Definition at line 44 of file CryptSha256.c.

◆ Sha256Update()

BOOLEAN EFIAPI Sha256Update	(	IN OUT VOID *	Sha256Context,
		IN CONST VOID *	Data,
		IN UINTN	DataSize
	)

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.

Parameters

[in,out]	Sha256Context	Pointer to the SHA-256 context.
[in]	Data	Pointer to the buffer containing the data to be hashed.
[in]	DataSize	Size of Data buffer in bytes.

Return values

TRUE	SHA-256 data digest succeeded.
FALSE	SHA-256 data digest failed.

Definition at line 113 of file CryptSha256.c.

◆ Sha384Duplicate()

BOOLEAN EFIAPI Sha384Duplicate	(	IN CONST VOID *	Sha384Context,
		OUT VOID *	NewSha384Context
	)

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.

Parameters

[in]	Sha384Context	Pointer to SHA-384 context being copied.
[out]	NewSha384Context	Pointer to new SHA-384 context.

Return values

TRUE	SHA-384 context copy succeeded.
FALSE	SHA-384 context copy failed.
FALSE	This interface is not supported.

Makes a copy of an existing SHA-384 context.

Return FALSE to indicate this interface is not supported.

Parameters

[in]	Sha384Context	Pointer to SHA-384 context being copied.
[out]	NewSha384Context	Pointer to new SHA-384 context.

Return values

FALSE This interface is not supported.

Definition at line 78 of file CryptSha512.c.

◆ Sha384Final()

BOOLEAN EFIAPI Sha384Final	(	IN OUT VOID *	Sha384Context,
		OUT UINT8 *	HashValue
	)

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.

Parameters

[in,out]	Sha384Context	Pointer to the SHA-384 context.
[out]	HashValue	Pointer to a buffer that receives the SHA-384 digest value (48 bytes).

Return values

TRUE	SHA-384 digest computation succeeded.
FALSE	SHA-384 digest computation failed.

Completes computation of the SHA-384 digest value.

Return FALSE to indicate this interface is not supported.

Parameters

[in,out]	Sha384Context	Pointer to the SHA-384 context.
[out]	HashValue	Pointer to a buffer that receives the SHA-384 digest value (48 bytes).

Return values

FALSE This interface is not supported.

Definition at line 163 of file CryptSha512.c.

◆ Sha384GetContextSize()

UINTN EFIAPI Sha384GetContextSize ( VOID )

Retrieves the size, in bytes, of the context buffer required for SHA-384 hash operations.

Returns: The size, in bytes, of the context buffer required for SHA-384 hash operations.

Retrieves the size, in bytes, of the context buffer required for SHA-384 hash operations.

Return zero to indicate this interface is not supported.

Return values

0	This interface is not supported.

Definition at line 20 of file CryptSha512.c.

◆ Sha384HashAll()

BOOLEAN EFIAPI Sha384HashAll	(	IN CONST VOID *	Data,
		IN UINTN	DataSize,
		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.

Parameters

[in]	Data	Pointer to the buffer containing the data to be hashed.
[in]	DataSize	Size of Data buffer in bytes.
[out]	HashValue	Pointer to a buffer that receives the SHA-384 digest value (48 bytes).

Return values

TRUE	SHA-384 digest computation succeeded.
FALSE	SHA-384 digest computation failed.
FALSE	This interface is not supported.

Computes the SHA-384 message digest of a input data buffer.

Return FALSE to indicate this interface is not supported.

Parameters

[in]	Data	Pointer to the buffer containing the data to be hashed.
[in]	DataSize	Size of Data buffer in bytes.
[out]	HashValue	Pointer to a buffer that receives the SHA-384 digest value (48 bytes).

Return values

FALSE This interface is not supported.

Definition at line 201 of file CryptSha512.c.

◆ Sha384Init()

BOOLEAN EFIAPI Sha384Init ( OUT VOID * Sha384Context )

Initializes user-supplied memory pointed by Sha384Context as SHA-384 hash context for subsequent use.

If Sha384Context is NULL, then return FALSE.

Parameters

[out] Sha384Context Pointer to SHA-384 context being initialized.

Return values

TRUE	SHA-384 context initialization succeeded.
FALSE	SHA-384 context initialization failed.

Initializes user-supplied memory pointed by Sha384Context as SHA-384 hash context for subsequent use.

Return FALSE to indicate this interface is not supported.

Parameters

[out] Sha384Context Pointer to SHA-384 context being initialized.

Return values

FALSE This interface is not supported.

Definition at line 44 of file CryptSha512.c.

◆ Sha384Update()

BOOLEAN EFIAPI Sha384Update	(	IN OUT VOID *	Sha384Context,
		IN CONST VOID *	Data,
		IN UINTN	DataSize
	)

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.

Parameters

[in,out]	Sha384Context	Pointer to the SHA-384 context.
[in]	Data	Pointer to the buffer containing the data to be hashed.
[in]	DataSize	Size of Data buffer in bytes.

Return values

TRUE	SHA-384 data digest succeeded.
FALSE	SHA-384 data digest failed.

Digests the input data and updates SHA-384 context.

Return FALSE to indicate this interface is not supported.

Parameters

[in,out]	Sha384Context	Pointer to the SHA-384 context.
[in]	Data	Pointer to the buffer containing the data to be hashed.
[in]	DataSize	Size of Data buffer in bytes.

Return values

FALSE This interface is not supported.

Definition at line 115 of file CryptSha512.c.

◆ Sha512Duplicate()

BOOLEAN EFIAPI Sha512Duplicate	(	IN CONST VOID *	Sha512Context,
		OUT VOID *	NewSha512Context
	)

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.

Parameters

[in]	Sha512Context	Pointer to SHA-512 context being copied.
[out]	NewSha512Context	Pointer to new SHA-512 context.

Return values

TRUE	SHA-512 context copy succeeded.
FALSE	SHA-512 context copy failed.
FALSE	This interface is not supported.

Makes a copy of an existing SHA-512 context.

Return FALSE to indicate this interface is not supported.

Parameters

[in]	Sha512Context	Pointer to SHA-512 context being copied.
[out]	NewSha512Context	Pointer to new SHA-512 context.

Return values

FALSE This interface is not supported.

Definition at line 304 of file CryptSha512.c.

◆ Sha512Final()

BOOLEAN EFIAPI Sha512Final	(	IN OUT VOID *	Sha512Context,
		OUT UINT8 *	HashValue
	)

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.

Parameters

[in,out]	Sha512Context	Pointer to the SHA-512 context.
[out]	HashValue	Pointer to a buffer that receives the SHA-512 digest value (64 bytes).

Return values

TRUE	SHA-512 digest computation succeeded.
FALSE	SHA-512 digest computation failed.

Completes computation of the SHA-512 digest value.

Return FALSE to indicate this interface is not supported.

Parameters

[in,out]	Sha512Context	Pointer to the SHA-512 context.
[out]	HashValue	Pointer to a buffer that receives the SHA-512 digest value (64 bytes).

Return values

FALSE This interface is not supported.

Definition at line 389 of file CryptSha512.c.

◆ Sha512GetContextSize()

UINTN EFIAPI Sha512GetContextSize ( VOID )

Retrieves the size, in bytes, of the context buffer required for SHA-512 hash operations.

Returns: The size, in bytes, of the context buffer required for SHA-512 hash operations.

Retrieves the size, in bytes, of the context buffer required for SHA-512 hash operations.

Return zero to indicate this interface is not supported.

Return values

0	This interface is not supported.

Definition at line 246 of file CryptSha512.c.

◆ Sha512HashAll()

BOOLEAN EFIAPI Sha512HashAll	(	IN CONST VOID *	Data,
		IN UINTN	DataSize,
		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.

Parameters

[in]	Data	Pointer to the buffer containing the data to be hashed.
[in]	DataSize	Size of Data buffer in bytes.
[out]	HashValue	Pointer to a buffer that receives the SHA-512 digest value (64 bytes).

Return values

TRUE	SHA-512 digest computation succeeded.
FALSE	SHA-512 digest computation failed.
FALSE	This interface is not supported.

Computes the SHA-512 message digest of a input data buffer.

Return FALSE to indicate this interface is not supported.

Parameters

[in]	Data	Pointer to the buffer containing the data to be hashed.
[in]	DataSize	Size of Data buffer in bytes.
[out]	HashValue	Pointer to a buffer that receives the SHA-512 digest value (64 bytes).

Return values

FALSE This interface is not supported.

Definition at line 427 of file CryptSha512.c.

◆ Sha512Init()

BOOLEAN EFIAPI Sha512Init ( OUT VOID * Sha512Context )

Initializes user-supplied memory pointed by Sha512Context as SHA-512 hash context for subsequent use.

If Sha512Context is NULL, then return FALSE.

Parameters

[out] Sha512Context Pointer to SHA-512 context being initialized.

Return values

TRUE	SHA-512 context initialization succeeded.
FALSE	SHA-512 context initialization failed.

Initializes user-supplied memory pointed by Sha512Context as SHA-512 hash context for subsequent use.

Return FALSE to indicate this interface is not supported.

Parameters

[out] Sha512Context Pointer to SHA-512 context being initialized.

Return values

FALSE This interface is not supported.

Definition at line 270 of file CryptSha512.c.

◆ Sha512Update()

BOOLEAN EFIAPI Sha512Update	(	IN OUT VOID *	Sha512Context,
		IN CONST VOID *	Data,
		IN UINTN	DataSize
	)

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.

Parameters

[in,out]	Sha512Context	Pointer to the SHA-512 context.
[in]	Data	Pointer to the buffer containing the data to be hashed.
[in]	DataSize	Size of Data buffer in bytes.

Return values

TRUE	SHA-512 data digest succeeded.
FALSE	SHA-512 data digest failed.

Digests the input data and updates SHA-512 context.

Return FALSE to indicate this interface is not supported.

Parameters

[in,out]	Sha512Context	Pointer to the SHA-512 context.
[in]	Data	Pointer to the buffer containing the data to be hashed.
[in]	DataSize	Size of Data buffer in bytes.

Return values

FALSE This interface is not supported.

Definition at line 341 of file CryptSha512.c.

◆ Sm3Duplicate()

BOOLEAN EFIAPI Sm3Duplicate	(	IN CONST VOID *	Sm3Context,
		OUT VOID *	NewSm3Context
	)

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.

Parameters

[in]	Sm3Context	Pointer to SM3 context being copied.
[out]	NewSm3Context	Pointer to new SM3 context.

Return values

TRUE	SM3 context copy succeeded.
FALSE	SM3 context copy failed.
FALSE	This interface is not supported.

Definition at line 79 of file CryptSm3.c.

◆ Sm3Final()

BOOLEAN EFIAPI Sm3Final	(	IN OUT VOID *	Sm3Context,
		OUT UINT8 *	HashValue
	)

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.

Parameters

[in,out]	Sm3Context	Pointer to the SM3 context.
[out]	HashValue	Pointer to a buffer that receives the SM3 digest value (32 bytes).

Return values

TRUE	SM3 digest computation succeeded.
FALSE	SM3 digest computation failed.

Definition at line 166 of file CryptSm3.c.

◆ Sm3GetContextSize()

UINTN EFIAPI Sm3GetContextSize ( VOID )

Retrieves the size, in bytes, of the context buffer required for SM3 hash operations.

Returns: The size, in bytes, of the context buffer required for SM3 hash operations.

Definition at line 20 of file CryptSm3.c.

◆ Sm3HashAll()

BOOLEAN EFIAPI Sm3HashAll	(	IN CONST VOID *	Data,
		IN UINTN	DataSize,
		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.

Parameters

[in]	Data	Pointer to the buffer containing the data to be hashed.
[in]	DataSize	Size of Data buffer in bytes.
[out]	HashValue	Pointer to a buffer that receives the SM3 digest value (32 bytes).

Return values

TRUE	SM3 digest computation succeeded.
FALSE	SM3 digest computation failed.
FALSE	This interface is not supported.

Definition at line 206 of file CryptSm3.c.

◆ Sm3Init()

BOOLEAN EFIAPI Sm3Init ( OUT VOID * Sm3Context )

Initializes user-supplied memory pointed by Sm3Context as SM3 hash context for subsequent use.

If Sm3Context is NULL, then return FALSE.

Parameters

[out] Sm3Context Pointer to SM3 context being initialized.

Return values

TRUE	SM3 context initialization succeeded.
FALSE	SM3 context initialization failed.

Definition at line 44 of file CryptSm3.c.

◆ Sm3Update()

BOOLEAN EFIAPI Sm3Update	(	IN OUT VOID *	Sm3Context,
		IN CONST VOID *	Data,
		IN UINTN	DataSize
	)

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.

Parameters

[in,out]	Sm3Context	Pointer to the SM3 context.
[in]	Data	Pointer to the buffer containing the data to be hashed.
[in]	DataSize	Size of Data buffer in bytes.

Return values

TRUE	SM3 data digest succeeded.
FALSE	SM3 data digest failed.

Definition at line 116 of file CryptSm3.c.

◆ VerifyEKUsInPkcs7Signature()

RETURN_STATUS EFIAPI VerifyEKUsInPkcs7Signature	(	IN CONST UINT8 *	Pkcs7Signature,
		IN CONST UINT32	SignatureSize,
		IN CONST CHAR8 *	RequiredEKUs[],
		IN CONST UINT32	RequiredEKUsSize,
		IN BOOLEAN	RequireAllPresent
	)

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.

Parameters

[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.
[in]	Pkcs7SignatureSize	Number of bytes in Pkcs7Signature.
[in]	RequiredEKUs	Array of null-terminated strings listing OIDs of required EKUs that must be present in the signature.
[in]	RequiredEKUsSize	Number of elements in the RequiredEKUs string array.
[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.

Return values

EFI_SUCCESS	The required EKUs were found in the signature.
EFI_INVALID_PARAMETER	A parameter was invalid.
EFI_NOT_FOUND	One or more EKU's were not found in the signature.

This function receives a PKCS#7 formatted signature blob, looks for the EKU SEQUENCE blob, and if found then looks for all the required EKUs. This function was created so that the Surface team can cut down on the number of Certificate Authorities (CA's) by checking EKU's on leaf signers for a specific product. This prevents one product's certificate from signing another product's firmware or unlock blobs.

Note that this function does not validate the certificate chain. That needs to be done before using this function.

Parameters

[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.
[in]	Pkcs7SignatureSize	Number of bytes in Pkcs7Signature.
[in]	RequiredEKUs	Array of null-terminated strings listing OIDs of required EKUs that must be present in the signature.
[in]	RequiredEKUsSize	Number of elements in the RequiredEKUs string array.
[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.

Return values

EFI_SUCCESS	The required EKUs were found in the signature.
EFI_INVALID_PARAMETER	A parameter was invalid.
EFI_NOT_FOUND	One or more EKU's were not found in the signature.

This function receives a PKCS#7 formatted signature blob, looks for the EKU SEQUENCE blob, and if found then looks for all the required EKUs. This function was created so that the Surface team can cut down on the number of Certificate Authorities (CA's) by checking EKU's on leaf signers for a specific product. This prevents one product's certificate from signing another product's firmware or unlock blobs.

Return RETURN_UNSUPPORTED to indicate this interface is not supported.

Parameters

[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.
[in]	Pkcs7SignatureSize	Number of bytes in pPkcs7Signature.
[in]	RequiredEKUs	Array of null-terminated strings listing OIDs of required EKUs that must be present in the signature. All specified EKU's must be present in order to succeed.
[in]	RequiredEKUsSize	Number of elements in the rgRequiredEKUs string. This parameter has a maximum of MAX_EKU_SEARCH.
[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.

Return values

RETURN_UNSUPPORTED The operation is not supported.

Definition at line 367 of file CryptPkcs7VerifyEku.c.

◆ X509CompareDateTime()

INT32 EFIAPI X509CompareDateTime	(	IN CONST VOID *	DateTime1,
		IN CONST VOID *	DateTime2
	)

Compare DateTime1 object and DateTime2 object.

If DateTime1 is NULL, then return -2. If DateTime2 is NULL, then return -2. If DateTime1 == DateTime2, then return 0 If DateTime1 > DateTime2, then return 1 If DateTime1 < DateTime2, then return -1

Parameters

[in]	DateTime1	Pointer to a DateTime Ojbect
[in]	DateTime2	Pointer to a DateTime Object

Return values

0	If DateTime1 == DateTime2
1	If DateTime1 > DateTime2
-1	If DateTime1 < DateTime2

Definition at line 1618 of file CryptX509.c.

◆ X509ConstructCertificate()

BOOLEAN EFIAPI X509ConstructCertificate	(	IN CONST UINT8 *	Cert,
		IN UINTN	CertSize,
		OUT UINT8 **	SingleX509Cert
	)

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.

Parameters

[in]	Cert	Pointer to the DER-encoded certificate data.
[in]	CertSize	The size of certificate data in bytes.
[out]	SingleX509Cert	The generated X509 object.

Return values

TRUE	The X509 object generation succeeded.
FALSE	The operation failed.
FALSE	This interface is not supported.

Construct a X509 object from DER-encoded certificate data.

If Cert is NULL, then return FALSE. If SingleX509Cert is NULL, then return FALSE.

Parameters

[in]	Cert	Pointer to the DER-encoded certificate data.
[in]	CertSize	The size of certificate data in bytes.
[out]	SingleX509Cert	The generated X509 object.

Return values

TRUE	The X509 object generation succeeded.
FALSE	The operation failed.

Construct a X509 object from DER-encoded certificate data.

Return FALSE to indicate this interface is not supported.

Parameters

[in]	Cert	Pointer to the DER-encoded certificate data.
[in]	CertSize	The size of certificate data in bytes.
[out]	SingleX509Cert	The generated X509 object.

Return values

FALSE This interface is not supported.

Definition at line 43 of file CryptX509.c.

◆ X509ConstructCertificateStack()

BOOLEAN EFIAPI X509ConstructCertificateStack	(	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.

Parameters

[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.
	...	A list of DER-encoded single certificate data followed by certificate size. A NULL terminates the list. The pairs are the arguments to X509ConstructCertificate().

Return values

TRUE	The X509 stack construction succeeded.
FALSE	The construction operation failed.
FALSE	This interface is not supported.

Construct a X509 stack object from a list of DER-encoded certificate data.

If X509Stack is NULL, then return FALSE.

Parameters

[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.
	...	A list of DER-encoded single certificate data followed by certificate size. A NULL terminates the list. The pairs are the arguments to X509ConstructCertificate().

Return values

TRUE	The X509 stack construction succeeded.
FALSE	The construction operation failed.

Construct a X509 stack object from a list of DER-encoded certificate data.

Return FALSE to indicate this interface is not supported.

Parameters

[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.
	...	A list of DER-encoded single certificate data followed by certificate size. A NULL terminates the list. The pairs are the arguments to X509ConstructCertificate().

Return values

FALSE This interface is not supported.

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.

Parameters

[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.
[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().

Return values

TRUE	The X509 stack construction succeeded.
FALSE	The construction operation failed.
FALSE	This interface is not supported.

Definition at line 190 of file CryptX509.c.

◆ X509ConstructCertificateStackV()

BOOLEAN EFIAPI X509ConstructCertificateStackV	(	IN OUT UINT8 **	X509Stack,
		IN VA_LIST	Args
	)

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.

Parameters

[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.
[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().

Return values

TRUE	The X509 stack construction succeeded.
FALSE	The construction operation failed.
FALSE	This interface is not supported.

Definition at line 94 of file CryptX509.c.

◆ X509FormatDateTime()

BOOLEAN EFIAPI X509FormatDateTime	(	IN CONST CHAR8 *	DateTimeStr,
		OUT VOID *	DateTime,
		IN OUT UINTN *	DateTimeSize
	)

Format a DateTimeStr to DataTime object in DataTime Buffer

If DateTimeStr is NULL, then return FALSE. If DateTimeSize is NULL, then return FALSE. If this interface is not supported, then return FALSE.

Parameters

[in]	DateTimeStr	DateTime string like YYYYMMDDhhmmssZ Ref: https://www.w3.org/TR/NOTE-datetime Z stand for UTC time
[out]	DateTime	Pointer to a DateTime object.
[in,out]	DateTimeSize	DateTime object buffer size.

Return values

TRUE	The DateTime object create successfully.
FALSE	If DateTimeStr is NULL. If DateTimeSize is NULL. If DateTime is not NULL and *DateTimeSize is 0. If Year Month Day Hour Minute Second combination is invalid datetime.
FALSE	If the DateTime is NULL. The required buffer size (including the final null) is returned in the DateTimeSize parameter.
FALSE	The operation is not supported.

Definition at line 1550 of file CryptX509.c.

◆ X509Free()

VOID EFIAPI X509Free ( IN VOID * X509Cert )

Release the specified X509 object.

If the interface is not supported, then ASSERT().

Parameters

[in] X509Cert Pointer to the X509 object to be released.

Release the specified X509 object.

If X509Cert is NULL, then return FALSE.

Parameters

[in] X509Cert Pointer to the X509 object to be released.

Definition at line 214 of file CryptX509.c.

◆ X509GetCertFromCertChain()

BOOLEAN EFIAPI X509GetCertFromCertChain	(	IN CONST UINT8 *	CertChain,
		IN UINTN	CertChainLength,
		IN CONST INT32	CertIndex,
		OUT CONST UINT8 **	Cert,
		OUT UINTN *	CertLength
	)

Get one X509 certificate from CertChain.

Parameters

[in]	CertChain	One or more ASN.1 DER-encoded X.509 certificates where the first certificate is signed by the Root Certificate or is the Root Certificate itself. and subsequent certificate is signed by the preceding certificate.
[in]	CertChainLength	Total length of the certificate chain, in bytes.
[in]	CertIndex	Index of certificate. If index is -1 indecate the last certificate in CertChain.
[out]	Cert	The certificate at the index of CertChain.
[out]	CertLength	The length certificate at the index of CertChain.

Return values

TRUE	Success.
FALSE	Failed to get certificate from certificate chain.

Get one X509 certificate from CertChain.

Parameters

[in]	CertChain	One or more ASN.1 DER-encoded X.509 certificates where the first certificate is signed by the Root Certificate or is the Root Certificate itself. and subsequent certificate is signed by the preceding certificate.
[in]	CertChainLength	Total length of the certificate chain, in bytes.
[in]	CertIndex	Index of certificate.
[out]	Cert	The certificate at the index of CertChain.
[out]	CertLength	The length certificate at the index of CertChain.

Return values

TRUE	Success.
FALSE	Failed to get certificate from certificate chain.

Get one X509 certificate from CertChain.

Parameters

[in]	CertChain	One or more ASN.1 DER-encoded X.509 certificates where the first certificate is signed by the Root Certificate or is the Root Cerificate itself. and subsequent cerificate is signed by the preceding cerificate.
[in]	CertChainLength	Total length of the certificate chain, in bytes.
[in]	CertIndex	Index of certificate.
[out]	Cert	The certificate at the index of CertChain.
[out]	CertLength	The length certificate at the index of CertChain.

Return values

TRUE	Success.
FALSE	Failed to get certificate from certificate chain.

Definition at line 1792 of file CryptX509.c.

◆ X509GetCommonName()

RETURN_STATUS EFIAPI X509GetCommonName	(	IN CONST UINT8 *	Cert,
		IN UINTN	CertSize,
		OUT CHAR8 *CommonName	OPTIONAL,
		IN OUT UINTN *	CommonNameSize
	)

Retrieve the common name (CN) string from one X.509 certificate.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[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.
[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.

Return values

RETURN_SUCCESS	The certificate CommonName retrieved successfully.
RETURN_INVALID_PARAMETER	If Cert is NULL. If CommonNameSize is NULL. If CommonName is not NULL and *CommonNameSize is 0. If Certificate is invalid.
RETURN_NOT_FOUND	If no CommonName entry exists.
RETURN_BUFFER_TOO_SMALL	If the CommonName is NULL. The required buffer size (including the final null) is returned in the CommonNameSize parameter.
RETURN_UNSUPPORTED	The operation is not supported.

Retrieve the common name (CN) string from one X.509 certificate.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[out]	CommonName	Buffer to contain the retrieved certificate common name string. 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.
[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.

Return values

RETURN_SUCCESS	The certificate CommonName retrieved successfully.
RETURN_INVALID_PARAMETER	If Cert is NULL. If CommonNameSize is NULL. If CommonName is not NULL and *CommonNameSize is 0. If Certificate is invalid.
RETURN_NOT_FOUND	If no CommonName entry exists.
RETURN_BUFFER_TOO_SMALL	If the CommonName is NULL. The required buffer size (including the final null) is returned in the CommonNameSize parameter.
RETURN_UNSUPPORTED	The operation is not supported.

Retrieve the common name (CN) string from one X.509 certificate.

Return RETURN_UNSUPPORTED to indicate this interface is not supported.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[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.
[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.

Return values

RETURN_UNSUPPORTED The operation is not supported.

Definition at line 514 of file CryptX509.c.

◆ X509GetExtendedBasicConstraints()

BOOLEAN EFIAPI X509GetExtendedBasicConstraints	(	CONST UINT8 *	Cert,
		UINTN	CertSize,
		UINT8 *	BasicConstraints,
		UINTN *	BasicConstraintsSize
	)

Retrieve the basic constraints from one X.509 certificate.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	size of the X509 certificate in bytes.
[out]	BasicConstraints	basic constraints bytes.
[in,out]	BasicConstraintsSize	basic constraints buffer size in bytes.

Return values

TRUE	The basic constraints retrieve successfully.
FALSE	If cert is NULL. If cert_size is NULL. If basic_constraints is not NULL and *basic_constraints_size is 0. If cert is invalid.
FALSE	The required buffer size is small. The return buffer size is basic_constraints_size parameter.
FALSE	If no Extension entry match oid.
FALSE	The operation is not supported.

Retrieve the basic constraints from one X.509 certificate.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	size of the X509 certificate in bytes.
[out]	BasicConstraints	basic constraints bytes.
[in,out]	BasicConstraintsSize	basic constraints buffer sizs in bytes.

Return values

TRUE	The basic constraints retrieve successfully.
FALSE	If cert is NULL. If cert_size is NULL. If basic_constraints is not NULL and *basic_constraints_size is 0. If cert is invalid.
FALSE	The required buffer size is small. The return buffer size is basic_constraints_size parameter.
FALSE	If no Extension entry match oid.
FALSE	The operation is not supported.

Definition at line 1938 of file CryptX509.c.

◆ X509GetExtendedKeyUsage()

BOOLEAN EFIAPI X509GetExtendedKeyUsage	(	IN CONST UINT8 *	Cert,
		IN UINTN	CertSize,
		OUT UINT8 *	Usage,
		IN OUT UINTN *	UsageSize
	)

Retrieve the Extended Key Usage from one X.509 certificate.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[out]	Usage	Key Usage bytes.
[in,out]	UsageSize	Key Usage buffer size in bytes.

Return values

TRUE	The Usage bytes retrieve successfully.
FALSE	If Cert is NULL. If CertSize is NULL. If Usage is not NULL and *UsageSize is 0. If Cert is invalid.
FALSE	If the Usage is NULL. The required buffer size is returned in the UsageSize parameter.
FALSE	The operation is not supported.

Retrieve the Extended Key Usage from one X.509 certificate.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[out]	Usage	Key Usage bytes.
[in,out]	UsageSize	Key Usage buffer sizs in bytes.

Return values

TRUE	The Usage bytes retrieve successfully.
FALSE	If Cert is NULL. If CertSize is NULL. If Usage is not NULL and *UsageSize is 0. If Cert is invalid.
FALSE	If the Usage is NULL. The required buffer size is returned in the UsageSize parameter.
FALSE	The operation is not supported.

Definition at line 1406 of file CryptX509.c.

◆ X509GetExtensionData()

BOOLEAN EFIAPI X509GetExtensionData	(	IN CONST UINT8 *	Cert,
		IN UINTN	CertSize,
		IN CONST UINT8 *	Oid,
		IN UINTN	OidSize,
		OUT UINT8 *	ExtensionData,
		IN OUT UINTN *	ExtensionDataSize
	)

Retrieve Extension data from one X.509 certificate.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[in]	Oid	Object identifier buffer
[in]	OidSize	Object identifier buffer size
[out]	ExtensionData	Extension bytes.
[in,out]	ExtensionDataSize	Extension bytes size.

Return values

TRUE	The certificate Extension data retrieved successfully.
FALSE	If Cert is NULL. If ExtensionDataSize is NULL. If ExtensionData is not NULL and *ExtensionDataSize is 0. If Certificate is invalid.
FALSE	If no Extension entry match Oid.
FALSE	If the ExtensionData is NULL. The required buffer size is returned in the ExtensionDataSize parameter.
FALSE	The operation is not supported.

Definition at line 1274 of file CryptX509.c.

◆ X509GetIssuerName()

BOOLEAN EFIAPI X509GetIssuerName	(	IN CONST UINT8 *	Cert,
		IN UINTN	CertSize,
		OUT UINT8 *	CertIssuer,
		IN OUT UINTN *	CertIssuerSize
	)

Retrieve the issuer bytes from one X.509 certificate.

If Cert is NULL, then return FALSE. If CertIssuerSize is NULL, then return FALSE. If this interface is not supported, then return FALSE.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[out]	CertIssuer	Pointer to the retrieved certificate subject bytes.
[in,out]	CertIssuerSize	The size in bytes of the CertIssuer buffer on input, and the size of buffer returned CertSubject on output.

Return values

TRUE	The certificate issuer retrieved successfully.
FALSE	Invalid certificate, or the CertIssuerSize is too small for the result. The CertIssuerSize will be updated with the required size.
FALSE	This interface is not supported.

Definition at line 1097 of file CryptX509.c.

◆ X509GetKeyUsage()

BOOLEAN EFIAPI X509GetKeyUsage	(	IN CONST UINT8 *	Cert,
		IN UINTN	CertSize,
		OUT UINTN *	Usage
	)

Retrieve the Key Usage from one X.509 certificate.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[out]	Usage	Key Usage (CRYPTO_X509_KU_*)

Return values

TRUE	The certificate Key Usage retrieved successfully.
FALSE	Invalid certificate, or Usage is NULL
FALSE	This interface is not supported.

Definition at line 1639 of file CryptX509.c.

◆ X509GetOrganizationName()

RETURN_STATUS EFIAPI X509GetOrganizationName	(	IN CONST UINT8 *	Cert,
		IN UINTN	CertSize,
		OUT CHAR8 *NameBuffer	OPTIONAL,
		IN OUT UINTN *	NameBufferSize
	)

Retrieve the organization name (O) string from one X.509 certificate.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[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.
[in,out]	NameBufferSize	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.

Return values

RETURN_SUCCESS	The certificate Organization Name retrieved successfully.
RETURN_INVALID_PARAMETER	If Cert is NULL. If NameBufferSize is NULL. If NameBuffer is not NULL and *CommonNameSize is 0. If Certificate is invalid.
RETURN_NOT_FOUND	If no Organization Name entry exists.
RETURN_BUFFER_TOO_SMALL	If the NameBuffer is NULL. The required buffer size (including the final null) is returned in the CommonNameSize parameter.
RETURN_UNSUPPORTED	The operation is not supported.

Retrieve the organization name (ON) string from one X.509 certificate.

Return RETURN_UNSUPPORTED to indicate this interface is not supported.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[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.
[in,out]	NameBufferSize	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.

Return values

RETURN_UNSUPPORTED The operation is not supported.

Definition at line 552 of file CryptX509.c.

◆ X509GetSerialNumber()

BOOLEAN EFIAPI X509GetSerialNumber	(	IN CONST UINT8 *	Cert,
		IN UINTN	CertSize,
		OUT UINT8 *	SerialNumber,
		OPTIONAL IN OUT UINTN *	SerialNumberSize
	)

Retrieve the serialNumber from one X.509 certificate.

If Cert is NULL, then return FALSE. If CertSize is 0, then return FALSE. If this interface is not supported, then return FALSE.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[out]	SerialNumber	Pointer to the retrieved certificate SerialNumber bytes.
[in,out]	SerialNumberSize	The size in bytes of the SerialNumber buffer on input, and the size of buffer returned SerialNumber on output.

Return values

TRUE	The certificate serialNumber retrieved successfully.
FALSE	If Cert is NULL or CertSize is Zero. If SerialNumberSize is NULL. If Certificate is invalid.
FALSE	If no SerialNumber exists.
FALSE	If the SerialNumber is NULL. The required buffer size (including the final null) is returned in the SerialNumberSize parameter.
FALSE	The operation is not supported.

Definition at line 1011 of file CryptX509.c.

◆ X509GetSignatureAlgorithm()

BOOLEAN EFIAPI X509GetSignatureAlgorithm	(	IN CONST UINT8 *	Cert,
		IN UINTN	CertSize,
		OUT UINT8 *	Oid,
		OPTIONAL IN OUT UINTN *	OidSize
	)

Retrieve the Signature Algorithm from one X.509 certificate.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[out]	Oid	Signature Algorithm Object identifier buffer.
[in,out]	OidSize	Signature Algorithm Object identifier buffer size

Return values

TRUE	The certificate Extension data retrieved successfully.
FALSE	If Cert is NULL. If OidSize is NULL. If Oid is not NULL and *OidSize is 0. If Certificate is invalid.
FALSE	If no SignatureType.
FALSE	If the Oid is NULL. The required buffer size is returned in the OidSize.
FALSE	The operation is not supported.

Definition at line 1180 of file CryptX509.c.

◆ X509GetSubjectName()

BOOLEAN EFIAPI X509GetSubjectName	(	IN CONST UINT8 *	Cert,
		IN UINTN	CertSize,
		OUT UINT8 *	CertSubject,
		IN OUT UINTN *	SubjectSize
	)

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.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[out]	CertSubject	Pointer to the retrieved certificate subject bytes.
[in,out]	SubjectSize	The size in bytes of the CertSubject buffer on input, and the size of buffer returned CertSubject on output.

Return values

TRUE	The certificate subject retrieved successfully.
FALSE	Invalid certificate, or the SubjectSize is too small for the result. The SubjectSize will be updated with the required size.
FALSE	This interface is not supported.

Retrieve the subject bytes from one X.509 certificate.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[out]	CertSubject	Pointer to the retrieved certificate subject bytes.
[in,out]	SubjectSize	The size in bytes of the CertSubject buffer on input, and the size of buffer returned CertSubject on output.

If Cert is NULL, then return FALSE. If SubjectSize is NULL, then return FALSE.

Return values

TRUE	The certificate subject retrieved successfully.
FALSE	Invalid certificate, or the SubjectSize is too small for the result. The SubjectSize will be updated with the required size.

Retrieve the subject bytes from one X.509 certificate.

Return FALSE to indicate this interface is not supported.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[out]	CertSubject	Pointer to the retrieved certificate subject bytes.
[in,out]	SubjectSize	The size in bytes of the CertSubject buffer on input, and the size of buffer returned CertSubject on output.

Return values

FALSE This interface is not supported.

Definition at line 277 of file CryptX509.c.

◆ X509GetTBSCert()

BOOLEAN EFIAPI X509GetTBSCert	(	IN CONST UINT8 *	Cert,
		IN UINTN	CertSize,
		OUT UINT8 **	TBSCert,
		OUT UINTN *	TBSCertSize
	)

Retrieve the TBSCertificate from one given X.509 certificate.

Parameters

[in]	Cert	Pointer to the given DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[out]	TBSCert	DER-Encoded To-Be-Signed certificate.
[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.

Return values

TRUE	The TBSCertificate was retrieved successfully.
FALSE	Invalid X.509 certificate.

Retrieve the TBSCertificate from one given X.509 certificate.

Parameters

[in]	Cert	Pointer to the given DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[out]	TBSCert	DER-Encoded To-Be-Signed certificate.
[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.

Return values

TRUE	The TBSCertificate was retrieved successfully.
FALSE	Invalid X.509 certificate.

Retrieve the TBSCertificate from one given X.509 certificate.

Return FALSE to indicate this interface is not supported.

Parameters

[in]	Cert	Pointer to the given DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[out]	TBSCert	DER-Encoded To-Be-Signed certificate.
[out]	TBSCertSize	Size of the TBS certificate in bytes.

Return values

FALSE This interface is not supported.

Definition at line 798 of file CryptX509.c.

◆ X509GetValidity()

BOOLEAN EFIAPI X509GetValidity	(	IN CONST UINT8 *	Cert,
		IN UINTN	CertSize,
		IN UINT8 *	From,
		IN OUT UINTN *	FromSize,
		IN UINT8 *	To,
		IN OUT UINTN *	ToSize
	)

Retrieve the Validity from one X.509 certificate

If Cert is NULL, then return FALSE. If CertIssuerSize is NULL, then return FALSE. If this interface is not supported, then return FALSE.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[in]	From	notBefore Pointer to DateTime object.
[in,out]	FromSize	notBefore DateTime object size.
[in]	To	notAfter Pointer to DateTime object.
[in,out]	ToSize	notAfter DateTime object size.

Note: X509CompareDateTime to compare DateTime oject x509SetDateTime to get a DateTime object from a DateTimeStr

Return values

TRUE	The certificate Validity retrieved successfully.
FALSE	Invalid certificate, or Validity retrieve failed.
FALSE	This interface is not supported.

Retrieve the Validity from one X.509 certificate

If Cert is NULL, then return FALSE. If CertIssuerSize is NULL, then return FALSE. If this interface is not supported, then return FALSE.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[out]	From	notBefore Pointer to DateTime object.
[in,out]	FromSize	notBefore DateTime object size.
[out]	To	notAfter Pointer to DateTime object.
[in,out]	ToSize	notAfter DateTime object size.

Note: X509CompareDateTime to compare DateTime oject x509SetDateTime to get a DateTime object from a DateTimeStr

Return values

TRUE	The certificate Validity retrieved successfully.
FALSE	Invalid certificate, or Validity retrieve failed.
FALSE	This interface is not supported.

Definition at line 1442 of file CryptX509.c.

◆ X509GetVersion()

BOOLEAN EFIAPI X509GetVersion	(	IN CONST UINT8 *	Cert,
		IN UINTN	CertSize,
		OUT UINTN *	Version
	)

Retrieve the version from one X.509 certificate.

If Cert is NULL, then return FALSE. If CertSize is 0, then return FALSE. If this interface is not supported, then return FALSE.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate.
[in]	CertSize	Size of the X509 certificate in bytes.
[out]	Version	Pointer to the retrieved version integer.

Return values

TRUE	The certificate version retrieved successfully.
FALSE	If Cert is NULL or CertSize is Zero.
FALSE	The operation is not supported.

Definition at line 957 of file CryptX509.c.

◆ X509StackFree()

VOID EFIAPI X509StackFree ( IN VOID * X509Stack )

Release the specified X509 stack object.

If the interface is not supported, then ASSERT().

Parameters

[in] X509Stack Pointer to the X509 stack object to be released.

Release the specified X509 stack object.

If X509Stack is NULL, then return FALSE.

Parameters

[in] X509Stack Pointer to the X509 stack object to be released.

Definition at line 241 of file CryptX509.c.

◆ X509VerifyCert()

BOOLEAN EFIAPI X509VerifyCert	(	IN CONST UINT8 *	Cert,
		IN UINTN	CertSize,
		IN CONST UINT8 *	CACert,
		IN UINTN	CACertSize
	)

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.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate to be verified.
[in]	CertSize	Size of the X509 certificate in bytes.
[in]	CACert	Pointer to the DER-encoded trusted CA certificate.
[in]	CACertSize	Size of the CA Certificate in bytes.

Return values

TRUE	The certificate was issued by the trusted CA.
FALSE	Invalid certificate or the certificate was not issued by the given trusted CA.
FALSE	This interface is not supported.

Verify one X509 certificate was issued by the trusted CA.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate to be verified.
[in]	CertSize	Size of the X509 certificate in bytes.
[in]	CACert	Pointer to the DER-encoded trusted CA certificate.
[in]	CACertSize	Size of the CA Certificate in bytes.

If Cert is NULL, then return FALSE. If CACert is NULL, then return FALSE.

Return values

TRUE	The certificate was issued by the trusted CA.
FALSE	Invalid certificate or the certificate was not issued by the given trusted CA.

Verify one X509 certificate was issued by the trusted CA.

Return FALSE to indicate this interface is not supported.

Parameters

[in]	Cert	Pointer to the DER-encoded X509 certificate to be verified.
[in]	CertSize	Size of the X509 certificate in bytes.
[in]	CACert	Pointer to the DER-encoded trusted CA certificate.
[in]	CACertSize	Size of the CA Certificate in bytes.

Return values

FALSE This interface is not supported.

Definition at line 659 of file CryptX509.c.

◆ X509VerifyCertChain()

BOOLEAN EFIAPI X509VerifyCertChain	(	IN CONST UINT8 *	RootCert,
		IN UINTN	RootCertLength,
		IN CONST UINT8 *	CertChain,
		IN UINTN	CertChainLength
	)

Verify one X509 certificate was issued by the trusted CA.

Parameters

[in]	RootCert	Trusted Root Certificate buffer
[in]	RootCertLength	Trusted Root Certificate buffer length
[in]	CertChain	One or more ASN.1 DER-encoded X.509 certificates where the first certificate is signed by the Root Certificate or is the Root Certificate itself. and subsequent certificate is signed by the preceding certificate.
[in]	CertChainLength	Total length of the certificate chain, in bytes.

Return values

TRUE	All certificates was issued by the first certificate in X509Certchain.
FALSE	Invalid certificate or the certificate was not issued by the given trusted CA.

Verify one X509 certificate was issued by the trusted CA.

Parameters

[in]	RootCert	Trusted Root Certificate buffer
[in]	RootCertLength	Trusted Root Certificate buffer length
[in]	CertChain	One or more ASN.1 DER-encoded X.509 certificates where the first certificate is signed by the Root Certificate or is the Root Cerificate itself. and subsequent cerificate is signed by the preceding cerificate.
[in]	CertChainLength	Total length of the certificate chain, in bytes.

Return values

TRUE	All cerificates was issued by the first certificate in X509Certchain.
FALSE	Invalid certificate or the certificate was not issued by the given trusted CA.

Definition at line 1705 of file CryptX509.c.

Data Structures

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ AES_BLOCK_SIZE

◆ CRYPTO_NID_BRAINPOOLP512R1

◆ CRYPTO_NID_NULL

◆ CRYPTO_NID_SECP256R1

◆ CRYPTO_NID_SECP384R1

◆ CRYPTO_NID_SECP521R1

◆ CRYPTO_NID_SHA256

◆ CRYPTO_NID_SHA384

◆ CRYPTO_NID_SHA512

◆ MD5_DIGEST_SIZE

◆ SHA1_DIGEST_SIZE

◆ SHA256_DIGEST_SIZE

◆ SHA384_DIGEST_SIZE

◆ SHA512_DIGEST_SIZE

◆ SM3_256_DIGEST_SIZE

◆ TDES_BLOCK_SIZE

Enumeration Type Documentation

◆ RSA_KEY_TAG

Function Documentation

◆ AeadAesGcmDecrypt()

◆ AeadAesGcmEncrypt()

◆ AesCbcDecrypt()

◆ AesCbcEncrypt()

◆ AesGetContextSize()

◆ AesInit()

◆ Asn1GetTag()

◆ AuthenticodeVerify()

◆ BigNumAdd()

◆ BigNumAddMod()

◆ BigNumBits()

◆ BigNumBytes()

◆ BigNumCmp()

◆ BigNumConstTime()

◆ BigNumContextFree()

◆ BigNumCopy()

◆ BigNumDiv()

◆ BigNumExpMod()

◆ BigNumFree()

◆ BigNumFromBin()

◆ BigNumInit()

◆ BigNumInverseMod()

◆ BigNumIsOdd()

◆ BigNumIsWord()

◆ BigNumMod()

◆ BigNumMulMod()

◆ BigNumNewContext()

◆ BigNumRShift()

◆ BigNumSetUint()

◆ BigNumSqrMod()

◆ BigNumSub()

◆ BigNumToBin()

◆ BigNumValueOne()

◆ DhComputeKey()

◆ DhFree()

◆ DhGenerateKey()

◆ DhGenerateParameter()

◆ DhNew()

◆ DhSetParameter()

◆ EcDhComputeKey()

◆ EcDsaSign()

◆ EcDsaVerify()

◆ EcFree()

◆ EcGenerateKey()

◆ EcGetPrivateKeyFromPem()

◆ EcGetPubKey()

◆ EcGetPublicKeyFromX509()

◆ EcGroupFree()

◆ EcGroupGetCurve()

◆ EcGroupGetOrder()

◆ EcGroupInit()

◆ EcNewByNid()

◆ EcPointAdd()

◆ EcPointDeInit()

◆ EcPointEqual()