]>
Commit | Line | Data |
---|---|---|
3eb9473e | 1 | /*++\r |
2 | \r | |
f57387d5 HT |
3 | Copyright (c) 2004, Intel Corporation. All rights reserved.<BR>\r |
4 | This program and the accompanying materials \r | |
3eb9473e | 5 | are licensed and made available under the terms and conditions of the BSD License \r |
6 | which accompanies this distribution. The full text of the license may be found at \r | |
7 | http://opensource.org/licenses/bsd-license.php \r | |
8 | \r | |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
11 | \r | |
12 | Module Name:\r | |
13 | \r | |
14 | Bis.h\r | |
15 | \r | |
16 | Abstract:\r | |
17 | \r | |
18 | This file defines the BIS protocol.\r | |
19 | \r | |
20 | --*/\r | |
21 | \r | |
22 | #ifndef _BIS_H_\r | |
23 | #define _BIS_H_\r | |
24 | \r | |
25 | #include <EfiSpec.h>\r | |
26 | \r | |
27 | //\r | |
28 | // Basic types\r | |
29 | //\r | |
30 | typedef VOID *BIS_APPLICATION_HANDLE;\r | |
31 | typedef UINT16 BIS_ALG_ID;\r | |
32 | typedef UINT32 BIS_CERT_ID;\r | |
33 | \r | |
34 | //\r | |
35 | // EFI_BIS_DATA type.\r | |
36 | //\r | |
37 | // EFI_BIS_DATA instances obtained from BIS must be freed by calling Free( ).\r | |
38 | //\r | |
39 | typedef struct _EFI_BIS_DATA {\r | |
40 | UINT32 Length; // Length of Data in 8 bit bytes.\r | |
41 | UINT8 *Data; // 32 Bit Flat Address of data.\r | |
42 | } EFI_BIS_DATA;\r | |
43 | \r | |
44 | //\r | |
45 | // EFI_BIS_VERSION type.\r | |
46 | //\r | |
47 | typedef struct _EFI_BIS_VERSION {\r | |
48 | UINT32 Major; // BIS Interface version number.\r | |
49 | UINT32 Minor; // Build number.\r | |
50 | } EFI_BIS_VERSION;\r | |
51 | \r | |
52 | //\r | |
53 | // ----------------------------------------------------//\r | |
54 | // Use these values to initialize EFI_BIS_VERSION.Major\r | |
55 | // and to interpret results of Initialize.\r | |
56 | // ----------------------------------------------------//\r | |
57 | //\r | |
58 | #define BIS_CURRENT_VERSION_MAJOR BIS_VERSION_1\r | |
59 | #define BIS_VERSION_1 1\r | |
60 | \r | |
61 | //\r | |
62 | // EFI_BIS_SIGNATURE_INFO type.\r | |
63 | //\r | |
64 | typedef struct _EFI_BIS_SIGNATURE_INFO {\r | |
65 | BIS_CERT_ID CertificateID; // Truncated hash of platform Boot Object\r | |
66 | // authorization certificate.\r | |
67 | //\r | |
68 | BIS_ALG_ID AlgorithmID; // A signature algorithm number.\r | |
69 | UINT16 KeyLength; // Length of alg. keys in bits.\r | |
70 | } EFI_BIS_SIGNATURE_INFO;\r | |
71 | \r | |
72 | //\r | |
73 | // Currently defined values for EFI_BIS_SIGNATURE_INFO.AlgorithmID.\r | |
74 | // The exact numeric values come from\r | |
75 | // "Common Data Security Architecture (CDSA) Specification".\r | |
76 | //\r | |
77 | #define BIS_ALG_DSA (41) // CSSM_ALGID_DSA\r | |
78 | #define BIS_ALG_RSA_MD5 (42) // CSSM_ALGID_MD5_WITH_RSA\r | |
79 | // Currently defined values for EFI_BIS_SIGNATURE_INFO.CertificateId.\r | |
80 | //\r | |
81 | #define BIS_CERT_ID_DSA BIS_ALG_DSA // CSSM_ALGID_DSA\r | |
82 | #define BIS_CERT_ID_RSA_MD5 BIS_ALG_RSA_MD5 // CSSM_ALGID_MD5_WITH_RSA\r | |
83 | // The following is a mask value that gets applied to the truncated hash of a\r | |
84 | // platform Boot Object Authorization Certificate to create the certificateID.\r | |
85 | // A certificateID must not have any bits set to the value 1 other than bits in\r | |
86 | // this mask.\r | |
87 | //\r | |
88 | #define BIS_CERT_ID_MASK (0xFF7F7FFF)\r | |
89 | \r | |
90 | //\r | |
91 | // Macros for dealing with the EFI_BIS_DATA object obtained\r | |
92 | // from BIS_GetSignatureInfo()\r | |
93 | // BIS_GET_SIGINFO_COUNT - tells how many EFI_BIS_SIGNATURE_INFO\r | |
94 | // elements are contained in a EFI_BIS_DATA struct pointed to\r | |
95 | // by the provided EFI_BIS_DATA*.\r | |
96 | //\r | |
97 | #define BIS_GET_SIGINFO_COUNT(BisDataPtr) ((BisDataPtr)->Length / sizeof (EFI_BIS_SIGNATURE_INFO))\r | |
98 | \r | |
99 | //\r | |
100 | // BIS_GET_SIGINFO_ARRAY - produces a EFI_BIS_SIGNATURE_INFO*\r | |
101 | // from a given EFI_BIS_DATA*.\r | |
102 | //\r | |
103 | #define BIS_GET_SIGINFO_ARRAY(BisDataPtr) ((EFI_BIS_SIGNATURE_INFO *) (BisDataPtr)->Data)\r | |
104 | \r | |
105 | //\r | |
106 | // Binary Value of "X-Intel-BIS-ParameterSet" Attribute.\r | |
107 | // (Value is Base64 encoded in actual signed manifest).\r | |
108 | // {EDD35E31-07B9-11d2-83A3-00A0C91FADCF}\r | |
109 | //\r | |
110 | #define BOOT_OBJECT_AUTHORIZATION_PARMSET_GUIDVALUE \\r | |
111 | { \\r | |
112 | 0xedd35e31, 0x7b9, 0x11d2, \\r | |
113 | { \\r | |
114 | 0x83, 0xa3, 0x0, 0xa0, 0xc9, 0x1f, 0xad, 0xcf \\r | |
115 | } \\r | |
116 | }\r | |
117 | \r | |
118 | //\r | |
119 | // -----------------------------------//\r | |
120 | // EFI_BIS_PROTOCOL\r | |
121 | // -----------------------------------//\r | |
122 | //\r | |
123 | #define EFI_BIS_PROTOCOL_GUID \\r | |
124 | { \\r | |
7ccf38a3 | 125 | 0x0b64aab0, 0x5429, 0x11d4, {0x98, 0x16, 0x00, 0xa0, 0xc9, 0x1f, 0xad, 0xcf} \\r |
3eb9473e | 126 | }\r |
127 | \r | |
128 | typedef struct _EFI_BIS_PROTOCOL EFI_BIS_PROTOCOL;\r | |
129 | \r | |
130 | typedef\r | |
131 | EFI_STATUS\r | |
132 | (EFIAPI *EFI_BIS_INITIALIZE) (\r | |
133 | IN EFI_BIS_PROTOCOL * This, // this\r | |
134 | OUT BIS_APPLICATION_HANDLE * AppHandle, // Application handle.\r | |
135 | IN OUT EFI_BIS_VERSION * InterfaceVersion, // ver needed/available.\r | |
136 | IN EFI_BIS_DATA * TargetAddress // Address of BIS platform.\r | |
137 | );\r | |
138 | \r | |
139 | typedef\r | |
140 | EFI_STATUS\r | |
141 | (EFIAPI *EFI_BIS_FREE) (\r | |
142 | IN BIS_APPLICATION_HANDLE AppHandle, // From Initialize( ).\r | |
143 | IN EFI_BIS_DATA * ToFree // EFI_BIS_DATA being freed.\r | |
144 | );\r | |
145 | \r | |
146 | typedef\r | |
147 | EFI_STATUS\r | |
148 | (EFIAPI *EFI_BIS_SHUTDOWN) (\r | |
149 | IN BIS_APPLICATION_HANDLE AppHandle // From Initialize( ).\r | |
150 | );\r | |
151 | \r | |
152 | typedef\r | |
153 | EFI_STATUS\r | |
154 | (EFIAPI *EFI_BIS_GET_BOOT_OBJECT_AUTHORIZATION_CERTIFICATE) (\r | |
155 | IN BIS_APPLICATION_HANDLE AppHandle, // From Initialize( ).\r | |
156 | OUT EFI_BIS_DATA **Certificate // Pointer to certificate.\r | |
157 | );\r | |
158 | \r | |
159 | typedef\r | |
160 | EFI_STATUS\r | |
161 | (EFIAPI *EFI_BIS_VERIFY_BOOT_OBJECT) (\r | |
162 | IN BIS_APPLICATION_HANDLE AppHandle, // From Initialize( ).\r | |
163 | IN EFI_BIS_DATA * Credentials, // Verification signed manifest.\r | |
164 | IN EFI_BIS_DATA * DataObject, // Boot object to verify.\r | |
165 | OUT BOOLEAN *IsVerified // Result of verifcation.\r | |
166 | );\r | |
167 | \r | |
168 | typedef\r | |
169 | EFI_STATUS\r | |
170 | (EFIAPI *EFI_BIS_GET_BOOT_OBJECT_AUTHORIZATION_CHECKFLAG) (\r | |
171 | IN BIS_APPLICATION_HANDLE AppHandle, // From Initialize( ).\r | |
172 | OUT BOOLEAN *CheckIsRequired // Value of check flag.\r | |
173 | );\r | |
174 | \r | |
175 | typedef\r | |
176 | EFI_STATUS\r | |
177 | (EFIAPI *EFI_BIS_GET_BOOT_OBJECT_AUTHORIZATION_UPDATE_TOKEN) (\r | |
178 | IN BIS_APPLICATION_HANDLE AppHandle, // From Initialize( ).\r | |
179 | OUT EFI_BIS_DATA **UpdateToken // Value of update token.\r | |
180 | );\r | |
181 | \r | |
182 | typedef\r | |
183 | EFI_STATUS\r | |
184 | (EFIAPI *EFI_BIS_UPDATE_BOOT_OBJECT_AUTHORIZATION) (\r | |
185 | IN BIS_APPLICATION_HANDLE AppHandle, // From Initialize( ).\r | |
186 | IN EFI_BIS_DATA * RequestCredential, // Update Request Manifest.\r | |
187 | OUT EFI_BIS_DATA **NewUpdateToken // Next update token.\r | |
188 | );\r | |
189 | \r | |
190 | typedef\r | |
191 | EFI_STATUS\r | |
192 | (EFIAPI *EFI_BIS_VERIFY_OBJECT_WITH_CREDENTIAL) (\r | |
193 | IN BIS_APPLICATION_HANDLE AppHandle, // From Initialize( ).\r | |
194 | IN EFI_BIS_DATA * Credentials, // Verification signed manifest.\r | |
195 | IN EFI_BIS_DATA * DataObject, // Boot object to verify.\r | |
196 | IN EFI_BIS_DATA * SectionName, // Name of credential section to use.\r | |
197 | IN EFI_BIS_DATA * AuthorityCertificate, // Certificate for credentials.\r | |
198 | OUT BOOLEAN *IsVerified // Result of verifcation.\r | |
199 | );\r | |
200 | \r | |
201 | typedef\r | |
202 | EFI_STATUS\r | |
203 | (EFIAPI *EFI_BIS_GET_SIGNATURE_INFO) (\r | |
204 | IN BIS_APPLICATION_HANDLE AppHandle, // From Initialize( ).\r | |
205 | OUT EFI_BIS_DATA **SignatureInfo // Signature info struct.\r | |
206 | );\r | |
207 | \r | |
208 | #define EFI_BIS_PROTOCOL_REVISION 0x00010000\r | |
209 | \r | |
e5bce275 | 210 | struct _EFI_BIS_PROTOCOL {\r |
3eb9473e | 211 | //\r |
212 | // member vars\r | |
213 | //\r | |
214 | UINT64 Revision;\r | |
215 | \r | |
216 | //\r | |
217 | // methods\r | |
218 | //\r | |
219 | EFI_BIS_INITIALIZE Initialize;\r | |
220 | EFI_BIS_SHUTDOWN Shutdown;\r | |
221 | EFI_BIS_FREE Free;\r | |
222 | EFI_BIS_GET_BOOT_OBJECT_AUTHORIZATION_CERTIFICATE GetBootObjectAuthorizationCertificate;\r | |
223 | EFI_BIS_GET_BOOT_OBJECT_AUTHORIZATION_CHECKFLAG GetBootObjectAuthorizationCheckFlag;\r | |
224 | EFI_BIS_GET_BOOT_OBJECT_AUTHORIZATION_UPDATE_TOKEN GetBootObjectAuthorizationUpdateToken;\r | |
225 | EFI_BIS_GET_SIGNATURE_INFO GetSignatureInfo;\r | |
226 | EFI_BIS_UPDATE_BOOT_OBJECT_AUTHORIZATION UpdateBootObjectAuthorization;\r | |
227 | EFI_BIS_VERIFY_BOOT_OBJECT VerifyBootObject;\r | |
228 | EFI_BIS_VERIFY_OBJECT_WITH_CREDENTIAL VerifyObjectWithCredential;\r | |
e5bce275 | 229 | };\r |
3eb9473e | 230 | \r |
231 | extern EFI_GUID gEfiBisProtocolGuid;\r | |
232 | \r | |
233 | #endif\r |