1 /** @file 2 Image signature database are defined for the signed image validation. 3 4 Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR> 5 SPDX-License-Identifier: BSD-2-Clause-Patent 6 7 @par Revision Reference: 8 GUIDs defined in UEFI 2.5 spec. 9 **/ 10 11 #ifndef __IMAGE_AUTHTICATION_H__ 12 #define __IMAGE_AUTHTICATION_H__ 13 14 #include <Guid/GlobalVariable.h> 15 #include <Protocol/Hash.h> 16 17 #define EFI_IMAGE_SECURITY_DATABASE_GUID \ 18 { \ 19 0xd719b2cb, 0x3d3a, 0x4596, { 0xa3, 0xbc, 0xda, 0xd0, 0xe, 0x67, 0x65, 0x6f } \ 20 } 21 22 /// 23 /// Varialbe name with guid EFI_IMAGE_SECURITY_DATABASE_GUID 24 /// for the authorized signature database. 25 /// 26 #define EFI_IMAGE_SECURITY_DATABASE L"db" 27 /// 28 /// Varialbe name with guid EFI_IMAGE_SECURITY_DATABASE_GUID 29 /// for the forbidden signature database. 30 /// 31 #define EFI_IMAGE_SECURITY_DATABASE1 L"dbx" 32 /// 33 /// Variable name with guid EFI_IMAGE_SECURITY_DATABASE_GUID 34 /// for the timestamp signature database. 35 /// 36 #define EFI_IMAGE_SECURITY_DATABASE2 L"dbt" 37 38 #define SECURE_BOOT_MODE_ENABLE 1 39 #define SECURE_BOOT_MODE_DISABLE 0 40 41 #define SETUP_MODE 1 42 #define USER_MODE 0 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 typedef struct { 91 /// 92 /// The SHA256 hash of an X.509 certificate's To-Be-Signed contents. 93 /// 94 EFI_SHA256_HASH ToBeSignedHash; 95 /// 96 /// The time that the certificate shall be considered to be revoked. 97 /// 98 EFI_TIME TimeOfRevocation; 99 } EFI_CERT_X509_SHA256; 100 101 typedef struct { 102 /// 103 /// The SHA384 hash of an X.509 certificate's To-Be-Signed contents. 104 /// 105 EFI_SHA384_HASH ToBeSignedHash; 106 /// 107 /// The time that the certificate shall be considered to be revoked. 108 /// 109 EFI_TIME TimeOfRevocation; 110 } EFI_CERT_X509_SHA384; 111 112 typedef struct { 113 /// 114 /// The SHA512 hash of an X.509 certificate's To-Be-Signed contents. 115 /// 116 EFI_SHA512_HASH ToBeSignedHash; 117 /// 118 /// The time that the certificate shall be considered to be revoked. 119 /// 120 EFI_TIME TimeOfRevocation; 121 } EFI_CERT_X509_SHA512; 122 123 #pragma pack() 124 125 /// 126 /// This identifies a signature containing a SHA-256 hash. The SignatureHeader size shall 127 /// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) + 128 /// 32 bytes. 129 /// 130 #define EFI_CERT_SHA256_GUID \ 131 { \ 132 0xc1c41626, 0x504c, 0x4092, {0xac, 0xa9, 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28} \ 133 } 134 135 /// 136 /// This identifies a signature containing an RSA-2048 key. The key (only the modulus 137 /// since the public key exponent is known to be 0x10001) shall be stored in big-endian 138 /// order. 139 /// The SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size 140 /// of SignatureOwner component) + 256 bytes. 141 /// 142 #define EFI_CERT_RSA2048_GUID \ 143 { \ 144 0x3c5766e8, 0x269c, 0x4e34, {0xaa, 0x14, 0xed, 0x77, 0x6e, 0x85, 0xb3, 0xb6} \ 145 } 146 147 /// 148 /// This identifies a signature containing a RSA-2048 signature of a SHA-256 hash. The 149 /// SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size of 150 /// SignatureOwner component) + 256 bytes. 151 /// 152 #define EFI_CERT_RSA2048_SHA256_GUID \ 153 { \ 154 0xe2b36190, 0x879b, 0x4a3d, {0xad, 0x8d, 0xf2, 0xe7, 0xbb, 0xa3, 0x27, 0x84} \ 155 } 156 157 /// 158 /// This identifies a signature containing a SHA-1 hash. The SignatureSize shall always 159 /// be 16 (size of SignatureOwner component) + 20 bytes. 160 /// 161 #define EFI_CERT_SHA1_GUID \ 162 { \ 163 0x826ca512, 0xcf10, 0x4ac9, {0xb1, 0x87, 0xbe, 0x1, 0x49, 0x66, 0x31, 0xbd} \ 164 } 165 166 /// 167 /// TThis identifies a signature containing a RSA-2048 signature of a SHA-1 hash. The 168 /// SignatureHeader size shall always be 0. The SignatureSize shall always be 16 (size of 169 /// SignatureOwner component) + 256 bytes. 170 /// 171 #define EFI_CERT_RSA2048_SHA1_GUID \ 172 { \ 173 0x67f8444f, 0x8743, 0x48f1, {0xa3, 0x28, 0x1e, 0xaa, 0xb8, 0x73, 0x60, 0x80} \ 174 } 175 176 /// 177 /// This identifies a signature based on an X.509 certificate. If the signature is an X.509 178 /// certificate then verification of the signature of an image should validate the public 179 /// key certificate in the image using certificate path verification, up to this X.509 180 /// certificate as a trusted root. The SignatureHeader size shall always be 0. The 181 /// SignatureSize may vary but shall always be 16 (size of the SignatureOwner component) + 182 /// the size of the certificate itself. 183 /// Note: This means that each certificate will normally be in a separate EFI_SIGNATURE_LIST. 184 /// 185 #define EFI_CERT_X509_GUID \ 186 { \ 187 0xa5c059a1, 0x94e4, 0x4aa7, {0x87, 0xb5, 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72} \ 188 } 189 190 /// 191 /// This identifies a signature containing a SHA-224 hash. The SignatureHeader size shall 192 /// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) + 193 /// 28 bytes. 194 /// 195 #define EFI_CERT_SHA224_GUID \ 196 { \ 197 0xb6e5233, 0xa65c, 0x44c9, {0x94, 0x7, 0xd9, 0xab, 0x83, 0xbf, 0xc8, 0xbd} \ 198 } 199 200 /// 201 /// This identifies a signature containing a SHA-384 hash. The SignatureHeader size shall 202 /// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) + 203 /// 48 bytes. 204 /// 205 #define EFI_CERT_SHA384_GUID \ 206 { \ 207 0xff3e5307, 0x9fd0, 0x48c9, {0x85, 0xf1, 0x8a, 0xd5, 0x6c, 0x70, 0x1e, 0x1} \ 208 } 209 210 /// 211 /// This identifies a signature containing a SHA-512 hash. The SignatureHeader size shall 212 /// always be 0. The SignatureSize shall always be 16 (size of SignatureOwner component) + 213 /// 64 bytes. 214 /// 215 #define EFI_CERT_SHA512_GUID \ 216 { \ 217 0x93e0fae, 0xa6c4, 0x4f50, {0x9f, 0x1b, 0xd4, 0x1e, 0x2b, 0x89, 0xc1, 0x9a} \ 218 } 219 220 /// 221 /// This identifies a signature containing the SHA256 hash of an X.509 certificate's 222 /// To-Be-Signed contents, and a time of revocation. The SignatureHeader size shall 223 /// always be 0. The SignatureSize shall always be 16 (size of the SignatureOwner component) 224 /// + 48 bytes for an EFI_CERT_X509_SHA256 structure. If the TimeOfRevocation is non-zero, 225 /// the certificate should be considered to be revoked from that time and onwards, and 226 /// otherwise the certificate shall be considered to always be revoked. 227 /// 228 #define EFI_CERT_X509_SHA256_GUID \ 229 { \ 230 0x3bd2a492, 0x96c0, 0x4079, {0xb4, 0x20, 0xfc, 0xf9, 0x8e, 0xf1, 0x03, 0xed } \ 231 } 232 233 /// 234 /// This identifies a signature containing the SHA384 hash of an X.509 certificate's 235 /// To-Be-Signed contents, and a time of revocation. The SignatureHeader size shall 236 /// always be 0. The SignatureSize shall always be 16 (size of the SignatureOwner component) 237 /// + 64 bytes for an EFI_CERT_X509_SHA384 structure. If the TimeOfRevocation is non-zero, 238 /// the certificate should be considered to be revoked from that time and onwards, and 239 /// otherwise the certificate shall be considered to always be revoked. 240 /// 241 #define EFI_CERT_X509_SHA384_GUID \ 242 { \ 243 0x7076876e, 0x80c2, 0x4ee6, {0xaa, 0xd2, 0x28, 0xb3, 0x49, 0xa6, 0x86, 0x5b } \ 244 } 245 246 /// 247 /// This identifies a signature containing the SHA512 hash of an X.509 certificate's 248 /// To-Be-Signed contents, and a time of revocation. The SignatureHeader size shall 249 /// always be 0. The SignatureSize shall always be 16 (size of the SignatureOwner component) 250 /// + 80 bytes for an EFI_CERT_X509_SHA512 structure. If the TimeOfRevocation is non-zero, 251 /// the certificate should be considered to be revoked from that time and onwards, and 252 /// otherwise the certificate shall be considered to always be revoked. 253 /// 254 #define EFI_CERT_X509_SHA512_GUID \ 255 { \ 256 0x446dbf63, 0x2502, 0x4cda, {0xbc, 0xfa, 0x24, 0x65, 0xd2, 0xb0, 0xfe, 0x9d } \ 257 } 258 259 /// 260 /// This identifies a signature containing a DER-encoded PKCS #7 version 1.5 [RFC2315] 261 /// SignedData value. 262 /// 263 #define EFI_CERT_TYPE_PKCS7_GUID \ 264 { \ 265 0x4aafd29d, 0x68df, 0x49ee, {0x8a, 0xa9, 0x34, 0x7d, 0x37, 0x56, 0x65, 0xa7} \ 266 } 267 268 //*********************************************************************** 269 // Image Execution Information Table Definition 270 //*********************************************************************** 271 typedef UINT32 EFI_IMAGE_EXECUTION_ACTION; 272 273 #define EFI_IMAGE_EXECUTION_AUTHENTICATION 0x00000007 274 #define EFI_IMAGE_EXECUTION_AUTH_UNTESTED 0x00000000 275 #define EFI_IMAGE_EXECUTION_AUTH_SIG_FAILED 0x00000001 276 #define EFI_IMAGE_EXECUTION_AUTH_SIG_PASSED 0x00000002 277 #define EFI_IMAGE_EXECUTION_AUTH_SIG_NOT_FOUND 0x00000003 278 #define EFI_IMAGE_EXECUTION_AUTH_SIG_FOUND 0x00000004 279 #define EFI_IMAGE_EXECUTION_POLICY_FAILED 0x00000005 280 #define EFI_IMAGE_EXECUTION_INITIALIZED 0x00000008 281 282 // 283 // EFI_IMAGE_EXECUTION_INFO is added to EFI System Configuration Table 284 // and assigned the GUID EFI_IMAGE_SECURITY_DATABASE_GUID. 285 // 286 typedef struct { 287 /// 288 /// Describes the action taken by the firmware regarding this image. 289 /// 290 EFI_IMAGE_EXECUTION_ACTION Action; 291 /// 292 /// Size of all of the entire structure. 293 /// 294 UINT32 InfoSize; 295 /// 296 /// If this image was a UEFI device driver (for option ROM, for example) this is the 297 /// null-terminated, user-friendly name for the device. If the image was for an application, 298 /// then this is the name of the application. If this cannot be determined, then a simple 299 /// NULL character should be put in this position. 300 /// CHAR16 Name[]; 301 /// 302 303 /// 304 /// For device drivers, this is the device path of the device for which this device driver 305 /// was intended. In some cases, the driver itself may be stored as part of the system 306 /// firmware, but this field should record the device's path, not the firmware path. For 307 /// applications, this is the device path of the application. If this cannot be determined, 308 /// a simple end-of-path device node should be put in this position. 309 /// EFI_DEVICE_PATH_PROTOCOL DevicePath; 310 /// 311 312 /// 313 /// Zero or more image signatures. If the image contained no signatures, 314 /// then this field is empty. 315 /// EFI_SIGNATURE_LIST Signature; 316 /// 317 } EFI_IMAGE_EXECUTION_INFO; 318 319 320 typedef struct { 321 /// 322 /// Number of EFI_IMAGE_EXECUTION_INFO structures. 323 /// 324 UINTN NumberOfImages; 325 /// 326 /// Number of image instances of EFI_IMAGE_EXECUTION_INFO structures. 327 /// 328 // EFI_IMAGE_EXECUTION_INFO InformationInfo[] 329 } EFI_IMAGE_EXECUTION_INFO_TABLE; 330 331 extern EFI_GUID gEfiImageSecurityDatabaseGuid; 332 extern EFI_GUID gEfiCertSha256Guid; 333 extern EFI_GUID gEfiCertRsa2048Guid; 334 extern EFI_GUID gEfiCertRsa2048Sha256Guid; 335 extern EFI_GUID gEfiCertSha1Guid; 336 extern EFI_GUID gEfiCertRsa2048Sha1Guid; 337 extern EFI_GUID gEfiCertX509Guid; 338 extern EFI_GUID gEfiCertSha224Guid; 339 extern EFI_GUID gEfiCertSha384Guid; 340 extern EFI_GUID gEfiCertSha512Guid; 341 extern EFI_GUID gEfiCertX509Sha256Guid; 342 extern EFI_GUID gEfiCertX509Sha384Guid; 343 extern EFI_GUID gEfiCertX509Sha512Guid; 344 extern EFI_GUID gEfiCertPkcs7Guid; 345 346 #endif 347