OcCryptoLib.h

Go to the documentation of this file.

 
#ifndef OC_CRYPTO_LIB_H
#define OC_CRYPTO_LIB_H
 
//
// Default to 128-bit key length for AES.
//
#ifndef CONFIG_AES_KEY_SIZE
#define CONFIG_AES_KEY_SIZE  16
#endif
 
//
// Set supported hashes to all by default.
//
#ifndef CONFIG_HAS_SUPPORTED_HASHES
#define OC_CRYPTO_SUPPORTS_SHA256  1
#define OC_CRYPTO_SUPPORTS_SHA384  1
#define OC_CRYPTO_SUPPORTS_SHA512  1
#define OC_CRYPTO_SUPPORTS_SHA1    1
#define OC_CRYPTO_SUPPORTS_MD5     1
#endif
 
//
// Digest sizes.
//
#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 OC_MAX_SHA_DIGEST_SIZE  SHA512_DIGEST_SIZE
 
//
// Block sizes.
//
#define SHA256_BLOCK_SIZE  64
#define SHA512_BLOCK_SIZE  128
#define SHA384_BLOCK_SIZE  SHA512_BLOCK_SIZE
 
//
// Derived parameters.
//
#define AES_BLOCK_SIZE  16
 
//
// Support all AES key sizes.
//
#if CONFIG_AES_KEY_SIZE == 32
#define AES_KEY_EXP_SIZE  240
#elif CONFIG_AES_KEY_SIZE == 24
#define AES_KEY_EXP_SIZE  208
#elif CONFIG_AES_KEY_SIZE == 16
#define AES_KEY_EXP_SIZE  176
#else
  #error "Only AES-128, AES-192, and AES-256 are supported!"
#endif
 
//
// ChaCha key size.
//
#define CHACHA_KEY_SIZE  32
 
//
// ChaCha IV size.
//
#define CHACHA_IV_SIZE  12
 
//
// Maximum OpenCore password length.
//
#define OC_PASSWORD_MAX_LEN  32
 
//
// Maximum OpenCore password retries.
//
#define OC_PASSWORD_MAX_RETRIES  3
 
//
// Possible RSA algorithm types supported by OcCryptoLib
// for RSA digital signature verification
// PcdOcCryptoAllowedSigHashTypes MUST be kept in sync with changes!
//
typedef enum OC_SIG_HASH_TYPE_ {
  OcSigHashTypeSha256,
  OcSigHashTypeSha384,
  OcSigHashTypeSha512,
  OcSigHashTypeMax
} OC_SIG_HASH_TYPE;
 
typedef struct AES_CONTEXT_ {
  UINT8    RoundKey[AES_KEY_EXP_SIZE];
  UINT8    Iv[AES_BLOCK_SIZE];
} AES_CONTEXT;
 
typedef struct CHACHA_CONTEXT_ {
  UINT32    Input[16];
} CHACHA_CONTEXT;
 
typedef struct MD5_CONTEXT_ {
  UINT8     Data[64];
  UINT32    DataLen;
  UINT64    BitLen;
  UINT32    State[4];
} MD5_CONTEXT;
 
typedef struct SHA1_CONTEXT_ {
  UINT8     Data[64];
  UINT32    DataLen;
  UINT64    BitLen;
  UINT32    State[5];
  UINT32    K[4];
} SHA1_CONTEXT;
 
typedef struct SHA256_CONTEXT_ {
  UINT8     Data[64];
  UINT32    DataLen;
  UINT64    BitLen;
  UINT32    State[8];
} SHA256_CONTEXT;
 
typedef struct SHA512_CONTEXT_ {
  UINT64    TotalLength;
  UINTN     Length;
  UINT8     Block[2 * SHA512_BLOCK_SIZE];
  UINT64    State[8];
} SHA512_CONTEXT;
 
typedef SHA512_CONTEXT SHA384_CONTEXT;
 
typedef struct {
  UINT16    NumQwords;
  UINT8     Reserved[6];
  UINT64    N0Inv;
} OC_RSA_PUBLIC_KEY_HDR;
 
STATIC_ASSERT (
  sizeof (OC_RSA_PUBLIC_KEY_HDR) == 16,
  "The PK header struct is malformed."
  );
 
typedef struct {
  OC_RSA_PUBLIC_KEY_HDR    Hdr;
  UINT64                   Data[];
} OC_RSA_PUBLIC_KEY;
 
