2 Platform Key, Key Exchange Key, and Image signature database are defined
3 for the signed image validation.
5 Copyright (c) 2009 - 2010, Intel Corporation
6 All rights reserved. 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
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.
14 @par Revision Reference:
15 GUIDs defined in UEFI 2.2 spec.
18 #ifndef __IMAGE_AUTHTICATION_H__
19 #define __IMAGE_AUTHTICATION_H__
21 #include <Guid/GlobalVariable.h>
23 #define EFI_IMAGE_SECURITY_DATABASE_GUID \
25 0xd719b2cb, 0x3d3a, 0x4596, { 0xa3, 0xbc, 0xda, 0xd0, 0xe, 0x67, 0x65, 0x6f } \
29 /// Varialbe name with guid EFI_IMAGE_SECURITY_DATABASE_GUID
30 /// for the authorized signature database.
32 #define EFI_IMAGE_SECURITY_DATABASE L"db"
34 /// Varialbe name with guid EFI_IMAGE_SECURITY_DATABASE_GUID
35 /// for the forbidden signature database.
37 #define EFI_IMAGE_SECURITY_DATABASE1 L"dbx"
42 /// Globally "SetupMode" variable to specify whether the system is currently operating
43 /// in setup mode (1) or not (0). All other values are reserved.
45 #define EFI_SETUP_MODE_NAME L"SetupMode"
47 /// Globally "PK" variable for the Platform Key Signature Database.
49 #define EFI_PLATFORM_KEY_NAME L"PK"
51 /// Globally "KEK" variable for the Key Exchange Key Signature Database.
53 #define EFI_KEY_EXCHANGE_KEY_NAME L"KEK"
55 /// Globally "SignatureSupport" variable returns an array of GUIDs,
56 /// with each GUID representing a type of signature which the platform
57 /// firmware supports for images and other data.
59 #define EFI_SIGNATURE_SUPPORT_NAME L"SignatureSupport"
61 //***********************************************************************
63 //***********************************************************************
65 /// The format of a signature database.
71 /// An identifier which identifies the agent which added the signature to the list.
73 EFI_GUID SignatureOwner
;
75 /// The format of the signature is defined by the SignatureType.
77 UINT8 SignatureData
[1];
82 /// Type of the signature. GUID signature types are defined in below.
84 EFI_GUID SignatureType
;
86 /// Total size of the signature list, including this header.
88 UINT32 SignatureListSize
;
90 /// Size of the signature header which precedes the array of signatures.
92 UINT32 SignatureHeaderSize
;
94 /// Size of each signature.
98 /// Header before the array of signatures. The format of this header is specified
99 /// by the SignatureType.
100 /// UINT8 SignatureHeader[SignatureHeaderSize];
102 /// An array of signatures. Each signature is SignatureSize bytes in length.
103 /// EFI_SIGNATURE_DATA Signatures[][SignatureSize];
105 } EFI_SIGNATURE_LIST
;
110 /// This identifies a signature containing a SHA-256 hash. The SignatureHeader size should
111 /// always be 0. The SignatureSize should always be 32 bytes.
113 #define EFI_CERT_SHA256_GUID \
115 0xc1c41626, 0x504c, 0x4092, {0xac, 0xa9, 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28} \
119 /// This identifies a signature containing an RSA-2048 key. The SignatureHeader size should
120 /// always be 0. The SignatureSize should always be 256 bytes.
122 #define EFI_CERT_RSA2048_GUID \
124 0x3c5766e8, 0x269c, 0x4e34, {0xaa, 0x14, 0xed, 0x77, 0x6e, 0x85, 0xb3, 0xb6} \
128 /// This identifies a signature containing a RSA-2048 signature of a SHA-256 hash. The
129 /// SignatureHeader size should always be 0. The SignatureSize should always be 256 bytes.
131 #define EFI_CERT_RSA2048_SHA256_GUID \
133 0xe2b36190, 0x879b, 0x4a3d, {0xad, 0x8d, 0xf2, 0xe7, 0xbb, 0xa3, 0x27, 0x84} \
137 /// This identifies a signature containing a SHA-1 hash. The SignatureHeader size should always
138 /// be 0. The SignatureSize should always be 20 bytes
140 #define EFI_CERT_SHA1_GUID \
142 0x826ca512, 0xcf10, 0x4ac9, {0xb1, 0x87, 0xbe, 0x1, 0x49, 0x66, 0x31, 0xbd} \
146 /// This identifies a signature containing a RSA-2048 signature of a SHA-1 hash. The
147 /// SignatureHeader size should always be 0. The SignatureSize should always be 256 bytes.
149 #define EFI_CERT_RSA2048_SHA1_GUID \
151 0x67f8444f, 0x8743, 0x48f1, {0xa3, 0x28, 0x1e, 0xaa, 0xb8, 0x73, 0x60, 0x80} \
155 /// This identifies a signature based on an X.509 certificate. If the signature is an X.509 certificate then
156 /// verification of the signature of an image should validate the public key certificate in the image using
157 /// certificate path verification, up to this X.509 certificate as a trusted root.
159 #define EFI_CERT_X509 \
161 0xa5c059a1, 0x94e4, 0x4aa7, {0x87, 0xb5, 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72} \
164 //***********************************************************************
165 // Image Execution Information Table Definition
166 //***********************************************************************
167 typedef UINT32 EFI_IMAGE_EXECUTION_ACTION
;
169 #define EFI_IMAGE_EXECUTION_AUTHENTICATION 0x00000007
170 #define EFI_IMAGE_EXECUTION_AUTH_UNTESTED 0x00000000
171 #define EFI_IMAGE_EXECUTION_AUTH_SIG_FAILED 0x00000001
172 #define EFI_IMAGE_EXECUTION_AUTH_SIG_PASSED 0x00000002
173 #define EFI_IMAGE_EXECUTION_AUTH_SIG_NOT_FOUND 0x00000003
174 #define EFI_IMAGE_EXECUTION_AUTH_SIG_FOUND 0x00000004
175 #define EFI_IMAGE_EXECUTION_POLICY_FAILED 0x00000005
176 #define EFI_IMAGE_EXECUTION_INITIALIZED 0x00000008
179 // EFI_IMAGE_EXECUTION_INFO is added to EFI System Configuration Table
180 // and assigned the GUID EFI_IMAGE_SECURITY_DATABASE_GUID.
184 /// Describes the action taken by the firmware regarding this image.
186 EFI_IMAGE_EXECUTION_ACTION Action
;
188 /// Size of all of the entire structure.
192 /// If this image was a UEFI device driver (for option ROM, for example) this is the
193 /// null-terminated, user-friendly name for the device. If the image was for an application,
194 /// then this is the name of the application. If this cannot be determined, then a simple
195 /// NULL character should be put in this position.
200 /// For device drivers, this is the device path of the device for which this device driver
201 /// was intended. In some cases, the driver itself may be stored as part of the system
202 /// firmware, but this field should record the device's path, not the firmware path. For
203 /// applications, this is the device path of the application. If this cannot be determined,
204 /// a simple end-of-path device node should be put in this position.
205 /// EFI_DEVICE_PATH_PROTOCOL DevicePath;
209 /// Zero or more image signatures. If the image contained no signatures,
210 /// then this field is empty.
212 EFI_SIGNATURE_LIST Signature
;
213 } EFI_IMAGE_EXECUTION_INFO
;
218 /// Number of EFI_IMAGE_EXECUTION_INFO structures.
220 UINTN NumberOfImages
;
222 /// Number of image instances of EFI_IMAGE_EXECUTION_INFO structures.
224 // EFI_IMAGE_EXECUTION_INFO InformationInfo[]
225 } EFI_IMAGE_EXECUTION_INFO_TABLE
;
227 extern EFI_GUID gEfiImageSecurityDatabaseGuid
;
228 extern EFI_GUID gEfiCertSha256Guid
;
229 extern EFI_GUID gEfiCertRsa2048Guid
;
230 extern EFI_GUID gEfiCertRsa2048Sha256Guid
;
231 extern EFI_GUID gEfiCertSha1Guid
;
232 extern EFI_GUID gEfiCertRsa2048Sha1Guid
;
233 extern EFI_GUID gEfiCertX509Guid
;