X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FInclude%2FGuid%2FImageAuthentication.h;h=2f51935c0c76bc18c6c07da1aa93077eb1755d7b;hp=ef160e72a30e9348b45fc8c3d38f1af9412d5c8e;hb=79e7b6472797f156d1ff28f3022b25d9c6f250f9;hpb=ab0eecec6e1233b7ca179d8a8f2b2e44e9546b7f diff --git a/MdePkg/Include/Guid/ImageAuthentication.h b/MdePkg/Include/Guid/ImageAuthentication.h index ef160e72a3..2f51935c0c 100644 --- a/MdePkg/Include/Guid/ImageAuthentication.h +++ b/MdePkg/Include/Guid/ImageAuthentication.h @@ -1,24 +1,24 @@ /** @file - Platform Key, Key Exchange Key, and Image signature database are defined - for the signed image validation. + Image signature database are defined for the signed image validation. - Copyright (c) 2009 - 2011, 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 + Copyright (c) 2009 - 2015, 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. + 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.3.1 spec. + GUIDs defined in UEFI 2.5 spec. **/ #ifndef __IMAGE_AUTHTICATION_H__ #define __IMAGE_AUTHTICATION_H__ #include +#include #define EFI_IMAGE_SECURITY_DATABASE_GUID \ { \ @@ -26,50 +26,35 @@ } /// -/// Varialbe name with guid EFI_IMAGE_SECURITY_DATABASE_GUID +/// 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 +/// Varialbe name with guid EFI_IMAGE_SECURITY_DATABASE_GUID /// for the forbidden signature database. /// #define EFI_IMAGE_SECURITY_DATABASE1 L"dbx" -#define SECURE_BOOT_MODE_ENABLE 1 -#define SECURE_BOOT_MODE_DISABLE 0 -#define SETUP_MODE 1 -#define USER_MODE 0 -/// -/// Globally "SetupMode" variable to specify whether the system is currently operating -/// in setup mode (1) or not (0). All other values are reserved. -/// -#define EFI_SETUP_MODE_NAME L"SetupMode" -/// -/// Globally "PK" variable for the Platform Key Signature Database. -/// -#define EFI_PLATFORM_KEY_NAME L"PK" /// -/// Globally "KEK" variable for the Key Exchange Key Signature Database. +/// Variable name with guid EFI_IMAGE_SECURITY_DATABASE_GUID +/// for the timestamp signature database. /// -#define EFI_KEY_EXCHANGE_KEY_NAME L"KEK" -/// -/// Globally "SignatureSupport" variable returns an array of GUIDs, -/// with each GUID representing a type of signature which the platform -/// firmware supports for images and other data. -/// -#define EFI_SIGNATURE_SUPPORT_NAME L"SignatureSupport" +#define EFI_IMAGE_SECURITY_DATABASE2 L"dbt" -/// -/// Globally "SecureBoot" variable to specify whether the platform firmware -/// is operating in Secure boot mode (1) or not (0). All other values are reserved. -/// -#define EFI_SECURE_BOOT_MODE_NAME L"SecureBoot" +#define SECURE_BOOT_MODE_ENABLE 1 +#define SECURE_BOOT_MODE_DISABLE 0 +#define SETUP_MODE_ENABLE 1 +#define SETUP_MODE_DISABLE 0 +#define DEPLOYED_MODE_ENABLE 1 +#define DEPLOYED_MODE_DISABLE 0 +#define AUDIT_MODE_ENABLE 1 +#define AUDIT_MODE_DISABLE 0 //*********************************************************************** // Signature Database //*********************************************************************** /// -/// The format of a signature database. +/// The format of a signature database. /// #pragma pack(1) @@ -100,17 +85,50 @@ typedef struct { /// /// Size of each signature. /// - UINT32 SignatureSize; + UINT32 SignatureSize; /// - /// Header before the array of signatures. The format of this header is specified + /// 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. + /// 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() /// @@ -127,8 +145,8 @@ typedef struct { /// 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) + 32 bytes. +/// The SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size +/// of SignatureOwner component) + 256 bytes. /// #define EFI_CERT_RSA2048_GUID \ { \ @@ -136,9 +154,9 @@ typedef struct { } /// -/// 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) + 32 bytes. +/// 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 \ { \ @@ -147,7 +165,7 @@ typedef struct { /// /// This identifies a signature containing a SHA-1 hash. The SignatureSize shall always -/// be 16 (size of SignatureOwner component) + 32 bytes. +/// be 16 (size of SignatureOwner component) + 20 bytes. /// #define EFI_CERT_SHA1_GUID \ { \ @@ -155,9 +173,9 @@ typedef struct { } /// -/// 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) + 32 bytes. +/// 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 \ { \ @@ -166,11 +184,11 @@ typedef struct { /// /// 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 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. +/// 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 \ @@ -196,7 +214,7 @@ typedef struct { #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 @@ -208,6 +226,45 @@ typedef struct { 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. @@ -216,13 +273,13 @@ typedef struct { { \ 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_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 @@ -232,7 +289,7 @@ typedef UINT32 EFI_IMAGE_EXECUTION_ACTION; #define EFI_IMAGE_EXECUTION_INITIALIZED 0x00000008 // -// EFI_IMAGE_EXECUTION_INFO is added to EFI System Configuration Table +// EFI_IMAGE_EXECUTION_INFO is added to EFI System Configuration Table // and assigned the GUID EFI_IMAGE_SECURITY_DATABASE_GUID. // typedef struct { @@ -245,27 +302,27 @@ typedef struct { /// 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 + /// 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, + /// 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, + /// Zero or more image signatures. If the image contained no signatures, /// then this field is empty. - /// - EFI_SIGNATURE_LIST Signature; + /// EFI_SIGNATURE_LIST Signature; + /// } EFI_IMAGE_EXECUTION_INFO; @@ -273,16 +330,16 @@ typedef struct { /// /// Number of EFI_IMAGE_EXECUTION_INFO structures. /// - UINTN NumberOfImages; + UINTN NumberOfImages; /// /// Number of image instances of EFI_IMAGE_EXECUTION_INFO structures. /// - // EFI_IMAGE_EXECUTION_INFO InformationInfo[] + // 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 gEfiCertRsa2048Guid; extern EFI_GUID gEfiCertRsa2048Sha256Guid; extern EFI_GUID gEfiCertSha1Guid; extern EFI_GUID gEfiCertRsa2048Sha1Guid; @@ -290,6 +347,9 @@ 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