MdePkg/Include/Guid/ImageAuthentication.h

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