STATIC_ASSERT (
  sizeof (OC_RSA_PUBLIC_KEY_HDR) == sizeof (OC_RSA_PUBLIC_KEY_HDR),
  "The PK struct is malformed."
  );
 
//
// Functions prototypes
//
 
VOID
AesInitCtxIv (
  OUT AES_CONTEXT  *Context,
  IN  CONST UINT8  *Key,
  IN  CONST UINT8  *Iv
  );
 
VOID
AesSetCtxIv (
  OUT AES_CONTEXT  *Context,
  IN  CONST UINT8  *Iv
  );
 
//
// Data size MUST be mutiple of AES_BLOCK_SIZE;
// Suggest https://en.wikipedia.org/wiki/Padding_(cryptography)#PKCS7 for Padding scheme
// NOTES: you need to set Iv in Context via AesInitCtxIv() or AesSetCtxIv()
//        no Iv should ever be reused with the same key
//
VOID
AesCbcEncryptBuffer (
  IN OUT AES_CONTEXT  *Context,
  IN OUT UINT8        *Data,
  IN     UINT32       Len
  );
 
VOID
AesCbcDecryptBuffer (
  IN OUT AES_CONTEXT  *Context,
  IN OUT UINT8        *Data,
  IN     UINT32       Len
  );
 
//
// Same function for encrypting as for decrypting.
// Iv is incremented for every block, and used after encryption as XOR-compliment for output
// Suggesting https://en.wikipedia.org/wiki/Padding_(cryptography)#PKCS7 for Padding scheme
// NOTES: you need to set Iv in Context via AesInitCtxIv() or AesSetCtxIv()
//        no Iv should ever be reused with the same key
//
VOID
AesCtrXcryptBuffer (
  IN OUT AES_CONTEXT  *Context,
  IN OUT UINT8        *Data,
  IN     UINT32       Len
  );
 
VOID
ChaChaInitCtx (
  OUT CHACHA_CONTEXT  *Context,
  IN  CONST UINT8     *Key,
  IN  CONST UINT8     *Iv,
  IN  UINT32          Counter
  );
 
VOID
ChaChaCryptBuffer (
  IN OUT CHACHA_CONTEXT  *Context,
  IN     CONST UINT8     *Source,
  OUT UINT8              *Destination,
  IN     UINT32          Length
  );
 
VOID
Md5Init (
  MD5_CONTEXT  *Context
  );
 
VOID
Md5Update (
  MD5_CONTEXT  *Context,
  CONST UINT8  *Data,
  UINTN        Len
  );
 
VOID
Md5Final (
  MD5_CONTEXT  *Context,
  UINT8        *Hash
  );
 
VOID
Md5 (
  UINT8  *Hash,
  UINT8  *Data,
  UINTN  Len
  );
 
VOID
Sha1Init (
  SHA1_CONTEXT  *Context
  );
 
VOID
Sha1Update (
  SHA1_CONTEXT  *Context,
  CONST UINT8   *Data,
  UINTN         Len
  );
 
VOID
Sha1Final (
  SHA1_CONTEXT  *Context,
  UINT8         *Hash
  );
 
VOID
Sha1 (
  UINT8  *Hash,
  UINT8  *Data,
  UINTN  Len
  );
 
VOID
Sha256Init (
  SHA256_CONTEXT  *Context
  );
 
VOID
Sha256Update (
  SHA256_CONTEXT  *Context,
  CONST UINT8     *Data,
  UINTN           Len
  );
 
VOID
Sha256Final (
  SHA256_CONTEXT  *Context,
  UINT8           *HashDigest
  );
 
VOID
Sha256 (
  UINT8        *Hash,
  CONST UINT8  *Data,
  UINTN        Len
  );
 
VOID
Sha512Init (
  SHA512_CONTEXT  *Context
  );
 
VOID
Sha512Update (
  SHA512_CONTEXT  *Context,
  CONST UINT8     *Data,
  UINTN           Len
  );
 
VOID
Sha512Final (
  SHA512_CONTEXT  *Context,
  UINT8           *HashDigest
  );
 
VOID
Sha512 (
  UINT8        *Hash,
  CONST UINT8  *Data,
  UINTN        Len
  );
 
