diff --git a/lib/libsecureboot/Makefile.libsa.inc b/lib/libsecureboot/Makefile.libsa.inc index 7397d0fc1144..b1b5d7dd1e30 100644 --- a/lib/libsecureboot/Makefile.libsa.inc +++ b/lib/libsecureboot/Makefile.libsa.inc @@ -1,59 +1,59 @@ BRSSL_CFLAGS+= -DNO_STDIO .include "Makefile.inc" # for "measured boot" # loader puts the equivalent of TPM's PCR register into kenv # this is not as good but *way* simpler than talking to TPM CFLAGS+= -DVE_PCR_SUPPORT # sources that only apply to libsa SRCS+= \ vectx.c \ veopen.c \ vepcr.c \ verify_file.c \ # Build library with support for the UEFI based authentication .if ${MK_LOADER_EFI_SECUREBOOT} == "yes" SRCS+= \ efi/efi_variables.c \ efi/efi_init.c # Add includes required by efi part CFLAGS+= \ + -I${SRCTOP}/sys/contrib/edk2/Include \ -I${SRCTOP}/stand/efi/include \ - -I${SRCTOP}/lib/libsecureboot/efi/include \ -I${SRCTOP}/stand/efi/include/${MACHINE} .endif .if ${MK_LOADER_VERIEXEC_PASS_MANIFEST} == "yes" SRCS+= \ pass_manifest.c .endif # this is the list of paths (relative to a file # that we need to verify) used to find a signed manifest. # the signature extensions in VE_SIGNATURE_EXT_LIST # will be applied to each. VE_MANIFEST_LIST?= manifest ../manifest verify_file.o: manifests.h manifests.h: @( echo '/* Autogenerated - DO NOT EDIT!!! */'; echo; \ echo "static const char *manifest_names[] = {"; \ echo '${VE_MANIFEST_LIST:@m@"$m",${.newline}@}'; \ echo 'NULL };' ) > ${.TARGET} # only add these if set XCFLAGS.verify_file+= \ ${VE_DEBUG_LEVEL \ VE_VERBOSE_DEFAULT \ VE_VERIFY_FLAGS \ :L:@v@${$v:S,^,-D$v=,}@} .if !empty(MANIFEST_SKIP_ALWAYS) XCFLAGS.verify_file+= -DMANIFEST_SKIP_ALWAYS=\"${MANIFEST_SKIP_ALWAYS}\" .elif !empty(MANIFEST_SKIP) XCFLAGS.verify_file+= -DMANIFEST_SKIP=\"${MANIFEST_SKIP}\" .endif diff --git a/lib/libsecureboot/efi/efi_variables.c b/lib/libsecureboot/efi/efi_variables.c index 3c36bc66f788..4b2b6b5c91ca 100644 --- a/lib/libsecureboot/efi/efi_variables.c +++ b/lib/libsecureboot/efi/efi_variables.c @@ -1,274 +1,275 @@ /*- * Copyright (c) 2019 Stormshield. * Copyright (c) 2019 Semihalf. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ #include #include #include #include #include +#include #include #define NEED_BRSSL_H #include "../libsecureboot-priv.h" #include static EFI_GUID ImageSecurityDatabaseGUID = EFI_IMAGE_SECURITY_DATABASE_GUID; static EFI_GUID efiCertX509GUID = EFI_CERT_X509_GUID; static EFI_GUID efiCertX509Sha256GUID = EFI_CERT_X509_SHA256_GUID; static EFI_GUID efiCertX509Sha384GUID = EFI_CERT_X509_SHA384_GUID; static EFI_GUID efiCertX509Sha5122UID = EFI_CERT_X509_SHA512_GUID; /* * Check if Secure Boot is enabled in firmware. * We evaluate two variables - Secure Boot and Setup Mode. * Secure Boot is enforced only if the first one equals 1 and the other 0. */ int efi_secure_boot_enabled(void) { UINT8 SecureBoot; UINT8 SetupMode; size_t length; EFI_STATUS status; length = sizeof(SecureBoot); status = efi_global_getenv("SecureBoot", &SecureBoot, &length); if (status != EFI_SUCCESS) { if (status == EFI_NOT_FOUND) return (0); printf("Failed to read \"SecureBoot\" variable\n"); return (-efi_status_to_errno(status)); } length = sizeof(SetupMode); status = efi_global_getenv("SetupMode", &SetupMode, &length); if (status != EFI_SUCCESS) SetupMode = 0; printf(" SecureBoot: %d, SetupMode: %d\n", SecureBoot, SetupMode); return (SecureBoot == 1 && SetupMode == 0); } /* * Iterate through UEFI variable and extract X509 certificates from it. * The EFI_* structures and related guids are defined in UEFI standard. */ static br_x509_certificate* efi_get_certs(const char *name, size_t *count) { br_x509_certificate *certs; UINT8 *database; EFI_SIGNATURE_LIST *list; EFI_SIGNATURE_DATA *entry; size_t db_size; ssize_t cert_count; EFI_STATUS status; database = NULL; certs = NULL; db_size = 0; cert_count = 0; /* * Read variable length and allocate memory for it */ status = efi_getenv(&ImageSecurityDatabaseGUID, name, database, &db_size); if (status != EFI_BUFFER_TOO_SMALL) return (NULL); database = malloc(db_size); if (database == NULL) return (NULL); status = efi_getenv(&ImageSecurityDatabaseGUID, name, database, &db_size); if (status != EFI_SUCCESS) goto fail; for (list = (EFI_SIGNATURE_LIST*) database; db_size >= list->SignatureListSize && db_size > 0; db_size -= list->SignatureListSize, list = (EFI_SIGNATURE_LIST*) ((UINT8*)list + list->SignatureListSize)) { /* We are only interested in entries containing X509 certs. */ if (memcmp(&efiCertX509GUID, &list->SignatureType, sizeof(EFI_GUID)) != 0) { continue; } entry = (EFI_SIGNATURE_DATA*) ((UINT8*)list + sizeof(EFI_SIGNATURE_LIST) + list->SignatureHeaderSize); certs = realloc(certs, (cert_count + 1) * sizeof(br_x509_certificate)); if (certs == NULL) { cert_count = 0; goto fail; } certs[cert_count].data_len = list->SignatureSize - sizeof(EFI_GUID); certs[cert_count].data = malloc(certs[cert_count].data_len); if (certs[cert_count].data == NULL) goto fail; memcpy(certs[cert_count].data, entry->SignatureData, certs[cert_count].data_len); cert_count++; } *count = cert_count; xfree(database); return (certs); fail: free_certificates(certs, cert_count); xfree(database); return (NULL); } /* * Extract digests from UEFI "dbx" variable. * UEFI standard specifies three types of digest - sha256, sha386, sha512. */ hash_data* efi_get_forbidden_digests(size_t *count) { UINT8 *database; hash_data *digests; EFI_SIGNATURE_LIST *list; EFI_SIGNATURE_DATA *entry; size_t db_size, header_size, hash_size; int digest_count, entry_count; EFI_STATUS status; db_size = 0; digest_count = 0; database = NULL; digests = NULL; status = efi_getenv(&ImageSecurityDatabaseGUID, "dbx", database, &db_size); if (status != EFI_BUFFER_TOO_SMALL) return (NULL); database = malloc(db_size); if (database == NULL) return (NULL); status = efi_getenv(&ImageSecurityDatabaseGUID, "dbx", database, &db_size); if (status != EFI_SUCCESS) goto fail; for (list = (EFI_SIGNATURE_LIST*) database; db_size >= list->SignatureListSize && db_size > 0; db_size -= list->SignatureListSize, list = (EFI_SIGNATURE_LIST*) ((UINT8*)list + list->SignatureListSize)) { /* We are only interested in entries that contain digests. */ if (memcmp(&efiCertX509Sha256GUID, &list->SignatureType, sizeof(EFI_GUID)) == 0) { hash_size = br_sha256_SIZE; } else if (memcmp(&efiCertX509Sha384GUID, &list->SignatureType, sizeof(EFI_GUID)) == 0) { hash_size = br_sha384_SIZE; } else if (memcmp(&efiCertX509Sha5122UID, &list->SignatureType, sizeof(EFI_GUID)) == 0) { hash_size = br_sha512_SIZE; } else { continue; } /* * A single entry can have multiple digests * of the same type for some reason. */ header_size = sizeof(EFI_SIGNATURE_LIST) + list->SignatureHeaderSize; /* Calculate the number of entries basing on structure size */ entry_count = list->SignatureListSize - header_size; entry_count /= list->SignatureSize; entry = (EFI_SIGNATURE_DATA*)((UINT8*)list + header_size); while (entry_count-- > 0) { digests = realloc(digests, (digest_count + 1) * sizeof(hash_data)); if (digests == NULL) { digest_count = 0; goto fail; } digests[digest_count].data = malloc(hash_size); if (digests[digest_count].data == NULL) goto fail; memcpy(digests[digest_count].data, entry->SignatureData, hash_size); digests[digest_count].hash_size = hash_size; entry = (EFI_SIGNATURE_DATA*)(entry + list->SignatureSize); digest_count++; } } xfree(database); if (count != NULL) *count = digest_count; return (digests); fail: while (digest_count--) xfree(digests[digest_count].data); xfree(database); xfree(digests); return (NULL); } /* Copy x509 certificates from db */ br_x509_certificate* efi_get_trusted_certs(size_t *count) { return (efi_get_certs("db", count)); } /* Copy forbidden certificates from dbx */ br_x509_certificate* efi_get_forbidden_certs(size_t *count) { return (efi_get_certs("dbx", count)); } diff --git a/lib/libsecureboot/efi/include/Guid/GlobalVariable.h b/lib/libsecureboot/efi/include/Guid/GlobalVariable.h deleted file mode 100644 index 3bd0a815fcf6..000000000000 --- a/lib/libsecureboot/efi/include/Guid/GlobalVariable.h +++ /dev/null @@ -1,192 +0,0 @@ -/** @file - GUID for EFI (NVRAM) Variables. - Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
- This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - @par Revision Reference: - GUID defined in UEFI 2.1 -**/ - -#ifndef __GLOBAL_VARIABLE_GUID_H__ -#define __GLOBAL_VARIABLE_GUID_H__ - -#include -#ifndef EFI_GLOBAL_VARIABLE -#define EFI_GLOBAL_VARIABLE \ - { \ - 0x8BE4DF61, 0x93CA, 0x11d2, {0xAA, 0x0D, 0x00, 0xE0, 0x98, 0x03, 0x2B, 0x8C } \ - } -#endif /* EFI_GLOBAL_VARIABLE */ - -extern EFI_GUID gEfiGlobalVariableGuid; - -// -// Follow UEFI 2.4 spec: -// To prevent name collisions with possible future globally defined variables, -// other internal firmware data variables that are not defined here must be -// saved with a unique VendorGuid other than EFI_GLOBAL_VARIABLE or -// any other GUID defined by the UEFI Specification. Implementations must -// only permit the creation of variables with a UEFI Specification-defined -// VendorGuid when these variables are documented in the UEFI Specification. -// -// Note: except the globally defined variables defined below, the spec also defines -// L"Boot####" - A boot load option. -// L"Driver####" - A driver load option. -// L"SysPrep####" - A System Prep application load option. -// L"Key####" - Describes hot key relationship with a Boot#### load option. -// The attribute for them is NV+BS+RT, #### is a printed hex value, and no 0x or h -// is included in the hex value. They can not be expressed as a #define like other globally -// defined variables, it is because we can not list the Boot0000, Boot0001, etc one by one. -// - -/// -/// The language codes that the firmware supports. This value is deprecated. -/// Its attribute is BS+RT. -/// -#define EFI_LANG_CODES_VARIABLE_NAME L"LangCodes" -/// -/// The language code that the system is configured for. This value is deprecated. -/// Its attribute is NV+BS+RT. -/// -#define EFI_LANG_VARIABLE_NAME L"Lang" -/// -/// The firmware's boot managers timeout, in seconds, before initiating the default boot selection. -/// Its attribute is NV+BS+RT. -/// -#define EFI_TIME_OUT_VARIABLE_NAME L"Timeout" -/// -/// The language codes that the firmware supports. -/// Its attribute is BS+RT. -/// -#define EFI_PLATFORM_LANG_CODES_VARIABLE_NAME L"PlatformLangCodes" -/// -/// The language code that the system is configured for. -/// Its attribute is NV+BS+RT. -/// -#define EFI_PLATFORM_LANG_VARIABLE_NAME L"PlatformLang" -/// -/// The device path of the default input/output/error output console. -/// Its attribute is NV+BS+RT. -/// -#define EFI_CON_IN_VARIABLE_NAME L"ConIn" -#define EFI_CON_OUT_VARIABLE_NAME L"ConOut" -#define EFI_ERR_OUT_VARIABLE_NAME L"ErrOut" -/// -/// The device path of all possible input/output/error output devices. -/// Its attribute is BS+RT. -/// -#define EFI_CON_IN_DEV_VARIABLE_NAME L"ConInDev" -#define EFI_CON_OUT_DEV_VARIABLE_NAME L"ConOutDev" -#define EFI_ERR_OUT_DEV_VARIABLE_NAME L"ErrOutDev" -/// -/// The ordered boot option load list. -/// Its attribute is NV+BS+RT. -/// -#define EFI_BOOT_ORDER_VARIABLE_NAME L"BootOrder" -/// -/// The boot option for the next boot only. -/// Its attribute is NV+BS+RT. -/// -#define EFI_BOOT_NEXT_VARIABLE_NAME L"BootNext" -/// -/// The boot option that was selected for the current boot. -/// Its attribute is BS+RT. -/// -#define EFI_BOOT_CURRENT_VARIABLE_NAME L"BootCurrent" -/// -/// The types of boot options supported by the boot manager. Should be treated as read-only. -/// Its attribute is BS+RT. -/// -#define EFI_BOOT_OPTION_SUPPORT_VARIABLE_NAME L"BootOptionSupport" -/// -/// The ordered driver load option list. -/// Its attribute is NV+BS+RT. -/// -#define EFI_DRIVER_ORDER_VARIABLE_NAME L"DriverOrder" -/// -/// The ordered System Prep Application load option list. -/// Its attribute is NV+BS+RT. -/// -#define EFI_SYS_PREP_ORDER_VARIABLE_NAME L"SysPrepOrder" -/// -/// Identifies the level of hardware error record persistence -/// support implemented by the platform. This variable is -/// only modified by firmware and is read-only to the OS. -/// Its attribute is NV+BS+RT. -/// -#define EFI_HW_ERR_REC_SUPPORT_VARIABLE_NAME L"HwErrRecSupport" -/// -/// Whether the system is operating in setup mode (1) or not (0). -/// All other values are reserved. Should be treated as read-only. -/// Its attribute is BS+RT. -/// -#define EFI_SETUP_MODE_NAME L"SetupMode" -/// -/// The Key Exchange Key Signature Database. -/// Its attribute is NV+BS+RT+AT. -/// -#define EFI_KEY_EXCHANGE_KEY_NAME L"KEK" -/// -/// The public Platform Key. -/// Its attribute is NV+BS+RT+AT. -/// -#define EFI_PLATFORM_KEY_NAME L"PK" -/// -/// Array of GUIDs representing the type of signatures supported -/// by the platform firmware. Should be treated as read-only. -/// Its attribute is BS+RT. -/// -#define EFI_SIGNATURE_SUPPORT_NAME L"SignatureSupport" -/// -/// Whether the platform firmware is operating in Secure boot mode (1) or not (0). -/// All other values are reserved. Should be treated as read-only. -/// Its attribute is BS+RT. -/// -#define EFI_SECURE_BOOT_MODE_NAME L"SecureBoot" -/// -/// The OEM's default Key Exchange Key Signature Database. Should be treated as read-only. -/// Its attribute is BS+RT. -/// -#define EFI_KEK_DEFAULT_VARIABLE_NAME L"KEKDefault" -/// -/// The OEM's default public Platform Key. Should be treated as read-only. -/// Its attribute is BS+RT. -/// -#define EFI_PK_DEFAULT_VARIABLE_NAME L"PKDefault" -/// -/// The OEM's default secure boot signature store. Should be treated as read-only. -/// Its attribute is BS+RT. -/// -#define EFI_DB_DEFAULT_VARIABLE_NAME L"dbDefault" -/// -/// The OEM's default secure boot blacklist signature store. Should be treated as read-only. -/// Its attribute is BS+RT. -/// -#define EFI_DBX_DEFAULT_VARIABLE_NAME L"dbxDefault" -/// -/// The OEM's default secure boot timestamp signature store. Should be treated as read-only. -/// Its attribute is BS+RT. -/// -#define EFI_DBT_DEFAULT_VARIABLE_NAME L"dbtDefault" -/// -/// Allows the firmware to indicate supported features and actions to the OS. -/// Its attribute is BS+RT. -/// -#define EFI_OS_INDICATIONS_SUPPORT_VARIABLE_NAME L"OsIndicationsSupported" -/// -/// Allows the OS to request the firmware to enable certain features and to take certain actions. -/// Its attribute is NV+BS+RT. -/// -#define EFI_OS_INDICATIONS_VARIABLE_NAME L"OsIndications" -/// -/// Whether the system is configured to use only vendor provided -/// keys or not. Should be treated as read-only. -/// Its attribute is BS+RT. -/// -#define EFI_VENDOR_KEYS_VARIABLE_NAME L"VendorKeys" - -#endif diff --git a/lib/libsecureboot/h/libsecureboot.h b/lib/libsecureboot/h/libsecureboot.h index d32df9594332..fa8360338cfc 100644 --- a/lib/libsecureboot/h/libsecureboot.h +++ b/lib/libsecureboot/h/libsecureboot.h @@ -1,98 +1,100 @@ /*- * Copyright (c) 2017-2018, Juniper Networks, Inc. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ /* */ #ifndef _LIBSECUREBOOT_H_ #define _LIBSECUREBOOT_H_ +#undef MIN /* Conflicts with EDK2 */ +#undef MAX #include #ifdef _STANDALONE #define _DEBUG_LEVEL_VAR DebugVe #include #else #include #include #include #include #include #include #endif #include unsigned char * read_fd(int, size_t); #ifndef NEED_BRSSL_H unsigned char * read_file(const char *, size_t *); #endif extern int DebugVe; extern int VerifyFlags; #ifndef DEBUG_PRINTF #define DEBUG_PRINTF(n, x) if (DebugVe >= n) printf x #endif int ve_trust_init(void); size_t ve_trust_anchors_add_buf(unsigned char *, size_t); size_t ve_trust_anchors_revoke(unsigned char *, size_t); int ve_trust_add(const char *); void ve_debug_set(int); void ve_enforce_validity_set(int); void ve_anchor_verbose_set(int); int ve_anchor_verbose_get(void); void ve_utc_set(time_t utc); char *ve_error_get(void); int ve_error_set(const char *, ...) __printflike(1,2); int ve_self_tests(void); void fingerprint_info_add(const char *, const char *, const char *, const char *, struct stat *); char * hexdigest(char *, size_t, unsigned char *, size_t); int verify_fd(int, const char *, off_t, struct stat *); int verify_open(const char *, int); unsigned char *verify_signed(const char *, int); unsigned char *verify_sig(const char *, int); unsigned char *verify_asc(const char *, int); /* OpenPGP */ void ve_pcr_init(void); void ve_pcr_update(const char *, unsigned char *, size_t); ssize_t ve_pcr_get(unsigned char *, size_t); int ve_pcr_updating_get(void); void ve_pcr_updating_set(int); char * ve_pcr_hashed_get(int); /* flags for verify_{asc,sig,signed} */ #define VEF_VERBOSE 1 #define VE_FINGERPRINT_OK 1 #define VE_FINGERPRINT_IGNORE 2 /* errors from verify_fd */ #define VE_FINGERPRINT_NONE -2 #define VE_FINGERPRINT_WRONG -3 #define VE_FINGERPRINT_UNKNOWN -4 /* may not be an error */ #endif /* _LIBSECUREBOOT_H_ */ diff --git a/lib/libsecureboot/efi/include/Guid/ImageAuthentication.h b/sys/contrib/edk2/Include/Guid/ImageAuthentication.h similarity index 75% rename from lib/libsecureboot/efi/include/Guid/ImageAuthentication.h rename to sys/contrib/edk2/Include/Guid/ImageAuthentication.h index b1fc1f54cce1..9cf77466da09 100644 --- a/lib/libsecureboot/efi/include/Guid/ImageAuthentication.h +++ b/sys/contrib/edk2/Include/Guid/ImageAuthentication.h @@ -1,350 +1,385 @@ -/** @file - Image signature database are defined for the signed image validation. - Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.
- This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - @par Revision Reference: - GUIDs defined in UEFI 2.5 spec. -**/ - -#ifndef __IMAGE_AUTHTICATION_H__ -#define __IMAGE_AUTHTICATION_H__ - -#include -#include -#include - -#define EFI_IMAGE_SECURITY_DATABASE_GUID \ - { \ - 0xd719b2cb, 0x3d3a, 0x4596, { 0xa3, 0xbc, 0xda, 0xd0, 0xe, 0x67, 0x65, 0x6f } \ - } - -/// -/// Varialbe name with guid EFI_IMAGE_SECURITY_DATABASE_GUID -/// for the authorized signature database. -/// -#define EFI_IMAGE_SECURITY_DATABASE L"db" -/// -/// Varialbe name with guid EFI_IMAGE_SECURITY_DATABASE_GUID -/// for the forbidden signature database. -/// -#define EFI_IMAGE_SECURITY_DATABASE1 L"dbx" -/// -/// Variable name with guid EFI_IMAGE_SECURITY_DATABASE_GUID -/// for the timestamp signature database. -/// -#define EFI_IMAGE_SECURITY_DATABASE2 L"dbt" - -#define SECURE_BOOT_MODE_ENABLE 1 -#define SECURE_BOOT_MODE_DISABLE 0 - -#define SETUP_MODE 1 -#define USER_MODE 0 - -//*********************************************************************** -// Signature Database -//*********************************************************************** -/// -/// The format of a signature database. -/// -#pragma pack(1) - -typedef struct { - /// - /// An identifier which identifies the agent which added the signature to the list. - /// - EFI_GUID SignatureOwner; - /// - /// The format of the signature is defined by the SignatureType. - /// - UINT8 SignatureData[1]; -} EFI_SIGNATURE_DATA; - -typedef struct { - /// - /// Type of the signature. GUID signature types are defined in below. - /// - EFI_GUID SignatureType; - /// - /// Total size of the signature list, including this header. - /// - UINT32 SignatureListSize; - /// - /// Size of the signature header which precedes the array of signatures. - /// - UINT32 SignatureHeaderSize; - /// - /// Size of each signature. - /// - UINT32 SignatureSize; - /// - /// Header before the array of signatures. The format of this header is specified - /// by the SignatureType. - /// UINT8 SignatureHeader[SignatureHeaderSize]; - /// - /// An array of signatures. Each signature is SignatureSize bytes in length. - /// EFI_SIGNATURE_DATA Signatures[][SignatureSize]; - /// -} EFI_SIGNATURE_LIST; - -typedef struct { - /// - /// The SHA256 hash of an X.509 certificate's To-Be-Signed contents. - /// - EFI_SHA256_HASH ToBeSignedHash; - /// - /// The time that the certificate shall be considered to be revoked. - /// - EFI_TIME TimeOfRevocation; -} EFI_CERT_X509_SHA256; - -typedef struct { - /// - /// The SHA384 hash of an X.509 certificate's To-Be-Signed contents. - /// - EFI_SHA384_HASH ToBeSignedHash; - /// - /// The time that the certificate shall be considered to be revoked. - /// - EFI_TIME TimeOfRevocation; -} EFI_CERT_X509_SHA384; - -typedef struct { - /// - /// The SHA512 hash of an X.509 certificate's To-Be-Signed contents. - /// - EFI_SHA512_HASH ToBeSignedHash; - /// - /// The time that the certificate shall be considered to be revoked. - /// - EFI_TIME TimeOfRevocation; -} EFI_CERT_X509_SHA512; - -#pragma pack() - -/// -/// This identifies a signature containing a SHA-256 hash. The SignatureHeader size shall -/// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) + -/// 32 bytes. -/// -#define EFI_CERT_SHA256_GUID \ - { \ - 0xc1c41626, 0x504c, 0x4092, {0xac, 0xa9, 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28} \ - } - -/// -/// This identifies a signature containing an RSA-2048 key. The key (only the modulus -/// since the public key exponent is known to be 0x10001) shall be stored in big-endian -/// order. -/// The SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size -/// of SignatureOwner component) + 256 bytes. -/// -#define EFI_CERT_RSA2048_GUID \ - { \ - 0x3c5766e8, 0x269c, 0x4e34, {0xaa, 0x14, 0xed, 0x77, 0x6e, 0x85, 0xb3, 0xb6} \ - } - -/// -/// This identifies a signature containing a RSA-2048 signature of a SHA-256 hash. The -/// SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size of -/// SignatureOwner component) + 256 bytes. -/// -#define EFI_CERT_RSA2048_SHA256_GUID \ - { \ - 0xe2b36190, 0x879b, 0x4a3d, {0xad, 0x8d, 0xf2, 0xe7, 0xbb, 0xa3, 0x27, 0x84} \ - } - -/// -/// This identifies a signature containing a SHA-1 hash. The SignatureSize shall always -/// be 16 (size of SignatureOwner component) + 20 bytes. -/// -#define EFI_CERT_SHA1_GUID \ - { \ - 0x826ca512, 0xcf10, 0x4ac9, {0xb1, 0x87, 0xbe, 0x1, 0x49, 0x66, 0x31, 0xbd} \ - } - -/// -/// TThis identifies a signature containing a RSA-2048 signature of a SHA-1 hash. The -/// SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size of -/// SignatureOwner component) + 256 bytes. -/// -#define EFI_CERT_RSA2048_SHA1_GUID \ - { \ - 0x67f8444f, 0x8743, 0x48f1, {0xa3, 0x28, 0x1e, 0xaa, 0xb8, 0x73, 0x60, 0x80} \ - } - -/// -/// This identifies a signature based on an X.509 certificate. If the signature is an X.509 -/// certificate then verification of the signature of an image should validate the public -/// key certificate in the image using certificate path verification, up to this X.509 -/// certificate as a trusted root. The SignatureHeader size shall always be 0. The -/// SignatureSize may vary but shall always be 16 (size of the SignatureOwner component) + -/// the size of the certificate itself. -/// Note: This means that each certificate will normally be in a separate EFI_SIGNATURE_LIST. -/// -#define EFI_CERT_X509_GUID \ - { \ - 0xa5c059a1, 0x94e4, 0x4aa7, {0x87, 0xb5, 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72} \ - } - -/// -/// This identifies a signature containing a SHA-224 hash. The SignatureHeader size shall -/// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) + -/// 28 bytes. -/// -#define EFI_CERT_SHA224_GUID \ - { \ - 0xb6e5233, 0xa65c, 0x44c9, {0x94, 0x7, 0xd9, 0xab, 0x83, 0xbf, 0xc8, 0xbd} \ - } - -/// -/// This identifies a signature containing a SHA-384 hash. The SignatureHeader size shall -/// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) + -/// 48 bytes. -/// -#define EFI_CERT_SHA384_GUID \ - { \ - 0xff3e5307, 0x9fd0, 0x48c9, {0x85, 0xf1, 0x8a, 0xd5, 0x6c, 0x70, 0x1e, 0x1} \ - } - -/// -/// This identifies a signature containing a SHA-512 hash. The SignatureHeader size shall -/// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) + -/// 64 bytes. -/// -#define EFI_CERT_SHA512_GUID \ - { \ - 0x93e0fae, 0xa6c4, 0x4f50, {0x9f, 0x1b, 0xd4, 0x1e, 0x2b, 0x89, 0xc1, 0x9a} \ - } - -/// -/// This identifies a signature containing the SHA256 hash of an X.509 certificate's -/// To-Be-Signed contents, and a time of revocation. The SignatureHeader size shall -/// always be 0. The SignatureSize shall always be 16 (size of the SignatureOwner component) -/// + 48 bytes for an EFI_CERT_X509_SHA256 structure. If the TimeOfRevocation is non-zero, -/// the certificate should be considered to be revoked from that time and onwards, and -/// otherwise the certificate shall be considered to always be revoked. -/// -#define EFI_CERT_X509_SHA256_GUID \ - { \ - 0x3bd2a492, 0x96c0, 0x4079, {0xb4, 0x20, 0xfc, 0xf9, 0x8e, 0xf1, 0x03, 0xed } \ - } - -/// -/// This identifies a signature containing the SHA384 hash of an X.509 certificate's -/// To-Be-Signed contents, and a time of revocation. The SignatureHeader size shall -/// always be 0. The SignatureSize shall always be 16 (size of the SignatureOwner component) -/// + 64 bytes for an EFI_CERT_X509_SHA384 structure. If the TimeOfRevocation is non-zero, -/// the certificate should be considered to be revoked from that time and onwards, and -/// otherwise the certificate shall be considered to always be revoked. -/// -#define EFI_CERT_X509_SHA384_GUID \ - { \ - 0x7076876e, 0x80c2, 0x4ee6, {0xaa, 0xd2, 0x28, 0xb3, 0x49, 0xa6, 0x86, 0x5b } \ - } - -/// -/// This identifies a signature containing the SHA512 hash of an X.509 certificate's -/// To-Be-Signed contents, and a time of revocation. The SignatureHeader size shall -/// always be 0. The SignatureSize shall always be 16 (size of the SignatureOwner component) -/// + 80 bytes for an EFI_CERT_X509_SHA512 structure. If the TimeOfRevocation is non-zero, -/// the certificate should be considered to be revoked from that time and onwards, and -/// otherwise the certificate shall be considered to always be revoked. -/// -#define EFI_CERT_X509_SHA512_GUID \ - { \ - 0x446dbf63, 0x2502, 0x4cda, {0xbc, 0xfa, 0x24, 0x65, 0xd2, 0xb0, 0xfe, 0x9d } \ - } - -/// -/// This identifies a signature containing a DER-encoded PKCS #7 version 1.5 [RFC2315] -/// SignedData value. -/// -#define EFI_CERT_TYPE_PKCS7_GUID \ - { \ - 0x4aafd29d, 0x68df, 0x49ee, {0x8a, 0xa9, 0x34, 0x7d, 0x37, 0x56, 0x65, 0xa7} \ - } - -//*********************************************************************** -// Image Execution Information Table Definition -//*********************************************************************** -typedef UINT32 EFI_IMAGE_EXECUTION_ACTION; - -#define EFI_IMAGE_EXECUTION_AUTHENTICATION 0x00000007 -#define EFI_IMAGE_EXECUTION_AUTH_UNTESTED 0x00000000 -#define EFI_IMAGE_EXECUTION_AUTH_SIG_FAILED 0x00000001 -#define EFI_IMAGE_EXECUTION_AUTH_SIG_PASSED 0x00000002 -#define EFI_IMAGE_EXECUTION_AUTH_SIG_NOT_FOUND 0x00000003 -#define EFI_IMAGE_EXECUTION_AUTH_SIG_FOUND 0x00000004 -#define EFI_IMAGE_EXECUTION_POLICY_FAILED 0x00000005 -#define EFI_IMAGE_EXECUTION_INITIALIZED 0x00000008 - -// -// EFI_IMAGE_EXECUTION_INFO is added to EFI System Configuration Table -// and assigned the GUID EFI_IMAGE_SECURITY_DATABASE_GUID. -// -typedef struct { - /// - /// Describes the action taken by the firmware regarding this image. - /// - EFI_IMAGE_EXECUTION_ACTION Action; - /// - /// Size of all of the entire structure. - /// - UINT32 InfoSize; - /// - /// If this image was a UEFI device driver (for option ROM, for example) this is the - /// null-terminated, user-friendly name for the device. If the image was for an application, - /// then this is the name of the application. If this cannot be determined, then a simple - /// NULL character should be put in this position. - /// CHAR16 Name[]; - /// - - /// - /// For device drivers, this is the device path of the device for which this device driver - /// was intended. In some cases, the driver itself may be stored as part of the system - /// firmware, but this field should record the device's path, not the firmware path. For - /// applications, this is the device path of the application. If this cannot be determined, - /// a simple end-of-path device node should be put in this position. - /// EFI_DEVICE_PATH_PROTOCOL DevicePath; - /// - - /// - /// Zero or more image signatures. If the image contained no signatures, - /// then this field is empty. - /// EFI_SIGNATURE_LIST Signature; - /// -} EFI_IMAGE_EXECUTION_INFO; - - -typedef struct { - /// - /// Number of EFI_IMAGE_EXECUTION_INFO structures. - /// - UINTN NumberOfImages; - /// - /// Number of image instances of EFI_IMAGE_EXECUTION_INFO structures. - /// - // EFI_IMAGE_EXECUTION_INFO InformationInfo[] -} EFI_IMAGE_EXECUTION_INFO_TABLE; - -extern EFI_GUID gEfiImageSecurityDatabaseGuid; -extern EFI_GUID gEfiCertSha256Guid; -extern EFI_GUID gEfiCertRsa2048Guid; -extern EFI_GUID gEfiCertRsa2048Sha256Guid; -extern EFI_GUID gEfiCertSha1Guid; -extern EFI_GUID gEfiCertRsa2048Sha1Guid; -extern EFI_GUID gEfiCertX509Guid; -extern EFI_GUID gEfiCertSha224Guid; -extern EFI_GUID gEfiCertSha384Guid; -extern EFI_GUID gEfiCertSha512Guid; -extern EFI_GUID gEfiCertX509Sha256Guid; -extern EFI_GUID gEfiCertX509Sha384Guid; -extern EFI_GUID gEfiCertX509Sha512Guid; -extern EFI_GUID gEfiCertPkcs7Guid; - -#endif +/** @file + Image signature database are defined for the signed image validation. + + Copyright (c) 2009 - 2024, Intel Corporation. All rights reserved.
+ SPDX-License-Identifier: BSD-2-Clause-Patent + + @par Revision Reference: + GUIDs defined in UEFI 2.5 spec. +**/ + +#ifndef __IMAGE_AUTHTICATION_H__ +#define __IMAGE_AUTHTICATION_H__ + +#include +#include + +#define EFI_IMAGE_SECURITY_DATABASE_GUID \ + { \ + 0xd719b2cb, 0x3d3a, 0x4596, { 0xa3, 0xbc, 0xda, 0xd0, 0xe, 0x67, 0x65, 0x6f } \ + } + +/// +/// Varialbe name with guid EFI_IMAGE_SECURITY_DATABASE_GUID +/// for the authorized signature database. +/// +#define EFI_IMAGE_SECURITY_DATABASE L"db" +/// +/// Varialbe name with guid EFI_IMAGE_SECURITY_DATABASE_GUID +/// for the forbidden signature database. +/// +#define EFI_IMAGE_SECURITY_DATABASE1 L"dbx" +/// +/// Variable name with guid EFI_IMAGE_SECURITY_DATABASE_GUID +/// for the timestamp signature database. +/// +#define EFI_IMAGE_SECURITY_DATABASE2 L"dbt" + +#define SECURE_BOOT_MODE_ENABLE 1 +#define SECURE_BOOT_MODE_DISABLE 0 + +#define SETUP_MODE 1 +#define USER_MODE 0 + +#define DEVICE_AUTH_BOOT_MODE_ENABLE 1 +#define DEVICE_AUTH_BOOT_MODE_DISABLE 0 + +// *********************************************************************** +// Signature Database +// *********************************************************************** +/// +/// The format of a signature database. +/// +#pragma pack(1) + +typedef struct { + /// + /// An identifier which identifies the agent which added the signature to the list. + /// + EFI_GUID SignatureOwner; + /// + /// The format of the signature is defined by the SignatureType. + /// + UINT8 SignatureData[1]; +} EFI_SIGNATURE_DATA; + +typedef struct { + /// + /// Type of the signature. GUID signature types are defined in below. + /// + EFI_GUID SignatureType; + /// + /// Total size of the signature list, including this header. + /// + UINT32 SignatureListSize; + /// + /// Size of the signature header which precedes the array of signatures. + /// + UINT32 SignatureHeaderSize; + /// + /// Size of each signature. + /// + UINT32 SignatureSize; + /// + /// Header before the array of signatures. The format of this header is specified + /// by the SignatureType. + /// UINT8 SignatureHeader[SignatureHeaderSize]; + /// + /// An array of signatures. Each signature is SignatureSize bytes in length. + /// EFI_SIGNATURE_DATA Signatures[][SignatureSize]; + /// +} EFI_SIGNATURE_LIST; + +typedef struct { + /// + /// The SHA256 hash of an X.509 certificate's To-Be-Signed contents. + /// + EFI_SHA256_HASH ToBeSignedHash; + /// + /// The time that the certificate shall be considered to be revoked. + /// + EFI_TIME TimeOfRevocation; +} EFI_CERT_X509_SHA256; + +typedef struct { + /// + /// The SHA384 hash of an X.509 certificate's To-Be-Signed contents. + /// + EFI_SHA384_HASH ToBeSignedHash; + /// + /// The time that the certificate shall be considered to be revoked. + /// + EFI_TIME TimeOfRevocation; +} EFI_CERT_X509_SHA384; + +typedef struct { + /// + /// The SHA512 hash of an X.509 certificate's To-Be-Signed contents. + /// + EFI_SHA512_HASH ToBeSignedHash; + /// + /// The time that the certificate shall be considered to be revoked. + /// + EFI_TIME TimeOfRevocation; +} EFI_CERT_X509_SHA512; + +typedef UINT8 EFI_SM3_HASH[32]; + +typedef struct { + /// + /// The SM3 hash of an X.509 certificate's To-Be-Signed contents. + /// + EFI_SM3_HASH ToBeSignedHash; + /// + /// The time that the certificate shall be considered to be revoked. + /// + EFI_TIME TimeOfRevocation; +} EFI_CERT_X509_SM3; + +#pragma pack() + +/// +/// This identifies a signature containing a SHA-256 hash. The SignatureHeader size shall +/// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) + +/// 32 bytes. +/// +#define EFI_CERT_SHA256_GUID \ + { \ + 0xc1c41626, 0x504c, 0x4092, {0xac, 0xa9, 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28} \ + } + +/// +/// This identifies a signature containing an RSA-2048 key. The key (only the modulus +/// since the public key exponent is known to be 0x10001) shall be stored in big-endian +/// order. +/// The SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size +/// of SignatureOwner component) + 256 bytes. +/// +#define EFI_CERT_RSA2048_GUID \ + { \ + 0x3c5766e8, 0x269c, 0x4e34, {0xaa, 0x14, 0xed, 0x77, 0x6e, 0x85, 0xb3, 0xb6} \ + } + +/// +/// This identifies a signature containing a RSA-2048 signature of a SHA-256 hash. The +/// SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size of +/// SignatureOwner component) + 256 bytes. +/// +#define EFI_CERT_RSA2048_SHA256_GUID \ + { \ + 0xe2b36190, 0x879b, 0x4a3d, {0xad, 0x8d, 0xf2, 0xe7, 0xbb, 0xa3, 0x27, 0x84} \ + } + +/// +/// This identifies a signature containing a SHA-1 hash. The SignatureSize shall always +/// be 16 (size of SignatureOwner component) + 20 bytes. +/// +#define EFI_CERT_SHA1_GUID \ + { \ + 0x826ca512, 0xcf10, 0x4ac9, {0xb1, 0x87, 0xbe, 0x1, 0x49, 0x66, 0x31, 0xbd} \ + } + +/// +/// This identifies a signature containing a SM3 hash. The SignatureSize shall always +/// be 16 (size of SignatureOwner component) + 32 bytes. +/// +#define EFI_CERT_SM3_GUID \ + { \ + 0x57347f87, 0x7a9b, 0x403a, { 0xb9, 0x3c, 0xdc, 0x4a, 0xfb, 0x7a, 0xe, 0xbc } \ + } + +/// +/// TThis identifies a signature containing a RSA-2048 signature of a SHA-1 hash. The +/// SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size of +/// SignatureOwner component) + 256 bytes. +/// +#define EFI_CERT_RSA2048_SHA1_GUID \ + { \ + 0x67f8444f, 0x8743, 0x48f1, {0xa3, 0x28, 0x1e, 0xaa, 0xb8, 0x73, 0x60, 0x80} \ + } + +/// +/// This identifies a signature based on an X.509 certificate. If the signature is an X.509 +/// certificate then verification of the signature of an image should validate the public +/// key certificate in the image using certificate path verification, up to this X.509 +/// certificate as a trusted root. The SignatureHeader size shall always be 0. The +/// SignatureSize may vary but shall always be 16 (size of the SignatureOwner component) + +/// the size of the certificate itself. +/// Note: This means that each certificate will normally be in a separate EFI_SIGNATURE_LIST. +/// +#define EFI_CERT_X509_GUID \ + { \ + 0xa5c059a1, 0x94e4, 0x4aa7, {0x87, 0xb5, 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72} \ + } + +/// +/// This identifies a signature containing the SM3 hash of an X.509 certificate's To-Be-Signed +/// contents, and a time of revocation. The SignatureHeader size shall always be 0. The +/// SignatureSize shall always be 16 (size of the SignatureOwner component) + 32 bytes for +/// an EFI_CERT_X509_SM3 structure. If the TimeOfRevocation is non-zero, the certificate should +/// be considered to be revoked from that time and onwards, and otherwise the certificate shall +/// be considered to always be revoked. +/// +#define EFI_CERT_X509_SM3_GUID \ + { \ + 0x60d807e5, 0x10b4, 0x49a9, {0x93, 0x31, 0xe4, 0x4, 0x37, 0x88, 0x8d, 0x37 } \ + } + +/// +/// This identifies a signature containing a SHA-224 hash. The SignatureHeader size shall +/// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) + +/// 28 bytes. +/// +#define EFI_CERT_SHA224_GUID \ + { \ + 0xb6e5233, 0xa65c, 0x44c9, {0x94, 0x7, 0xd9, 0xab, 0x83, 0xbf, 0xc8, 0xbd} \ + } + +/// +/// This identifies a signature containing a SHA-384 hash. The SignatureHeader size shall +/// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) + +/// 48 bytes. +/// +#define EFI_CERT_SHA384_GUID \ + { \ + 0xff3e5307, 0x9fd0, 0x48c9, {0x85, 0xf1, 0x8a, 0xd5, 0x6c, 0x70, 0x1e, 0x1} \ + } + +/// +/// This identifies a signature containing a SHA-512 hash. The SignatureHeader size shall +/// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) + +/// 64 bytes. +/// +#define EFI_CERT_SHA512_GUID \ + { \ + 0x93e0fae, 0xa6c4, 0x4f50, {0x9f, 0x1b, 0xd4, 0x1e, 0x2b, 0x89, 0xc1, 0x9a} \ + } + +/// +/// This identifies a signature containing the SHA256 hash of an X.509 certificate's +/// To-Be-Signed contents, and a time of revocation. The SignatureHeader size shall +/// always be 0. The SignatureSize shall always be 16 (size of the SignatureOwner component) +/// + 48 bytes for an EFI_CERT_X509_SHA256 structure. If the TimeOfRevocation is non-zero, +/// the certificate should be considered to be revoked from that time and onwards, and +/// otherwise the certificate shall be considered to always be revoked. +/// +#define EFI_CERT_X509_SHA256_GUID \ + { \ + 0x3bd2a492, 0x96c0, 0x4079, {0xb4, 0x20, 0xfc, 0xf9, 0x8e, 0xf1, 0x03, 0xed } \ + } + +/// +/// This identifies a signature containing the SHA384 hash of an X.509 certificate's +/// To-Be-Signed contents, and a time of revocation. The SignatureHeader size shall +/// always be 0. The SignatureSize shall always be 16 (size of the SignatureOwner component) +/// + 64 bytes for an EFI_CERT_X509_SHA384 structure. If the TimeOfRevocation is non-zero, +/// the certificate should be considered to be revoked from that time and onwards, and +/// otherwise the certificate shall be considered to always be revoked. +/// +#define EFI_CERT_X509_SHA384_GUID \ + { \ + 0x7076876e, 0x80c2, 0x4ee6, {0xaa, 0xd2, 0x28, 0xb3, 0x49, 0xa6, 0x86, 0x5b } \ + } + +/// +/// This identifies a signature containing the SHA512 hash of an X.509 certificate's +/// To-Be-Signed contents, and a time of revocation. The SignatureHeader size shall +/// always be 0. The SignatureSize shall always be 16 (size of the SignatureOwner component) +/// + 80 bytes for an EFI_CERT_X509_SHA512 structure. If the TimeOfRevocation is non-zero, +/// the certificate should be considered to be revoked from that time and onwards, and +/// otherwise the certificate shall be considered to always be revoked. +/// +#define EFI_CERT_X509_SHA512_GUID \ + { \ + 0x446dbf63, 0x2502, 0x4cda, {0xbc, 0xfa, 0x24, 0x65, 0xd2, 0xb0, 0xfe, 0x9d } \ + } + +/// +/// This identifies a signature containing a DER-encoded PKCS #7 version 1.5 [RFC2315] +/// SignedData value. +/// +#define EFI_CERT_TYPE_PKCS7_GUID \ + { \ + 0x4aafd29d, 0x68df, 0x49ee, {0x8a, 0xa9, 0x34, 0x7d, 0x37, 0x56, 0x65, 0xa7} \ + } + +// *********************************************************************** +// Image Execution Information Table Definition +// *********************************************************************** +typedef UINT32 EFI_IMAGE_EXECUTION_ACTION; + +#define EFI_IMAGE_EXECUTION_AUTHENTICATION 0x00000007 +#define EFI_IMAGE_EXECUTION_AUTH_UNTESTED 0x00000000 +#define EFI_IMAGE_EXECUTION_AUTH_SIG_FAILED 0x00000001 +#define EFI_IMAGE_EXECUTION_AUTH_SIG_PASSED 0x00000002 +#define EFI_IMAGE_EXECUTION_AUTH_SIG_NOT_FOUND 0x00000003 +#define EFI_IMAGE_EXECUTION_AUTH_SIG_FOUND 0x00000004 +#define EFI_IMAGE_EXECUTION_POLICY_FAILED 0x00000005 +#define EFI_IMAGE_EXECUTION_INITIALIZED 0x00000008 + +// +// EFI_IMAGE_EXECUTION_INFO is added to EFI System Configuration Table +// and assigned the GUID EFI_IMAGE_SECURITY_DATABASE_GUID. +// +typedef struct { + /// + /// Describes the action taken by the firmware regarding this image. + /// + EFI_IMAGE_EXECUTION_ACTION Action; + /// + /// Size of all of the entire structure. + /// + UINT32 InfoSize; + /// + /// If this image was a UEFI device driver (for option ROM, for example) this is the + /// null-terminated, user-friendly name for the device. If the image was for an application, + /// then this is the name of the application. If this cannot be determined, then a simple + /// NULL character should be put in this position. + /// CHAR16 Name[]; + /// + + /// + /// For device drivers, this is the device path of the device for which this device driver + /// was intended. In some cases, the driver itself may be stored as part of the system + /// firmware, but this field should record the device's path, not the firmware path. For + /// applications, this is the device path of the application. If this cannot be determined, + /// a simple end-of-path device node should be put in this position. + /// EFI_DEVICE_PATH_PROTOCOL DevicePath; + /// + + /// + /// Zero or more image signatures. If the image contained no signatures, + /// then this field is empty. + /// EFI_SIGNATURE_LIST Signature; + /// +} EFI_IMAGE_EXECUTION_INFO; + +typedef struct { + /// + /// Number of EFI_IMAGE_EXECUTION_INFO structures. + /// + UINTN NumberOfImages; + /// + /// Number of image instances of EFI_IMAGE_EXECUTION_INFO structures. + /// + // EFI_IMAGE_EXECUTION_INFO InformationInfo[] +} EFI_IMAGE_EXECUTION_INFO_TABLE; + +extern EFI_GUID gEfiImageSecurityDatabaseGuid; +extern EFI_GUID gEfiCertSha256Guid; +extern EFI_GUID gEfiCertRsa2048Guid; +extern EFI_GUID gEfiCertRsa2048Sha256Guid; +extern EFI_GUID gEfiCertSha1Guid; +extern EFI_GUID gEfiCertRsa2048Sha1Guid; +extern EFI_GUID gEfiCertX509Guid; +extern EFI_GUID gEfiCertSha224Guid; +extern EFI_GUID gEfiCertSha384Guid; +extern EFI_GUID gEfiCertSha512Guid; +extern EFI_GUID gEfiCertX509Sha256Guid; +extern EFI_GUID gEfiCertX509Sha384Guid; +extern EFI_GUID gEfiCertX509Sha512Guid; +extern EFI_GUID gEfiCertPkcs7Guid; +extern EFI_GUID gEfiCertSm3Guid; +extern EFI_GUID gEfiCertX509Sm3Guid; + +#endif diff --git a/lib/libsecureboot/efi/include/Protocol/Hash.h b/sys/contrib/edk2/Include/Protocol/Hash.h similarity index 78% rename from lib/libsecureboot/efi/include/Protocol/Hash.h rename to sys/contrib/edk2/Include/Protocol/Hash.h index 094bf20964cc..b76821fb4f0b 100644 --- a/lib/libsecureboot/efi/include/Protocol/Hash.h +++ b/sys/contrib/edk2/Include/Protocol/Hash.h @@ -1,169 +1,169 @@ -/** @file - EFI_HASH_SERVICE_BINDING_PROTOCOL as defined in UEFI 2.0. - EFI_HASH_PROTOCOL as defined in UEFI 2.0. - The EFI Hash Service Binding Protocol is used to locate hashing services support - provided by a driver and to create and destroy instances of the EFI Hash Protocol - so that a multiple drivers can use the underlying hashing services. -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-This program and the accompanying materials are licensed and made available under -the terms and conditions of the BSD License that accompanies this distribution. -The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. -**/ - -#ifndef __EFI_HASH_PROTOCOL_H__ -#define __EFI_HASH_PROTOCOL_H__ - -#include -#define CONST const - -#define EFI_HASH_SERVICE_BINDING_PROTOCOL_GUID \ - { \ - 0x42881c98, 0xa4f3, 0x44b0, {0xa3, 0x9d, 0xdf, 0xa1, 0x86, 0x67, 0xd8, 0xcd } \ - } - -#define EFI_HASH_PROTOCOL_GUID \ - { \ - 0xc5184932, 0xdba5, 0x46db, {0xa5, 0xba, 0xcc, 0x0b, 0xda, 0x9c, 0x14, 0x35 } \ - } - -#define EFI_HASH_ALGORITHM_SHA1_GUID \ - { \ - 0x2ae9d80f, 0x3fb2, 0x4095, {0xb7, 0xb1, 0xe9, 0x31, 0x57, 0xb9, 0x46, 0xb6 } \ - } - -#define EFI_HASH_ALGORITHM_SHA224_GUID \ - { \ - 0x8df01a06, 0x9bd5, 0x4bf7, {0xb0, 0x21, 0xdb, 0x4f, 0xd9, 0xcc, 0xf4, 0x5b } \ - } - -#define EFI_HASH_ALGORITHM_SHA256_GUID \ - { \ - 0x51aa59de, 0xfdf2, 0x4ea3, {0xbc, 0x63, 0x87, 0x5f, 0xb7, 0x84, 0x2e, 0xe9 } \ - } - -#define EFI_HASH_ALGORITHM_SHA384_GUID \ - { \ - 0xefa96432, 0xde33, 0x4dd2, {0xae, 0xe6, 0x32, 0x8c, 0x33, 0xdf, 0x77, 0x7a } \ - } - -#define EFI_HASH_ALGORITHM_SHA512_GUID \ - { \ - 0xcaa4381e, 0x750c, 0x4770, {0xb8, 0x70, 0x7a, 0x23, 0xb4, 0xe4, 0x21, 0x30 } \ - } - -#define EFI_HASH_ALGORTIHM_MD5_GUID \ - { \ - 0xaf7c79c, 0x65b5, 0x4319, {0xb0, 0xae, 0x44, 0xec, 0x48, 0x4e, 0x4a, 0xd7 } \ - } - -#define EFI_HASH_ALGORITHM_SHA1_NOPAD_GUID \ - { \ - 0x24c5dc2f, 0x53e2, 0x40ca, {0x9e, 0xd6, 0xa5, 0xd9, 0xa4, 0x9f, 0x46, 0x3b } \ - } - -#define EFI_HASH_ALGORITHM_SHA256_NOPAD_GUID \ - { \ - 0x8628752a, 0x6cb7, 0x4814, {0x96, 0xfc, 0x24, 0xa8, 0x15, 0xac, 0x22, 0x26 } \ - } - -// -// Note: Use of the following algorithms with EFI_HASH_PROTOCOL is deprecated. -// EFI_HASH_ALGORITHM_SHA1_GUID -// EFI_HASH_ALGORITHM_SHA224_GUID -// EFI_HASH_ALGORITHM_SHA256_GUID -// EFI_HASH_ALGORITHM_SHA384_GUID -// EFI_HASH_ALGORITHM_SHA512_GUID -// EFI_HASH_ALGORTIHM_MD5_GUID -// - -typedef struct _EFI_HASH_PROTOCOL EFI_HASH_PROTOCOL; - -typedef UINT8 EFI_MD5_HASH[16]; -typedef UINT8 EFI_SHA1_HASH[20]; -typedef UINT8 EFI_SHA224_HASH[28]; -typedef UINT8 EFI_SHA256_HASH[32]; -typedef UINT8 EFI_SHA384_HASH[48]; -typedef UINT8 EFI_SHA512_HASH[64]; - -typedef union { - EFI_MD5_HASH *Md5Hash; - EFI_SHA1_HASH *Sha1Hash; - EFI_SHA224_HASH *Sha224Hash; - EFI_SHA256_HASH *Sha256Hash; - EFI_SHA384_HASH *Sha384Hash; - EFI_SHA512_HASH *Sha512Hash; -} EFI_HASH_OUTPUT; - -/** - Returns the size of the hash which results from a specific algorithm. - @param[in] This Points to this instance of EFI_HASH_PROTOCOL. - @param[in] HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use. - @param[out] HashSize Holds the returned size of the algorithm's hash. - @retval EFI_SUCCESS Hash size returned successfully. - @retval EFI_INVALID_PARAMETER HashSize is NULL or HashAlgorithm is NULL. - @retval EFI_UNSUPPORTED The algorithm specified by HashAlgorithm is not supported - by this driver. -**/ -typedef -EFI_STATUS -(EFIAPI *EFI_HASH_GET_HASH_SIZE)( - IN CONST EFI_HASH_PROTOCOL *This, - IN CONST EFI_GUID *HashAlgorithm, - OUT UINTN *HashSize - ); - -/** - Creates a hash for the specified message text. - @param[in] This Points to this instance of EFI_HASH_PROTOCOL. - @param[in] HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use. - @param[in] Extend Specifies whether to create a new hash (FALSE) or extend the specified - existing hash (TRUE). - @param[in] Message Points to the start of the message. - @param[in] MessageSize The size of Message, in bytes. - @param[in,out] Hash On input, if Extend is TRUE, then this parameter holds a pointer - to a pointer to an array containing the hash to extend. If Extend - is FALSE, then this parameter holds a pointer to a pointer to a - caller-allocated array that will receive the result of the hash - computation. On output (regardless of the value of Extend), the - array will contain the result of the hash computation. - @retval EFI_SUCCESS Hash returned successfully. - @retval EFI_INVALID_PARAMETER Message or Hash, HashAlgorithm is NULL or MessageSize is 0. - MessageSize is not an integer multiple of block size. - @retval EFI_UNSUPPORTED The algorithm specified by HashAlgorithm is not supported by this - driver. Or, Extend is TRUE, and the algorithm doesn't support extending the hash. -**/ -typedef -EFI_STATUS -(EFIAPI *EFI_HASH_HASH)( - IN CONST EFI_HASH_PROTOCOL *This, - IN CONST EFI_GUID *HashAlgorithm, - IN BOOLEAN Extend, - IN CONST UINT8 *Message, - IN UINT64 MessageSize, - IN OUT EFI_HASH_OUTPUT *Hash - ); - -/// -/// This protocol allows creating a hash of an arbitrary message digest -/// using one or more hash algorithms. -/// -struct _EFI_HASH_PROTOCOL { - EFI_HASH_GET_HASH_SIZE GetHashSize; - EFI_HASH_HASH Hash; -}; - -extern EFI_GUID gEfiHashServiceBindingProtocolGuid; -extern EFI_GUID gEfiHashProtocolGuid; -extern EFI_GUID gEfiHashAlgorithmSha1Guid; -extern EFI_GUID gEfiHashAlgorithmSha224Guid; -extern EFI_GUID gEfiHashAlgorithmSha256Guid; -extern EFI_GUID gEfiHashAlgorithmSha384Guid; -extern EFI_GUID gEfiHashAlgorithmSha512Guid; -extern EFI_GUID gEfiHashAlgorithmMD5Guid; -extern EFI_GUID gEfiHashAlgorithmSha1NoPadGuid; -extern EFI_GUID gEfiHashAlgorithmSha256NoPadGuid; - -#endif +/** @file + EFI_HASH_SERVICE_BINDING_PROTOCOL as defined in UEFI 2.0. + EFI_HASH_PROTOCOL as defined in UEFI 2.0. + The EFI Hash Service Binding Protocol is used to locate hashing services support + provided by a driver and to create and destroy instances of the EFI Hash Protocol + so that a multiple drivers can use the underlying hashing services. + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef __EFI_HASH_PROTOCOL_H__ +#define __EFI_HASH_PROTOCOL_H__ + +#define EFI_HASH_SERVICE_BINDING_PROTOCOL_GUID \ + { \ + 0x42881c98, 0xa4f3, 0x44b0, {0xa3, 0x9d, 0xdf, 0xa1, 0x86, 0x67, 0xd8, 0xcd } \ + } + +#define EFI_HASH_PROTOCOL_GUID \ + { \ + 0xc5184932, 0xdba5, 0x46db, {0xa5, 0xba, 0xcc, 0x0b, 0xda, 0x9c, 0x14, 0x35 } \ + } + +#define EFI_HASH_ALGORITHM_SHA1_GUID \ + { \ + 0x2ae9d80f, 0x3fb2, 0x4095, {0xb7, 0xb1, 0xe9, 0x31, 0x57, 0xb9, 0x46, 0xb6 } \ + } + +#define EFI_HASH_ALGORITHM_SHA224_GUID \ + { \ + 0x8df01a06, 0x9bd5, 0x4bf7, {0xb0, 0x21, 0xdb, 0x4f, 0xd9, 0xcc, 0xf4, 0x5b } \ + } + +#define EFI_HASH_ALGORITHM_SHA256_GUID \ + { \ + 0x51aa59de, 0xfdf2, 0x4ea3, {0xbc, 0x63, 0x87, 0x5f, 0xb7, 0x84, 0x2e, 0xe9 } \ + } + +#define EFI_HASH_ALGORITHM_SHA384_GUID \ + { \ + 0xefa96432, 0xde33, 0x4dd2, {0xae, 0xe6, 0x32, 0x8c, 0x33, 0xdf, 0x77, 0x7a } \ + } + +#define EFI_HASH_ALGORITHM_SHA512_GUID \ + { \ + 0xcaa4381e, 0x750c, 0x4770, {0xb8, 0x70, 0x7a, 0x23, 0xb4, 0xe4, 0x21, 0x30 } \ + } + +#define EFI_HASH_ALGORTIHM_MD5_GUID \ + { \ + 0xaf7c79c, 0x65b5, 0x4319, {0xb0, 0xae, 0x44, 0xec, 0x48, 0x4e, 0x4a, 0xd7 } \ + } + +#define EFI_HASH_ALGORITHM_SHA1_NOPAD_GUID \ + { \ + 0x24c5dc2f, 0x53e2, 0x40ca, {0x9e, 0xd6, 0xa5, 0xd9, 0xa4, 0x9f, 0x46, 0x3b } \ + } + +#define EFI_HASH_ALGORITHM_SHA256_NOPAD_GUID \ + { \ + 0x8628752a, 0x6cb7, 0x4814, {0x96, 0xfc, 0x24, 0xa8, 0x15, 0xac, 0x22, 0x26 } \ + } + +// +// Note: Use of the following algorithms with EFI_HASH_PROTOCOL is deprecated. +// EFI_HASH_ALGORITHM_SHA1_GUID +// EFI_HASH_ALGORITHM_SHA224_GUID +// EFI_HASH_ALGORITHM_SHA256_GUID +// EFI_HASH_ALGORITHM_SHA384_GUID +// EFI_HASH_ALGORITHM_SHA512_GUID +// EFI_HASH_ALGORTIHM_MD5_GUID +// + +typedef struct _EFI_HASH_PROTOCOL EFI_HASH_PROTOCOL; + +typedef UINT8 EFI_MD5_HASH[16]; +typedef UINT8 EFI_SHA1_HASH[20]; +typedef UINT8 EFI_SHA224_HASH[28]; +typedef UINT8 EFI_SHA256_HASH[32]; +typedef UINT8 EFI_SHA384_HASH[48]; +typedef UINT8 EFI_SHA512_HASH[64]; + +typedef union { + EFI_MD5_HASH *Md5Hash; + EFI_SHA1_HASH *Sha1Hash; + EFI_SHA224_HASH *Sha224Hash; + EFI_SHA256_HASH *Sha256Hash; + EFI_SHA384_HASH *Sha384Hash; + EFI_SHA512_HASH *Sha512Hash; +} EFI_HASH_OUTPUT; + +/** + Returns the size of the hash which results from a specific algorithm. + + @param[in] This Points to this instance of EFI_HASH_PROTOCOL. + @param[in] HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use. + @param[out] HashSize Holds the returned size of the algorithm's hash. + + @retval EFI_SUCCESS Hash size returned successfully. + @retval EFI_INVALID_PARAMETER HashSize is NULL or HashAlgorithm is NULL. + @retval EFI_UNSUPPORTED The algorithm specified by HashAlgorithm is not supported + by this driver. + +**/ +typedef +EFI_STATUS +(EFIAPI *EFI_HASH_GET_HASH_SIZE)( + IN CONST EFI_HASH_PROTOCOL *This, + IN CONST EFI_GUID *HashAlgorithm, + OUT UINTN *HashSize + ); + +/** + Creates a hash for the specified message text. + + @param[in] This Points to this instance of EFI_HASH_PROTOCOL. + @param[in] HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use. + @param[in] Extend Specifies whether to create a new hash (FALSE) or extend the specified + existing hash (TRUE). + @param[in] Message Points to the start of the message. + @param[in] MessageSize The size of Message, in bytes. + @param[in,out] Hash On input, if Extend is TRUE, then this parameter holds a pointer + to a pointer to an array containing the hash to extend. If Extend + is FALSE, then this parameter holds a pointer to a pointer to a + caller-allocated array that will receive the result of the hash + computation. On output (regardless of the value of Extend), the + array will contain the result of the hash computation. + + @retval EFI_SUCCESS Hash returned successfully. + @retval EFI_INVALID_PARAMETER Message or Hash, HashAlgorithm is NULL or MessageSize is 0. + MessageSize is not an integer multiple of block size. + @retval EFI_UNSUPPORTED The algorithm specified by HashAlgorithm is not supported by this + driver. Or, Extend is TRUE, and the algorithm doesn't support extending the hash. + +**/ +typedef +EFI_STATUS +(EFIAPI *EFI_HASH_HASH)( + IN CONST EFI_HASH_PROTOCOL *This, + IN CONST EFI_GUID *HashAlgorithm, + IN BOOLEAN Extend, + IN CONST UINT8 *Message, + IN UINT64 MessageSize, + IN OUT EFI_HASH_OUTPUT *Hash + ); + +/// +/// This protocol allows creating a hash of an arbitrary message digest +/// using one or more hash algorithms. +/// +struct _EFI_HASH_PROTOCOL { + EFI_HASH_GET_HASH_SIZE GetHashSize; + EFI_HASH_HASH Hash; +}; + +extern EFI_GUID gEfiHashServiceBindingProtocolGuid; +extern EFI_GUID gEfiHashProtocolGuid; +extern EFI_GUID gEfiHashAlgorithmSha1Guid; +extern EFI_GUID gEfiHashAlgorithmSha224Guid; +extern EFI_GUID gEfiHashAlgorithmSha256Guid; +extern EFI_GUID gEfiHashAlgorithmSha384Guid; +extern EFI_GUID gEfiHashAlgorithmSha512Guid; +extern EFI_GUID gEfiHashAlgorithmMD5Guid; +extern EFI_GUID gEfiHashAlgorithmSha1NoPadGuid; +extern EFI_GUID gEfiHashAlgorithmSha256NoPadGuid; + +#endif diff --git a/sys/contrib/edk2/Include/Protocol/Hash2.h b/sys/contrib/edk2/Include/Protocol/Hash2.h new file mode 100644 index 000000000000..59a41b45b575 --- /dev/null +++ b/sys/contrib/edk2/Include/Protocol/Hash2.h @@ -0,0 +1,196 @@ +/** @file + EFI_HASH2_SERVICE_BINDING_PROTOCOL as defined in UEFI 2.5. + EFI_HASH2_PROTOCOL as defined in UEFI 2.5. + The EFI Hash2 Service Binding Protocol is used to locate hashing services support + provided by a driver and to create and destroy instances of the EFI Hash2 Protocol + so that a multiple drivers can use the underlying hashing services. + EFI_HASH2_PROTOCOL describes hashing functions for which the algorithm-required + message padding and finalization are performed by the supporting driver. + +Copyright (c) 2015, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef __EFI_HASH2_PROTOCOL_H__ +#define __EFI_HASH2_PROTOCOL_H__ + +#define EFI_HASH2_SERVICE_BINDING_PROTOCOL_GUID \ + { \ + 0xda836f8d, 0x217f, 0x4ca0, { 0x99, 0xc2, 0x1c, 0xa4, 0xe1, 0x60, 0x77, 0xea } \ + } + +#define EFI_HASH2_PROTOCOL_GUID \ + { \ + 0x55b1d734, 0xc5e1, 0x49db, { 0x96, 0x47, 0xb1, 0x6a, 0xfb, 0xe, 0x30, 0x5b } \ + } + +#include + +// +// NOTE: +// Algorithms EFI_HASH_ALGORITHM_SHA1_NOPAD and +// EFI_HASH_ALGORITHM_SHA256_NOPAD_GUID are not compatible with +// EFI_HASH2_PROTOCOL and will return EFI_UNSUPPORTED if used with any +// EFI_HASH2_PROTOCOL function. +// + +// +// Note: SHA-1 and MD5 are included for backwards compatibility. +// New driver implementations are encouraged to consider stronger algorithms. +// + +typedef struct _EFI_HASH2_PROTOCOL EFI_HASH2_PROTOCOL; + +typedef UINT8 EFI_MD5_HASH2[16]; +typedef UINT8 EFI_SHA1_HASH2[20]; +typedef UINT8 EFI_SHA224_HASH2[28]; +typedef UINT8 EFI_SHA256_HASH2[32]; +typedef UINT8 EFI_SHA384_HASH2[48]; +typedef UINT8 EFI_SHA512_HASH2[64]; + +typedef union { + EFI_MD5_HASH2 Md5Hash; + EFI_SHA1_HASH2 Sha1Hash; + EFI_SHA224_HASH2 Sha224Hash; + EFI_SHA256_HASH2 Sha256Hash; + EFI_SHA384_HASH2 Sha384Hash; + EFI_SHA512_HASH2 Sha512Hash; +} EFI_HASH2_OUTPUT; + +/** + Returns the size of the hash which results from a specific algorithm. + + @param[in] This Points to this instance of EFI_HASH2_PROTOCOL. + @param[in] HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use. + @param[out] HashSize Holds the returned size of the algorithm's hash. + + @retval EFI_SUCCESS Hash size returned successfully. + @retval EFI_INVALID_PARAMETER This or HashSize is NULL. + @retval EFI_UNSUPPORTED The algorithm specified by HashAlgorithm is not supported by this driver + or HashAlgorithm is null. + +**/ +typedef +EFI_STATUS +(EFIAPI *EFI_HASH2_GET_HASH_SIZE)( + IN CONST EFI_HASH2_PROTOCOL *This, + IN CONST EFI_GUID *HashAlgorithm, + OUT UINTN *HashSize + ); + +/** + Creates a hash for the specified message text. The hash is not extendable. + The output is final with any algorithm-required padding added by the function. + + @param[in] This Points to this instance of EFI_HASH2_PROTOCOL. + @param[in] HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use. + @param[in] Message Points to the start of the message. + @param[in] MessageSize The size of Message, in bytes. + @param[in,out] Hash On input, points to a caller-allocated buffer of the size + returned by GetHashSize() for the specified HashAlgorithm. + On output, the buffer holds the resulting hash computed from the message. + + @retval EFI_SUCCESS Hash returned successfully. + @retval EFI_INVALID_PARAMETER This or Hash is NULL. + @retval EFI_UNSUPPORTED The algorithm specified by HashAlgorithm is not supported by this driver + or HashAlgorithm is Null. + @retval EFI_OUT_OF_RESOURCES Some resource required by the function is not available + or MessageSize is greater than platform maximum. + +**/ +typedef +EFI_STATUS +(EFIAPI *EFI_HASH2_HASH)( + IN CONST EFI_HASH2_PROTOCOL *This, + IN CONST EFI_GUID *HashAlgorithm, + IN CONST UINT8 *Message, + IN UINTN MessageSize, + IN OUT EFI_HASH2_OUTPUT *Hash + ); + +/** + This function must be called to initialize a digest calculation to be subsequently performed using the + EFI_HASH2_PROTOCOL functions HashUpdate() and HashFinal(). + + @param[in] This Points to this instance of EFI_HASH2_PROTOCOL. + @param[in] HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use. + + @retval EFI_SUCCESS Initialized successfully. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_UNSUPPORTED The algorithm specified by HashAlgorithm is not supported by this driver + or HashAlgorithm is Null. + @retval EFI_OUT_OF_RESOURCES Process failed due to lack of required resource. + @retval EFI_ALREADY_STARTED This function is called when the operation in progress is still in processing Hash(), + or HashInit() is already called before and not terminated by HashFinal() yet on the same instance. + +**/ +typedef +EFI_STATUS +(EFIAPI *EFI_HASH2_HASH_INIT)( + IN CONST EFI_HASH2_PROTOCOL *This, + IN CONST EFI_GUID *HashAlgorithm + ); + +/** + Updates the hash of a computation in progress by adding a message text. + + @param[in] This Points to this instance of EFI_HASH2_PROTOCOL. + @param[in] Message Points to the start of the message. + @param[in] MessageSize The size of Message, in bytes. + + @retval EFI_SUCCESS Digest in progress updated successfully. + @retval EFI_INVALID_PARAMETER This or Hash is NULL. + @retval EFI_OUT_OF_RESOURCES Some resource required by the function is not available + or MessageSize is greater than platform maximum. + @retval EFI_NOT_READY This call was not preceded by a valid call to HashInit(), + or the operation in progress was terminated by a call to Hash() or HashFinal() on the same instance. + +**/ +typedef +EFI_STATUS +(EFIAPI *EFI_HASH2_HASH_UPDATE)( + IN CONST EFI_HASH2_PROTOCOL *This, + IN CONST UINT8 *Message, + IN UINTN MessageSize + ); + +/** + Finalizes a hash operation in progress and returns calculation result. + The output is final with any necessary padding added by the function. + The hash may not be further updated or extended after HashFinal(). + + @param[in] This Points to this instance of EFI_HASH2_PROTOCOL. + @param[in,out] Hash On input, points to a caller-allocated buffer of the size + returned by GetHashSize() for the specified HashAlgorithm specified in preceding HashInit(). + On output, the buffer holds the resulting hash computed from the message. + + @retval EFI_SUCCESS Hash returned successfully. + @retval EFI_INVALID_PARAMETER This or Hash is NULL. + @retval EFI_NOT_READY This call was not preceded by a valid call to HashInit() and at least one call to HashUpdate(), + or the operation in progress was canceled by a call to Hash() on the same instance. + +**/ +typedef +EFI_STATUS +(EFIAPI *EFI_HASH2_HASH_FINAL)( + IN CONST EFI_HASH2_PROTOCOL *This, + IN OUT EFI_HASH2_OUTPUT *Hash + ); + +/// +/// This protocol describes hashing functions for which the algorithm-required message padding and +/// finalization are performed by the supporting driver. +/// +struct _EFI_HASH2_PROTOCOL { + EFI_HASH2_GET_HASH_SIZE GetHashSize; + EFI_HASH2_HASH Hash; + EFI_HASH2_HASH_INIT HashInit; + EFI_HASH2_HASH_UPDATE HashUpdate; + EFI_HASH2_HASH_FINAL HashFinal; +}; + +extern EFI_GUID gEfiHash2ServiceBindingProtocolGuid; +extern EFI_GUID gEfiHash2ProtocolGuid; + +#endif