MdePkg/Include/Guid/ImageAuthentication.h

   1 /** @file
   2   Image signature database are defined for the signed image validation.
   3
   4   Copyright (c) 2009 - 2013, Intel Corporation. All rights reserved.<BR>
   5   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13   @par Revision Reference:
  14   GUIDs defined in UEFI 2.3.1 spec.
  15 **/
  16
  17 #ifndef __IMAGE_AUTHTICATION_H__
  18 #define __IMAGE_AUTHTICATION_H__
  19
  20 #include <Guid/GlobalVariable.h>
  21
  22 #define EFI_IMAGE_SECURITY_DATABASE_GUID \
  23   { \
  24     0xd719b2cb, 0x3d3a, 0x4596, { 0xa3, 0xbc, 0xda, 0xd0, 0xe, 0x67, 0x65, 0x6f } \
  25   }
  26
  27 ///
  28 /// Varialbe name with guid EFI_IMAGE_SECURITY_DATABASE_GUID
  29 /// for the authorized signature database.
  30 ///
  31 #define EFI_IMAGE_SECURITY_DATABASE       L"db"
  32 ///
  33 /// Varialbe name with guid EFI_IMAGE_SECURITY_DATABASE_GUID
  34 /// for the forbidden signature database.
  35 ///
  36 #define EFI_IMAGE_SECURITY_DATABASE1      L"dbx"
  37
  38 #define SECURE_BOOT_MODE_ENABLE           1
  39 #define SECURE_BOOT_MODE_DISABLE          0
  40 #define SETUP_MODE                        1
  41 #define USER_MODE                         0
  42
  43
  44 //***********************************************************************
  45 // Signature Database
  46 //***********************************************************************
  47 ///
  48 /// The format of a signature database.
  49 ///
  50 #pragma pack(1)
  51
  52 typedef struct {
  53   ///
  54   /// An identifier which identifies the agent which added the signature to the list.
  55   ///
  56   EFI_GUID          SignatureOwner;
  57   ///
  58   /// The format of the signature is defined by the SignatureType.
  59   ///
  60   UINT8             SignatureData[1];
  61 } EFI_SIGNATURE_DATA;
  62
  63 typedef struct {
  64   ///
  65   /// Type of the signature. GUID signature types are defined in below.
  66   ///
  67   EFI_GUID            SignatureType;
  68   ///
  69   /// Total size of the signature list, including this header.
  70   ///
  71   UINT32              SignatureListSize;
  72   ///
  73   /// Size of the signature header which precedes the array of signatures.
  74   ///
  75   UINT32              SignatureHeaderSize;
  76   ///
  77   /// Size of each signature.
  78   ///
  79   UINT32              SignatureSize;
  80   ///
  81   /// Header before the array of signatures. The format of this header is specified
  82   /// by the SignatureType.
  83   /// UINT8           SignatureHeader[SignatureHeaderSize];
  84   ///
  85   /// An array of signatures. Each signature is SignatureSize bytes in length.
  86   /// EFI_SIGNATURE_DATA Signatures[][SignatureSize];
  87   ///
  88 } EFI_SIGNATURE_LIST;
  89
  90 #pragma pack()
  91
  92 ///
  93 /// This identifies a signature containing a SHA-256 hash. The SignatureHeader size shall
  94 /// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) +
  95 /// 32 bytes.
  96 ///
  97 #define EFI_CERT_SHA256_GUID \
  98   { \
  99     0xc1c41626, 0x504c, 0x4092, {0xac, 0xa9, 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28} \
 100   }
 101
 102 ///
 103 /// This identifies a signature containing an RSA-2048 key. The key (only the modulus
 104 /// since the public key exponent is known to be 0x10001) shall be stored in big-endian
 105 /// order.
 106 /// The SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size
 107 /// of SignatureOwner component) + 256 bytes.
 108 ///
 109 #define EFI_CERT_RSA2048_GUID \
 110   { \
 111     0x3c5766e8, 0x269c, 0x4e34, {0xaa, 0x14, 0xed, 0x77, 0x6e, 0x85, 0xb3, 0xb6} \
 112   }
 113
 114 ///
 115 /// This identifies a signature containing a RSA-2048 signature of a SHA-256 hash.  The
 116 /// SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size of
 117 /// SignatureOwner component) + 256 bytes.
 118 ///
 119 #define EFI_CERT_RSA2048_SHA256_GUID \
 120   { \
 121     0xe2b36190, 0x879b, 0x4a3d, {0xad, 0x8d, 0xf2, 0xe7, 0xbb, 0xa3, 0x27, 0x84} \
 122   }
 123
 124 ///
 125 /// This identifies a signature containing a SHA-1 hash.  The SignatureSize shall always
 126 /// be 16 (size of SignatureOwner component) + 20 bytes.
 127 ///
 128 #define EFI_CERT_SHA1_GUID \
 129   { \
 130     0x826ca512, 0xcf10, 0x4ac9, {0xb1, 0x87, 0xbe, 0x1, 0x49, 0x66, 0x31, 0xbd} \
 131   }
 132
 133 ///
 134 /// TThis identifies a signature containing a RSA-2048 signature of a SHA-1 hash.  The
 135 /// SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size of
 136 /// SignatureOwner component) + 256 bytes.
 137 ///
 138 #define EFI_CERT_RSA2048_SHA1_GUID \
 139   { \
 140     0x67f8444f, 0x8743, 0x48f1, {0xa3, 0x28, 0x1e, 0xaa, 0xb8, 0x73, 0x60, 0x80} \
 141   }
 142
 143 ///
 144 /// This identifies a signature based on an X.509 certificate. If the signature is an X.509
 145 /// certificate then verification of the signature of an image should validate the public
 146 /// key certificate in the image using certificate path verification, up to this X.509
 147 /// certificate as a trusted root.  The SignatureHeader size shall always be 0. The
 148 /// SignatureSize may vary but shall always be 16 (size of the SignatureOwner component) +
 149 /// the size of the certificate itself.
 150 /// Note: This means that each certificate will normally be in a separate EFI_SIGNATURE_LIST.
 151 ///
 152 #define EFI_CERT_X509_GUID \
 153   { \
 154     0xa5c059a1, 0x94e4, 0x4aa7, {0x87, 0xb5, 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72} \
 155   }
 156
 157 ///
 158 /// This identifies a signature containing a SHA-224 hash. The SignatureHeader size shall
 159 /// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) +
 160 /// 28 bytes.
 161 ///
 162 #define EFI_CERT_SHA224_GUID \
 163   { \
 164     0xb6e5233, 0xa65c, 0x44c9, {0x94, 0x7, 0xd9, 0xab, 0x83, 0xbf, 0xc8, 0xbd} \
 165   }
 166
 167 ///
 168 /// This identifies a signature containing a SHA-384 hash. The SignatureHeader size shall
 169 /// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) +
 170 /// 48 bytes.
 171 ///
 172 #define EFI_CERT_SHA384_GUID \
 173   { \
 174     0xff3e5307, 0x9fd0, 0x48c9, {0x85, 0xf1, 0x8a, 0xd5, 0x6c, 0x70, 0x1e, 0x1} \
 175   }
 176
 177 ///
 178 /// This identifies a signature containing a SHA-512 hash. The SignatureHeader size shall
 179 /// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) +
 180 /// 64 bytes.
 181 ///
 182 #define EFI_CERT_SHA512_GUID \
 183   { \
 184     0x93e0fae, 0xa6c4, 0x4f50, {0x9f, 0x1b, 0xd4, 0x1e, 0x2b, 0x89, 0xc1, 0x9a} \
 185   }
 186
 187 ///
 188 /// This identifies a signature containing a DER-encoded PKCS #7 version 1.5 [RFC2315]
 189 /// SignedData value.
 190 ///
 191 #define EFI_CERT_TYPE_PKCS7_GUID \
 192   { \
 193     0x4aafd29d, 0x68df, 0x49ee, {0x8a, 0xa9, 0x34, 0x7d, 0x37, 0x56, 0x65, 0xa7} \
 194   }
 195
 196 //***********************************************************************
 197 // Image Execution Information Table Definition
 198 //***********************************************************************
 199 typedef UINT32 EFI_IMAGE_EXECUTION_ACTION;
 200
 201 #define EFI_IMAGE_EXECUTION_AUTHENTICATION      0x00000007
 202 #define EFI_IMAGE_EXECUTION_AUTH_UNTESTED       0x00000000
 203 #define EFI_IMAGE_EXECUTION_AUTH_SIG_FAILED     0x00000001
 204 #define EFI_IMAGE_EXECUTION_AUTH_SIG_PASSED     0x00000002
 205 #define EFI_IMAGE_EXECUTION_AUTH_SIG_NOT_FOUND  0x00000003
 206 #define EFI_IMAGE_EXECUTION_AUTH_SIG_FOUND      0x00000004
 207 #define EFI_IMAGE_EXECUTION_POLICY_FAILED       0x00000005
 208 #define EFI_IMAGE_EXECUTION_INITIALIZED         0x00000008
 209
 210 //
 211 // EFI_IMAGE_EXECUTION_INFO is added to EFI System Configuration Table
 212 // and assigned the GUID EFI_IMAGE_SECURITY_DATABASE_GUID.
 213 //
 214 typedef struct {
 215   ///
 216   /// Describes the action taken by the firmware regarding this image.
 217   ///
 218   EFI_IMAGE_EXECUTION_ACTION    Action;
 219   ///
 220   /// Size of all of the entire structure.
 221   ///
 222   UINT32                        InfoSize;
 223   ///
 224   /// If this image was a UEFI device driver (for option ROM, for example) this is the
 225   /// null-terminated, user-friendly name for the device. If the image was for an application,
 226   /// then this is the name of the application. If this cannot be determined, then a simple
 227   /// NULL character should be put in this position.
 228   /// CHAR16                    Name[];
 229   ///
 230
 231   ///
 232   /// For device drivers, this is the device path of the device for which this device driver
 233   /// was intended. In some cases, the driver itself may be stored as part of the system
 234   /// firmware, but this field should record the device's path, not the firmware path. For
 235   /// applications, this is the device path of the application. If this cannot be determined,
 236   /// a simple end-of-path device node should be put in this position.
 237   /// EFI_DEVICE_PATH_PROTOCOL  DevicePath;
 238   ///
 239
 240   ///
 241   /// Zero or more image signatures. If the image contained no signatures,
 242   /// then this field is empty.
 243   ///
 244   EFI_SIGNATURE_LIST            Signature;
 245 } EFI_IMAGE_EXECUTION_INFO;
 246
 247
 248 typedef struct {
 249   ///
 250   /// Number of EFI_IMAGE_EXECUTION_INFO structures.
 251   ///
 252   UINTN                     NumberOfImages;
 253   ///
 254   /// Number of image instances of EFI_IMAGE_EXECUTION_INFO structures.
 255   ///
 256   // EFI_IMAGE_EXECUTION_INFO  InformationInfo[]
 257 } EFI_IMAGE_EXECUTION_INFO_TABLE;
 258
 259 extern EFI_GUID gEfiImageSecurityDatabaseGuid;
 260 extern EFI_GUID gEfiCertSha256Guid;
 261 extern EFI_GUID gEfiCertRsa2048Guid;
 262 extern EFI_GUID gEfiCertRsa2048Sha256Guid;
 263 extern EFI_GUID gEfiCertSha1Guid;
 264 extern EFI_GUID gEfiCertRsa2048Sha1Guid;
 265 extern EFI_GUID gEfiCertX509Guid;
 266 extern EFI_GUID gEfiCertSha224Guid;
 267 extern EFI_GUID gEfiCertSha384Guid;
 268 extern EFI_GUID gEfiCertSha512Guid;
 269 extern EFI_GUID gEfiCertPkcs7Guid;
 270
 271 #endif