VOID
Sha384Init (
  SHA384_CONTEXT  *Context
  );
 
VOID
Sha384Update (
  SHA384_CONTEXT  *Context,
  CONST UINT8     *Data,
  UINTN           Len
  );
 
VOID
Sha384Final (
  SHA384_CONTEXT  *Context,
  UINT8           *HashDigest
  );
 
VOID
Sha384 (
  UINT8        *Hash,
  CONST UINT8  *Data,
  UINTN        Len
  );
 
BOOLEAN
EFIAPI
TryEnableAccel (
  VOID
  );
 
INTN
SigVerifyShaHashBySize (
  IN CONST VOID   *Data,
  IN UINTN        DataSize,
  IN CONST UINT8  *Hash,
  IN UINTN        HashSize
  );
 
#define RSA_MOD_MAX_SIZE  BASE_16KB
 
#define RSA_SCRATCH_BUFFER_SIZE(ModulusSize) \
  ((ModulusSize) * 3U)
 
STATIC_ASSERT (
  RSA_MOD_MAX_SIZE <= MAX_UINTN / 3U,
  "The definition of RSA_SCRATCH_BUFFER_SIZE may cause an overflow"
  );
 
BOOLEAN
RsaVerifySigHashFromKey (
  IN CONST OC_RSA_PUBLIC_KEY  *Key,
  IN CONST UINT8              *Signature,
  IN UINTN                    SignatureSize,
  IN CONST UINT8              *Hash,
  IN UINTN                    HashSize,
  IN OC_SIG_HASH_TYPE         Algorithm,
  IN VOID                     *Scratch
  );
 
#ifndef OC_CRYPTO_NDYNALLOC
 
BOOLEAN
RsaVerifySigHashFromKeyDynalloc (
  IN CONST OC_RSA_PUBLIC_KEY  *Key,
  IN CONST UINT8              *Signature,
  IN UINTN                    SignatureSize,
  IN CONST UINT8              *Hash,
  IN UINTN                    HashSize,
  IN OC_SIG_HASH_TYPE         Algorithm
  );
 
#endif // OC_CRYPTO_NDYNALLOC
 
BOOLEAN
RsaVerifySigDataFromKey (
  IN CONST OC_RSA_PUBLIC_KEY  *Key,
  IN CONST UINT8              *Signature,
  IN UINTN                    SignatureSize,
  IN CONST UINT8              *Data,
  IN UINTN                    DataSize,
  IN OC_SIG_HASH_TYPE         Algorithm,
  IN VOID                     *Scratch
  );
 
#ifndef OC_CRYPTO_NDYNALLOC
 
BOOLEAN
RsaVerifySigDataFromKeyDynalloc (
  IN CONST OC_RSA_PUBLIC_KEY  *Key,
  IN CONST UINT8              *Signature,
  IN UINTN                    SignatureSize,
  IN CONST UINT8              *Data,
  IN UINTN                    DataSize,
  IN OC_SIG_HASH_TYPE         Algorithm
  );
 
#endif // OC_CRYPTO_NDYNALLOC
 
BOOLEAN
RsaVerifySigDataFromData (
  IN CONST UINT8       *Modulus,
  IN UINTN             ModulusSize,
  IN UINT32            Exponent,
  IN CONST UINT8       *Signature,
  IN UINTN             SignatureSize,
  IN CONST UINT8       *Data,
  IN UINTN             DataSize,
  IN OC_SIG_HASH_TYPE  Algorithm
  );
 
INTN
SecureCompareMem (
  IN CONST VOID  *DestinationBuffer,
  IN CONST VOID  *SourceBuffer,
  IN UINTN       Length
  );
 
VOID *
SecureZeroMem (
  OUT VOID   *Buffer,
  IN  UINTN  Length
  );
 
VOID
OcHashPasswordSha512 (
  IN  CONST UINT8  *Password,
  IN  UINT32       PasswordSize,
  IN  CONST UINT8  *Salt,
  IN  UINT32       SaltSize,
  OUT UINT8        *Hash
  );
 
BOOLEAN
OcVerifyPasswordSha512 (
  IN CONST UINT8  *Password,
  IN UINT32       PasswordSize,
  IN CONST UINT8  *Salt,
  IN UINT32       SaltSize,
  IN CONST UINT8  *RefHash
  );
 
#endif // OC_CRYPTO_LIB_H