]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Guid/ImageAuthentication.h
MdePkg: Add AuditMode/DeployedMode name definition
[mirror_edk2.git] / MdePkg / Include / Guid / ImageAuthentication.h
index 8b46e7356b757600ff142871c456df5aa3155fcb..2f51935c0c76bc18c6c07da1aa93077eb1755d7b 100644 (file)
@@ -1,23 +1,24 @@
 /** @file\r
   Image signature database are defined for the signed image validation.\r
 \r
-  Copyright (c) 2009 - 2013, Intel Corporation. All rights reserved.<BR>\r
-  This program and the accompanying materials                          \r
-  are licensed and made available under the terms and conditions of the BSD License         \r
-  which accompanies this distribution.  The full text of the license may be found at        \r
-  http://opensource.org/licenses/bsd-license.php                                            \r
+  Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials\r
+  are licensed and made available under the terms and conditions of the BSD License\r
+  which accompanies this distribution.  The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.php\r
 \r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
   @par Revision Reference:\r
-  GUIDs defined in UEFI 2.3.1 spec.\r
+  GUIDs defined in UEFI 2.5 spec.\r
 **/\r
 \r
 #ifndef __IMAGE_AUTHTICATION_H__\r
 #define __IMAGE_AUTHTICATION_H__\r
 \r
 #include <Guid/GlobalVariable.h>\r
+#include <Protocol/Hash.h>\r
 \r
 #define EFI_IMAGE_SECURITY_DATABASE_GUID \\r
   { \\r
   }\r
 \r
 ///\r
-/// Varialbe name with guid EFI_IMAGE_SECURITY_DATABASE_GUID \r
+/// Varialbe name with guid EFI_IMAGE_SECURITY_DATABASE_GUID\r
 /// for the authorized signature database.\r
 ///\r
 #define EFI_IMAGE_SECURITY_DATABASE       L"db"\r
 ///\r
-/// Varialbe name with guid EFI_IMAGE_SECURITY_DATABASE_GUID \r
+/// Varialbe name with guid EFI_IMAGE_SECURITY_DATABASE_GUID\r
 /// for the forbidden signature database.\r
 ///\r
 #define EFI_IMAGE_SECURITY_DATABASE1      L"dbx"\r
+///\r
+/// Variable name with guid EFI_IMAGE_SECURITY_DATABASE_GUID\r
+/// for the timestamp signature database.\r
+///\r
+#define EFI_IMAGE_SECURITY_DATABASE2      L"dbt"\r
 \r
 #define SECURE_BOOT_MODE_ENABLE           1\r
 #define SECURE_BOOT_MODE_DISABLE          0\r
-#define SETUP_MODE                        1\r
-#define USER_MODE                         0\r
-\r
+#define SETUP_MODE_ENABLE                 1\r
+#define SETUP_MODE_DISABLE                0\r
+#define DEPLOYED_MODE_ENABLE              1\r
+#define DEPLOYED_MODE_DISABLE             0\r
+#define AUDIT_MODE_ENABLE                 1\r
+#define AUDIT_MODE_DISABLE                0\r
 \r
 //***********************************************************************\r
 // Signature Database\r
 //***********************************************************************\r
 ///\r
-/// The format of a signature database. \r
+/// The format of a signature database.\r
 ///\r
 #pragma pack(1)\r
 \r
@@ -76,17 +85,50 @@ typedef struct {
   ///\r
   /// Size of each signature.\r
   ///\r
-  UINT32              SignatureSize; \r
+  UINT32              SignatureSize;\r
   ///\r
-  /// Header before the array of signatures. The format of this header is specified \r
+  /// Header before the array of signatures. The format of this header is specified\r
   /// by the SignatureType.\r
   /// UINT8           SignatureHeader[SignatureHeaderSize];\r
   ///\r
-  /// An array of signatures. Each signature is SignatureSize bytes in length. \r
+  /// An array of signatures. Each signature is SignatureSize bytes in length.\r
   /// EFI_SIGNATURE_DATA Signatures[][SignatureSize];\r
   ///\r
 } EFI_SIGNATURE_LIST;\r
 \r
