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