]>
Commit | Line | Data |
---|---|---|
0c18794e | 1 | /** @file\r |
2 | Implement authentication services for the authenticated variable\r | |
3 | service in UEFI2.2.\r | |
4 | \r | |
dc204d5a JY |
5 | Caution: This module requires additional review when modified.\r |
6 | This driver will have external input - variable data. It may be input in SMM mode.\r | |
7 | This external input must be validated carefully to avoid security issue like\r | |
8 | buffer overflow, integer overflow.\r | |
9 | Variable attribute should also be checked to avoid authentication bypass.\r | |
10 | \r | |
11 | ProcessVarWithPk(), ProcessVarWithKek() and ProcessVariable() are the function to do\r | |
12 | variable authentication.\r | |
13 | \r | |
14 | VerifyTimeBasedPayload() and VerifyCounterBasedPayload() are sub function to do verification.\r | |
15 | They will do basic validation for authentication data structure, then call crypto library\r | |
16 | to verify the signature.\r | |
17 | \r | |
ecc722ad | 18 | Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>\r |
2d3fb919 | 19 | This program and the accompanying materials\r |
20 | are licensed and made available under the terms and conditions of the BSD License\r | |
21 | which accompanies this distribution. The full text of the license may be found at\r | |
0c18794e | 22 | http://opensource.org/licenses/bsd-license.php\r |
23 | \r | |
2d3fb919 | 24 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r |
0c18794e | 25 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r |
26 | \r | |
27 | **/\r | |
28 | \r | |
29 | #include "Variable.h"\r | |
30 | #include "AuthService.h"\r | |
31 | \r | |
32 | ///\r | |
33 | /// Global database array for scratch\r | |
2d3fb919 | 34 | ///\r |
0c18794e | 35 | UINT8 mPubKeyStore[MAX_KEYDB_SIZE];\r |
36 | UINT32 mPubKeyNumber;\r | |
37 | UINT32 mPlatformMode;\r | |
ae09f979 | 38 | EFI_GUID mSignatureSupport[] = {EFI_CERT_SHA1_GUID, EFI_CERT_SHA256_GUID, EFI_CERT_RSA2048_GUID, EFI_CERT_X509_GUID};\r |
0c18794e | 39 | //\r |
40 | // Public Exponent of RSA Key.\r | |
41 | //\r | |
42 | CONST UINT8 mRsaE[] = { 0x01, 0x00, 0x01 };\r | |
43 | //\r | |
44 | // Hash context pointer\r | |
45 | //\r | |
46 | VOID *mHashCtx = NULL;\r | |
47 | \r | |
0c18794e | 48 | //\r |
2d3fb919 | 49 | // Pointer to runtime buffer.\r |
50 | // For "Append" operation to an existing variable, a read/modify/write operation\r | |
51 | // is supported by firmware internally. Reserve runtime buffer to cache previous\r | |
0c18794e | 52 | // variable data in runtime phase because memory allocation is forbidden in virtual mode.\r |
53 | //\r | |
54 | VOID *mStorageArea = NULL;\r | |
55 | \r | |
2d3fb919 | 56 | //\r |
57 | // The serialization of the values of the VariableName, VendorGuid and Attributes\r | |
58 | // parameters of the SetVariable() call and the TimeStamp component of the\r | |
59 | // EFI_VARIABLE_AUTHENTICATION_2 descriptor followed by the variable's new value\r | |
60 | // i.e. (VariableName, VendorGuid, Attributes, TimeStamp, Data)\r | |
61 | //\r | |
62 | UINT8 *mSerializationRuntimeBuffer = NULL;\r | |
63 | \r | |
d912bad7 | 64 | //\r |
65 | // Requirement for different signature type which have been defined in UEFI spec.\r | |
66 | // These data are used to peform SignatureList format check while setting PK/KEK variable.\r | |
67 | //\r | |
68 | EFI_SIGNATURE_ITEM mSupportSigItem[] = {\r | |
69 | //{SigType, SigHeaderSize, SigDataSize }\r | |
70 | {EFI_CERT_SHA256_GUID, 0, 32 },\r | |
71 | {EFI_CERT_RSA2048_GUID, 0, 256 },\r | |
72 | {EFI_CERT_RSA2048_SHA256_GUID, 0, 256 },\r | |
73 | {EFI_CERT_SHA1_GUID, 0, 20 },\r | |
74 | {EFI_CERT_RSA2048_SHA1_GUID, 0, 256 },\r | |
75 | {EFI_CERT_X509_GUID, 0, ((UINT32) ~0)},\r | |
76 | {EFI_CERT_SHA224_GUID, 0, 28 },\r | |
77 | {EFI_CERT_SHA384_GUID, 0, 48 },\r | |
78 | {EFI_CERT_SHA512_GUID, 0, 64 }\r | |
79 | };\r | |
80 | \r | |
ecc722ad | 81 | /**\r |
82 | Determine whether this operation needs a physical present user.\r | |
83 | \r | |
84 | @param[in] VariableName Name of the Variable.\r | |
85 | @param[in] VendorGuid GUID of the Variable.\r | |
86 | \r | |
87 | @retval TRUE This variable is protected, only a physical present user could set this variable.\r | |
88 | @retval FALSE This variable is not protected.\r | |
89 | \r | |
90 | **/\r | |
91 | BOOLEAN\r | |
92 | NeedPhysicallyPresent(\r | |
93 | IN CHAR16 *VariableName,\r | |
94 | IN EFI_GUID *VendorGuid\r | |
95 | )\r | |
96 | {\r | |
97 | if ((CompareGuid (VendorGuid, &gEfiSecureBootEnableDisableGuid) && (StrCmp (VariableName, EFI_SECURE_BOOT_ENABLE_NAME) == 0))\r | |
98 | || (CompareGuid (VendorGuid, &gEfiCustomModeEnableGuid) && (StrCmp (VariableName, EFI_CUSTOM_MODE_NAME) == 0))) {\r | |
99 | return TRUE;\r | |
100 | }\r | |
101 | \r | |
102 | return FALSE;\r | |
103 | }\r | |
104 | \r | |
105 | /**\r | |
106 | Determine whether the platform is operating in Custom Secure Boot mode.\r | |
107 | \r | |
108 | @retval TRUE The platform is operating in Custom mode.\r | |
109 | @retval FALSE The platform is operating in Standard mode.\r | |
110 | \r | |
111 | **/\r | |
112 | BOOLEAN\r | |
113 | InCustomMode (\r | |
114 | VOID\r | |
115 | )\r | |
116 | {\r | |
117 | VARIABLE_POINTER_TRACK Variable;\r | |
118 | \r | |
119 | FindVariable (EFI_CUSTOM_MODE_NAME, &gEfiCustomModeEnableGuid, &Variable, &mVariableModuleGlobal->VariableGlobal, FALSE);\r | |
120 | if (Variable.CurrPtr != NULL && *(GetVariableDataPtr (Variable.CurrPtr)) == CUSTOM_SECURE_BOOT_MODE) {\r | |
121 | return TRUE;\r | |
122 | }\r | |
123 | \r | |
124 | return FALSE;\r | |
125 | }\r | |
126 | \r | |
127 | \r | |
0c18794e | 128 | /**\r |
2d3fb919 | 129 | Internal function to delete a Variable given its name and GUID, no authentication\r |
130 | required.\r | |
0c18794e | 131 | \r |
2d3fb919 | 132 | @param[in] VariableName Name of the Variable.\r |
133 | @param[in] VendorGuid GUID of the Variable.\r | |
0c18794e | 134 | \r |
2d3fb919 | 135 | @retval EFI_SUCCESS Variable deleted successfully.\r |
136 | @retval Others The driver failded to start the device.\r | |
0c18794e | 137 | \r |
138 | **/\r | |
139 | EFI_STATUS\r | |
2d3fb919 | 140 | DeleteVariable (\r |
141 | IN CHAR16 *VariableName,\r | |
142 | IN EFI_GUID *VendorGuid\r | |
143 | )\r | |
144 | {\r | |
145 | EFI_STATUS Status;\r | |
146 | VARIABLE_POINTER_TRACK Variable;\r | |
147 | \r | |
ecc722ad | 148 | Status = FindVariable (VariableName, VendorGuid, &Variable, &mVariableModuleGlobal->VariableGlobal, FALSE);\r |
2d3fb919 | 149 | if (EFI_ERROR (Status)) {\r |
150 | return EFI_SUCCESS;\r | |
151 | }\r | |
152 | \r | |
153 | ASSERT (Variable.CurrPtr != NULL);\r | |
154 | return UpdateVariable (VariableName, VendorGuid, NULL, 0, 0, 0, 0, &Variable, NULL);\r | |
155 | }\r | |
0c18794e | 156 | \r |
157 | /**\r | |
158 | Initializes for authenticated varibale service.\r | |
159 | \r | |
160 | @retval EFI_SUCCESS Function successfully executed.\r | |
161 | @retval EFI_OUT_OF_RESOURCES Fail to allocate enough memory resources.\r | |
162 | \r | |
163 | **/\r | |
164 | EFI_STATUS\r | |
165 | AutenticatedVariableServiceInitialize (\r | |
166 | VOID\r | |
167 | )\r | |
168 | {\r | |
169 | EFI_STATUS Status;\r | |
170 | VARIABLE_POINTER_TRACK Variable;\r | |
7aaf2fd6 | 171 | VARIABLE_POINTER_TRACK PkVariable;\r |
0c18794e | 172 | UINT8 VarValue;\r |
173 | UINT32 VarAttr;\r | |
174 | UINT8 *Data;\r | |
175 | UINTN DataSize;\r | |
176 | UINTN CtxSize;\r | |
beda2356 | 177 | UINT8 SecureBootMode;\r |
178 | UINT8 SecureBootEnable;\r | |
ecc722ad | 179 | UINT8 CustomMode;\r |
ed47ae02 | 180 | UINT32 ListSize;\r |
2d3fb919 | 181 | \r |
0c18794e | 182 | //\r |
183 | // Initialize hash context.\r | |
184 | //\r | |
185 | CtxSize = Sha256GetContextSize ();\r | |
186 | mHashCtx = AllocateRuntimePool (CtxSize);\r | |
187 | if (mHashCtx == NULL) {\r | |
188 | return EFI_OUT_OF_RESOURCES;\r | |
189 | }\r | |
190 | \r | |
191 | //\r | |
192 | // Reserved runtime buffer for "Append" operation in virtual mode.\r | |
193 | //\r | |
2d3fb919 | 194 | mStorageArea = AllocateRuntimePool (PcdGet32 (PcdMaxVariableSize));\r |
0c18794e | 195 | if (mStorageArea == NULL) {\r |
196 | return EFI_OUT_OF_RESOURCES;\r | |
197 | }\r | |
198 | \r | |
199 | //\r | |
2d3fb919 | 200 | // Prepare runtime buffer for serialized data of time-based authenticated\r |
201 | // Variable, i.e. (VariableName, VendorGuid, Attributes, TimeStamp, Data).\r | |
202 | //\r | |
203 | mSerializationRuntimeBuffer = AllocateRuntimePool (PcdGet32 (PcdMaxVariableSize) + sizeof (EFI_GUID) + sizeof (UINT32) + sizeof (EFI_TIME));\r | |
204 | if (mSerializationRuntimeBuffer == NULL) {\r | |
205 | return EFI_OUT_OF_RESOURCES;\r | |
206 | }\r | |
207 | \r | |
208 | //\r | |
209 | // Check "AuthVarKeyDatabase" variable's existence.\r | |
210 | // If it doesn't exist, create a new one with initial value of 0 and EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS set.\r | |
0c18794e | 211 | //\r |
212 | Status = FindVariable (\r | |
2d3fb919 | 213 | AUTHVAR_KEYDB_NAME,\r |
214 | &gEfiAuthenticatedVariableGuid,\r | |
215 | &Variable,\r | |
ecc722ad | 216 | &mVariableModuleGlobal->VariableGlobal,\r |
217 | FALSE\r | |
0c18794e | 218 | );\r |
219 | \r | |
220 | if (Variable.CurrPtr == NULL) {\r | |
221 | VarAttr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS;\r | |
222 | VarValue = 0;\r | |
223 | mPubKeyNumber = 0;\r | |
224 | Status = UpdateVariable (\r | |
225 | AUTHVAR_KEYDB_NAME,\r | |
226 | &gEfiAuthenticatedVariableGuid,\r | |
227 | &VarValue,\r | |
228 | sizeof(UINT8),\r | |
229 | VarAttr,\r | |
230 | 0,\r | |
231 | 0,\r | |
232 | &Variable,\r | |
233 | NULL\r | |
234 | );\r | |
235 | if (EFI_ERROR (Status)) {\r | |
236 | return Status;\r | |
237 | }\r | |
238 | } else {\r | |
239 | //\r | |
240 | // Load database in global variable for cache.\r | |
241 | //\r | |
242 | DataSize = DataSizeOfVariable (Variable.CurrPtr);\r | |
243 | Data = GetVariableDataPtr (Variable.CurrPtr);\r | |
244 | ASSERT ((DataSize != 0) && (Data != NULL));\r | |
245 | CopyMem (mPubKeyStore, (UINT8 *) Data, DataSize);\r | |
246 | mPubKeyNumber = (UINT32) (DataSize / EFI_CERT_TYPE_RSA2048_SIZE);\r | |
247 | }\r | |
7aaf2fd6 | 248 | \r |
ecc722ad | 249 | FindVariable (EFI_PLATFORM_KEY_NAME, &gEfiGlobalVariableGuid, &PkVariable, &mVariableModuleGlobal->VariableGlobal, FALSE);\r |
7aaf2fd6 | 250 | if (PkVariable.CurrPtr == NULL) {\r |
251 | DEBUG ((EFI_D_INFO, "Variable %s does not exist.\n", EFI_PLATFORM_KEY_NAME));\r | |
252 | } else {\r | |
253 | DEBUG ((EFI_D_INFO, "Variable %s exists.\n", EFI_PLATFORM_KEY_NAME));\r | |
254 | }\r | |
255 | \r | |
0c18794e | 256 | //\r |
05a643f9 | 257 | // Create "SetupMode" varable with BS+RT attribute set.\r |
0c18794e | 258 | //\r |
05a643f9 | 259 | FindVariable (EFI_SETUP_MODE_NAME, &gEfiGlobalVariableGuid, &Variable, &mVariableModuleGlobal->VariableGlobal, FALSE);\r |
260 | if (PkVariable.CurrPtr == NULL) {\r | |
261 | mPlatformMode = SETUP_MODE;\r | |
262 | } else {\r | |
263 | mPlatformMode = USER_MODE;\r | |
264 | }\r | |
265 | Status = UpdateVariable (\r | |
2d3fb919 | 266 | EFI_SETUP_MODE_NAME,\r |
267 | &gEfiGlobalVariableGuid,\r | |
05a643f9 | 268 | &mPlatformMode,\r |
269 | sizeof(UINT8),\r | |
270 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r | |
271 | 0,\r | |
272 | 0,\r | |
2d3fb919 | 273 | &Variable,\r |
05a643f9 | 274 | NULL\r |
0c18794e | 275 | );\r |
05a643f9 | 276 | if (EFI_ERROR (Status)) {\r |
277 | return Status;\r | |
0c18794e | 278 | }\r |
05a643f9 | 279 | \r |
0c18794e | 280 | //\r |
05a643f9 | 281 | // Create "SignatureSupport" varable with BS+RT attribute set.\r |
0c18794e | 282 | //\r |
05a643f9 | 283 | FindVariable (EFI_SIGNATURE_SUPPORT_NAME, &gEfiGlobalVariableGuid, &Variable, &mVariableModuleGlobal->VariableGlobal, FALSE);\r |
284 | Status = UpdateVariable (\r | |
285 | EFI_SIGNATURE_SUPPORT_NAME,\r | |
286 | &gEfiGlobalVariableGuid,\r | |
287 | mSignatureSupport,\r | |
288 | sizeof(mSignatureSupport),\r | |
289 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r | |
290 | 0,\r | |
291 | 0,\r | |
292 | &Variable,\r | |
293 | NULL\r | |
294 | );\r | |
295 | if (EFI_ERROR (Status)) {\r | |
296 | return Status;\r | |
0c18794e | 297 | }\r |
beda2356 | 298 | \r |
299 | //\r | |
300 | // If "SecureBootEnable" variable exists, then update "SecureBoot" variable.\r | |
2d3fb919 | 301 | // If "SecureBootEnable" variable is SECURE_BOOT_ENABLE and in USER_MODE, Set "SecureBoot" variable to SECURE_BOOT_MODE_ENABLE.\r |
beda2356 | 302 | // If "SecureBootEnable" variable is SECURE_BOOT_DISABLE, Set "SecureBoot" variable to SECURE_BOOT_MODE_DISABLE.\r |
303 | //\r | |
8f8ca22e | 304 | SecureBootEnable = SECURE_BOOT_DISABLE;\r |
ecc722ad | 305 | FindVariable (EFI_SECURE_BOOT_ENABLE_NAME, &gEfiSecureBootEnableDisableGuid, &Variable, &mVariableModuleGlobal->VariableGlobal, FALSE);\r |
beda2356 | 306 | if (Variable.CurrPtr != NULL) {\r |
307 | SecureBootEnable = *(GetVariableDataPtr (Variable.CurrPtr));\r | |
2d3fb919 | 308 | } else if (mPlatformMode == USER_MODE) {\r |
309 | //\r | |
310 | // "SecureBootEnable" not exist, initialize it in USER_MODE.\r | |
311 | //\r | |
8f8ca22e | 312 | SecureBootEnable = SECURE_BOOT_ENABLE;\r |
beda2356 | 313 | Status = UpdateVariable (\r |
2d3fb919 | 314 | EFI_SECURE_BOOT_ENABLE_NAME,\r |
315 | &gEfiSecureBootEnableDisableGuid,\r | |
316 | &SecureBootEnable,\r | |
317 | sizeof (UINT8),\r | |
318 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r | |
319 | 0,\r | |
320 | 0,\r | |
beda2356 | 321 | &Variable,\r |
322 | NULL\r | |
323 | );\r | |
324 | if (EFI_ERROR (Status)) {\r | |
325 | return Status;\r | |
326 | }\r | |
327 | }\r | |
328 | \r | |
05a643f9 | 329 | //\r |
330 | // Create "SecureBoot" varable with BS+RT attribute set.\r | |
331 | //\r | |
2d3fb919 | 332 | if (SecureBootEnable == SECURE_BOOT_ENABLE && mPlatformMode == USER_MODE) {\r |
333 | SecureBootMode = SECURE_BOOT_MODE_ENABLE;\r | |
334 | } else {\r | |
335 | SecureBootMode = SECURE_BOOT_MODE_DISABLE;\r | |
336 | }\r | |
ecc722ad | 337 | FindVariable (EFI_SECURE_BOOT_MODE_NAME, &gEfiGlobalVariableGuid, &Variable, &mVariableModuleGlobal->VariableGlobal, FALSE);\r |
2d3fb919 | 338 | Status = UpdateVariable (\r |
339 | EFI_SECURE_BOOT_MODE_NAME,\r | |
340 | &gEfiGlobalVariableGuid,\r | |
341 | &SecureBootMode,\r | |
342 | sizeof (UINT8),\r | |
05a643f9 | 343 | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r |
2d3fb919 | 344 | 0,\r |
345 | 0,\r | |
346 | &Variable,\r | |
347 | NULL\r | |
348 | );\r | |
349 | if (EFI_ERROR (Status)) {\r | |
350 | return Status;\r | |
351 | }\r | |
352 | \r | |
7aaf2fd6 | 353 | DEBUG ((EFI_D_INFO, "Variable %s is %x\n", EFI_SETUP_MODE_NAME, mPlatformMode));\r |
354 | DEBUG ((EFI_D_INFO, "Variable %s is %x\n", EFI_SECURE_BOOT_MODE_NAME, SecureBootMode));\r | |
355 | DEBUG ((EFI_D_INFO, "Variable %s is %x\n", EFI_SECURE_BOOT_ENABLE_NAME, SecureBootEnable));\r | |
356 | \r | |
0c18794e | 357 | //\r |
ecc722ad | 358 | // Check "CustomMode" variable's existence.\r |
0c18794e | 359 | //\r |
ecc722ad | 360 | FindVariable (EFI_CUSTOM_MODE_NAME, &gEfiCustomModeEnableGuid, &Variable, &mVariableModuleGlobal->VariableGlobal, FALSE);\r |
361 | if (Variable.CurrPtr != NULL) {\r | |
362 | CustomMode = *(GetVariableDataPtr (Variable.CurrPtr));\r | |
363 | } else {\r | |
0c18794e | 364 | //\r |
ecc722ad | 365 | // "CustomMode" not exist, initialize it in STANDARD_SECURE_BOOT_MODE.\r |
0c18794e | 366 | //\r |
ecc722ad | 367 | CustomMode = STANDARD_SECURE_BOOT_MODE;\r |
368 | Status = UpdateVariable (\r | |
369 | EFI_CUSTOM_MODE_NAME,\r | |
370 | &gEfiCustomModeEnableGuid,\r | |
371 | &CustomMode,\r | |
372 | sizeof (UINT8),\r | |
373 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r | |
374 | 0,\r | |
375 | 0,\r | |
376 | &Variable,\r | |
377 | NULL\r | |
378 | );\r | |
2d3fb919 | 379 | if (EFI_ERROR (Status)) {\r |
380 | return Status;\r | |
0c18794e | 381 | }\r |
0c18794e | 382 | }\r |
ecc722ad | 383 | \r |
384 | DEBUG ((EFI_D_INFO, "Variable %s is %x\n", EFI_CUSTOM_MODE_NAME, CustomMode));\r | |
2d3fb919 | 385 | \r |
ed47ae02 | 386 | //\r |
387 | // Check "certdb" variable's existence.\r | |
388 | // If it doesn't exist, then create a new one with \r | |
389 | // EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set.\r | |
390 | //\r | |
391 | Status = FindVariable (\r | |
392 | EFI_CERT_DB_NAME,\r | |
393 | &gEfiCertDbGuid,\r | |
394 | &Variable,\r | |
395 | &mVariableModuleGlobal->VariableGlobal,\r | |
396 | FALSE\r | |
397 | );\r | |
398 | \r | |
399 | if (Variable.CurrPtr == NULL) {\r | |
400 | VarAttr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;\r | |
401 | ListSize = 0;\r | |
402 | Status = UpdateVariable (\r | |
403 | EFI_CERT_DB_NAME,\r | |
404 | &gEfiCertDbGuid,\r | |
405 | &ListSize,\r | |
406 | sizeof (UINT32),\r | |
407 | VarAttr,\r | |
408 | 0,\r | |
409 | 0,\r | |
410 | &Variable,\r | |
411 | NULL\r | |
412 | );\r | |
413 | \r | |
414 | } \r | |
415 | \r | |
0c18794e | 416 | return Status;\r |
417 | }\r | |
418 | \r | |
419 | /**\r | |
420 | Add public key in store and return its index.\r | |
421 | \r | |
422 | @param[in] PubKey Input pointer to Public Key data\r | |
423 | \r | |
424 | @return Index of new added item\r | |
425 | \r | |
426 | **/\r | |
427 | UINT32\r | |
428 | AddPubKeyInStore (\r | |
429 | IN UINT8 *PubKey\r | |
430 | )\r | |
431 | {\r | |
432 | EFI_STATUS Status;\r | |
433 | BOOLEAN IsFound;\r | |
434 | UINT32 Index;\r | |
435 | VARIABLE_POINTER_TRACK Variable;\r | |
436 | UINT8 *Ptr;\r | |
437 | \r | |
438 | if (PubKey == NULL) {\r | |
439 | return 0;\r | |
440 | }\r | |
441 | \r | |
442 | Status = FindVariable (\r | |
443 | AUTHVAR_KEYDB_NAME,\r | |
444 | &gEfiAuthenticatedVariableGuid,\r | |
445 | &Variable,\r | |
ecc722ad | 446 | &mVariableModuleGlobal->VariableGlobal,\r |
447 | FALSE\r | |
0c18794e | 448 | );\r |
449 | ASSERT_EFI_ERROR (Status);\r | |
450 | //\r | |
451 | // Check whether the public key entry does exist.\r | |
452 | //\r | |
453 | IsFound = FALSE;\r | |
454 | for (Ptr = mPubKeyStore, Index = 1; Index <= mPubKeyNumber; Index++) {\r | |
455 | if (CompareMem (Ptr, PubKey, EFI_CERT_TYPE_RSA2048_SIZE) == 0) {\r | |
456 | IsFound = TRUE;\r | |
457 | break;\r | |
458 | }\r | |
459 | Ptr += EFI_CERT_TYPE_RSA2048_SIZE;\r | |
460 | }\r | |
461 | \r | |
462 | if (!IsFound) {\r | |
463 | //\r | |
464 | // Add public key in database.\r | |
465 | //\r | |
466 | if (mPubKeyNumber == MAX_KEY_NUM) {\r | |
467 | //\r | |
468 | // Notes: Database is full, need enhancement here, currently just return 0.\r | |
469 | //\r | |
470 | return 0;\r | |
471 | }\r | |
472 | \r | |
473 | CopyMem (mPubKeyStore + mPubKeyNumber * EFI_CERT_TYPE_RSA2048_SIZE, PubKey, EFI_CERT_TYPE_RSA2048_SIZE);\r | |
474 | Index = ++mPubKeyNumber;\r | |
475 | //\r | |
476 | // Update public key database variable.\r | |
477 | //\r | |
478 | Status = UpdateVariable (\r | |
479 | AUTHVAR_KEYDB_NAME,\r | |
480 | &gEfiAuthenticatedVariableGuid,\r | |
481 | mPubKeyStore,\r | |
482 | mPubKeyNumber * EFI_CERT_TYPE_RSA2048_SIZE,\r | |
483 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS,\r | |
484 | 0,\r | |
485 | 0,\r | |
486 | &Variable,\r | |
487 | NULL\r | |
488 | );\r | |
489 | ASSERT_EFI_ERROR (Status);\r | |
490 | }\r | |
491 | \r | |
492 | return Index;\r | |
493 | }\r | |
494 | \r | |
495 | /**\r | |
85560919 | 496 | Verify data payload with AuthInfo in EFI_CERT_TYPE_RSA2048_SHA256_GUID type.\r |
0c18794e | 497 | Follow the steps in UEFI2.2.\r |
498 | \r | |
dc204d5a JY |
499 | Caution: This function may receive untrusted input.\r |
500 | This function may be invoked in SMM mode, and datasize and data are external input.\r | |
501 | This function will do basic validation, before parse the data.\r | |
502 | This function will parse the authentication carefully to avoid security issues, like\r | |
503 | buffer overflow, integer overflow.\r | |
504 | \r | |
0c18794e | 505 | @param[in] Data Pointer to data with AuthInfo.\r |
506 | @param[in] DataSize Size of Data.\r | |
507 | @param[in] PubKey Public key used for verification.\r | |
508 | \r | |
2d3fb919 | 509 | @retval EFI_INVALID_PARAMETER Invalid parameter.\r |
0c18794e | 510 | @retval EFI_SECURITY_VIOLATION If authentication failed.\r |
2d3fb919 | 511 | @retval EFI_SUCCESS Authentication successful.\r |
0c18794e | 512 | \r |
513 | **/\r | |
514 | EFI_STATUS\r | |
515 | VerifyCounterBasedPayload (\r | |
516 | IN UINT8 *Data,\r | |
517 | IN UINTN DataSize,\r | |
518 | IN UINT8 *PubKey\r | |
519 | )\r | |
520 | {\r | |
521 | BOOLEAN Status;\r | |
522 | EFI_VARIABLE_AUTHENTICATION *CertData;\r | |
523 | EFI_CERT_BLOCK_RSA_2048_SHA256 *CertBlock;\r | |
524 | UINT8 Digest[SHA256_DIGEST_SIZE];\r | |
525 | VOID *Rsa;\r | |
526 | \r | |
527 | Rsa = NULL;\r | |
528 | CertData = NULL;\r | |
529 | CertBlock = NULL;\r | |
530 | \r | |
531 | if (Data == NULL || PubKey == NULL) {\r | |
532 | return EFI_INVALID_PARAMETER;\r | |
533 | }\r | |
534 | \r | |
535 | CertData = (EFI_VARIABLE_AUTHENTICATION *) Data;\r | |
536 | CertBlock = (EFI_CERT_BLOCK_RSA_2048_SHA256 *) (CertData->AuthInfo.CertData);\r | |
537 | \r | |
538 | //\r | |
539 | // wCertificateType should be WIN_CERT_TYPE_EFI_GUID.\r | |
85560919 | 540 | // Cert type should be EFI_CERT_TYPE_RSA2048_SHA256_GUID.\r |
0c18794e | 541 | //\r |
542 | if ((CertData->AuthInfo.Hdr.wCertificateType != WIN_CERT_TYPE_EFI_GUID) ||\r | |
85560919 | 543 | !CompareGuid (&CertData->AuthInfo.CertType, &gEfiCertTypeRsa2048Sha256Guid)\r |
0c18794e | 544 | ) {\r |
545 | //\r | |
546 | // Invalid AuthInfo type, return EFI_SECURITY_VIOLATION.\r | |
547 | //\r | |
548 | return EFI_SECURITY_VIOLATION;\r | |
549 | }\r | |
550 | //\r | |
551 | // Hash data payload with SHA256.\r | |
552 | //\r | |
553 | ZeroMem (Digest, SHA256_DIGEST_SIZE);\r | |
554 | Status = Sha256Init (mHashCtx);\r | |
555 | if (!Status) {\r | |
556 | goto Done;\r | |
557 | }\r | |
558 | Status = Sha256Update (mHashCtx, Data + AUTHINFO_SIZE, (UINTN) (DataSize - AUTHINFO_SIZE));\r | |
559 | if (!Status) {\r | |
560 | goto Done;\r | |
561 | }\r | |
562 | //\r | |
563 | // Hash Monotonic Count.\r | |
564 | //\r | |
565 | Status = Sha256Update (mHashCtx, &CertData->MonotonicCount, sizeof (UINT64));\r | |
566 | if (!Status) {\r | |
567 | goto Done;\r | |
568 | }\r | |
569 | Status = Sha256Final (mHashCtx, Digest);\r | |
570 | if (!Status) {\r | |
571 | goto Done;\r | |
572 | }\r | |
573 | //\r | |
574 | // Generate & Initialize RSA Context.\r | |
575 | //\r | |
576 | Rsa = RsaNew ();\r | |
577 | ASSERT (Rsa != NULL);\r | |
2d3fb919 | 578 | //\r |
0c18794e | 579 | // Set RSA Key Components.\r |
580 | // NOTE: Only N and E are needed to be set as RSA public key for signature verification.\r | |
581 | //\r | |
582 | Status = RsaSetKey (Rsa, RsaKeyN, PubKey, EFI_CERT_TYPE_RSA2048_SIZE);\r | |
583 | if (!Status) {\r | |
584 | goto Done;\r | |
585 | }\r | |
586 | Status = RsaSetKey (Rsa, RsaKeyE, mRsaE, sizeof (mRsaE));\r | |
587 | if (!Status) {\r | |
588 | goto Done;\r | |
589 | }\r | |
590 | //\r | |
591 | // Verify the signature.\r | |
592 | //\r | |
593 | Status = RsaPkcs1Verify (\r | |
2d3fb919 | 594 | Rsa,\r |
595 | Digest,\r | |
596 | SHA256_DIGEST_SIZE,\r | |
597 | CertBlock->Signature,\r | |
0c18794e | 598 | EFI_CERT_TYPE_RSA2048_SHA256_SIZE\r |
599 | );\r | |
600 | \r | |
601 | Done:\r | |
602 | if (Rsa != NULL) {\r | |
603 | RsaFree (Rsa);\r | |
604 | }\r | |
605 | if (Status) {\r | |
606 | return EFI_SUCCESS;\r | |
607 | } else {\r | |
608 | return EFI_SECURITY_VIOLATION;\r | |
609 | }\r | |
610 | }\r | |
611 | \r | |
0c18794e | 612 | /**\r |
613 | Update platform mode.\r | |
614 | \r | |
615 | @param[in] Mode SETUP_MODE or USER_MODE.\r | |
616 | \r | |
617 | @return EFI_INVALID_PARAMETER Invalid parameter.\r | |
618 | @return EFI_SUCCESS Update platform mode successfully.\r | |
619 | \r | |
620 | **/\r | |
621 | EFI_STATUS\r | |
622 | UpdatePlatformMode (\r | |
623 | IN UINT32 Mode\r | |
624 | )\r | |
625 | {\r | |
626 | EFI_STATUS Status;\r | |
627 | VARIABLE_POINTER_TRACK Variable;\r | |
628 | UINT32 VarAttr;\r | |
629 | UINT8 SecureBootMode;\r | |
beda2356 | 630 | UINT8 SecureBootEnable;\r |
631 | UINTN VariableDataSize;\r | |
2d3fb919 | 632 | \r |
0c18794e | 633 | Status = FindVariable (\r |
2d3fb919 | 634 | EFI_SETUP_MODE_NAME,\r |
635 | &gEfiGlobalVariableGuid,\r | |
636 | &Variable,\r | |
ecc722ad | 637 | &mVariableModuleGlobal->VariableGlobal,\r |
638 | FALSE\r | |
0c18794e | 639 | );\r |
640 | if (EFI_ERROR (Status)) {\r | |
641 | return Status;\r | |
642 | }\r | |
643 | \r | |
05a643f9 | 644 | //\r |
645 | // Update the value of SetupMode variable by a simple mem copy, this could avoid possible\r | |
646 | // variable storage reclaim at runtime.\r | |
647 | //\r | |
648 | mPlatformMode = (UINT8) Mode;\r | |
649 | CopyMem (GetVariableDataPtr (Variable.CurrPtr), &mPlatformMode, sizeof(UINT8));\r | |
0c18794e | 650 | \r |
2d3fb919 | 651 | if (AtRuntime ()) {\r |
652 | //\r | |
653 | // SecureBoot Variable indicates whether the platform firmware is operating\r | |
654 | // in Secure boot mode (1) or not (0), so we should not change SecureBoot\r | |
655 | // Variable in runtime.\r | |
656 | //\r | |
657 | return Status;\r | |
658 | }\r | |
659 | \r | |
0c18794e | 660 | //\r |
661 | // Check "SecureBoot" variable's existence.\r | |
662 | // If it doesn't exist, firmware has no capability to perform driver signing verification,\r | |
663 | // then set "SecureBoot" to 0.\r | |
664 | //\r | |
665 | Status = FindVariable (\r | |
2d3fb919 | 666 | EFI_SECURE_BOOT_MODE_NAME,\r |
667 | &gEfiGlobalVariableGuid,\r | |
668 | &Variable,\r | |
ecc722ad | 669 | &mVariableModuleGlobal->VariableGlobal,\r |
670 | FALSE\r | |
0c18794e | 671 | );\r |
672 | //\r | |
673 | // If "SecureBoot" variable exists, then check "SetupMode" variable update.\r | |
674 | // If "SetupMode" variable is USER_MODE, "SecureBoot" variable is set to 1.\r | |
675 | // If "SetupMode" variable is SETUP_MODE, "SecureBoot" variable is set to 0.\r | |
676 | //\r | |
677 | if (Variable.CurrPtr == NULL) {\r | |
678 | SecureBootMode = SECURE_BOOT_MODE_DISABLE;\r | |
679 | } else {\r | |
680 | if (mPlatformMode == USER_MODE) {\r | |
681 | SecureBootMode = SECURE_BOOT_MODE_ENABLE;\r | |
682 | } else if (mPlatformMode == SETUP_MODE) {\r | |
683 | SecureBootMode = SECURE_BOOT_MODE_DISABLE;\r | |
684 | } else {\r | |
685 | return EFI_NOT_FOUND;\r | |
686 | }\r | |
687 | }\r | |
688 | \r | |
2d3fb919 | 689 | VarAttr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS;\r |
beda2356 | 690 | Status = UpdateVariable (\r |
0c18794e | 691 | EFI_SECURE_BOOT_MODE_NAME,\r |
692 | &gEfiGlobalVariableGuid,\r | |
693 | &SecureBootMode,\r | |
694 | sizeof(UINT8),\r | |
695 | VarAttr,\r | |
696 | 0,\r | |
697 | 0,\r | |
698 | &Variable,\r | |
699 | NULL\r | |
700 | );\r | |
beda2356 | 701 | if (EFI_ERROR (Status)) {\r |
702 | return Status;\r | |
703 | }\r | |
704 | \r | |
705 | //\r | |
706 | // Check "SecureBootEnable" variable's existence. It can enable/disable secure boot feature.\r | |
707 | //\r | |
708 | Status = FindVariable (\r | |
2d3fb919 | 709 | EFI_SECURE_BOOT_ENABLE_NAME,\r |
710 | &gEfiSecureBootEnableDisableGuid,\r | |
711 | &Variable,\r | |
ecc722ad | 712 | &mVariableModuleGlobal->VariableGlobal,\r |
713 | FALSE\r | |
beda2356 | 714 | );\r |
2d3fb919 | 715 | \r |
beda2356 | 716 | if (SecureBootMode == SECURE_BOOT_MODE_ENABLE) {\r |
717 | //\r | |
718 | // Create the "SecureBootEnable" variable as secure boot is enabled.\r | |
719 | //\r | |
720 | SecureBootEnable = SECURE_BOOT_ENABLE;\r | |
721 | VariableDataSize = sizeof (SecureBootEnable);\r | |
722 | } else {\r | |
723 | //\r | |
2d3fb919 | 724 | // Delete the "SecureBootEnable" variable if this variable exist as "SecureBoot"\r |
beda2356 | 725 | // variable is not in secure boot state.\r |
726 | //\r | |
727 | if (Variable.CurrPtr == NULL || EFI_ERROR (Status)) {\r | |
728 | return EFI_SUCCESS;\r | |
729 | }\r | |
730 | SecureBootEnable = SECURE_BOOT_DISABLE;\r | |
731 | VariableDataSize = 0;\r | |
732 | }\r | |
2d3fb919 | 733 | \r |
beda2356 | 734 | Status = UpdateVariable (\r |
2d3fb919 | 735 | EFI_SECURE_BOOT_ENABLE_NAME,\r |
736 | &gEfiSecureBootEnableDisableGuid,\r | |
737 | &SecureBootEnable,\r | |
738 | VariableDataSize,\r | |
739 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r | |
740 | 0,\r | |
741 | 0,\r | |
beda2356 | 742 | &Variable,\r |
743 | NULL\r | |
744 | );\r | |
745 | return Status;\r | |
0c18794e | 746 | }\r |
747 | \r | |
d912bad7 | 748 | /**\r |
749 | Check input data form to make sure it is a valid EFI_SIGNATURE_LIST for PK/KEK variable.\r | |
750 | \r | |
751 | @param[in] VariableName Name of Variable to be check.\r | |
752 | @param[in] VendorGuid Variable vendor GUID.\r | |
753 | @param[in] Data Point to the variable data to be checked.\r | |
754 | @param[in] DataSize Size of Data.\r | |
755 | \r | |
756 | @return EFI_INVALID_PARAMETER Invalid signature list format.\r | |
757 | @return EFI_SUCCESS Passed signature list format check successfully.\r | |
758 | \r | |
759 | **/\r | |
760 | EFI_STATUS\r | |
761 | CheckSignatureListFormat(\r | |
762 | IN CHAR16 *VariableName,\r | |
763 | IN EFI_GUID *VendorGuid,\r | |
764 | IN VOID *Data,\r | |
765 | IN UINTN DataSize\r | |
766 | )\r | |
767 | {\r | |
768 | EFI_SIGNATURE_LIST *SigList;\r | |
769 | UINTN SigDataSize;\r | |
770 | UINT32 Index;\r | |
771 | UINT32 SigCount;\r | |
772 | BOOLEAN IsPk;\r | |
773 | \r | |
774 | if (DataSize == 0) {\r | |
775 | return EFI_SUCCESS;\r | |
776 | }\r | |
777 | \r | |
778 | ASSERT (VariableName != NULL && VendorGuid != NULL && Data != NULL);\r | |
779 | \r | |
780 | if (CompareGuid (VendorGuid, &gEfiGlobalVariableGuid) && (StrCmp (VariableName, EFI_PLATFORM_KEY_NAME) == 0)){\r | |
781 | IsPk = TRUE;\r | |
782 | } else if (CompareGuid (VendorGuid, &gEfiGlobalVariableGuid) && (StrCmp (VariableName, EFI_KEY_EXCHANGE_KEY_NAME) == 0)) {\r | |
783 | IsPk = FALSE;\r | |
784 | } else {\r | |
785 | return EFI_SUCCESS;\r | |
786 | }\r | |
787 | \r | |
788 | SigCount = 0;\r | |
789 | SigList = (EFI_SIGNATURE_LIST *) Data;\r | |
790 | SigDataSize = DataSize;\r | |
791 | \r | |
792 | //\r | |
793 | // Walk throuth the input signature list and check the data format.\r | |
794 | // If any signature is incorrectly formed, the whole check will fail.\r | |
795 | //\r | |
796 | while ((SigDataSize > 0) && (SigDataSize >= SigList->SignatureListSize)) {\r | |
797 | for (Index = 0; Index < (sizeof (mSupportSigItem) / sizeof (EFI_SIGNATURE_ITEM)); Index++ ) {\r | |
798 | if (CompareGuid (&SigList->SignatureType, &mSupportSigItem[Index].SigType)) {\r | |
799 | //\r | |
800 | // The value of SignatureSize should always be 16 (size of SignatureOwner \r | |
801 | // component) add the data length according to signature type.\r | |
802 | //\r | |
803 | if (mSupportSigItem[Index].SigDataSize != ((UINT32) ~0) && \r | |
804 | (SigList->SignatureSize - sizeof (EFI_GUID)) != mSupportSigItem[Index].SigDataSize) {\r | |
805 | return EFI_INVALID_PARAMETER;\r | |
806 | }\r | |
807 | if (mSupportSigItem[Index].SigHeaderSize != ((UINTN) ~0) &&\r | |
808 | SigList->SignatureHeaderSize != mSupportSigItem[Index].SigHeaderSize) {\r | |
809 | return EFI_INVALID_PARAMETER;\r | |
810 | }\r | |
811 | break;\r | |
812 | }\r | |
813 | }\r | |
814 | \r | |
815 | if (Index == (sizeof (mSupportSigItem) / sizeof (EFI_SIGNATURE_ITEM))) {\r | |
816 | //\r | |
817 | // Undefined signature type.\r | |
818 | //\r | |
819 | return EFI_INVALID_PARAMETER;\r | |
820 | }\r | |
821 | \r | |
822 | if ((SigList->SignatureListSize - sizeof (EFI_SIGNATURE_LIST) - SigList->SignatureHeaderSize) % SigList->SignatureSize != 0) {\r | |
823 | return EFI_INVALID_PARAMETER;\r | |
824 | }\r | |
825 | SigCount += (SigList->SignatureListSize - sizeof (EFI_SIGNATURE_LIST) - SigList->SignatureHeaderSize) / SigList->SignatureSize;\r | |
826 | \r | |
827 | SigDataSize -= SigList->SignatureListSize;\r | |
828 | SigList = (EFI_SIGNATURE_LIST *) ((UINT8 *) SigList + SigList->SignatureListSize);\r | |
829 | }\r | |
830 | \r | |
831 | if (((UINTN) SigList - (UINTN) Data) != DataSize) {\r | |
832 | return EFI_INVALID_PARAMETER;\r | |
833 | }\r | |
834 | \r | |
835 | if (IsPk && SigCount > 1) {\r | |
836 | return EFI_INVALID_PARAMETER;\r | |
837 | }\r | |
838 | \r | |
839 | return EFI_SUCCESS;\r | |
840 | }\r | |
841 | \r | |
0c18794e | 842 | /**\r |
843 | Process variable with platform key for verification.\r | |
844 | \r | |
dc204d5a JY |
845 | Caution: This function may receive untrusted input.\r |
846 | This function may be invoked in SMM mode, and datasize and data are external input.\r | |
847 | This function will do basic validation, before parse the data.\r | |
848 | This function will parse the authentication carefully to avoid security issues, like\r | |
849 | buffer overflow, integer overflow.\r | |
850 | This function will check attribute carefully to avoid authentication bypass.\r | |
851 | \r | |
0c18794e | 852 | @param[in] VariableName Name of Variable to be found.\r |
853 | @param[in] VendorGuid Variable vendor GUID.\r | |
854 | @param[in] Data Data pointer.\r | |
855 | @param[in] DataSize Size of Data found. If size is less than the\r | |
856 | data, this value contains the required size.\r | |
857 | @param[in] Variable The variable information which is used to keep track of variable usage.\r | |
858 | @param[in] Attributes Attribute value of the variable\r | |
859 | @param[in] IsPk Indicate whether it is to process pk.\r | |
860 | \r | |
861 | @return EFI_INVALID_PARAMETER Invalid parameter.\r | |
2d3fb919 | 862 | @return EFI_SECURITY_VIOLATION The variable does NOT pass the validation.\r |
863 | check carried out by the firmware.\r | |
0c18794e | 864 | @return EFI_SUCCESS Variable passed validation successfully.\r |
865 | \r | |
866 | **/\r | |
867 | EFI_STATUS\r | |
868 | ProcessVarWithPk (\r | |
869 | IN CHAR16 *VariableName,\r | |
870 | IN EFI_GUID *VendorGuid,\r | |
871 | IN VOID *Data,\r | |
872 | IN UINTN DataSize,\r | |
873 | IN VARIABLE_POINTER_TRACK *Variable,\r | |
874 | IN UINT32 Attributes OPTIONAL,\r | |
875 | IN BOOLEAN IsPk\r | |
876 | )\r | |
877 | {\r | |
878 | EFI_STATUS Status;\r | |
0c18794e | 879 | BOOLEAN Del;\r |
2d3fb919 | 880 | UINT8 *Payload;\r |
881 | UINTN PayloadSize;\r | |
0c18794e | 882 | \r |
8c1babfd | 883 | if ((Attributes & EFI_VARIABLE_NON_VOLATILE) == 0 || \r |
884 | (Attributes & EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS) == 0) {\r | |
0c18794e | 885 | //\r |
05a643f9 | 886 | // PK, KEK and db/dbx should set EFI_VARIABLE_NON_VOLATILE attribute and should be a time-based\r |
8c1babfd | 887 | // authenticated variable.\r |
0c18794e | 888 | //\r |
889 | return EFI_INVALID_PARAMETER;\r | |
890 | }\r | |
891 | \r | |
785d84ea | 892 | Del = FALSE;\r |
893 | if ((InCustomMode() && UserPhysicalPresent()) || (mPlatformMode == SETUP_MODE && !IsPk)) {\r | |
8c1babfd | 894 | Payload = (UINT8 *) Data + AUTHINFO2_SIZE (Data);\r |
895 | PayloadSize = DataSize - AUTHINFO2_SIZE (Data);\r | |
785d84ea | 896 | if (PayloadSize == 0) {\r |
897 | Del = TRUE;\r | |
898 | }\r | |
2d3fb919 | 899 | \r |
d912bad7 | 900 | Status = CheckSignatureListFormat(VariableName, VendorGuid, Payload, PayloadSize);\r |
901 | if (EFI_ERROR (Status)) {\r | |
902 | return Status;\r | |
903 | }\r | |
904 | \r | |
2d3fb919 | 905 | Status = UpdateVariable (\r |
906 | VariableName,\r | |
907 | VendorGuid,\r | |
908 | Payload,\r | |
909 | PayloadSize,\r | |
910 | Attributes,\r | |
911 | 0,\r | |
8c1babfd | 912 | 0,\r |
2d3fb919 | 913 | Variable,\r |
8c1babfd | 914 | &((EFI_VARIABLE_AUTHENTICATION_2 *) Data)->TimeStamp\r |
2d3fb919 | 915 | );\r |
785d84ea | 916 | } else if (mPlatformMode == USER_MODE) {\r |
917 | //\r | |
918 | // Verify against X509 Cert in PK database.\r | |
919 | //\r | |
920 | Status = VerifyTimeBasedPayload (\r | |
921 | VariableName,\r | |
922 | VendorGuid,\r | |
923 | Data,\r | |
924 | DataSize,\r | |
925 | Variable,\r | |
926 | Attributes,\r | |
927 | AuthVarTypePk,\r | |
928 | &Del\r | |
929 | );\r | |
930 | } else {\r | |
931 | //\r | |
932 | // Verify against the certificate in data payload.\r | |
933 | //\r | |
934 | Status = VerifyTimeBasedPayload (\r | |
935 | VariableName,\r | |
936 | VendorGuid,\r | |
937 | Data,\r | |
938 | DataSize,\r | |
939 | Variable,\r | |
940 | Attributes,\r | |
941 | AuthVarTypePayload,\r | |
942 | &Del\r | |
943 | );\r | |
944 | }\r | |
ecc722ad | 945 | \r |
785d84ea | 946 | if (!EFI_ERROR(Status) && IsPk) {\r |
947 | if (mPlatformMode == SETUP_MODE && !Del) {\r | |
948 | //\r | |
949 | // If enroll PK in setup mode, need change to user mode.\r | |
950 | //\r | |
951 | Status = UpdatePlatformMode (USER_MODE);\r | |
952 | } else if (mPlatformMode == USER_MODE && Del){\r | |
953 | //\r | |
954 | // If delete PK in user mode, need change to setup mode.\r | |
955 | //\r | |
956 | Status = UpdatePlatformMode (SETUP_MODE);\r | |
957 | }\r | |
0c18794e | 958 | }\r |
959 | \r | |
960 | return Status;\r | |
961 | }\r | |
962 | \r | |
963 | /**\r | |
964 | Process variable with key exchange key for verification.\r | |
965 | \r | |
dc204d5a JY |
966 | Caution: This function may receive untrusted input.\r |
967 | This function may be invoked in SMM mode, and datasize and data are external input.\r | |
968 | This function will do basic validation, before parse the data.\r | |
969 | This function will parse the authentication carefully to avoid security issues, like\r | |
970 | buffer overflow, integer overflow.\r | |
971 | This function will check attribute carefully to avoid authentication bypass.\r | |
972 | \r | |
0c18794e | 973 | @param[in] VariableName Name of Variable to be found.\r |
974 | @param[in] VendorGuid Variable vendor GUID.\r | |
975 | @param[in] Data Data pointer.\r | |
976 | @param[in] DataSize Size of Data found. If size is less than the\r | |
977 | data, this value contains the required size.\r | |
978 | @param[in] Variable The variable information which is used to keep track of variable usage.\r | |
979 | @param[in] Attributes Attribute value of the variable.\r | |
980 | \r | |
981 | @return EFI_INVALID_PARAMETER Invalid parameter.\r | |
2d3fb919 | 982 | @return EFI_SECURITY_VIOLATION The variable does NOT pass the validation\r |
983 | check carried out by the firmware.\r | |
0c18794e | 984 | @return EFI_SUCCESS Variable pass validation successfully.\r |
985 | \r | |
986 | **/\r | |
987 | EFI_STATUS\r | |
988 | ProcessVarWithKek (\r | |
989 | IN CHAR16 *VariableName,\r | |
990 | IN EFI_GUID *VendorGuid,\r | |
991 | IN VOID *Data,\r | |
992 | IN UINTN DataSize,\r | |
993 | IN VARIABLE_POINTER_TRACK *Variable,\r | |
994 | IN UINT32 Attributes OPTIONAL\r | |
995 | )\r | |
996 | {\r | |
997 | EFI_STATUS Status;\r | |
2d3fb919 | 998 | UINT8 *Payload;\r |
999 | UINTN PayloadSize;\r | |
ecc722ad | 1000 | \r |
8c1babfd | 1001 | if ((Attributes & EFI_VARIABLE_NON_VOLATILE) == 0 ||\r |
1002 | (Attributes & EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS) == 0) {\r | |
ecc722ad | 1003 | //\r |
8c1babfd | 1004 | // DB and DBX should set EFI_VARIABLE_NON_VOLATILE attribute and should be a time-based\r |
1005 | // authenticated variable.\r | |
ecc722ad | 1006 | //\r |
1007 | return EFI_INVALID_PARAMETER;\r | |
1008 | }\r | |
0c18794e | 1009 | \r |
ecc722ad | 1010 | Status = EFI_SUCCESS;\r |
1011 | if (mPlatformMode == USER_MODE && !(InCustomMode() && UserPhysicalPresent())) {\r | |
8c1babfd | 1012 | //\r |
1013 | // Time-based, verify against X509 Cert KEK.\r | |
1014 | //\r | |
1015 | return VerifyTimeBasedPayload (\r | |
1016 | VariableName,\r | |
1017 | VendorGuid,\r | |
1018 | Data,\r | |
1019 | DataSize,\r | |
1020 | Variable,\r | |
1021 | Attributes,\r | |
1022 | AuthVarTypeKek,\r | |
1023 | NULL\r | |
1024 | );\r | |
0c18794e | 1025 | } else {\r |
1026 | //\r | |
ecc722ad | 1027 | // If in setup mode or custom secure boot mode, no authentication needed.\r |
0c18794e | 1028 | //\r |
8c1babfd | 1029 | Payload = (UINT8 *) Data + AUTHINFO2_SIZE (Data);\r |
1030 | PayloadSize = DataSize - AUTHINFO2_SIZE (Data);\r | |
2d3fb919 | 1031 | \r |
0c18794e | 1032 | Status = UpdateVariable (\r |
2d3fb919 | 1033 | VariableName,\r |
1034 | VendorGuid,\r | |
1035 | Payload,\r | |
1036 | PayloadSize,\r | |
1037 | Attributes,\r | |
1038 | 0,\r | |
8c1babfd | 1039 | 0,\r |
0c18794e | 1040 | Variable,\r |
8c1babfd | 1041 | &((EFI_VARIABLE_AUTHENTICATION_2 *) Data)->TimeStamp\r |
0c18794e | 1042 | );\r |
1043 | }\r | |
1044 | \r | |
1045 | return Status;\r | |
1046 | }\r | |
1047 | \r | |
1048 | /**\r | |
1049 | Process variable with EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS/EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set\r | |
1050 | \r | |
dc204d5a JY |
1051 | Caution: This function may receive untrusted input.\r |
1052 | This function may be invoked in SMM mode, and datasize and data are external input.\r | |
1053 | This function will do basic validation, before parse the data.\r | |
1054 | This function will parse the authentication carefully to avoid security issues, like\r | |
1055 | buffer overflow, integer overflow.\r | |
1056 | This function will check attribute carefully to avoid authentication bypass.\r | |
1057 | \r | |
0c18794e | 1058 | @param[in] VariableName Name of Variable to be found.\r |
1059 | @param[in] VendorGuid Variable vendor GUID.\r | |
1060 | \r | |
1061 | @param[in] Data Data pointer.\r | |
1062 | @param[in] DataSize Size of Data found. If size is less than the\r | |
1063 | data, this value contains the required size.\r | |
1064 | @param[in] Variable The variable information which is used to keep track of variable usage.\r | |
1065 | @param[in] Attributes Attribute value of the variable.\r | |
1066 | \r | |
1067 | @return EFI_INVALID_PARAMETER Invalid parameter.\r | |
1068 | @return EFI_WRITE_PROTECTED Variable is write-protected and needs authentication with\r | |
1069 | EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS set.\r | |
1070 | @return EFI_SECURITY_VIOLATION The variable is with EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS\r | |
2d3fb919 | 1071 | set, but the AuthInfo does NOT pass the validation\r |
1072 | check carried out by the firmware.\r | |
0c18794e | 1073 | @return EFI_SUCCESS Variable is not write-protected or pass validation successfully.\r |
1074 | \r | |
1075 | **/\r | |
1076 | EFI_STATUS\r | |
1077 | ProcessVariable (\r | |
1078 | IN CHAR16 *VariableName,\r | |
1079 | IN EFI_GUID *VendorGuid,\r | |
1080 | IN VOID *Data,\r | |
1081 | IN UINTN DataSize,\r | |
1082 | IN VARIABLE_POINTER_TRACK *Variable,\r | |
1083 | IN UINT32 Attributes\r | |
1084 | )\r | |
1085 | {\r | |
1086 | EFI_STATUS Status;\r | |
1087 | BOOLEAN IsDeletion;\r | |
1088 | BOOLEAN IsFirstTime;\r | |
1089 | UINT8 *PubKey;\r | |
1090 | EFI_VARIABLE_AUTHENTICATION *CertData;\r | |
1091 | EFI_CERT_BLOCK_RSA_2048_SHA256 *CertBlock;\r | |
1092 | UINT32 KeyIndex;\r | |
1093 | UINT64 MonotonicCount;\r | |
1094 | \r | |
2d3fb919 | 1095 | KeyIndex = 0;\r |
0c18794e | 1096 | CertData = NULL;\r |
1097 | CertBlock = NULL;\r | |
1098 | PubKey = NULL;\r | |
1099 | IsDeletion = FALSE;\r | |
1100 | \r | |
ecc722ad | 1101 | if (NeedPhysicallyPresent(VariableName, VendorGuid) && !UserPhysicalPresent()) {\r |
1102 | //\r | |
1103 | // This variable is protected, only physical present user could modify its value.\r | |
1104 | //\r | |
1105 | return EFI_SECURITY_VIOLATION;\r | |
1106 | }\r | |
1107 | \r | |
0c18794e | 1108 | //\r |
1109 | // Process Time-based Authenticated variable.\r | |
1110 | //\r | |
1111 | if ((Attributes & EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS) != 0) {\r | |
ed47ae02 | 1112 | return VerifyTimeBasedPayload (\r |
1113 | VariableName,\r | |
1114 | VendorGuid,\r | |
1115 | Data,\r | |
1116 | DataSize,\r | |
1117 | Variable,\r | |
1118 | Attributes,\r | |
1119 | AuthVarTypePriv,\r | |
1120 | NULL\r | |
1121 | );\r | |
0c18794e | 1122 | }\r |
2d3fb919 | 1123 | \r |
0c18794e | 1124 | //\r |
1125 | // Determine if first time SetVariable with the EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS.\r | |
1126 | //\r | |
1127 | if ((Attributes & EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS) != 0) {\r | |
1128 | //\r | |
1129 | // Determine current operation type.\r | |
1130 | //\r | |
1131 | if (DataSize == AUTHINFO_SIZE) {\r | |
1132 | IsDeletion = TRUE;\r | |
1133 | }\r | |
1134 | //\r | |
1135 | // Determine whether this is the first time with EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS set.\r | |
1136 | //\r | |
1137 | if (Variable->CurrPtr == NULL) {\r | |
1138 | IsFirstTime = TRUE;\r | |
1139 | } else if ((Variable->CurrPtr->Attributes & EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS) == 0) {\r | |
1140 | IsFirstTime = TRUE;\r | |
1141 | } else {\r | |
1142 | KeyIndex = Variable->CurrPtr->PubKeyIndex;\r | |
1143 | IsFirstTime = FALSE;\r | |
1144 | }\r | |
389c8779 | 1145 | } else if ((Variable->CurrPtr != NULL) && \r |
1146 | ((Variable->CurrPtr->Attributes & (EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS)) != 0)\r | |
1147 | ) {\r | |
0c18794e | 1148 | //\r |
1149 | // If the variable is already write-protected, it always needs authentication before update.\r | |
1150 | //\r | |
1151 | return EFI_WRITE_PROTECTED;\r | |
1152 | } else {\r | |
1153 | //\r | |
1154 | // If without EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS, set and attributes collision.\r | |
1155 | // That means it is not authenticated variable, just update variable as usual.\r | |
1156 | //\r | |
1157 | Status = UpdateVariable (VariableName, VendorGuid, Data, DataSize, Attributes, 0, 0, Variable, NULL);\r | |
1158 | return Status;\r | |
1159 | }\r | |
1160 | \r | |
1161 | //\r | |
1162 | // Get PubKey and check Monotonic Count value corresponding to the variable.\r | |
1163 | //\r | |
1164 | CertData = (EFI_VARIABLE_AUTHENTICATION *) Data;\r | |
1165 | CertBlock = (EFI_CERT_BLOCK_RSA_2048_SHA256 *) (CertData->AuthInfo.CertData);\r | |
1166 | PubKey = CertBlock->PublicKey;\r | |
1167 | \r | |
1168 | //\r | |
1169 | // Update Monotonic Count value.\r | |
1170 | //\r | |
1171 | MonotonicCount = CertData->MonotonicCount;\r | |
1172 | \r | |
1173 | if (!IsFirstTime) {\r | |
1174 | //\r | |
1175 | // Check input PubKey.\r | |
1176 | //\r | |
1177 | if (CompareMem (PubKey, mPubKeyStore + (KeyIndex - 1) * EFI_CERT_TYPE_RSA2048_SIZE, EFI_CERT_TYPE_RSA2048_SIZE) != 0) {\r | |
1178 | return EFI_SECURITY_VIOLATION;\r | |
1179 | }\r | |
1180 | //\r | |
1181 | // Compare the current monotonic count and ensure that it is greater than the last SetVariable\r | |
1182 | // operation with the EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS attribute set.\r | |
1183 | //\r | |
1184 | if (CertData->MonotonicCount <= Variable->CurrPtr->MonotonicCount) {\r | |
1185 | //\r | |
1186 | // Monotonic count check fail, suspicious replay attack, return EFI_SECURITY_VIOLATION.\r | |
1187 | //\r | |
1188 | return EFI_SECURITY_VIOLATION;\r | |
1189 | }\r | |
2d3fb919 | 1190 | }\r |
0c18794e | 1191 | //\r |
1192 | // Verify the certificate in Data payload.\r | |
1193 | //\r | |
1194 | Status = VerifyCounterBasedPayload (Data, DataSize, PubKey);\r | |
1195 | if (EFI_ERROR (Status)) {\r | |
1196 | return Status;\r | |
1197 | }\r | |
2d3fb919 | 1198 | \r |
0c18794e | 1199 | //\r |
1200 | // Now, the signature has been verified!\r | |
1201 | //\r | |
1202 | if (IsFirstTime && !IsDeletion) {\r | |
1203 | //\r | |
1204 | // Update public key database variable if need.\r | |
1205 | //\r | |
1206 | KeyIndex = AddPubKeyInStore (PubKey);\r | |
4e33001c | 1207 | if (KeyIndex == 0) {\r |
1208 | return EFI_SECURITY_VIOLATION;\r | |
1209 | }\r | |
0c18794e | 1210 | }\r |
1211 | \r | |
1212 | //\r | |
1213 | // Verification pass.\r | |
1214 | //\r | |
1215 | return UpdateVariable (VariableName, VendorGuid, (UINT8*)Data + AUTHINFO_SIZE, DataSize - AUTHINFO_SIZE, Attributes, KeyIndex, MonotonicCount, Variable, NULL);\r | |
1216 | }\r | |
1217 | \r | |
2d3fb919 | 1218 | /**\r |
1219 | Merge two buffers which formatted as EFI_SIGNATURE_LIST. Only the new EFI_SIGNATURE_DATA\r | |
1220 | will be appended to the original EFI_SIGNATURE_LIST, duplicate EFI_SIGNATURE_DATA\r | |
1221 | will be ignored.\r | |
1222 | \r | |
1223 | @param[in, out] Data Pointer to original EFI_SIGNATURE_LIST.\r | |
1224 | @param[in] DataSize Size of Data buffer.\r | |
1225 | @param[in] NewData Pointer to new EFI_SIGNATURE_LIST to be appended.\r | |
1226 | @param[in] NewDataSize Size of NewData buffer.\r | |
1227 | \r | |
1228 | @return Size of the merged buffer.\r | |
1229 | \r | |
1230 | **/\r | |
1231 | UINTN\r | |
1232 | AppendSignatureList (\r | |
1233 | IN OUT VOID *Data,\r | |
1234 | IN UINTN DataSize,\r | |
1235 | IN VOID *NewData,\r | |
1236 | IN UINTN NewDataSize\r | |
1237 | )\r | |
1238 | {\r | |
1239 | EFI_SIGNATURE_LIST *CertList;\r | |
1240 | EFI_SIGNATURE_DATA *Cert;\r | |
1241 | UINTN CertCount;\r | |
1242 | EFI_SIGNATURE_LIST *NewCertList;\r | |
1243 | EFI_SIGNATURE_DATA *NewCert;\r | |
1244 | UINTN NewCertCount;\r | |
1245 | UINTN Index;\r | |
1246 | UINTN Index2;\r | |
1247 | UINTN Size;\r | |
1248 | UINT8 *Tail;\r | |
1249 | UINTN CopiedCount;\r | |
1250 | UINTN SignatureListSize;\r | |
1251 | BOOLEAN IsNewCert;\r | |
1252 | \r | |
1253 | Tail = (UINT8 *) Data + DataSize;\r | |
1254 | \r | |
1255 | NewCertList = (EFI_SIGNATURE_LIST *) NewData;\r | |
1256 | while ((NewDataSize > 0) && (NewDataSize >= NewCertList->SignatureListSize)) {\r | |
1257 | NewCert = (EFI_SIGNATURE_DATA *) ((UINT8 *) NewCertList + sizeof (EFI_SIGNATURE_LIST) + NewCertList->SignatureHeaderSize);\r | |
1258 | NewCertCount = (NewCertList->SignatureListSize - sizeof (EFI_SIGNATURE_LIST) - NewCertList->SignatureHeaderSize) / NewCertList->SignatureSize;\r | |
1259 | \r | |
1260 | CopiedCount = 0;\r | |
1261 | for (Index = 0; Index < NewCertCount; Index++) {\r | |
1262 | IsNewCert = TRUE;\r | |
1263 | \r | |
1264 | Size = DataSize;\r | |
1265 | CertList = (EFI_SIGNATURE_LIST *) Data;\r | |
1266 | while ((Size > 0) && (Size >= CertList->SignatureListSize)) {\r | |
1267 | if (CompareGuid (&CertList->SignatureType, &NewCertList->SignatureType) &&\r | |
1268 | (CertList->SignatureSize == NewCertList->SignatureSize)) {\r | |
1269 | Cert = (EFI_SIGNATURE_DATA *) ((UINT8 *) CertList + sizeof (EFI_SIGNATURE_LIST) + CertList->SignatureHeaderSize);\r | |
1270 | CertCount = (CertList->SignatureListSize - sizeof (EFI_SIGNATURE_LIST) - CertList->SignatureHeaderSize) / CertList->SignatureSize;\r | |
1271 | for (Index2 = 0; Index2 < CertCount; Index2++) {\r | |
1272 | //\r | |
1273 | // Iterate each Signature Data in this Signature List.\r | |
1274 | //\r | |
1275 | if (CompareMem (NewCert, Cert, CertList->SignatureSize) == 0) {\r | |
1276 | IsNewCert = FALSE;\r | |
1277 | break;\r | |
1278 | }\r | |
1279 | Cert = (EFI_SIGNATURE_DATA *) ((UINT8 *) Cert + CertList->SignatureSize);\r | |
1280 | }\r | |
1281 | }\r | |
1282 | \r | |
1283 | if (!IsNewCert) {\r | |
1284 | break;\r | |
1285 | }\r | |
1286 | Size -= CertList->SignatureListSize;\r | |
1287 | CertList = (EFI_SIGNATURE_LIST *) ((UINT8 *) CertList + CertList->SignatureListSize);\r | |
1288 | }\r | |
1289 | \r | |
1290 | if (IsNewCert) {\r | |
1291 | //\r | |
1292 | // New EFI_SIGNATURE_DATA, append it.\r | |
1293 | //\r | |
1294 | if (CopiedCount == 0) {\r | |
1295 | //\r | |
1296 | // Copy EFI_SIGNATURE_LIST header for only once.\r | |
1297 | //\r | |
1298 | CopyMem (Tail, NewCertList, sizeof (EFI_SIGNATURE_LIST) + NewCertList->SignatureHeaderSize);\r | |
1299 | Tail = Tail + sizeof (EFI_SIGNATURE_LIST) + NewCertList->SignatureHeaderSize;\r | |
1300 | }\r | |
1301 | \r | |
1302 | CopyMem (Tail, NewCert, NewCertList->SignatureSize);\r | |
1303 | Tail += NewCertList->SignatureSize;\r | |
1304 | CopiedCount++;\r | |
1305 | }\r | |
1306 | \r | |
1307 | NewCert = (EFI_SIGNATURE_DATA *) ((UINT8 *) NewCert + NewCertList->SignatureSize);\r | |
1308 | }\r | |
1309 | \r | |
1310 | //\r | |
1311 | // Update SignatureListSize in newly appended EFI_SIGNATURE_LIST.\r | |
1312 | //\r | |
1313 | if (CopiedCount != 0) {\r | |
1314 | SignatureListSize = sizeof (EFI_SIGNATURE_LIST) + NewCertList->SignatureHeaderSize + (CopiedCount * NewCertList->SignatureSize);\r | |
1315 | CertList = (EFI_SIGNATURE_LIST *) (Tail - SignatureListSize);\r | |
1316 | CertList->SignatureListSize = (UINT32) SignatureListSize;\r | |
1317 | }\r | |
1318 | \r | |
1319 | NewDataSize -= NewCertList->SignatureListSize;\r | |
1320 | NewCertList = (EFI_SIGNATURE_LIST *) ((UINT8 *) NewCertList + NewCertList->SignatureListSize);\r | |
1321 | }\r | |
1322 | \r | |
1323 | return (Tail - (UINT8 *) Data);\r | |
1324 | }\r | |
1325 | \r | |
0c18794e | 1326 | /**\r |
1327 | Compare two EFI_TIME data.\r | |
1328 | \r | |
1329 | \r | |
1330 | @param FirstTime A pointer to the first EFI_TIME data.\r | |
1331 | @param SecondTime A pointer to the second EFI_TIME data.\r | |
1332 | \r | |
1333 | @retval TRUE The FirstTime is not later than the SecondTime.\r | |
1334 | @retval FALSE The FirstTime is later than the SecondTime.\r | |
1335 | \r | |
1336 | **/\r | |
1337 | BOOLEAN\r | |
1338 | CompareTimeStamp (\r | |
1339 | IN EFI_TIME *FirstTime,\r | |
1340 | IN EFI_TIME *SecondTime\r | |
1341 | )\r | |
1342 | {\r | |
1343 | if (FirstTime->Year != SecondTime->Year) {\r | |
1344 | return (BOOLEAN) (FirstTime->Year < SecondTime->Year);\r | |
1345 | } else if (FirstTime->Month != SecondTime->Month) {\r | |
1346 | return (BOOLEAN) (FirstTime->Month < SecondTime->Month);\r | |
1347 | } else if (FirstTime->Day != SecondTime->Day) {\r | |
1348 | return (BOOLEAN) (FirstTime->Day < SecondTime->Day);\r | |
1349 | } else if (FirstTime->Hour != SecondTime->Hour) {\r | |
1350 | return (BOOLEAN) (FirstTime->Hour < SecondTime->Hour);\r | |
1351 | } else if (FirstTime->Minute != SecondTime->Minute) {\r | |
1352 | return (BOOLEAN) (FirstTime->Minute < FirstTime->Minute);\r | |
2d3fb919 | 1353 | }\r |
0c18794e | 1354 | \r |
1355 | return (BOOLEAN) (FirstTime->Second <= SecondTime->Second);\r | |
1356 | }\r | |
1357 | \r | |
ed47ae02 | 1358 | /**\r |
1359 | Find matching signer's certificates for common authenticated variable\r | |
1360 | by corresponding VariableName and VendorGuid from "certdb".\r | |
1361 | \r | |
1362 | The data format of "certdb":\r | |
1363 | //\r | |
1364 | // UINT32 CertDbListSize;\r | |
1365 | // /// AUTH_CERT_DB_DATA Certs1[];\r | |
1366 | // /// AUTH_CERT_DB_DATA Certs2[];\r | |
1367 | // /// ...\r | |
1368 | // /// AUTH_CERT_DB_DATA Certsn[];\r | |
1369 | //\r | |
1370 | \r | |
1371 | @param[in] VariableName Name of authenticated Variable.\r | |
1372 | @param[in] VendorGuid Vendor GUID of authenticated Variable.\r | |
1373 | @param[in] Data Pointer to variable "certdb".\r | |
1374 | @param[in] DataSize Size of variable "certdb".\r | |
1375 | @param[out] CertOffset Offset of matching CertData, from starting of Data.\r | |
1376 | @param[out] CertDataSize Length of CertData in bytes.\r | |
1377 | @param[out] CertNodeOffset Offset of matching AUTH_CERT_DB_DATA , from\r | |
1378 | starting of Data.\r | |
1379 | @param[out] CertNodeSize Length of AUTH_CERT_DB_DATA in bytes.\r | |
1380 | \r | |
1381 | @retval EFI_INVALID_PARAMETER Any input parameter is invalid.\r | |
1382 | @retval EFI_NOT_FOUND Fail to find matching certs.\r | |
1383 | @retval EFI_SUCCESS Find matching certs and output parameters.\r | |
1384 | \r | |
1385 | **/\r | |
1386 | EFI_STATUS\r | |
1387 | FindCertsFromDb (\r | |
1388 | IN CHAR16 *VariableName,\r | |
1389 | IN EFI_GUID *VendorGuid,\r | |
1390 | IN UINT8 *Data,\r | |
1391 | IN UINTN DataSize,\r | |
1392 | OUT UINT32 *CertOffset, OPTIONAL\r | |
1393 | OUT UINT32 *CertDataSize, OPTIONAL\r | |
1394 | OUT UINT32 *CertNodeOffset,OPTIONAL\r | |
1395 | OUT UINT32 *CertNodeSize OPTIONAL\r | |
1396 | )\r | |
1397 | {\r | |
1398 | UINT32 Offset;\r | |
1399 | AUTH_CERT_DB_DATA *Ptr;\r | |
1400 | UINT32 CertSize;\r | |
1401 | UINT32 NameSize;\r | |
1402 | UINT32 NodeSize;\r | |
1403 | UINT32 CertDbListSize;\r | |
1404 | \r | |
1405 | if ((VariableName == NULL) || (VendorGuid == NULL) || (Data == NULL)) {\r | |
1406 | return EFI_INVALID_PARAMETER;\r | |
1407 | }\r | |
1408 | \r | |
1409 | //\r | |
1410 | // Check whether DataSize matches recorded CertDbListSize.\r | |
1411 | //\r | |
1412 | if (DataSize < sizeof (UINT32)) {\r | |
1413 | return EFI_INVALID_PARAMETER;\r | |
1414 | }\r | |
1415 | \r | |
1416 | CertDbListSize = ReadUnaligned32 ((UINT32 *) Data);\r | |
1417 | \r | |
1418 | if (CertDbListSize != (UINT32) DataSize) {\r | |
1419 | return EFI_INVALID_PARAMETER;\r | |
1420 | }\r | |
1421 | \r | |
1422 | Offset = sizeof (UINT32);\r | |
1423 | \r | |
1424 | //\r | |
1425 | // Get corresponding certificates by VendorGuid and VariableName.\r | |
1426 | //\r | |
1427 | while (Offset < (UINT32) DataSize) {\r | |
1428 | Ptr = (AUTH_CERT_DB_DATA *) (Data + Offset);\r | |
1429 | //\r | |
1430 | // Check whether VendorGuid matches.\r | |
1431 | //\r | |
1432 | if (CompareGuid (&Ptr->VendorGuid, VendorGuid)) {\r | |
1433 | NodeSize = ReadUnaligned32 (&Ptr->CertNodeSize);\r | |
1434 | NameSize = ReadUnaligned32 (&Ptr->NameSize);\r | |
1435 | CertSize = ReadUnaligned32 (&Ptr->CertDataSize);\r | |
1436 | \r | |
1437 | if (NodeSize != sizeof (EFI_GUID) + sizeof (UINT32) * 3 + CertSize +\r | |
1438 | sizeof (CHAR16) * NameSize) {\r | |
1439 | return EFI_INVALID_PARAMETER;\r | |
1440 | }\r | |
1441 | \r | |
1442 | Offset = Offset + sizeof (EFI_GUID) + sizeof (UINT32) * 3;\r | |
1443 | //\r | |
1444 | // Check whether VariableName matches.\r | |
1445 | //\r | |
1446 | if ((NameSize == StrLen (VariableName)) && \r | |
1447 | (CompareMem (Data + Offset, VariableName, NameSize * sizeof (CHAR16)) == 0)) {\r | |
1448 | Offset = Offset + NameSize * sizeof (CHAR16);\r | |
1449 | \r | |
1450 | if (CertOffset != NULL) {\r | |
1451 | *CertOffset = Offset;\r | |
1452 | }\r | |
1453 | \r | |
1454 | if (CertDataSize != NULL) {\r | |
1455 | *CertDataSize = CertSize; \r | |
1456 | }\r | |
1457 | \r | |
1458 | if (CertNodeOffset != NULL) {\r | |
1459 | *CertNodeOffset = (UINT32) ((UINT8 *) Ptr - Data);\r | |
1460 | }\r | |
1461 | \r | |
1462 | if (CertNodeSize != NULL) {\r | |
1463 | *CertNodeSize = NodeSize;\r | |
1464 | }\r | |
1465 | \r | |
1466 | return EFI_SUCCESS;\r | |
1467 | } else {\r | |
1468 | Offset = Offset + NameSize * sizeof (CHAR16) + CertSize;\r | |
1469 | }\r | |
1470 | } else {\r | |
1471 | NodeSize = ReadUnaligned32 (&Ptr->CertNodeSize);\r | |
1472 | Offset = Offset + NodeSize;\r | |
1473 | }\r | |
1474 | }\r | |
1475 | \r | |
1476 | return EFI_NOT_FOUND; \r | |
1477 | }\r | |
1478 | \r | |
1479 | /**\r | |
1480 | Retrieve signer's certificates for common authenticated variable\r | |
1481 | by corresponding VariableName and VendorGuid from "certdb".\r | |
1482 | \r | |
1483 | @param[in] VariableName Name of authenticated Variable.\r | |
1484 | @param[in] VendorGuid Vendor GUID of authenticated Variable.\r | |
1485 | @param[out] CertData Pointer to signer's certificates.\r | |
1486 | @param[out] CertDataSize Length of CertData in bytes.\r | |
1487 | \r | |
1488 | @retval EFI_INVALID_PARAMETER Any input parameter is invalid.\r | |
1489 | @retval EFI_NOT_FOUND Fail to find "certdb" or matching certs.\r | |
1490 | @retval EFI_SUCCESS Get signer's certificates successfully.\r | |
1491 | \r | |
1492 | **/\r | |
1493 | EFI_STATUS\r | |
1494 | GetCertsFromDb (\r | |
1495 | IN CHAR16 *VariableName,\r | |
1496 | IN EFI_GUID *VendorGuid,\r | |
1497 | OUT UINT8 **CertData,\r | |
1498 | OUT UINT32 *CertDataSize\r | |
1499 | )\r | |
1500 | {\r | |
1501 | VARIABLE_POINTER_TRACK CertDbVariable;\r | |
1502 | EFI_STATUS Status;\r | |
1503 | UINT8 *Data;\r | |
1504 | UINTN DataSize;\r | |
1505 | UINT32 CertOffset;\r | |
1506 | \r | |
1507 | if ((VariableName == NULL) || (VendorGuid == NULL) || (CertData == NULL) || (CertDataSize == NULL)) {\r | |
1508 | return EFI_INVALID_PARAMETER;\r | |
1509 | }\r | |
1510 | \r | |
1511 | //\r | |
1512 | // Get variable "certdb".\r | |
1513 | //\r | |
1514 | Status = FindVariable (\r | |
1515 | EFI_CERT_DB_NAME,\r | |
1516 | &gEfiCertDbGuid,\r | |
1517 | &CertDbVariable,\r | |
1518 | &mVariableModuleGlobal->VariableGlobal,\r | |
1519 | FALSE\r | |
1520 | ); \r | |
1521 | if (EFI_ERROR (Status)) {\r | |
1522 | return Status;\r | |
1523 | }\r | |
1524 | \r | |
1525 | DataSize = DataSizeOfVariable (CertDbVariable.CurrPtr);\r | |
1526 | Data = GetVariableDataPtr (CertDbVariable.CurrPtr);\r | |
1527 | if ((DataSize == 0) || (Data == NULL)) {\r | |
1528 | ASSERT (FALSE);\r | |
1529 | return EFI_NOT_FOUND;\r | |
1530 | }\r | |
1531 | \r | |
1532 | Status = FindCertsFromDb (\r | |
1533 | VariableName,\r | |
1534 | VendorGuid,\r | |
1535 | Data,\r | |
1536 | DataSize,\r | |
1537 | &CertOffset,\r | |
1538 | CertDataSize,\r | |
1539 | NULL,\r | |
1540 | NULL\r | |
1541 | );\r | |
1542 | \r | |
1543 | if (EFI_ERROR (Status)) {\r | |
1544 | return Status;\r | |
1545 | }\r | |
1546 | \r | |
1547 | *CertData = Data + CertOffset;\r | |
1548 | return EFI_SUCCESS;\r | |
1549 | }\r | |
1550 | \r | |
1551 | /**\r | |
1552 | Delete matching signer's certificates when deleting common authenticated\r | |
1553 | variable by corresponding VariableName and VendorGuid from "certdb".\r | |
1554 | \r | |
1555 | @param[in] VariableName Name of authenticated Variable.\r | |
1556 | @param[in] VendorGuid Vendor GUID of authenticated Variable.\r | |
1557 | \r | |
1558 | @retval EFI_INVALID_PARAMETER Any input parameter is invalid.\r | |
1559 | @retval EFI_NOT_FOUND Fail to find "certdb" or matching certs.\r | |
1560 | @retval EFI_OUT_OF_RESOURCES The operation is failed due to lack of resources.\r | |
1561 | @retval EFI_SUCCESS The operation is completed successfully.\r | |
1562 | \r | |
1563 | **/\r | |
1564 | EFI_STATUS\r | |
1565 | DeleteCertsFromDb (\r | |
1566 | IN CHAR16 *VariableName,\r | |
1567 | IN EFI_GUID *VendorGuid\r | |
1568 | )\r | |
1569 | {\r | |
1570 | VARIABLE_POINTER_TRACK CertDbVariable;\r | |
1571 | EFI_STATUS Status;\r | |
1572 | UINT8 *Data;\r | |
1573 | UINTN DataSize;\r | |
1574 | UINT32 VarAttr;\r | |
1575 | UINT32 CertNodeOffset;\r | |
1576 | UINT32 CertNodeSize;\r | |
1577 | UINT8 *NewCertDb;\r | |
1578 | UINT32 NewCertDbSize;\r | |
1579 | \r | |
1580 | if ((VariableName == NULL) || (VendorGuid == NULL)) {\r | |
1581 | return EFI_INVALID_PARAMETER;\r | |
1582 | }\r | |
1583 | \r | |
1584 | //\r | |
1585 | // Get variable "certdb".\r | |
1586 | //\r | |
1587 | Status = FindVariable (\r | |
1588 | EFI_CERT_DB_NAME,\r | |
1589 | &gEfiCertDbGuid,\r | |
1590 | &CertDbVariable,\r | |
1591 | &mVariableModuleGlobal->VariableGlobal,\r | |
1592 | FALSE\r | |
1593 | ); \r | |
1594 | if (EFI_ERROR (Status)) {\r | |
1595 | return Status;\r | |
1596 | }\r | |
1597 | \r | |
1598 | DataSize = DataSizeOfVariable (CertDbVariable.CurrPtr);\r | |
1599 | Data = GetVariableDataPtr (CertDbVariable.CurrPtr);\r | |
1600 | if ((DataSize == 0) || (Data == NULL)) {\r | |
1601 | ASSERT (FALSE);\r | |
1602 | return EFI_NOT_FOUND;\r | |
1603 | }\r | |
1604 | \r | |
1605 | if (DataSize == sizeof (UINT32)) {\r | |
1606 | //\r | |
1607 | // There is no certs in certdb.\r | |
1608 | //\r | |
1609 | return EFI_SUCCESS;\r | |
1610 | }\r | |
1611 | \r | |
1612 | //\r | |
1613 | // Get corresponding cert node from certdb.\r | |
1614 | //\r | |
1615 | Status = FindCertsFromDb (\r | |
1616 | VariableName,\r | |
1617 | VendorGuid,\r | |
1618 | Data,\r | |
1619 | DataSize,\r | |
1620 | NULL,\r | |
1621 | NULL,\r | |
1622 | &CertNodeOffset,\r | |
1623 | &CertNodeSize\r | |
1624 | );\r | |
1625 | \r | |
1626 | if (EFI_ERROR (Status)) {\r | |
1627 | return Status;\r | |
1628 | }\r | |
1629 | \r | |
1630 | if (DataSize < (CertNodeOffset + CertNodeSize)) {\r | |
1631 | return EFI_NOT_FOUND;\r | |
1632 | }\r | |
1633 | \r | |
1634 | //\r | |
1635 | // Construct new data content of variable "certdb".\r | |
1636 | //\r | |
1637 | NewCertDbSize = (UINT32) DataSize - CertNodeSize;\r | |
1638 | NewCertDb = AllocateZeroPool (NewCertDbSize);\r | |
1639 | if (NewCertDb == NULL) {\r | |
1640 | return EFI_OUT_OF_RESOURCES;\r | |
1641 | }\r | |
1642 | \r | |
1643 | //\r | |
1644 | // Copy the DB entries before deleting node.\r | |
1645 | //\r | |
1646 | CopyMem (NewCertDb, Data, CertNodeOffset);\r | |
1647 | //\r | |
1648 | // Update CertDbListSize.\r | |
1649 | //\r | |
1650 | CopyMem (NewCertDb, &NewCertDbSize, sizeof (UINT32));\r | |
1651 | //\r | |
1652 | // Copy the DB entries after deleting node.\r | |
1653 | //\r | |
1654 | if (DataSize > (CertNodeOffset + CertNodeSize)) {\r | |
1655 | CopyMem (\r | |
1656 | NewCertDb + CertNodeOffset,\r | |
1657 | Data + CertNodeOffset + CertNodeSize,\r | |
1658 | DataSize - CertNodeOffset - CertNodeSize\r | |
1659 | );\r | |
1660 | }\r | |
1661 | \r | |
1662 | //\r | |
1663 | // Set "certdb".\r | |
1664 | // \r | |
1665 | VarAttr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS; \r | |
1666 | Status = UpdateVariable (\r | |
1667 | EFI_CERT_DB_NAME,\r | |
1668 | &gEfiCertDbGuid,\r | |
1669 | NewCertDb,\r | |
1670 | NewCertDbSize,\r | |
1671 | VarAttr,\r | |
1672 | 0,\r | |
1673 | 0,\r | |
1674 | &CertDbVariable,\r | |
1675 | NULL\r | |
1676 | );\r | |
1677 | \r | |
1678 | FreePool (NewCertDb);\r | |
1679 | return Status;\r | |
1680 | }\r | |
1681 | \r | |
1682 | /**\r | |
1683 | Insert signer's certificates for common authenticated variable with VariableName\r | |
1684 | and VendorGuid in AUTH_CERT_DB_DATA to "certdb".\r | |
1685 | \r | |
1686 | @param[in] VariableName Name of authenticated Variable.\r | |
1687 | @param[in] VendorGuid Vendor GUID of authenticated Variable.\r | |
1688 | @param[in] CertData Pointer to signer's certificates.\r | |
1689 | @param[in] CertDataSize Length of CertData in bytes.\r | |
1690 | \r | |
1691 | @retval EFI_INVALID_PARAMETER Any input parameter is invalid.\r | |
1692 | @retval EFI_ACCESS_DENIED An AUTH_CERT_DB_DATA entry with same VariableName\r | |
1693 | and VendorGuid already exists.\r | |
1694 | @retval EFI_OUT_OF_RESOURCES The operation is failed due to lack of resources.\r | |
1695 | @retval EFI_SUCCESS Insert an AUTH_CERT_DB_DATA entry to "certdb"\r | |
1696 | \r | |
1697 | **/\r | |
1698 | EFI_STATUS\r | |
1699 | InsertCertsToDb (\r | |
1700 | IN CHAR16 *VariableName,\r | |
1701 | IN EFI_GUID *VendorGuid,\r | |
1702 | IN UINT8 *CertData,\r | |
1703 | IN UINTN CertDataSize\r | |
1704 | )\r | |
1705 | {\r | |
1706 | VARIABLE_POINTER_TRACK CertDbVariable;\r | |
1707 | EFI_STATUS Status;\r | |
1708 | UINT8 *Data;\r | |
1709 | UINTN DataSize;\r | |
1710 | UINT32 VarAttr;\r | |
1711 | UINT8 *NewCertDb;\r | |
1712 | UINT32 NewCertDbSize;\r | |
1713 | UINT32 CertNodeSize;\r | |
1714 | UINT32 NameSize;\r | |
1715 | AUTH_CERT_DB_DATA *Ptr;\r | |
1716 | \r | |
1717 | if ((VariableName == NULL) || (VendorGuid == NULL) || (CertData == NULL)) {\r | |
1718 | return EFI_INVALID_PARAMETER;\r | |
1719 | }\r | |
1720 | \r | |
1721 | //\r | |
1722 | // Get variable "certdb".\r | |
1723 | //\r | |
1724 | Status = FindVariable (\r | |
1725 | EFI_CERT_DB_NAME,\r | |
1726 | &gEfiCertDbGuid,\r | |
1727 | &CertDbVariable,\r | |
1728 | &mVariableModuleGlobal->VariableGlobal,\r | |
1729 | FALSE\r | |
1730 | ); \r | |
1731 | if (EFI_ERROR (Status)) {\r | |
1732 | return Status;\r | |
1733 | }\r | |
1734 | \r | |
1735 | DataSize = DataSizeOfVariable (CertDbVariable.CurrPtr);\r | |
1736 | Data = GetVariableDataPtr (CertDbVariable.CurrPtr);\r | |
1737 | if ((DataSize == 0) || (Data == NULL)) {\r | |
1738 | ASSERT (FALSE);\r | |
1739 | return EFI_NOT_FOUND;\r | |
1740 | }\r | |
1741 | \r | |
1742 | //\r | |
1743 | // Find whether matching cert node already exists in "certdb".\r | |
1744 | // If yes return error.\r | |
1745 | //\r | |
1746 | Status = FindCertsFromDb (\r | |
1747 | VariableName,\r | |
1748 | VendorGuid,\r | |
1749 | Data,\r | |
1750 | DataSize,\r | |
1751 | NULL,\r | |
1752 | NULL,\r | |
1753 | NULL,\r | |
1754 | NULL\r | |
1755 | );\r | |
1756 | \r | |
1757 | if (!EFI_ERROR (Status)) {\r | |
1758 | ASSERT (FALSE);\r | |
1759 | return EFI_ACCESS_DENIED;\r | |
1760 | }\r | |
1761 | \r | |
1762 | //\r | |
1763 | // Construct new data content of variable "certdb".\r | |
1764 | //\r | |
1765 | NameSize = (UINT32) StrLen (VariableName);\r | |
1766 | CertNodeSize = sizeof (AUTH_CERT_DB_DATA) + (UINT32) CertDataSize + NameSize * sizeof (CHAR16); \r | |
1767 | NewCertDbSize = (UINT32) DataSize + CertNodeSize; \r | |
1768 | NewCertDb = AllocateZeroPool (NewCertDbSize);\r | |
1769 | if (NewCertDb == NULL) {\r | |
1770 | return EFI_OUT_OF_RESOURCES;\r | |
1771 | }\r | |
1772 | \r | |
1773 | //\r | |
1774 | // Copy the DB entries before deleting node.\r | |
1775 | //\r | |
1776 | CopyMem (NewCertDb, Data, DataSize);\r | |
1777 | //\r | |
1778 | // Update CertDbListSize.\r | |
1779 | //\r | |
1780 | CopyMem (NewCertDb, &NewCertDbSize, sizeof (UINT32));\r | |
1781 | //\r | |
1782 | // Construct new cert node.\r | |
1783 | //\r | |
1784 | Ptr = (AUTH_CERT_DB_DATA *) (NewCertDb + DataSize);\r | |
1785 | CopyGuid (&Ptr->VendorGuid, VendorGuid);\r | |
1786 | CopyMem (&Ptr->CertNodeSize, &CertNodeSize, sizeof (UINT32));\r | |
1787 | CopyMem (&Ptr->NameSize, &NameSize, sizeof (UINT32));\r | |
1788 | CopyMem (&Ptr->CertDataSize, &CertDataSize, sizeof (UINT32));\r | |
1789 | \r | |
1790 | CopyMem (\r | |
1791 | (UINT8 *) Ptr + sizeof (AUTH_CERT_DB_DATA),\r | |
1792 | VariableName,\r | |
1793 | NameSize * sizeof (CHAR16)\r | |
1794 | );\r | |
1795 | \r | |
1796 | CopyMem (\r | |
1797 | (UINT8 *) Ptr + sizeof (AUTH_CERT_DB_DATA) + NameSize * sizeof (CHAR16),\r | |
1798 | CertData,\r | |
1799 | CertDataSize\r | |
1800 | );\r | |
1801 | \r | |
1802 | //\r | |
1803 | // Set "certdb".\r | |
1804 | // \r | |
1805 | VarAttr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS; \r | |
1806 | Status = UpdateVariable (\r | |
1807 | EFI_CERT_DB_NAME,\r | |
1808 | &gEfiCertDbGuid,\r | |
1809 | NewCertDb,\r | |
1810 | NewCertDbSize,\r | |
1811 | VarAttr,\r | |
1812 | 0,\r | |
1813 | 0,\r | |
1814 | &CertDbVariable,\r | |
1815 | NULL\r | |
1816 | );\r | |
1817 | \r | |
1818 | FreePool (NewCertDb);\r | |
1819 | return Status;\r | |
1820 | }\r | |
1821 | \r | |
0c18794e | 1822 | /**\r |
1823 | Process variable with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set\r | |
1824 | \r | |
dc204d5a JY |
1825 | Caution: This function may receive untrusted input.\r |
1826 | This function may be invoked in SMM mode, and datasize and data are external input.\r | |
1827 | This function will do basic validation, before parse the data.\r | |
1828 | This function will parse the authentication carefully to avoid security issues, like\r | |
1829 | buffer overflow, integer overflow.\r | |
1830 | \r | |
0c18794e | 1831 | @param[in] VariableName Name of Variable to be found.\r |
1832 | @param[in] VendorGuid Variable vendor GUID.\r | |
1833 | @param[in] Data Data pointer.\r | |
1834 | @param[in] DataSize Size of Data found. If size is less than the\r | |
1835 | data, this value contains the required size.\r | |
1836 | @param[in] Variable The variable information which is used to keep track of variable usage.\r | |
1837 | @param[in] Attributes Attribute value of the variable.\r | |
785d84ea | 1838 | @param[in] AuthVarType Verify against PK, KEK database, private database or certificate in data payload.\r |
0c18794e | 1839 | @param[out] VarDel Delete the variable or not.\r |
1840 | \r | |
1841 | @retval EFI_INVALID_PARAMETER Invalid parameter.\r | |
2d3fb919 | 1842 | @retval EFI_SECURITY_VIOLATION The variable does NOT pass the validation\r |
1843 | check carried out by the firmware.\r | |
0c18794e | 1844 | @retval EFI_OUT_OF_RESOURCES Failed to process variable due to lack\r |
1845 | of resources.\r | |
1846 | @retval EFI_SUCCESS Variable pass validation successfully.\r | |
1847 | \r | |
1848 | **/\r | |
1849 | EFI_STATUS\r | |
1850 | VerifyTimeBasedPayload (\r | |
1851 | IN CHAR16 *VariableName,\r | |
1852 | IN EFI_GUID *VendorGuid,\r | |
1853 | IN VOID *Data,\r | |
1854 | IN UINTN DataSize,\r | |
1855 | IN VARIABLE_POINTER_TRACK *Variable,\r | |
1856 | IN UINT32 Attributes,\r | |
ed47ae02 | 1857 | IN AUTHVAR_TYPE AuthVarType,\r |
0c18794e | 1858 | OUT BOOLEAN *VarDel\r |
1859 | )\r | |
1860 | {\r | |
1861 | UINT8 *RootCert;\r | |
1862 | UINT8 *SigData;\r | |
2d3fb919 | 1863 | UINT8 *PayloadPtr;\r |
0c18794e | 1864 | UINTN RootCertSize;\r |
1865 | UINTN Index;\r | |
2d3fb919 | 1866 | UINTN CertCount;\r |
1867 | UINTN PayloadSize;\r | |
0c18794e | 1868 | UINT32 Attr;\r |
1869 | UINT32 SigDataSize;\r | |
1870 | UINT32 KekDataSize;\r | |
0c18794e | 1871 | BOOLEAN VerifyStatus;\r |
1872 | EFI_STATUS Status;\r | |
1873 | EFI_SIGNATURE_LIST *CertList;\r | |
1874 | EFI_SIGNATURE_DATA *Cert;\r | |
1875 | VARIABLE_POINTER_TRACK KekVariable;\r | |
1876 | EFI_VARIABLE_AUTHENTICATION_2 *CertData;\r | |
1877 | UINT8 *NewData;\r | |
1878 | UINTN NewDataSize;\r | |
1879 | VARIABLE_POINTER_TRACK PkVariable;\r | |
2d3fb919 | 1880 | UINT8 *Buffer;\r |
1881 | UINTN Length;\r | |
ed47ae02 | 1882 | UINT8 *SignerCerts;\r |
1883 | UINT8 *WrapSigData;\r | |
1884 | UINTN CertStackSize;\r | |
1885 | UINT8 *CertsInCertDb;\r | |
1886 | UINT32 CertsSizeinDb;\r | |
0c18794e | 1887 | \r |
0c18794e | 1888 | VerifyStatus = FALSE;\r |
1889 | CertData = NULL;\r | |
1890 | NewData = NULL;\r | |
1891 | Attr = Attributes;\r | |
ed47ae02 | 1892 | WrapSigData = NULL;\r |
1893 | SignerCerts = NULL;\r | |
1894 | RootCert = NULL;\r | |
0c18794e | 1895 | \r |
1896 | //\r | |
2d3fb919 | 1897 | // When the attribute EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS is\r |
0c18794e | 1898 | // set, then the Data buffer shall begin with an instance of a complete (and serialized)\r |
2d3fb919 | 1899 | // EFI_VARIABLE_AUTHENTICATION_2 descriptor. The descriptor shall be followed by the new\r |
1900 | // variable value and DataSize shall reflect the combined size of the descriptor and the new\r | |
1901 | // variable value. The authentication descriptor is not part of the variable data and is not\r | |
0c18794e | 1902 | // returned by subsequent calls to GetVariable().\r |
1903 | //\r | |
1904 | CertData = (EFI_VARIABLE_AUTHENTICATION_2 *) Data;\r | |
2d3fb919 | 1905 | \r |
1906 | //\r | |
1907 | // Verify that Pad1, Nanosecond, TimeZone, Daylight and Pad2 components of the\r | |
1908 | // TimeStamp value are set to zero.\r | |
1909 | //\r | |
1910 | if ((CertData->TimeStamp.Pad1 != 0) ||\r | |
1911 | (CertData->TimeStamp.Nanosecond != 0) ||\r | |
1912 | (CertData->TimeStamp.TimeZone != 0) ||\r | |
1913 | (CertData->TimeStamp.Daylight != 0) ||\r | |
1914 | (CertData->TimeStamp.Pad2 != 0)) {\r | |
2e24814a | 1915 | return EFI_SECURITY_VIOLATION;\r |
2d3fb919 | 1916 | }\r |
1917 | \r | |
0c18794e | 1918 | if ((Variable->CurrPtr != NULL) && ((Attributes & EFI_VARIABLE_APPEND_WRITE) == 0)) {\r |
1919 | if (CompareTimeStamp (&CertData->TimeStamp, &Variable->CurrPtr->TimeStamp)) {\r | |
1920 | //\r | |
1921 | // TimeStamp check fail, suspicious replay attack, return EFI_SECURITY_VIOLATION.\r | |
1922 | //\r | |
1923 | return EFI_SECURITY_VIOLATION;\r | |
1924 | }\r | |
1925 | }\r | |
1926 | \r | |
1927 | //\r | |
1928 | // wCertificateType should be WIN_CERT_TYPE_EFI_GUID.\r | |
1929 | // Cert type should be EFI_CERT_TYPE_PKCS7_GUID.\r | |
1930 | //\r | |
1931 | if ((CertData->AuthInfo.Hdr.wCertificateType != WIN_CERT_TYPE_EFI_GUID) ||\r | |
2d3fb919 | 1932 | !CompareGuid (&CertData->AuthInfo.CertType, &gEfiCertPkcs7Guid)) {\r |
0c18794e | 1933 | //\r |
1934 | // Invalid AuthInfo type, return EFI_SECURITY_VIOLATION.\r | |
1935 | //\r | |
1936 | return EFI_SECURITY_VIOLATION;\r | |
1937 | }\r | |
2d3fb919 | 1938 | \r |
0c18794e | 1939 | //\r |
1940 | // Find out Pkcs7 SignedData which follows the EFI_VARIABLE_AUTHENTICATION_2 descriptor.\r | |
1941 | // AuthInfo.Hdr.dwLength is the length of the entire certificate, including the length of the header.\r | |
1942 | //\r | |
2d3fb919 | 1943 | SigData = CertData->AuthInfo.CertData;\r |
1944 | SigDataSize = CertData->AuthInfo.Hdr.dwLength - (UINT32) (OFFSET_OF (WIN_CERTIFICATE_UEFI_GUID, CertData));\r | |
648f98d1 | 1945 | \r |
0c18794e | 1946 | //\r |
1947 | // Find out the new data payload which follows Pkcs7 SignedData directly.\r | |
1948 | //\r | |
2d3fb919 | 1949 | PayloadPtr = SigData + SigDataSize;\r |
1950 | PayloadSize = DataSize - OFFSET_OF_AUTHINFO2_CERT_DATA - (UINTN) SigDataSize;\r | |
0c18794e | 1951 | \r |
1952 | //\r | |
1953 | // Construct a buffer to fill with (VariableName, VendorGuid, Attributes, TimeStamp, Data).\r | |
1954 | //\r | |
2d3fb919 | 1955 | NewDataSize = PayloadSize + sizeof (EFI_TIME) + sizeof (UINT32) +\r |
1956 | sizeof (EFI_GUID) + StrSize (VariableName) - sizeof (CHAR16);\r | |
1957 | NewData = mSerializationRuntimeBuffer;\r | |
0c18794e | 1958 | \r |
2d3fb919 | 1959 | Buffer = NewData;\r |
1960 | Length = StrLen (VariableName) * sizeof (CHAR16);\r | |
1961 | CopyMem (Buffer, VariableName, Length);\r | |
1962 | Buffer += Length;\r | |
0c18794e | 1963 | \r |
2d3fb919 | 1964 | Length = sizeof (EFI_GUID);\r |
1965 | CopyMem (Buffer, VendorGuid, Length);\r | |
1966 | Buffer += Length;\r | |
0c18794e | 1967 | \r |
2d3fb919 | 1968 | Length = sizeof (UINT32);\r |
1969 | CopyMem (Buffer, &Attr, Length);\r | |
1970 | Buffer += Length;\r | |
0c18794e | 1971 | \r |
2d3fb919 | 1972 | Length = sizeof (EFI_TIME);\r |
1973 | CopyMem (Buffer, &CertData->TimeStamp, Length);\r | |
1974 | Buffer += Length;\r | |
0c18794e | 1975 | \r |
2d3fb919 | 1976 | CopyMem (Buffer, PayloadPtr, PayloadSize);\r |
0c18794e | 1977 | \r |
ed47ae02 | 1978 | if (AuthVarType == AuthVarTypePk) {\r |
0c18794e | 1979 | //\r |
1980 | // Get platform key from variable.\r | |
1981 | //\r | |
1982 | Status = FindVariable (\r | |
2d3fb919 | 1983 | EFI_PLATFORM_KEY_NAME,\r |
1984 | &gEfiGlobalVariableGuid,\r | |
1985 | &PkVariable,\r | |
ecc722ad | 1986 | &mVariableModuleGlobal->VariableGlobal,\r |
1987 | FALSE\r | |
0c18794e | 1988 | );\r |
1989 | if (EFI_ERROR (Status)) {\r | |
1990 | return Status;\r | |
1991 | }\r | |
1992 | \r | |
1993 | CertList = (EFI_SIGNATURE_LIST *) GetVariableDataPtr (PkVariable.CurrPtr);\r | |
1994 | Cert = (EFI_SIGNATURE_DATA *) ((UINT8 *) CertList + sizeof (EFI_SIGNATURE_LIST) + CertList->SignatureHeaderSize);\r | |
1995 | RootCert = Cert->SignatureData;\r | |
4e33001c | 1996 | RootCertSize = CertList->SignatureSize - (sizeof (EFI_SIGNATURE_DATA) - 1);\r |
0c18794e | 1997 | \r |
1998 | \r | |
1999 | //\r | |
2000 | // Verify Pkcs7 SignedData via Pkcs7Verify library.\r | |
2001 | //\r | |
2002 | VerifyStatus = Pkcs7Verify (\r | |
2003 | SigData,\r | |
2004 | SigDataSize,\r | |
2005 | RootCert,\r | |
2006 | RootCertSize,\r | |
2007 | NewData,\r | |
2008 | NewDataSize\r | |
2009 | );\r | |
2010 | \r | |
ed47ae02 | 2011 | } else if (AuthVarType == AuthVarTypeKek) {\r |
2d3fb919 | 2012 | \r |
0c18794e | 2013 | //\r |
2014 | // Get KEK database from variable.\r | |
2015 | //\r | |
2016 | Status = FindVariable (\r | |
2d3fb919 | 2017 | EFI_KEY_EXCHANGE_KEY_NAME,\r |
2018 | &gEfiGlobalVariableGuid,\r | |
2019 | &KekVariable,\r | |
ecc722ad | 2020 | &mVariableModuleGlobal->VariableGlobal,\r |
2021 | FALSE\r | |
0c18794e | 2022 | );\r |
2023 | if (EFI_ERROR (Status)) {\r | |
2024 | return Status;\r | |
2025 | }\r | |
2026 | \r | |
2027 | //\r | |
2028 | // Ready to verify Pkcs7 SignedData. Go through KEK Signature Database to find out X.509 CertList.\r | |
2d3fb919 | 2029 | //\r |
0c18794e | 2030 | KekDataSize = KekVariable.CurrPtr->DataSize;\r |
2031 | CertList = (EFI_SIGNATURE_LIST *) GetVariableDataPtr (KekVariable.CurrPtr);\r | |
2032 | while ((KekDataSize > 0) && (KekDataSize >= CertList->SignatureListSize)) {\r | |
2033 | if (CompareGuid (&CertList->SignatureType, &gEfiCertX509Guid)) {\r | |
2034 | Cert = (EFI_SIGNATURE_DATA *) ((UINT8 *) CertList + sizeof (EFI_SIGNATURE_LIST) + CertList->SignatureHeaderSize);\r | |
2035 | CertCount = (CertList->SignatureListSize - sizeof (EFI_SIGNATURE_LIST) - CertList->SignatureHeaderSize) / CertList->SignatureSize;\r | |
2036 | for (Index = 0; Index < CertCount; Index++) {\r | |
2037 | //\r | |
2038 | // Iterate each Signature Data Node within this CertList for a verify\r | |
2039 | //\r | |
2040 | RootCert = Cert->SignatureData;\r | |
4e33001c | 2041 | RootCertSize = CertList->SignatureSize - (sizeof (EFI_SIGNATURE_DATA) - 1);\r |
2d3fb919 | 2042 | \r |
0c18794e | 2043 | //\r |
2044 | // Verify Pkcs7 SignedData via Pkcs7Verify library.\r | |
2045 | //\r | |
2046 | VerifyStatus = Pkcs7Verify (\r | |
2047 | SigData,\r | |
2048 | SigDataSize,\r | |
2049 | RootCert,\r | |
2050 | RootCertSize,\r | |
2051 | NewData,\r | |
2052 | NewDataSize\r | |
2053 | );\r | |
2054 | if (VerifyStatus) {\r | |
2055 | goto Exit;\r | |
2056 | }\r | |
2057 | Cert = (EFI_SIGNATURE_DATA *) ((UINT8 *) Cert + CertList->SignatureSize);\r | |
2058 | }\r | |
2059 | }\r | |
2060 | KekDataSize -= CertList->SignatureListSize;\r | |
2061 | CertList = (EFI_SIGNATURE_LIST *) ((UINT8 *) CertList + CertList->SignatureListSize);\r | |
2062 | }\r | |
ed47ae02 | 2063 | } else if (AuthVarType == AuthVarTypePriv) {\r |
2064 | \r | |
2065 | //\r | |
2066 | // Process common authenticated variable except PK/KEK/DB/DBX.\r | |
2067 | // Get signer's certificates from SignedData.\r | |
2068 | //\r | |
2069 | VerifyStatus = Pkcs7GetSigners (\r | |
2070 | SigData,\r | |
2071 | SigDataSize,\r | |
2072 | &SignerCerts,\r | |
2073 | &CertStackSize,\r | |
2074 | &RootCert,\r | |
2075 | &RootCertSize\r | |
2076 | );\r | |
2077 | if (!VerifyStatus) {\r | |
2078 | goto Exit;\r | |
2079 | }\r | |
2080 | \r | |
2081 | //\r | |
2082 | // Get previously stored signer's certificates from certdb for existing\r | |
2083 | // variable. Check whether they are identical with signer's certificates\r | |
2084 | // in SignedData. If not, return error immediately.\r | |
2085 | //\r | |
2086 | if ((Variable->CurrPtr != NULL)) {\r | |
2087 | VerifyStatus = FALSE;\r | |
2088 | \r | |
2089 | Status = GetCertsFromDb (VariableName, VendorGuid, &CertsInCertDb, &CertsSizeinDb);\r | |
2090 | if (EFI_ERROR (Status)) {\r | |
2091 | goto Exit;\r | |
2092 | }\r | |
2093 | \r | |
2094 | if ((CertStackSize != CertsSizeinDb) ||\r | |
2095 | (CompareMem (SignerCerts, CertsInCertDb, CertsSizeinDb) != 0)) {\r | |
2096 | goto Exit;\r | |
2097 | }\r | |
2098 | }\r | |
2099 | \r | |
2100 | VerifyStatus = Pkcs7Verify (\r | |
2101 | SigData,\r | |
2102 | SigDataSize,\r | |
2103 | RootCert,\r | |
2104 | RootCertSize,\r | |
2105 | NewData,\r | |
2106 | NewDataSize\r | |
2107 | );\r | |
2108 | if (!VerifyStatus) {\r | |
2109 | goto Exit;\r | |
2110 | }\r | |
2111 | \r | |
2112 | //\r | |
2113 | // Delete signer's certificates when delete the common authenticated variable.\r | |
2114 | //\r | |
2115 | if ((PayloadSize == 0) && (Variable->CurrPtr != NULL)) {\r | |
2116 | Status = DeleteCertsFromDb (VariableName, VendorGuid);\r | |
2117 | if (EFI_ERROR (Status)) {\r | |
2118 | VerifyStatus = FALSE;\r | |
2119 | goto Exit;\r | |
2120 | }\r | |
2121 | } else if (Variable->CurrPtr == NULL) {\r | |
2122 | //\r | |
2123 | // Insert signer's certificates when adding a new common authenticated variable.\r | |
2124 | //\r | |
2125 | Status = InsertCertsToDb (VariableName, VendorGuid, SignerCerts, CertStackSize);\r | |
2126 | if (EFI_ERROR (Status)) {\r | |
2127 | VerifyStatus = FALSE;\r | |
2128 | goto Exit;\r | |
2129 | }\r | |
2130 | }\r | |
785d84ea | 2131 | } else if (AuthVarType == AuthVarTypePayload) {\r |
2132 | CertList = (EFI_SIGNATURE_LIST *) PayloadPtr;\r | |
2133 | Cert = (EFI_SIGNATURE_DATA *) ((UINT8 *) CertList + sizeof (EFI_SIGNATURE_LIST) + CertList->SignatureHeaderSize);\r | |
2134 | RootCert = Cert->SignatureData;\r | |
2135 | RootCertSize = CertList->SignatureSize - (sizeof (EFI_SIGNATURE_DATA) - 1);\r | |
2136 | \r | |
2137 | // Verify Pkcs7 SignedData via Pkcs7Verify library.\r | |
2138 | //\r | |
2139 | VerifyStatus = Pkcs7Verify (\r | |
2140 | SigData,\r | |
2141 | SigDataSize,\r | |
2142 | RootCert,\r | |
2143 | RootCertSize,\r | |
2144 | NewData,\r | |
2145 | NewDataSize\r | |
2146 | );\r | |
ed47ae02 | 2147 | } else {\r |
2148 | return EFI_SECURITY_VIOLATION;\r | |
0c18794e | 2149 | }\r |
2150 | \r | |
2151 | Exit:\r | |
2152 | \r | |
ed47ae02 | 2153 | if (AuthVarType == AuthVarTypePriv) {\r |
2154 | Pkcs7FreeSigners (RootCert);\r | |
2155 | Pkcs7FreeSigners (SignerCerts);\r | |
2156 | }\r | |
2157 | \r | |
0c18794e | 2158 | if (!VerifyStatus) {\r |
2159 | return EFI_SECURITY_VIOLATION;\r | |
2160 | }\r | |
2161 | \r | |
d912bad7 | 2162 | Status = CheckSignatureListFormat(VariableName, VendorGuid, PayloadPtr, PayloadSize);\r |
2163 | if (EFI_ERROR (Status)) {\r | |
2164 | return Status;\r | |
2165 | }\r | |
2166 | \r | |
2d3fb919 | 2167 | if ((PayloadSize == 0) && (VarDel != NULL)) {\r |
0c18794e | 2168 | *VarDel = TRUE;\r |
2169 | }\r | |
2d3fb919 | 2170 | \r |
0c18794e | 2171 | //\r |
2172 | // Final step: Update/Append Variable if it pass Pkcs7Verify\r | |
2173 | //\r | |
ed47ae02 | 2174 | return UpdateVariable (\r |
2175 | VariableName,\r | |
2176 | VendorGuid,\r | |
2177 | PayloadPtr,\r | |
2178 | PayloadSize,\r | |
2179 | Attributes,\r | |
2180 | 0,\r | |
2181 | 0,\r | |
2182 | Variable,\r | |
2183 | &CertData->TimeStamp\r | |
2184 | );\r | |
0c18794e | 2185 | }\r |
ed47ae02 | 2186 | \r |