+typedef struct {\r
+  ///\r
+  /// The SHA256 hash of an X.509 certificate's To-Be-Signed contents.\r
+  ///\r
+  EFI_SHA256_HASH     ToBeSignedHash;\r
+  ///\r
+  /// The time that the certificate shall be considered to be revoked.\r
+  ///\r
+  EFI_TIME            TimeOfRevocation;\r
+} EFI_CERT_X509_SHA256;\r
+\r
+typedef struct {\r
+  ///\r
+  /// The SHA384 hash of an X.509 certificate's To-Be-Signed contents.\r
+  ///\r
+  EFI_SHA384_HASH     ToBeSignedHash;\r
+  ///\r
+  /// The time that the certificate shall be considered to be revoked.\r
+  ///\r
+  EFI_TIME            TimeOfRevocation;\r
+} EFI_CERT_X509_SHA384;\r
+\r
+typedef struct {\r
+  ///\r
+  /// The SHA512 hash of an X.509 certificate's To-Be-Signed contents.\r
+  ///\r
+  EFI_SHA512_HASH     ToBeSignedHash;\r
+  ///\r
+  /// The time that the certificate shall be considered to be revoked.\r
+  ///\r
+  EFI_TIME            TimeOfRevocation;\r
+} EFI_CERT_X509_SHA512;\r
+\r
 #pragma pack()\r
 \r
 ///\r
@@ -103,7 +145,7 @@ typedef struct {
 /// This identifies a signature containing an RSA-2048 key. The key (only the modulus\r
 /// since the public key exponent is known to be 0x10001) shall be stored in big-endian\r
 /// order.\r
-/// The SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size \r
+/// The SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size\r
 /// of SignatureOwner component) + 256 bytes.\r
 ///\r
 #define EFI_CERT_RSA2048_GUID \\r
@@ -112,8 +154,8 @@ typedef struct {
   }\r
 \r
 ///\r
-/// This identifies a signature containing a RSA-2048 signature of a SHA-256 hash.  The \r
-/// SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size of \r
+/// This identifies a signature containing a RSA-2048 signature of a SHA-256 hash.  The\r
+/// SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size of\r
 /// SignatureOwner component) + 256 bytes.\r
 ///\r
 #define EFI_CERT_RSA2048_SHA256_GUID \\r
@@ -131,8 +173,8 @@ typedef struct {
   }\r
 \r
 ///\r
-/// TThis identifies a signature containing a RSA-2048 signature of a SHA-1 hash.  The \r
-/// SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size of \r
+/// TThis identifies a signature containing a RSA-2048 signature of a SHA-1 hash.  The\r
+/// SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size of\r
 /// SignatureOwner component) + 256 bytes.\r
 ///\r
 #define EFI_CERT_RSA2048_SHA1_GUID \\r
@@ -142,11 +184,11 @@ typedef struct {
 \r
 ///\r
 /// This identifies a signature based on an X.509 certificate. If the signature is an X.509\r
-/// certificate then verification of the signature of an image should validate the public \r
-/// key certificate in the image using certificate path verification, up to this X.509 \r
+/// certificate then verification of the signature of an image should validate the public\r
+/// key certificate in the image using certificate path verification, up to this X.509\r
 /// certificate as a trusted root.  The SignatureHeader size shall always be 0. The\r
-/// SignatureSize may vary but shall always be 16 (size of the SignatureOwner component) + \r
-/// the size of the certificate itself. \r
+/// SignatureSize may vary but shall always be 16 (size of the SignatureOwner component) +\r
+/// the size of the certificate itself.\r
 /// Note: This means that each certificate will normally be in a separate EFI_SIGNATURE_LIST.\r
 ///\r
 #define EFI_CERT_X509_GUID \\r
@@ -172,7 +214,7 @@ typedef struct {
 #define EFI_CERT_SHA384_GUID \\r
   { \\r
     0xff3e5307, 0x9fd0, 0x48c9, {0x85, 0xf1, 0x8a, 0xd5, 0x6c, 0x70, 0x1e, 0x1} \\r
-  }  \r
+  }\r
 \r
 ///\r
 /// This identifies a signature containing a SHA-512 hash. The SignatureHeader size shall\r
@@ -184,6 +226,45 @@ typedef struct {
     0x93e0fae, 0xa6c4, 0x4f50, {0x9f, 0x1b, 0xd4, 0x1e, 0x2b, 0x89, 0xc1, 0x9a} \\r
   }\r
 \r
+///\r
+/// This identifies a signature containing the SHA256 hash of an X.509 certificate's\r
+/// To-Be-Signed contents, and a time of revocation. The SignatureHeader size shall\r
+/// always be 0. The SignatureSize shall always be 16 (size of the SignatureOwner component)\r
+/// + 48 bytes for an EFI_CERT_X509_SHA256 structure. If the TimeOfRevocation is non-zero,\r
+/// the certificate should be considered to be revoked from that time and onwards, and\r
+/// otherwise the certificate shall be considered to always be revoked.\r
+///\r
+#define EFI_CERT_X509_SHA256_GUID \\r
+  { \\r
+    0x3bd2a492, 0x96c0, 0x4079, {0xb4, 0x20, 0xfc, 0xf9, 0x8e, 0xf1, 0x03, 0xed } \\r
+  }\r
+\r
+///\r
+/// This identifies a signature containing the SHA384 hash of an X.509 certificate's\r
+/// To-Be-Signed contents, and a time of revocation. The SignatureHeader size shall\r
+/// always be 0. The SignatureSize shall always be 16 (size of the SignatureOwner component)\r
+/// + 64 bytes for an EFI_CERT_X509_SHA384 structure. If the TimeOfRevocation is non-zero,\r
+/// the certificate should be considered to be revoked from that time and onwards, and\r
+/// otherwise the certificate shall be considered to always be revoked.\r
+///\r
+#define EFI_CERT_X509_SHA384_GUID \\r
+  { \\r
+    0x7076876e, 0x80c2, 0x4ee6, {0xaa, 0xd2, 0x28, 0xb3, 0x49, 0xa6, 0x86, 0x5b } \\r
+  }\r
+\r
+///\r
+/// This identifies a signature containing the SHA512 hash of an X.509 certificate's\r
+/// To-Be-Signed contents, and a time of revocation. The SignatureHeader size shall\r
+/// always be 0. The SignatureSize shall always be 16 (size of the SignatureOwner component)\r
+/// + 80 bytes for an EFI_CERT_X509_SHA512 structure. If the TimeOfRevocation is non-zero,\r
+/// the certificate should be considered to be revoked from that time and onwards, and\r
+/// otherwise the certificate shall be considered to always be revoked.\r
+///\r
+#define EFI_CERT_X509_SHA512_GUID \\r
+  { \\r
+    0x446dbf63, 0x2502, 0x4cda, {0xbc, 0xfa, 0x24, 0x65, 0xd2, 0xb0, 0xfe, 0x9d } \\r
+  }\r
+\r
 ///\r
 /// This identifies a signature containing a DER-encoded PKCS #7 version 1.5 [RFC2315]\r
 /// SignedData value.\r
@@ -192,13 +273,13 @@ typedef struct {
   { \\r
     0x4aafd29d, 0x68df, 0x49ee, {0x8a, 0xa9, 0x34, 0x7d, 0x37, 0x56, 0x65, 0xa7} \\r
   }\r
-  \r
+\r
 //***********************************************************************\r
 // Image Execution Information Table Definition\r
 //***********************************************************************\r
 typedef UINT32 EFI_IMAGE_EXECUTION_ACTION;\r
 \r
-#define EFI_IMAGE_EXECUTION_AUTHENTICATION      0x00000007 \r
+#define EFI_IMAGE_EXECUTION_AUTHENTICATION      0x00000007\r
 #define EFI_IMAGE_EXECUTION_AUTH_UNTESTED       0x00000000\r
 #define EFI_IMAGE_EXECUTION_AUTH_SIG_FAILED     0x00000001\r
 #define EFI_IMAGE_EXECUTION_AUTH_SIG_PASSED     0x00000002\r
@@ -208,7 +289,7 @@ typedef UINT32 EFI_IMAGE_EXECUTION_ACTION;
 #define EFI_IMAGE_EXECUTION_INITIALIZED         0x00000008\r
 \r
 //\r
-// EFI_IMAGE_EXECUTION_INFO is added to EFI System Configuration Table \r
+// EFI_IMAGE_EXECUTION_INFO is added to EFI System Configuration Table\r
 // and assigned the GUID EFI_IMAGE_SECURITY_DATABASE_GUID.\r
 //\r
 typedef struct {\r
@@ -221,27 +302,27 @@ typedef struct {
   ///\r
   UINT32                        InfoSize;\r
   ///\r
-  /// If this image was a UEFI device driver (for option ROM, for example) this is the \r
-  /// null-terminated, user-friendly name for the device. If the image was for an application, \r
-  /// then this is the name of the application. If this cannot be determined, then a simple \r
+  /// If this image was a UEFI device driver (for option ROM, for example) this is the\r
+  /// null-terminated, user-friendly name for the device. If the image was for an application,\r
+  /// then this is the name of the application. If this cannot be determined, then a simple\r
   /// NULL character should be put in this position.\r
   /// CHAR16                    Name[];\r
   ///\r
 \r
   ///\r
-  /// For device drivers, this is the device path of the device for which this device driver \r
-  /// was intended. In some cases, the driver itself may be stored as part of the system \r
-  /// firmware, but this field should record the device's path, not the firmware path. For \r
-  /// applications, this is the device path of the application. If this cannot be determined, \r
+  /// For device drivers, this is the device path of the device for which this device driver\r
+  /// was intended. In some cases, the driver itself may be stored as part of the system\r
+  /// firmware, but this field should record the device's path, not the firmware path. For\r
+  /// applications, this is the device path of the application. If this cannot be determined,\r
   /// a simple end-of-path device node should be put in this position.\r
   /// EFI_DEVICE_PATH_PROTOCOL  DevicePath;\r
   ///\r
 \r
   ///\r
-  /// Zero or more image signatures. If the image contained no signatures, \r
+  /// Zero or more image signatures. If the image contained no signatures,\r
   /// then this field is empty.\r
-  ///\r
-  EFI_SIGNATURE_LIST            Signature;\r
+  /// EFI_SIGNATURE_LIST            Signature;\r
+  /// \r
 } EFI_IMAGE_EXECUTION_INFO;\r
 \r
 \r
@@ -249,16 +330,16 @@ typedef struct {
   ///\r
   /// Number of EFI_IMAGE_EXECUTION_INFO structures.\r
   ///\r
-  UINTN                     NumberOfImages; \r
+  UINTN                     NumberOfImages;\r
   ///\r
   /// Number of image instances of EFI_IMAGE_EXECUTION_INFO structures.\r
   ///\r
-  // EFI_IMAGE_EXECUTION_INFO  InformationInfo[] \r
+  // EFI_IMAGE_EXECUTION_INFO  InformationInfo[]\r
 } EFI_IMAGE_EXECUTION_INFO_TABLE;\r
 \r
 extern EFI_GUID gEfiImageSecurityDatabaseGuid;\r
 extern EFI_GUID gEfiCertSha256Guid;\r
-extern EFI_GUID gEfiCertRsa2048Guid;      \r
+extern EFI_GUID gEfiCertRsa2048Guid;\r
 extern EFI_GUID gEfiCertRsa2048Sha256Guid;\r
 extern EFI_GUID gEfiCertSha1Guid;\r
 extern EFI_GUID gEfiCertRsa2048Sha1Guid;\r
@@ -266,6 +347,9 @@ extern EFI_GUID gEfiCertX509Guid;
 extern EFI_GUID gEfiCertSha224Guid;\r
 extern EFI_GUID gEfiCertSha384Guid;\r
 extern EFI_GUID gEfiCertSha512Guid;\r
+extern EFI_GUID gEfiCertX509Sha256Guid;\r
+extern EFI_GUID gEfiCertX509Sha384Guid;\r
+extern EFI_GUID gEfiCertX509Sha512Guid;\r
 extern EFI_GUID gEfiCertPkcs7Guid;\r
 \r
 #endif\r