]> git.proxmox.com Git - mirror_edk2.git/blob - SecurityPkg/VariableAuthenticated/SecureBootConfigDxe/SecureBootConfigImpl.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
1. Set the secure boot state to Standard Mode when user leaving secure boot setup...
[mirror_edk2.git] / SecurityPkg / VariableAuthenticated / SecureBootConfigDxe / SecureBootConfigImpl.c
1 /** @file
2 HII Config Access protocol implementation of SecureBoot configuration module.
3
4 Copyright (c) 2011 - 2013, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 **/
14
15 #include "SecureBootConfigImpl.h"
16
17 CHAR16 mSecureBootStorageName[] = L"SECUREBOOT_CONFIGURATION";
18
19 SECUREBOOT_CONFIG_PRIVATE_DATA mSecureBootConfigPrivateDateTemplate = {
20 SECUREBOOT_CONFIG_PRIVATE_DATA_SIGNATURE,
21 {
22 SecureBootExtractConfig,
23 SecureBootRouteConfig,
24 SecureBootCallback
25 }
26 };
27
28 HII_VENDOR_DEVICE_PATH mSecureBootHiiVendorDevicePath = {
29 {
30 {
31 HARDWARE_DEVICE_PATH,
32 HW_VENDOR_DP,
33 {
34 (UINT8) (sizeof (VENDOR_DEVICE_PATH)),
35 (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)
36 }
37 },
38 SECUREBOOT_CONFIG_FORM_SET_GUID
39 },
40 {
41 END_DEVICE_PATH_TYPE,
42 END_ENTIRE_DEVICE_PATH_SUBTYPE,
43 {
44 (UINT8) (END_DEVICE_PATH_LENGTH),
45 (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)
46 }
47 }
48 };
49
50
51 //
52 // OID ASN.1 Value for Hash Algorithms
53 //
54 UINT8 mHashOidValue[] = {
55 0x2A, 0x86, 0x48, 0x86, 0xF7, 0x0D, 0x02, 0x05, // OBJ_md5
56 0x2B, 0x0E, 0x03, 0x02, 0x1A, // OBJ_sha1
57 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x04, // OBJ_sha224
58 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x01, // OBJ_sha256
59 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x02, // OBJ_sha384
60 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x03, // OBJ_sha512
61 };
62
63 HASH_TABLE mHash[] = {
64 { L"SHA1", 20, &mHashOidValue[8], 5, Sha1GetContextSize, Sha1Init, Sha1Update, Sha1Final },
65 { L"SHA224", 28, &mHashOidValue[13], 9, NULL, NULL, NULL, NULL },
66 { L"SHA256", 32, &mHashOidValue[22], 9, Sha256GetContextSize,Sha256Init, Sha256Update, Sha256Final},
67 { L"SHA384", 48, &mHashOidValue[31], 9, NULL, NULL, NULL, NULL },
68 { L"SHA512", 64, &mHashOidValue[40], 9, NULL, NULL, NULL, NULL }
69 };
70
71 //
72 // Variable Definitions
73 //
74 UINT32 mPeCoffHeaderOffset = 0;
75 WIN_CERTIFICATE *mCertificate = NULL;
76 IMAGE_TYPE mImageType;
77 UINT8 *mImageBase = NULL;
78 UINTN mImageSize = 0;
79 UINT8 mImageDigest[MAX_DIGEST_SIZE];
80 UINTN mImageDigestSize;
81 EFI_GUID mCertType;
82 EFI_IMAGE_SECURITY_DATA_DIRECTORY *mSecDataDir = NULL;
83 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION mNtHeader;
84
85 //
86 // Possible DER-encoded certificate file suffixes, end with NULL pointer.
87 //
88 CHAR16* mDerEncodedSuffix[] = {
89 L".cer",
90 L".der",
91 L".crt",
92 NULL
93 };
94 CHAR16* mSupportX509Suffix = L"*.cer/der/crt";
95
96 /**
97 This code checks if the FileSuffix is one of the possible DER-encoded certificate suffix.
98
99 @param[in] FileSuffix The suffix of the input certificate file
100
101 @retval TRUE It's a DER-encoded certificate.
102 @retval FALSE It's NOT a DER-encoded certificate.
103
104 **/
105 BOOLEAN
106 IsDerEncodeCertificate (
107 IN CONST CHAR16 *FileSuffix
108 )
109 {
110 UINTN Index;
111 for (Index = 0; mDerEncodedSuffix[Index] != NULL; Index++) {
112 if (StrCmp (FileSuffix, mDerEncodedSuffix[Index]) == 0) {
113 return TRUE;
114 }
115 }
116 return FALSE;
117 }
118
119 /**
120 Set Secure Boot option into variable space.
121
122 @param[in] VarValue The option of Secure Boot.
123
124 @retval EFI_SUCCESS The operation is finished successfully.
125 @retval Others Other errors as indicated.
126
127 **/
128 EFI_STATUS
129 SaveSecureBootVariable (
130 IN UINT8 VarValue
131 )
132 {
133 EFI_STATUS Status;
134
135 Status = gRT->SetVariable (
136 EFI_SECURE_BOOT_ENABLE_NAME,
137 &gEfiSecureBootEnableDisableGuid,
138 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,
139 sizeof (UINT8),
140 &VarValue
141 );
142 return Status;
143 }
144
145 /**
146 Create a time based data payload by concatenating the EFI_VARIABLE_AUTHENTICATION_2
147 descriptor with the input data. NO authentication is required in this function.
148
149 @param[in, out] DataSize On input, the size of Data buffer in bytes.
150 On output, the size of data returned in Data
151 buffer in bytes.
152 @param[in, out] Data On input, Pointer to data buffer to be wrapped or
153 pointer to NULL to wrap an empty payload.
154 On output, Pointer to the new payload date buffer allocated from pool,
155 it's caller's responsibility to free the memory when finish using it.
156
157 @retval EFI_SUCCESS Create time based payload successfully.
158 @retval EFI_OUT_OF_RESOURCES There are not enough memory resourses to create time based payload.
159 @retval EFI_INVALID_PARAMETER The parameter is invalid.
160 @retval Others Unexpected error happens.
161
162 **/
163 EFI_STATUS
164 CreateTimeBasedPayload (
165 IN OUT UINTN *DataSize,
166 IN OUT UINT8 **Data
167 )
168 {
169 EFI_STATUS Status;
170 UINT8 *NewData;
171 UINT8 *Payload;
172 UINTN PayloadSize;
173 EFI_VARIABLE_AUTHENTICATION_2 *DescriptorData;
174 UINTN DescriptorSize;
175 EFI_TIME Time;
176
177 if (Data == NULL || DataSize == NULL) {
178 return EFI_INVALID_PARAMETER;
179 }
180
181 //
182 // In Setup mode or Custom mode, the variable does not need to be signed but the
183 // parameters to the SetVariable() call still need to be prepared as authenticated
184 // variable. So we create EFI_VARIABLE_AUTHENTICATED_2 descriptor without certificate
185 // data in it.
186 //
187 Payload = *Data;
188 PayloadSize = *DataSize;
189
190 DescriptorSize = OFFSET_OF (EFI_VARIABLE_AUTHENTICATION_2, AuthInfo) + OFFSET_OF (WIN_CERTIFICATE_UEFI_GUID, CertData);
191 NewData = (UINT8*) AllocateZeroPool (DescriptorSize + PayloadSize);
192 if (NewData == NULL) {
193 return EFI_OUT_OF_RESOURCES;
194 }
195
196 if ((Payload != NULL) && (PayloadSize != 0)) {
197 CopyMem (NewData + DescriptorSize, Payload, PayloadSize);
198 }
199
200 DescriptorData = (EFI_VARIABLE_AUTHENTICATION_2 *) (NewData);
201
202 ZeroMem (&Time, sizeof (EFI_TIME));
203 Status = gRT->GetTime (&Time, NULL);
204 if (EFI_ERROR (Status)) {
205 FreePool(NewData);
206 return Status;
207 }
208 Time.Pad1 = 0;
209 Time.Nanosecond = 0;
210 Time.TimeZone = 0;
211 Time.Daylight = 0;
212 Time.Pad2 = 0;
213 CopyMem (&DescriptorData->TimeStamp, &Time, sizeof (EFI_TIME));
214
215 DescriptorData->AuthInfo.Hdr.dwLength = OFFSET_OF (WIN_CERTIFICATE_UEFI_GUID, CertData);
216 DescriptorData->AuthInfo.Hdr.wRevision = 0x0200;
217 DescriptorData->AuthInfo.Hdr.wCertificateType = WIN_CERT_TYPE_EFI_GUID;
218 CopyGuid (&DescriptorData->AuthInfo.CertType, &gEfiCertPkcs7Guid);
219
220 if (Payload != NULL) {
221 FreePool(Payload);
222 }
223
224 *DataSize = DescriptorSize + PayloadSize;
225 *Data = NewData;
226 return EFI_SUCCESS;
227 }
228
229 /**
230 Internal helper function to delete a Variable given its name and GUID, NO authentication
231 required.
232
233 @param[in] VariableName Name of the Variable.
234 @param[in] VendorGuid GUID of the Variable.
235
236 @retval EFI_SUCCESS Variable deleted successfully.
237 @retval Others The driver failed to start the device.
238
239 **/
240 EFI_STATUS
241 DeleteVariable (
242 IN CHAR16 *VariableName,
243 IN EFI_GUID *VendorGuid
244 )
245 {
246 EFI_STATUS Status;
247 VOID* Variable;
248 UINT8 *Data;
249 UINTN DataSize;
250 UINT32 Attr;
251
252 GetVariable2 (VariableName, VendorGuid, &Variable, NULL);
253 if (Variable == NULL) {
254 return EFI_SUCCESS;
255 }
256 FreePool (Variable);
257
258 Data = NULL;
259 DataSize = 0;
260 Attr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS
261 | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;
262
263 Status = CreateTimeBasedPayload (&DataSize, &Data);
264 if (EFI_ERROR (Status)) {
265 DEBUG ((EFI_D_ERROR, "Fail to create time-based data payload: %r", Status));
266 return Status;
267 }
268
269 Status = gRT->SetVariable (
270 VariableName,
271 VendorGuid,
272 Attr,
273 DataSize,
274 Data
275 );
276 if (Data != NULL) {
277 FreePool (Data);
278 }
279 return Status;
280 }
281
282 /**
283
284 Set the platform secure boot mode into "Custom" or "Standard" mode.
285
286 @param[in] SecureBootMode New secure boot mode: STANDARD_SECURE_BOOT_MODE or
287 CUSTOM_SECURE_BOOT_MODE.
288
289 @return EFI_SUCCESS The platform has switched to the special mode successfully.
290 @return other Fail to operate the secure boot mode.
291
292 **/
293 EFI_STATUS
294 SetSecureBootMode (
295 IN UINT8 SecureBootMode
296 )
297 {
298 return gRT->SetVariable (
299 EFI_CUSTOM_MODE_NAME,
300 &gEfiCustomModeEnableGuid,
301 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,
302 sizeof (UINT8),
303 &SecureBootMode
304 );
305 }
306
307 /**
308 Generate the PK signature list from the X509 Certificate storing file (.cer)
309
310 @param[in] X509File FileHandle of X509 Certificate storing file.
311 @param[out] PkCert Point to the data buffer to store the signature list.
312
313 @return EFI_UNSUPPORTED Unsupported Key Length.
314 @return EFI_OUT_OF_RESOURCES There are not enough memory resourses to form the signature list.
315
316 **/
317 EFI_STATUS
318 CreatePkX509SignatureList (
319 IN EFI_FILE_HANDLE X509File,
320 OUT EFI_SIGNATURE_LIST **PkCert
321 )
322 {
323 EFI_STATUS Status;
324 UINT8 *X509Data;
325 UINTN X509DataSize;
326 EFI_SIGNATURE_DATA *PkCertData;
327
328 X509Data = NULL;
329 PkCertData = NULL;
330 X509DataSize = 0;
331
332 Status = ReadFileContent (X509File, (VOID**) &X509Data, &X509DataSize, 0);
333 if (EFI_ERROR (Status)) {
334 goto ON_EXIT;
335 }
336 ASSERT (X509Data != NULL);
337
338 //
339 // Allocate space for PK certificate list and initialize it.
340 // Create PK database entry with SignatureHeaderSize equals 0.
341 //
342 *PkCert = (EFI_SIGNATURE_LIST*) AllocateZeroPool (
343 sizeof(EFI_SIGNATURE_LIST) + sizeof(EFI_SIGNATURE_DATA) - 1
344 + X509DataSize
345 );
346 if (*PkCert == NULL) {
347 Status = EFI_OUT_OF_RESOURCES;
348 goto ON_EXIT;
349 }
350
351 (*PkCert)->SignatureListSize = (UINT32) (sizeof(EFI_SIGNATURE_LIST)
352 + sizeof(EFI_SIGNATURE_DATA) - 1
353 + X509DataSize);
354 (*PkCert)->SignatureSize = (UINT32) (sizeof(EFI_SIGNATURE_DATA) - 1 + X509DataSize);
355 (*PkCert)->SignatureHeaderSize = 0;
356 CopyGuid (&(*PkCert)->SignatureType, &gEfiCertX509Guid);
357 PkCertData = (EFI_SIGNATURE_DATA*) ((UINTN)(*PkCert)
358 + sizeof(EFI_SIGNATURE_LIST)
359 + (*PkCert)->SignatureHeaderSize);
360 CopyGuid (&PkCertData->SignatureOwner, &gEfiGlobalVariableGuid);
361 //
362 // Fill the PK database with PKpub data from X509 certificate file.
363 //
364 CopyMem (&(PkCertData->SignatureData[0]), X509Data, X509DataSize);
365
366 ON_EXIT:
367
368 if (X509Data != NULL) {
369 FreePool (X509Data);
370 }
371
372 if (EFI_ERROR(Status) && *PkCert != NULL) {
373 FreePool (*PkCert);
374 *PkCert = NULL;
375 }
376
377 return Status;
378 }
379
380 /**
381 Enroll new PK into the System without original PK's authentication.
382
383 The SignatureOwner GUID will be the same with PK's vendorguid.
384
385 @param[in] PrivateData The module's private data.
386
387 @retval EFI_SUCCESS New PK enrolled successfully.
388 @retval EFI_INVALID_PARAMETER The parameter is invalid.
389 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
390
391 **/
392 EFI_STATUS
393 EnrollPlatformKey (
394 IN SECUREBOOT_CONFIG_PRIVATE_DATA* Private
395 )
396 {
397 EFI_STATUS Status;
398 UINT32 Attr;
399 UINTN DataSize;
400 EFI_SIGNATURE_LIST *PkCert;
401 UINT16* FilePostFix;
402
403 if (Private->FileContext->FileName == NULL) {
404 return EFI_INVALID_PARAMETER;
405 }
406
407 PkCert = NULL;
408
409 Status = SetSecureBootMode(CUSTOM_SECURE_BOOT_MODE);
410 if (EFI_ERROR (Status)) {
411 return Status;
412 }
413
414 //
415 // Parse the file's postfix. Only support DER encoded X.509 certificate files.
416 //
417 FilePostFix = Private->FileContext->FileName + StrLen (Private->FileContext->FileName) - 4;
418 if (!IsDerEncodeCertificate(FilePostFix)) {
419 DEBUG ((EFI_D_ERROR, "Unsupported file type, only DER encoded certificate (%s) is supported.", mSupportX509Suffix));
420 return EFI_INVALID_PARAMETER;
421 }
422 DEBUG ((EFI_D_INFO, "FileName= %s\n", Private->FileContext->FileName));
423 DEBUG ((EFI_D_INFO, "FilePostFix = %s\n", FilePostFix));
424
425 //
426 // Prase the selected PK file and generature PK certificate list.
427 //
428 Status = CreatePkX509SignatureList (
429 Private->FileContext->FHandle,
430 &PkCert
431 );
432 if (EFI_ERROR (Status)) {
433 goto ON_EXIT;
434 }
435 ASSERT (PkCert != NULL);
436
437 //
438 // Set Platform Key variable.
439 //
440 Attr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS
441 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;
442 DataSize = PkCert->SignatureListSize;
443 Status = CreateTimeBasedPayload (&DataSize, (UINT8**) &PkCert);
444 if (EFI_ERROR (Status)) {
445 DEBUG ((EFI_D_ERROR, "Fail to create time-based data payload: %r", Status));
446 goto ON_EXIT;
447 }
448
449 Status = gRT->SetVariable(
450 EFI_PLATFORM_KEY_NAME,
451 &gEfiGlobalVariableGuid,
452 Attr,
453 DataSize,
454 PkCert
455 );
456 if (EFI_ERROR (Status)) {
457 if (Status == EFI_OUT_OF_RESOURCES) {
458 DEBUG ((EFI_D_ERROR, "Enroll PK failed with out of resource.\n"));
459 }
460 goto ON_EXIT;
461 }
462
463 ON_EXIT:
464
465 if (PkCert != NULL) {
466 FreePool(PkCert);
467 }
468
469 if (Private->FileContext->FHandle != NULL) {
470 CloseFile (Private->FileContext->FHandle);
471 Private->FileContext->FHandle = NULL;
472 }
473
474 return Status;
475 }
476
477 /**
478 Remove the PK variable.
479
480 @retval EFI_SUCCESS Delete PK successfully.
481 @retval Others Could not allow to delete PK.
482
483 **/
484 EFI_STATUS
485 DeletePlatformKey (
486 VOID
487 )
488 {
489 EFI_STATUS Status;
490
491 Status = SetSecureBootMode(CUSTOM_SECURE_BOOT_MODE);
492 if (EFI_ERROR (Status)) {
493 return Status;
494 }
495
496 Status = DeleteVariable (
497 EFI_PLATFORM_KEY_NAME,
498 &gEfiGlobalVariableGuid
499 );
500 return Status;
501 }
502
503 /**
504 Enroll a new KEK item from public key storing file (*.pbk).
505
506 @param[in] PrivateData The module's private data.
507
508 @retval EFI_SUCCESS New KEK enrolled successfully.
509 @retval EFI_INVALID_PARAMETER The parameter is invalid.
510 @retval EFI_UNSUPPORTED Unsupported command.
511 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
512
513 **/
514 EFI_STATUS
515 EnrollRsa2048ToKek (
516 IN SECUREBOOT_CONFIG_PRIVATE_DATA *Private
517 )
518 {
519 EFI_STATUS Status;
520 UINT32 Attr;
521 UINTN DataSize;
522 EFI_SIGNATURE_LIST *KekSigList;
523 UINTN KeyBlobSize;
524 UINT8 *KeyBlob;
525 CPL_KEY_INFO *KeyInfo;
526 EFI_SIGNATURE_DATA *KEKSigData;
527 UINTN KekSigListSize;
528 UINT8 *KeyBuffer;
529 UINTN KeyLenInBytes;
530
531 Attr = 0;
532 DataSize = 0;
533 KeyBuffer = NULL;
534 KeyBlobSize = 0;
535 KeyBlob = NULL;
536 KeyInfo = NULL;
537 KEKSigData = NULL;
538 KekSigList = NULL;
539 KekSigListSize = 0;
540
541 //
542 // Form the KeKpub certificate list into EFI_SIGNATURE_LIST type.
543 // First, We have to parse out public key data from the pbk key file.
544 //
545 Status = ReadFileContent (
546 Private->FileContext->FHandle,
547 (VOID**) &KeyBlob,
548 &KeyBlobSize,
549 0
550 );
551 if (EFI_ERROR (Status)) {
552 goto ON_EXIT;
553 }
554 ASSERT (KeyBlob != NULL);
555 KeyInfo = (CPL_KEY_INFO *) KeyBlob;
556 if (KeyInfo->KeyLengthInBits / 8 != WIN_CERT_UEFI_RSA2048_SIZE) {
557 DEBUG ((DEBUG_ERROR, "Unsupported key length, Only RSA2048 is supported.\n"));
558 Status = EFI_UNSUPPORTED;
559 goto ON_EXIT;
560 }
561
562 //
563 // Convert the Public key to fix octet string format represented in RSA PKCS#1.
564 //
565 KeyLenInBytes = KeyInfo->KeyLengthInBits / 8;
566 KeyBuffer = AllocateZeroPool (KeyLenInBytes);
567 if (KeyBuffer == NULL) {
568 Status = EFI_OUT_OF_RESOURCES;
569 goto ON_EXIT;
570 }
571 Int2OctStr (
572 (UINTN*) (KeyBlob + sizeof (CPL_KEY_INFO)),
573 KeyLenInBytes / sizeof (UINTN),
574 KeyBuffer,
575 KeyLenInBytes
576 );
577 CopyMem(KeyBlob + sizeof(CPL_KEY_INFO), KeyBuffer, KeyLenInBytes);
578
579 //
580 // Form an new EFI_SIGNATURE_LIST.
581 //
582 KekSigListSize = sizeof(EFI_SIGNATURE_LIST)
583 + sizeof(EFI_SIGNATURE_DATA) - 1
584 + WIN_CERT_UEFI_RSA2048_SIZE;
585
586 KekSigList = (EFI_SIGNATURE_LIST*) AllocateZeroPool (KekSigListSize);
587 if (KekSigList == NULL) {
588 Status = EFI_OUT_OF_RESOURCES;
589 goto ON_EXIT;
590 }
591
592 KekSigList->SignatureListSize = sizeof(EFI_SIGNATURE_LIST)
593 + sizeof(EFI_SIGNATURE_DATA) - 1
594 + WIN_CERT_UEFI_RSA2048_SIZE;
595 KekSigList->SignatureHeaderSize = 0;
596 KekSigList->SignatureSize = sizeof(EFI_SIGNATURE_DATA) - 1 + WIN_CERT_UEFI_RSA2048_SIZE;
597 CopyGuid (&KekSigList->SignatureType, &gEfiCertRsa2048Guid);
598
599 KEKSigData = (EFI_SIGNATURE_DATA*)((UINT8*)KekSigList + sizeof(EFI_SIGNATURE_LIST));
600 CopyGuid (&KEKSigData->SignatureOwner, Private->SignatureGUID);
601 CopyMem (
602 KEKSigData->SignatureData,
603 KeyBlob + sizeof(CPL_KEY_INFO),
604 WIN_CERT_UEFI_RSA2048_SIZE
605 );
606
607 //
608 // Check if KEK entry has been already existed.
609 // If true, use EFI_VARIABLE_APPEND_WRITE attribute to append the
610 // new KEK to original variable.
611 //
612 Attr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS
613 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;
614 Status = CreateTimeBasedPayload (&KekSigListSize, (UINT8**) &KekSigList);
615 if (EFI_ERROR (Status)) {
616 DEBUG ((EFI_D_ERROR, "Fail to create time-based data payload: %r", Status));
617 goto ON_EXIT;
618 }
619
620 Status = gRT->GetVariable(
621 EFI_KEY_EXCHANGE_KEY_NAME,
622 &gEfiGlobalVariableGuid,
623 NULL,
624 &DataSize,
625 NULL
626 );
627 if (Status == EFI_BUFFER_TOO_SMALL) {
628 Attr |= EFI_VARIABLE_APPEND_WRITE;
629 } else if (Status != EFI_NOT_FOUND) {
630 goto ON_EXIT;
631 }
632
633 //
634 // Done. Now we have formed the correct KEKpub database item, just set it into variable storage,
635 //
636 Status = gRT->SetVariable(
637 EFI_KEY_EXCHANGE_KEY_NAME,
638 &gEfiGlobalVariableGuid,
639 Attr,
640 KekSigListSize,
641 KekSigList
642 );
643 if (EFI_ERROR (Status)) {
644 goto ON_EXIT;
645 }
646
647 ON_EXIT:
648
649 CloseFile (Private->FileContext->FHandle);
650 Private->FileContext->FHandle = NULL;
651 Private->FileContext->FileName = NULL;
652
653 if (Private->SignatureGUID != NULL) {
654 FreePool (Private->SignatureGUID);
655 Private->SignatureGUID = NULL;
656 }
657
658 if (KeyBlob != NULL) {
659 FreePool (KeyBlob);
660 }
661 if (KeyBuffer != NULL) {
662 FreePool (KeyBuffer);
663 }
664 if (KekSigList != NULL) {
665 FreePool (KekSigList);
666 }
667
668 return Status;
669 }
670
671 /**
672 Enroll a new KEK item from X509 certificate file.
673
674 @param[in] PrivateData The module's private data.
675
676 @retval EFI_SUCCESS New X509 is enrolled successfully.
677 @retval EFI_INVALID_PARAMETER The parameter is invalid.
678 @retval EFI_UNSUPPORTED Unsupported command.
679 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
680
681 **/
682 EFI_STATUS
683 EnrollX509ToKek (
684 IN SECUREBOOT_CONFIG_PRIVATE_DATA *Private
685 )
686 {
687 EFI_STATUS Status;
688 UINTN X509DataSize;
689 VOID *X509Data;
690 EFI_SIGNATURE_DATA *KEKSigData;
691 EFI_SIGNATURE_LIST *KekSigList;
692 UINTN DataSize;
693 UINTN KekSigListSize;
694 UINT32 Attr;
695
696 X509Data = NULL;
697 X509DataSize = 0;
698 KekSigList = NULL;
699 KekSigListSize = 0;
700 DataSize = 0;
701 KEKSigData = NULL;
702
703 Status = ReadFileContent (
704 Private->FileContext->FHandle,
705 &X509Data,
706 &X509DataSize,
707 0
708 );
709 if (EFI_ERROR (Status)) {
710 goto ON_EXIT;
711 }
712 ASSERT (X509Data != NULL);
713
714 KekSigListSize = sizeof(EFI_SIGNATURE_LIST) + sizeof(EFI_SIGNATURE_DATA) - 1 + X509DataSize;
715 KekSigList = (EFI_SIGNATURE_LIST*) AllocateZeroPool (KekSigListSize);
716 if (KekSigList == NULL) {
717 Status = EFI_OUT_OF_RESOURCES;
718 goto ON_EXIT;
719 }
720
721 //
722 // Fill Certificate Database parameters.
723 //
724 KekSigList->SignatureListSize = (UINT32) KekSigListSize;
725 KekSigList->SignatureHeaderSize = 0;
726 KekSigList->SignatureSize = (UINT32) (sizeof(EFI_SIGNATURE_DATA) - 1 + X509DataSize);
727 CopyGuid (&KekSigList->SignatureType, &gEfiCertX509Guid);
728
729 KEKSigData = (EFI_SIGNATURE_DATA*) ((UINT8*) KekSigList + sizeof (EFI_SIGNATURE_LIST));
730 CopyGuid (&KEKSigData->SignatureOwner, Private->SignatureGUID);
731 CopyMem (KEKSigData->SignatureData, X509Data, X509DataSize);
732
733 //
734 // Check if KEK been already existed.
735 // If true, use EFI_VARIABLE_APPEND_WRITE attribute to append the
736 // new kek to original variable
737 //
738 Attr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS
739 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;
740 Status = CreateTimeBasedPayload (&KekSigListSize, (UINT8**) &KekSigList);
741 if (EFI_ERROR (Status)) {
742 DEBUG ((EFI_D_ERROR, "Fail to create time-based data payload: %r", Status));
743 goto ON_EXIT;
744 }
745
746 Status = gRT->GetVariable(
747 EFI_KEY_EXCHANGE_KEY_NAME,
748 &gEfiGlobalVariableGuid,
749 NULL,
750 &DataSize,
751 NULL
752 );
753 if (Status == EFI_BUFFER_TOO_SMALL) {
754 Attr |= EFI_VARIABLE_APPEND_WRITE;
755 } else if (Status != EFI_NOT_FOUND) {
756 goto ON_EXIT;
757 }
758
759 Status = gRT->SetVariable(
760 EFI_KEY_EXCHANGE_KEY_NAME,
761 &gEfiGlobalVariableGuid,
762 Attr,
763 KekSigListSize,
764 KekSigList
765 );
766 if (EFI_ERROR (Status)) {
767 goto ON_EXIT;
768 }
769
770 ON_EXIT:
771
772 CloseFile (Private->FileContext->FHandle);
773 Private->FileContext->FileName = NULL;
774 Private->FileContext->FHandle = NULL;
775
776 if (Private->SignatureGUID != NULL) {
777 FreePool (Private->SignatureGUID);
778 Private->SignatureGUID = NULL;
779 }
780
781 if (KekSigList != NULL) {
782 FreePool (KekSigList);
783 }
784
785 return Status;
786 }
787
788 /**
789 Enroll new KEK into the System without PK's authentication.
790 The SignatureOwner GUID will be Private->SignatureGUID.
791
792 @param[in] PrivateData The module's private data.
793
794 @retval EFI_SUCCESS New KEK enrolled successful.
795 @retval EFI_INVALID_PARAMETER The parameter is invalid.
796 @retval others Fail to enroll KEK data.
797
798 **/
799 EFI_STATUS
800 EnrollKeyExchangeKey (
801 IN SECUREBOOT_CONFIG_PRIVATE_DATA *Private
802 )
803 {
804 UINT16* FilePostFix;
805 EFI_STATUS Status;
806
807 if ((Private->FileContext->FileName == NULL) || (Private->SignatureGUID == NULL)) {
808 return EFI_INVALID_PARAMETER;
809 }
810
811 Status = SetSecureBootMode(CUSTOM_SECURE_BOOT_MODE);
812 if (EFI_ERROR (Status)) {
813 return Status;
814 }
815
816 //
817 // Parse the file's postfix. Supports DER-encoded X509 certificate,
818 // and .pbk as RSA public key file.
819 //
820 FilePostFix = Private->FileContext->FileName + StrLen (Private->FileContext->FileName) - 4;
821 if (IsDerEncodeCertificate(FilePostFix)) {
822 return EnrollX509ToKek (Private);
823 } else if (CompareMem (FilePostFix, L".pbk",4) == 0) {
824 return EnrollRsa2048ToKek (Private);
825 } else {
826 return EFI_INVALID_PARAMETER;
827 }
828 }
829
830 /**
831 Enroll a new X509 certificate into Signature Database (DB or DBX) without
832 KEK's authentication.
833
834 @param[in] PrivateData The module's private data.
835 @param[in] VariableName Variable name of signature database, must be
836 EFI_IMAGE_SECURITY_DATABASE or EFI_IMAGE_SECURITY_DATABASE1.
837
838 @retval EFI_SUCCESS New X509 is enrolled successfully.
839 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
840
841 **/
842 EFI_STATUS
843 EnrollX509toSigDB (
844 IN SECUREBOOT_CONFIG_PRIVATE_DATA *Private,
845 IN CHAR16 *VariableName
846 )
847 {
848 EFI_STATUS Status;
849 UINTN X509DataSize;
850 VOID *X509Data;
851 EFI_SIGNATURE_LIST *SigDBCert;
852 EFI_SIGNATURE_DATA *SigDBCertData;
853 VOID *Data;
854 UINTN DataSize;
855 UINTN SigDBSize;
856 UINT32 Attr;
857
858 X509DataSize = 0;
859 SigDBSize = 0;
860 DataSize = 0;
861 X509Data = NULL;
862 SigDBCert = NULL;
863 SigDBCertData = NULL;
864 Data = NULL;
865
866 Status = ReadFileContent (
867 Private->FileContext->FHandle,
868 &X509Data,
869 &X509DataSize,
870 0
871 );
872 if (EFI_ERROR (Status)) {
873 goto ON_EXIT;
874 }
875 ASSERT (X509Data != NULL);
876
877 SigDBSize = sizeof(EFI_SIGNATURE_LIST) + sizeof(EFI_SIGNATURE_DATA) - 1 + X509DataSize;
878
879 Data = AllocateZeroPool (SigDBSize);
880 if (Data == NULL) {
881 Status = EFI_OUT_OF_RESOURCES;
882 goto ON_EXIT;
883 }
884
885 //
886 // Fill Certificate Database parameters.
887 //
888 SigDBCert = (EFI_SIGNATURE_LIST*) Data;
889 SigDBCert->SignatureListSize = (UINT32) SigDBSize;
890 SigDBCert->SignatureHeaderSize = 0;
891 SigDBCert->SignatureSize = (UINT32) (sizeof(EFI_SIGNATURE_DATA) - 1 + X509DataSize);
892 CopyGuid (&SigDBCert->SignatureType, &gEfiCertX509Guid);
893
894 SigDBCertData = (EFI_SIGNATURE_DATA*) ((UINT8* ) SigDBCert + sizeof (EFI_SIGNATURE_LIST));
895 CopyGuid (&SigDBCertData->SignatureOwner, Private->SignatureGUID);
896 CopyMem ((UINT8* ) (SigDBCertData->SignatureData), X509Data, X509DataSize);
897
898 //
899 // Check if signature database entry has been already existed.
900 // If true, use EFI_VARIABLE_APPEND_WRITE attribute to append the
901 // new signature data to original variable
902 //
903 Attr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS
904 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;
905 Status = CreateTimeBasedPayload (&SigDBSize, (UINT8**) &Data);
906 if (EFI_ERROR (Status)) {
907 DEBUG ((EFI_D_ERROR, "Fail to create time-based data payload: %r", Status));
908 goto ON_EXIT;
909 }
910
911 Status = gRT->GetVariable(
912 VariableName,
913 &gEfiImageSecurityDatabaseGuid,
914 NULL,
915 &DataSize,
916 NULL
917 );
918 if (Status == EFI_BUFFER_TOO_SMALL) {
919 Attr |= EFI_VARIABLE_APPEND_WRITE;
920 } else if (Status != EFI_NOT_FOUND) {
921 goto ON_EXIT;
922 }
923
924 Status = gRT->SetVariable(
925 VariableName,
926 &gEfiImageSecurityDatabaseGuid,
927 Attr,
928 SigDBSize,
929 Data
930 );
931 if (EFI_ERROR (Status)) {
932 goto ON_EXIT;
933 }
934
935 ON_EXIT:
936
937 CloseFile (Private->FileContext->FHandle);
938 Private->FileContext->FileName = NULL;
939 Private->FileContext->FHandle = NULL;
940
941 if (Private->SignatureGUID != NULL) {
942 FreePool (Private->SignatureGUID);
943 Private->SignatureGUID = NULL;
944 }
945
946 if (Data != NULL) {
947 FreePool (Data);
948 }
949
950 if (X509Data != NULL) {
951 FreePool (X509Data);
952 }
953
954 return Status;
955 }
956
957 /**
958 Load PE/COFF image information into internal buffer and check its validity.
959
960 @retval EFI_SUCCESS Successful
961 @retval EFI_UNSUPPORTED Invalid PE/COFF file
962 @retval EFI_ABORTED Serious error occurs, like file I/O error etc.
963
964 **/
965 EFI_STATUS
966 LoadPeImage (
967 VOID
968 )
969 {
970 EFI_IMAGE_DOS_HEADER *DosHdr;
971 EFI_IMAGE_NT_HEADERS32 *NtHeader32;
972 EFI_IMAGE_NT_HEADERS64 *NtHeader64;
973
974 NtHeader32 = NULL;
975 NtHeader64 = NULL;
976 //
977 // Read the Dos header
978 //
979 DosHdr = (EFI_IMAGE_DOS_HEADER*)(mImageBase);
980 if (DosHdr->e_magic == EFI_IMAGE_DOS_SIGNATURE)
981 {
982 //
983 // DOS image header is present,
984 // So read the PE header after the DOS image header
985 //
986 mPeCoffHeaderOffset = DosHdr->e_lfanew;
987 }
988 else
989 {
990 mPeCoffHeaderOffset = 0;
991 }
992
993 //
994 // Read PE header and check the signature validity and machine compatibility
995 //
996 NtHeader32 = (EFI_IMAGE_NT_HEADERS32*) (mImageBase + mPeCoffHeaderOffset);
997 if (NtHeader32->Signature != EFI_IMAGE_NT_SIGNATURE)
998 {
999 return EFI_UNSUPPORTED;
1000 }
1001
1002 mNtHeader.Pe32 = NtHeader32;
1003
1004 //
1005 // Check the architecture field of PE header and get the Certificate Data Directory data
1006 // Note the size of FileHeader field is constant for both IA32 and X64 arch
1007 //
1008 if ((NtHeader32->FileHeader.Machine == EFI_IMAGE_MACHINE_IA32)
1009 || (NtHeader32->FileHeader.Machine == EFI_IMAGE_MACHINE_EBC)) {
1010 //
1011 // IA-32 Architecture
1012 //
1013 mImageType = ImageType_IA32;
1014 mSecDataDir = (EFI_IMAGE_SECURITY_DATA_DIRECTORY*) &(NtHeader32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY]);
1015 }
1016 else if ((NtHeader32->FileHeader.Machine == EFI_IMAGE_MACHINE_IA64)
1017 || (NtHeader32->FileHeader.Machine == EFI_IMAGE_MACHINE_X64)) {
1018 //
1019 // 64-bits Architecture
1020 //
1021 mImageType = ImageType_X64;
1022 NtHeader64 = (EFI_IMAGE_NT_HEADERS64 *) (mImageBase + mPeCoffHeaderOffset);
1023 mSecDataDir = (EFI_IMAGE_SECURITY_DATA_DIRECTORY*) &(NtHeader64->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY]);
1024 } else {
1025 return EFI_UNSUPPORTED;
1026 }
1027
1028 return EFI_SUCCESS;
1029 }
1030
1031 /**
1032 Calculate hash of Pe/Coff image based on the authenticode image hashing in
1033 PE/COFF Specification 8.0 Appendix A
1034
1035 @param[in] HashAlg Hash algorithm type.
1036
1037 @retval TRUE Successfully hash image.
1038 @retval FALSE Fail in hash image.
1039
1040 **/
1041 BOOLEAN
1042 HashPeImage (
1043 IN UINT32 HashAlg
1044 )
1045 {
1046 BOOLEAN Status;
1047 UINT16 Magic;
1048 EFI_IMAGE_SECTION_HEADER *Section;
1049 VOID *HashCtx;
1050 UINTN CtxSize;
1051 UINT8 *HashBase;
1052 UINTN HashSize;
1053 UINTN SumOfBytesHashed;
1054 EFI_IMAGE_SECTION_HEADER *SectionHeader;
1055 UINTN Index;
1056 UINTN Pos;
1057
1058 HashCtx = NULL;
1059 SectionHeader = NULL;
1060 Status = FALSE;
1061
1062 if ((HashAlg != HASHALG_SHA1) && (HashAlg != HASHALG_SHA256)) {
1063 return FALSE;
1064 }
1065
1066 //
1067 // Initialize context of hash.
1068 //
1069 ZeroMem (mImageDigest, MAX_DIGEST_SIZE);
1070
1071 if (HashAlg == HASHALG_SHA1) {
1072 mImageDigestSize = SHA1_DIGEST_SIZE;
1073 mCertType = gEfiCertSha1Guid;
1074 } else if (HashAlg == HASHALG_SHA256) {
1075 mImageDigestSize = SHA256_DIGEST_SIZE;
1076 mCertType = gEfiCertSha256Guid;
1077 }
1078
1079 CtxSize = mHash[HashAlg].GetContextSize();
1080
1081 HashCtx = AllocatePool (CtxSize);
1082 ASSERT (HashCtx != NULL);
1083
1084 // 1. Load the image header into memory.
1085
1086 // 2. Initialize a SHA hash context.
1087 Status = mHash[HashAlg].HashInit(HashCtx);
1088 if (!Status) {
1089 goto Done;
1090 }
1091 //
1092 // Measuring PE/COFF Image Header;
1093 // But CheckSum field and SECURITY data directory (certificate) are excluded
1094 //
1095 if (mNtHeader.Pe32->FileHeader.Machine == IMAGE_FILE_MACHINE_IA64 && mNtHeader.Pe32->OptionalHeader.Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
1096 //
1097 // NOTE: Some versions of Linux ELILO for Itanium have an incorrect magic value
1098 // in the PE/COFF Header. If the MachineType is Itanium(IA64) and the
1099 // Magic value in the OptionalHeader is EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
1100 // then override the magic value to EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
1101 //
1102 Magic = EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC;
1103 } else {
1104 //
1105 // Get the magic value from the PE/COFF Optional Header
1106 //
1107 Magic = mNtHeader.Pe32->OptionalHeader.Magic;
1108 }
1109
1110 //
1111 // 3. Calculate the distance from the base of the image header to the image checksum address.
1112 // 4. Hash the image header from its base to beginning of the image checksum.
1113 //
1114 HashBase = mImageBase;
1115 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
1116 //
1117 // Use PE32 offset.
1118 //
1119 HashSize = (UINTN) ((UINT8 *) (&mNtHeader.Pe32->OptionalHeader.CheckSum) - HashBase);
1120 } else {
1121 //
1122 // Use PE32+ offset.
1123 //
1124 HashSize = (UINTN) ((UINT8 *) (&mNtHeader.Pe32Plus->OptionalHeader.CheckSum) - HashBase);
1125 }
1126
1127 Status = mHash[HashAlg].HashUpdate(HashCtx, HashBase, HashSize);
1128 if (!Status) {
1129 goto Done;
1130 }
1131 //
1132 // 5. Skip over the image checksum (it occupies a single ULONG).
1133 // 6. Get the address of the beginning of the Cert Directory.
1134 // 7. Hash everything from the end of the checksum to the start of the Cert Directory.
1135 //
1136 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
1137 //
1138 // Use PE32 offset.
1139 //
1140 HashBase = (UINT8 *) &mNtHeader.Pe32->OptionalHeader.CheckSum + sizeof (UINT32);
1141 HashSize = (UINTN) ((UINT8 *) (&mNtHeader.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY]) - HashBase);
1142 } else {
1143 //
1144 // Use PE32+ offset.
1145 //
1146 HashBase = (UINT8 *) &mNtHeader.Pe32Plus->OptionalHeader.CheckSum + sizeof (UINT32);
1147 HashSize = (UINTN) ((UINT8 *) (&mNtHeader.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY]) - HashBase);
1148 }
1149
1150 Status = mHash[HashAlg].HashUpdate(HashCtx, HashBase, HashSize);
1151 if (!Status) {
1152 goto Done;
1153 }
1154 //
1155 // 8. Skip over the Cert Directory. (It is sizeof(IMAGE_DATA_DIRECTORY) bytes.)
1156 // 9. Hash everything from the end of the Cert Directory to the end of image header.
1157 //
1158 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
1159 //
1160 // Use PE32 offset
1161 //
1162 HashBase = (UINT8 *) &mNtHeader.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY + 1];
1163 HashSize = mNtHeader.Pe32->OptionalHeader.SizeOfHeaders - (UINTN) ((UINT8 *) (&mNtHeader.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY + 1]) - mImageBase);
1164 } else {
1165 //
1166 // Use PE32+ offset.
1167 //
1168 HashBase = (UINT8 *) &mNtHeader.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY + 1];
1169 HashSize = mNtHeader.Pe32Plus->OptionalHeader.SizeOfHeaders - (UINTN) ((UINT8 *) (&mNtHeader.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY + 1]) - mImageBase);
1170 }
1171
1172 Status = mHash[HashAlg].HashUpdate(HashCtx, HashBase, HashSize);
1173 if (!Status) {
1174 goto Done;
1175 }
1176 //
1177 // 10. Set the SUM_OF_BYTES_HASHED to the size of the header.
1178 //
1179 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
1180 //
1181 // Use PE32 offset.
1182 //
1183 SumOfBytesHashed = mNtHeader.Pe32->OptionalHeader.SizeOfHeaders;
1184 } else {
1185 //
1186 // Use PE32+ offset
1187 //
1188 SumOfBytesHashed = mNtHeader.Pe32Plus->OptionalHeader.SizeOfHeaders;
1189 }
1190
1191 //
1192 // 11. Build a temporary table of pointers to all the IMAGE_SECTION_HEADER
1193 // structures in the image. The 'NumberOfSections' field of the image
1194 // header indicates how big the table should be. Do not include any
1195 // IMAGE_SECTION_HEADERs in the table whose 'SizeOfRawData' field is zero.
1196 //
1197 SectionHeader = (EFI_IMAGE_SECTION_HEADER *) AllocateZeroPool (sizeof (EFI_IMAGE_SECTION_HEADER) * mNtHeader.Pe32->FileHeader.NumberOfSections);
1198 ASSERT (SectionHeader != NULL);
1199 //
1200 // 12. Using the 'PointerToRawData' in the referenced section headers as
1201 // a key, arrange the elements in the table in ascending order. In other
1202 // words, sort the section headers according to the disk-file offset of
1203 // the section.
1204 //
1205 Section = (EFI_IMAGE_SECTION_HEADER *) (
1206 mImageBase +
1207 mPeCoffHeaderOffset +
1208 sizeof (UINT32) +
1209 sizeof (EFI_IMAGE_FILE_HEADER) +
1210 mNtHeader.Pe32->FileHeader.SizeOfOptionalHeader
1211 );
1212 for (Index = 0; Index < mNtHeader.Pe32->FileHeader.NumberOfSections; Index++) {
1213 Pos = Index;
1214 while ((Pos > 0) && (Section->PointerToRawData < SectionHeader[Pos - 1].PointerToRawData)) {
1215 CopyMem (&SectionHeader[Pos], &SectionHeader[Pos - 1], sizeof (EFI_IMAGE_SECTION_HEADER));
1216 Pos--;
1217 }
1218 CopyMem (&SectionHeader[Pos], Section, sizeof (EFI_IMAGE_SECTION_HEADER));
1219 Section += 1;
1220 }
1221
1222 //
1223 // 13. Walk through the sorted table, bring the corresponding section
1224 // into memory, and hash the entire section (using the 'SizeOfRawData'
1225 // field in the section header to determine the amount of data to hash).
1226 // 14. Add the section's 'SizeOfRawData' to SUM_OF_BYTES_HASHED .
1227 // 15. Repeat steps 13 and 14 for all the sections in the sorted table.
1228 //
1229 for (Index = 0; Index < mNtHeader.Pe32->FileHeader.NumberOfSections; Index++) {
1230 Section = &SectionHeader[Index];
1231 if (Section->SizeOfRawData == 0) {
1232 continue;
1233 }
1234 HashBase = mImageBase + Section->PointerToRawData;
1235 HashSize = (UINTN) Section->SizeOfRawData;
1236
1237 Status = mHash[HashAlg].HashUpdate(HashCtx, HashBase, HashSize);
1238 if (!Status) {
1239 goto Done;
1240 }
1241
1242 SumOfBytesHashed += HashSize;
1243 }
1244
1245 //
1246 // 16. If the file size is greater than SUM_OF_BYTES_HASHED, there is extra
1247 // data in the file that needs to be added to the hash. This data begins
1248 // at file offset SUM_OF_BYTES_HASHED and its length is:
1249 // FileSize - (CertDirectory->Size)
1250 //
1251 if (mImageSize > SumOfBytesHashed) {
1252 HashBase = mImageBase + SumOfBytesHashed;
1253 if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
1254 //
1255 // Use PE32 offset.
1256 //
1257 HashSize = (UINTN)(
1258 mImageSize -
1259 mNtHeader.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY].Size -
1260 SumOfBytesHashed);
1261 } else {
1262 //
1263 // Use PE32+ offset.
1264 //
1265 HashSize = (UINTN)(
1266 mImageSize -
1267 mNtHeader.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY].Size -
1268 SumOfBytesHashed);
1269 }
1270
1271 Status = mHash[HashAlg].HashUpdate(HashCtx, HashBase, HashSize);
1272 if (!Status) {
1273 goto Done;
1274 }
1275 }
1276
1277 Status = mHash[HashAlg].HashFinal(HashCtx, mImageDigest);
1278
1279 Done:
1280 if (HashCtx != NULL) {
1281 FreePool (HashCtx);
1282 }
1283 if (SectionHeader != NULL) {
1284 FreePool (SectionHeader);
1285 }
1286 return Status;
1287 }
1288
1289 /**
1290 Recognize the Hash algorithm in PE/COFF Authenticode and caculate hash of
1291 Pe/Coff image based on the authenticated image hashing in PE/COFF Specification
1292 8.0 Appendix A
1293
1294 @retval EFI_UNSUPPORTED Hash algorithm is not supported.
1295 @retval EFI_SUCCESS Hash successfully.
1296
1297 **/
1298 EFI_STATUS
1299 HashPeImageByType (
1300 VOID
1301 )
1302 {
1303 UINT8 Index;
1304 WIN_CERTIFICATE_EFI_PKCS *PkcsCertData;
1305
1306 PkcsCertData = (WIN_CERTIFICATE_EFI_PKCS *) (mImageBase + mSecDataDir->Offset);
1307
1308 for (Index = 0; Index < HASHALG_MAX; Index++) {
1309 //
1310 // Check the Hash algorithm in PE/COFF Authenticode.
1311 // According to PKCS#7 Definition:
1312 // SignedData ::= SEQUENCE {
1313 // version Version,
1314 // digestAlgorithms DigestAlgorithmIdentifiers,
1315 // contentInfo ContentInfo,
1316 // .... }
1317 // The DigestAlgorithmIdentifiers can be used to determine the hash algorithm in PE/COFF hashing
1318 // This field has the fixed offset (+32) in final Authenticode ASN.1 data.
1319 // Fixed offset (+32) is calculated based on two bytes of length encoding.
1320 //
1321 if ((*(PkcsCertData->CertData + 1) & TWO_BYTE_ENCODE) != TWO_BYTE_ENCODE) {
1322 //
1323 // Only support two bytes of Long Form of Length Encoding.
1324 //
1325 continue;
1326 }
1327
1328 //
1329 if (CompareMem (PkcsCertData->CertData + 32, mHash[Index].OidValue, mHash[Index].OidLength) == 0) {
1330 break;
1331 }
1332 }
1333
1334 if (Index == HASHALG_MAX) {
1335 return EFI_UNSUPPORTED;
1336 }
1337
1338 //
1339 // HASH PE Image based on Hash algorithm in PE/COFF Authenticode.
1340 //
1341 if (!HashPeImage(Index)) {
1342 return EFI_UNSUPPORTED;
1343 }
1344
1345 return EFI_SUCCESS;
1346 }
1347
1348 /**
1349 Enroll a new executable's signature into Signature Database.
1350
1351 @param[in] PrivateData The module's private data.
1352 @param[in] VariableName Variable name of signature database, must be
1353 EFI_IMAGE_SECURITY_DATABASE or EFI_IMAGE_SECURITY_DATABASE1.
1354
1355 @retval EFI_SUCCESS New signature is enrolled successfully.
1356 @retval EFI_INVALID_PARAMETER The parameter is invalid.
1357 @retval EFI_UNSUPPORTED Unsupported command.
1358 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
1359
1360 **/
1361 EFI_STATUS
1362 EnrollImageSignatureToSigDB (
1363 IN SECUREBOOT_CONFIG_PRIVATE_DATA *Private,
1364 IN CHAR16 *VariableName
1365 )
1366 {
1367 EFI_STATUS Status;
1368 EFI_SIGNATURE_LIST *SigDBCert;
1369 EFI_SIGNATURE_DATA *SigDBCertData;
1370 VOID *Data;
1371 UINTN DataSize;
1372 UINTN SigDBSize;
1373 UINT32 Attr;
1374 WIN_CERTIFICATE_UEFI_GUID *GuidCertData;
1375
1376 Data = NULL;
1377 GuidCertData = NULL;
1378
1379 //
1380 // Form the SigDB certificate list.
1381 // Format the data item into EFI_SIGNATURE_LIST type.
1382 //
1383 // We need to parse executable's signature data from specified signed executable file.
1384 // In current implementation, we simply trust the pass-in signed executable file.
1385 // In reality, it's OS's responsibility to verify the signed executable file.
1386 //
1387
1388 //
1389 // Read the whole file content
1390 //
1391 Status = ReadFileContent(
1392 Private->FileContext->FHandle,
1393 (VOID **) &mImageBase,
1394 &mImageSize,
1395 0
1396 );
1397 if (EFI_ERROR (Status)) {
1398 goto ON_EXIT;
1399 }
1400 ASSERT (mImageBase != NULL);
1401
1402 Status = LoadPeImage ();
1403 if (EFI_ERROR (Status)) {
1404 goto ON_EXIT;
1405 }
1406
1407 if (mSecDataDir->SizeOfCert == 0) {
1408 if (!HashPeImage (HASHALG_SHA256)) {
1409 Status = EFI_SECURITY_VIOLATION;
1410 goto ON_EXIT;
1411 }
1412 } else {
1413
1414 //
1415 // Read the certificate data
1416 //
1417 mCertificate = (WIN_CERTIFICATE *)(mImageBase + mSecDataDir->Offset);
1418
1419 if (mCertificate->wCertificateType == WIN_CERT_TYPE_EFI_GUID) {
1420 GuidCertData = (WIN_CERTIFICATE_UEFI_GUID*) mCertificate;
1421 if (CompareMem (&GuidCertData->CertType, &gEfiCertTypeRsa2048Sha256Guid, sizeof(EFI_GUID)) != 0) {
1422 Status = EFI_ABORTED;
1423 goto ON_EXIT;
1424 }
1425
1426 if (!HashPeImage (HASHALG_SHA256)) {
1427 Status = EFI_ABORTED;
1428 goto ON_EXIT;;
1429 }
1430
1431 } else if (mCertificate->wCertificateType == WIN_CERT_TYPE_PKCS_SIGNED_DATA) {
1432
1433 Status = HashPeImageByType ();
1434 if (EFI_ERROR (Status)) {
1435 goto ON_EXIT;;
1436 }
1437 } else {
1438 Status = EFI_ABORTED;
1439 goto ON_EXIT;
1440 }
1441 }
1442
1443 //
1444 // Create a new SigDB entry.
1445 //
1446 SigDBSize = sizeof(EFI_SIGNATURE_LIST)
1447 + sizeof(EFI_SIGNATURE_DATA) - 1
1448 + (UINT32) mImageDigestSize;
1449
1450 Data = (UINT8*) AllocateZeroPool (SigDBSize);
1451 if (Data == NULL) {
1452 Status = EFI_OUT_OF_RESOURCES;
1453 goto ON_EXIT;
1454 }
1455
1456 //
1457 // Adjust the Certificate Database parameters.
1458 //
1459 SigDBCert = (EFI_SIGNATURE_LIST*) Data;
1460 SigDBCert->SignatureListSize = (UINT32) SigDBSize;
1461 SigDBCert->SignatureHeaderSize = 0;
1462 SigDBCert->SignatureSize = sizeof(EFI_SIGNATURE_DATA) - 1 + (UINT32) mImageDigestSize;
1463 CopyGuid (&SigDBCert->SignatureType, &mCertType);
1464
1465 SigDBCertData = (EFI_SIGNATURE_DATA*)((UINT8*)SigDBCert + sizeof(EFI_SIGNATURE_LIST));
1466 CopyGuid (&SigDBCertData->SignatureOwner, Private->SignatureGUID);
1467 CopyMem (SigDBCertData->SignatureData, mImageDigest, mImageDigestSize);
1468
1469 Attr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS
1470 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;
1471 Status = CreateTimeBasedPayload (&SigDBSize, (UINT8**) &Data);
1472 if (EFI_ERROR (Status)) {
1473 DEBUG ((EFI_D_ERROR, "Fail to create time-based data payload: %r", Status));
1474 goto ON_EXIT;
1475 }
1476
1477 //
1478 // Check if SigDB variable has been already existed.
1479 // If true, use EFI_VARIABLE_APPEND_WRITE attribute to append the
1480 // new signature data to original variable
1481 //
1482 DataSize = 0;
1483 Status = gRT->GetVariable(
1484 VariableName,
1485 &gEfiImageSecurityDatabaseGuid,
1486 NULL,
1487 &DataSize,
1488 NULL
1489 );
1490 if (Status == EFI_BUFFER_TOO_SMALL) {
1491 Attr |= EFI_VARIABLE_APPEND_WRITE;
1492 } else if (Status != EFI_NOT_FOUND) {
1493 goto ON_EXIT;
1494 }
1495
1496 //
1497 // Enroll the variable.
1498 //
1499 Status = gRT->SetVariable(
1500 VariableName,
1501 &gEfiImageSecurityDatabaseGuid,
1502 Attr,
1503 SigDBSize,
1504 Data
1505 );
1506 if (EFI_ERROR (Status)) {
1507 goto ON_EXIT;
1508 }
1509
1510 ON_EXIT:
1511
1512 CloseFile (Private->FileContext->FHandle);
1513 Private->FileContext->FHandle = NULL;
1514 Private->FileContext->FileName = NULL;
1515
1516 if (Private->SignatureGUID != NULL) {
1517 FreePool (Private->SignatureGUID);
1518 Private->SignatureGUID = NULL;
1519 }
1520
1521 if (Data != NULL) {
1522 FreePool (Data);
1523 }
1524
1525 if (mImageBase != NULL) {
1526 FreePool (mImageBase);
1527 mImageBase = NULL;
1528 }
1529
1530 return Status;
1531 }
1532
1533 /**
1534 Enroll signature into DB/DBX without KEK's authentication.
1535 The SignatureOwner GUID will be Private->SignatureGUID.
1536
1537 @param[in] PrivateData The module's private data.
1538 @param[in] VariableName Variable name of signature database, must be
1539 EFI_IMAGE_SECURITY_DATABASE or EFI_IMAGE_SECURITY_DATABASE1.
1540
1541 @retval EFI_SUCCESS New signature enrolled successfully.
1542 @retval EFI_INVALID_PARAMETER The parameter is invalid.
1543 @retval others Fail to enroll signature data.
1544
1545 **/
1546 EFI_STATUS
1547 EnrollSignatureDatabase (
1548 IN SECUREBOOT_CONFIG_PRIVATE_DATA *Private,
1549 IN CHAR16 *VariableName
1550 )
1551 {
1552 UINT16* FilePostFix;
1553 EFI_STATUS Status;
1554
1555 if ((Private->FileContext->FileName == NULL) || (Private->FileContext->FHandle == NULL) || (Private->SignatureGUID == NULL)) {
1556 return EFI_INVALID_PARAMETER;
1557 }
1558
1559 Status = SetSecureBootMode(CUSTOM_SECURE_BOOT_MODE);
1560 if (EFI_ERROR (Status)) {
1561 return Status;
1562 }
1563
1564 //
1565 // Parse the file's postfix.
1566 //
1567 FilePostFix = Private->FileContext->FileName + StrLen (Private->FileContext->FileName) - 4;
1568 if (IsDerEncodeCertificate(FilePostFix)) {
1569 //
1570 // Supports DER-encoded X509 certificate.
1571 //
1572 return EnrollX509toSigDB (Private, VariableName);
1573 }
1574
1575 return EnrollImageSignatureToSigDB (Private, VariableName);
1576 }
1577
1578 /**
1579 List all signatures in specified signature database (e.g. KEK/DB/DBX)
1580 by GUID in the page for user to select and delete as needed.
1581
1582 @param[in] PrivateData Module's private data.
1583 @param[in] VariableName The variable name of the vendor's signature database.
1584 @param[in] VendorGuid A unique identifier for the vendor.
1585 @param[in] LabelNumber Label number to insert opcodes.
1586 @param[in] FormId Form ID of current page.
1587 @param[in] QuestionIdBase Base question id of the signature list.
1588
1589 @retval EFI_SUCCESS Success to update the signature list page
1590 @retval EFI_OUT_OF_RESOURCES Unable to allocate required resources.
1591
1592 **/
1593 EFI_STATUS
1594 UpdateDeletePage (
1595 IN SECUREBOOT_CONFIG_PRIVATE_DATA *PrivateData,
1596 IN CHAR16 *VariableName,
1597 IN EFI_GUID *VendorGuid,
1598 IN UINT16 LabelNumber,
1599 IN EFI_FORM_ID FormId,
1600 IN EFI_QUESTION_ID QuestionIdBase
1601 )
1602 {
1603 EFI_STATUS Status;
1604 UINT32 Index;
1605 UINTN CertCount;
1606 UINTN GuidIndex;
1607 VOID *StartOpCodeHandle;
1608 VOID *EndOpCodeHandle;
1609 EFI_IFR_GUID_LABEL *StartLabel;
1610 EFI_IFR_GUID_LABEL *EndLabel;
1611 UINTN DataSize;
1612 UINT8 *Data;
1613 EFI_SIGNATURE_LIST *CertList;
1614 EFI_SIGNATURE_DATA *Cert;
1615 UINT32 ItemDataSize;
1616 CHAR16 *GuidStr;
1617 EFI_STRING_ID GuidID;
1618 EFI_STRING_ID Help;
1619
1620 Data = NULL;
1621 CertList = NULL;
1622 Cert = NULL;
1623 GuidStr = NULL;
1624 StartOpCodeHandle = NULL;
1625 EndOpCodeHandle = NULL;
1626
1627 //
1628 // Initialize the container for dynamic opcodes.
1629 //
1630 StartOpCodeHandle = HiiAllocateOpCodeHandle ();
1631 if (StartOpCodeHandle == NULL) {
1632 Status = EFI_OUT_OF_RESOURCES;
1633 goto ON_EXIT;
1634 }
1635
1636 EndOpCodeHandle = HiiAllocateOpCodeHandle ();
1637 if (EndOpCodeHandle == NULL) {
1638 Status = EFI_OUT_OF_RESOURCES;
1639 goto ON_EXIT;
1640 }
1641
1642 //
1643 // Create Hii Extend Label OpCode.
1644 //
1645 StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (
1646 StartOpCodeHandle,
1647 &gEfiIfrTianoGuid,
1648 NULL,
1649 sizeof (EFI_IFR_GUID_LABEL)
1650 );
1651 StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
1652 StartLabel->Number = LabelNumber;
1653
1654 EndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (
1655 EndOpCodeHandle,
1656 &gEfiIfrTianoGuid,
1657 NULL,
1658 sizeof (EFI_IFR_GUID_LABEL)
1659 );
1660 EndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
1661 EndLabel->Number = LABEL_END;
1662
1663 //
1664 // Read Variable.
1665 //
1666 DataSize = 0;
1667 Status = gRT->GetVariable (VariableName, VendorGuid, NULL, &DataSize, Data);
1668 if (EFI_ERROR (Status) && Status != EFI_BUFFER_TOO_SMALL) {
1669 goto ON_EXIT;
1670 }
1671
1672 Data = (UINT8 *) AllocateZeroPool (DataSize);
1673 if (Data == NULL) {
1674 Status = EFI_OUT_OF_RESOURCES;
1675 goto ON_EXIT;
1676 }
1677
1678 Status = gRT->GetVariable (VariableName, VendorGuid, NULL, &DataSize, Data);
1679 if (EFI_ERROR (Status)) {
1680 goto ON_EXIT;
1681 }
1682
1683 GuidStr = AllocateZeroPool (100);
1684 if (GuidStr == NULL) {
1685 Status = EFI_OUT_OF_RESOURCES;
1686 goto ON_EXIT;
1687 }
1688
1689 //
1690 // Enumerate all KEK pub data.
1691 //
1692 ItemDataSize = (UINT32) DataSize;
1693 CertList = (EFI_SIGNATURE_LIST *) Data;
1694 GuidIndex = 0;
1695
1696 while ((ItemDataSize > 0) && (ItemDataSize >= CertList->SignatureListSize)) {
1697
1698 if (CompareGuid (&CertList->SignatureType, &gEfiCertRsa2048Guid)) {
1699 Help = STRING_TOKEN (STR_CERT_TYPE_RSA2048_SHA256_GUID);
1700 } else if (CompareGuid (&CertList->SignatureType, &gEfiCertX509Guid)) {
1701 Help = STRING_TOKEN (STR_CERT_TYPE_PCKS7_GUID);
1702 } else if (CompareGuid (&CertList->SignatureType, &gEfiCertSha1Guid)) {
1703 Help = STRING_TOKEN (STR_CERT_TYPE_SHA1_GUID);
1704 } else if (CompareGuid (&CertList->SignatureType, &gEfiCertSha256Guid)) {
1705 Help = STRING_TOKEN (STR_CERT_TYPE_SHA256_GUID);
1706 } else {
1707 //
1708 // The signature type is not supported in current implementation.
1709 //
1710 continue;
1711 }
1712
1713 CertCount = (CertList->SignatureListSize - sizeof (EFI_SIGNATURE_LIST) - CertList->SignatureHeaderSize) / CertList->SignatureSize;
1714 for (Index = 0; Index < CertCount; Index++) {
1715 Cert = (EFI_SIGNATURE_DATA *) ((UINT8 *) CertList
1716 + sizeof (EFI_SIGNATURE_LIST)
1717 + CertList->SignatureHeaderSize
1718 + Index * CertList->SignatureSize);
1719 //
1720 // Display GUID and help
1721 //
1722 GuidToString (&Cert->SignatureOwner, GuidStr, 100);
1723 GuidID = HiiSetString (PrivateData->HiiHandle, 0, GuidStr, NULL);
1724 HiiCreateCheckBoxOpCode (
1725 StartOpCodeHandle,
1726 (EFI_QUESTION_ID) (QuestionIdBase + GuidIndex++),
1727 0,
1728 0,
1729 GuidID,
1730 Help,
1731 EFI_IFR_FLAG_CALLBACK,
1732 0,
1733 NULL
1734 );
1735 }
1736
1737 ItemDataSize -= CertList->SignatureListSize;
1738 CertList = (EFI_SIGNATURE_LIST *) ((UINT8 *) CertList + CertList->SignatureListSize);
1739 }
1740
1741 ON_EXIT:
1742 HiiUpdateForm (
1743 PrivateData->HiiHandle,
1744 &gSecureBootConfigFormSetGuid,
1745 FormId,
1746 StartOpCodeHandle,
1747 EndOpCodeHandle
1748 );
1749
1750 if (StartOpCodeHandle != NULL) {
1751 HiiFreeOpCodeHandle (StartOpCodeHandle);
1752 }
1753
1754 if (EndOpCodeHandle != NULL) {
1755 HiiFreeOpCodeHandle (EndOpCodeHandle);
1756 }
1757
1758 if (Data != NULL) {
1759 FreePool (Data);
1760 }
1761
1762 if (GuidStr != NULL) {
1763 FreePool (GuidStr);
1764 }
1765
1766 return EFI_SUCCESS;
1767 }
1768
1769 /**
1770 Delete a KEK entry from KEK database.
1771
1772 @param[in] PrivateData Module's private data.
1773 @param[in] QuestionId Question id of the KEK item to delete.
1774
1775 @retval EFI_SUCCESS Delete kek item successfully.
1776 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
1777
1778 **/
1779 EFI_STATUS
1780 DeleteKeyExchangeKey (
1781 IN SECUREBOOT_CONFIG_PRIVATE_DATA *PrivateData,
1782 IN EFI_QUESTION_ID QuestionId
1783 )
1784 {
1785 EFI_STATUS Status;
1786 UINTN DataSize;
1787 UINT8 *Data;
1788 UINT8 *OldData;
1789 UINT32 Attr;
1790 UINT32 Index;
1791 EFI_SIGNATURE_LIST *CertList;
1792 EFI_SIGNATURE_LIST *NewCertList;
1793 EFI_SIGNATURE_DATA *Cert;
1794 UINTN CertCount;
1795 UINT32 Offset;
1796 BOOLEAN IsKEKItemFound;
1797 UINT32 KekDataSize;
1798 UINTN DeleteKekIndex;
1799 UINTN GuidIndex;
1800
1801 Data = NULL;
1802 OldData = NULL;
1803 CertList = NULL;
1804 Cert = NULL;
1805 Attr = 0;
1806 DeleteKekIndex = QuestionId - OPTION_DEL_KEK_QUESTION_ID;
1807
1808 Status = SetSecureBootMode(CUSTOM_SECURE_BOOT_MODE);
1809 if (EFI_ERROR (Status)) {
1810 return Status;
1811 }
1812
1813 //
1814 // Get original KEK variable.
1815 //
1816 DataSize = 0;
1817 Status = gRT->GetVariable (EFI_KEY_EXCHANGE_KEY_NAME, &gEfiGlobalVariableGuid, NULL, &DataSize, NULL);
1818 if (EFI_ERROR(Status) && Status != EFI_BUFFER_TOO_SMALL) {
1819 goto ON_EXIT;
1820 }
1821
1822 OldData = (UINT8*)AllocateZeroPool(DataSize);
1823 if (OldData == NULL) {
1824 Status = EFI_OUT_OF_RESOURCES;
1825 goto ON_EXIT;
1826 }
1827
1828 Status = gRT->GetVariable (EFI_KEY_EXCHANGE_KEY_NAME, &gEfiGlobalVariableGuid, &Attr, &DataSize, OldData);
1829 if (EFI_ERROR(Status)) {
1830 goto ON_EXIT;
1831 }
1832
1833 //
1834 // Allocate space for new variable.
1835 //
1836 Data = (UINT8*) AllocateZeroPool (DataSize);
1837 if (Data == NULL) {
1838 Status = EFI_OUT_OF_RESOURCES;
1839 goto ON_EXIT;
1840 }
1841
1842 //
1843 // Enumerate all KEK pub data and erasing the target item.
1844 //
1845 IsKEKItemFound = FALSE;
1846 KekDataSize = (UINT32) DataSize;
1847 CertList = (EFI_SIGNATURE_LIST *) OldData;
1848 Offset = 0;
1849 GuidIndex = 0;
1850 while ((KekDataSize > 0) && (KekDataSize >= CertList->SignatureListSize)) {
1851 if (CompareGuid (&CertList->SignatureType, &gEfiCertRsa2048Guid) ||
1852 CompareGuid (&CertList->SignatureType, &gEfiCertX509Guid)) {
1853 CopyMem (Data + Offset, CertList, (sizeof(EFI_SIGNATURE_LIST) + CertList->SignatureHeaderSize));
1854 NewCertList = (EFI_SIGNATURE_LIST *)(Data + Offset);
1855 Offset += (sizeof(EFI_SIGNATURE_LIST) + CertList->SignatureHeaderSize);
1856 Cert = (EFI_SIGNATURE_DATA *) ((UINT8 *) CertList + sizeof (EFI_SIGNATURE_LIST) + CertList->SignatureHeaderSize);
1857 CertCount = (CertList->SignatureListSize - sizeof (EFI_SIGNATURE_LIST) - CertList->SignatureHeaderSize) / CertList->SignatureSize;
1858 for (Index = 0; Index < CertCount; Index++) {
1859 if (GuidIndex == DeleteKekIndex ) {
1860 //
1861 // Find it! Skip it!
1862 //
1863 NewCertList->SignatureListSize -= CertList->SignatureSize;
1864 IsKEKItemFound = TRUE;
1865 } else {
1866 //
1867 // This item doesn't match. Copy it to the Data buffer.
1868 //
1869 CopyMem (Data + Offset, Cert, CertList->SignatureSize);
1870 Offset += CertList->SignatureSize;
1871 }
1872 GuidIndex++;
1873 Cert = (EFI_SIGNATURE_DATA *) ((UINT8*) Cert + CertList->SignatureSize);
1874 }
1875 } else {
1876 //
1877 // This List doesn't match. Copy it to the Data buffer.
1878 //
1879 CopyMem (Data + Offset, CertList, CertList->SignatureListSize);
1880 Offset += CertList->SignatureListSize;
1881 }
1882
1883 KekDataSize -= CertList->SignatureListSize;
1884 CertList = (EFI_SIGNATURE_LIST*) ((UINT8*) CertList + CertList->SignatureListSize);
1885 }
1886
1887 if (!IsKEKItemFound) {
1888 //
1889 // Doesn't find the Kek Item!
1890 //
1891 Status = EFI_NOT_FOUND;
1892 goto ON_EXIT;
1893 }
1894
1895 //
1896 // Delete the Signature header if there is no signature in the list.
1897 //
1898 KekDataSize = Offset;
1899 CertList = (EFI_SIGNATURE_LIST*) Data;
1900 Offset = 0;
1901 ZeroMem (OldData, KekDataSize);
1902 while ((KekDataSize > 0) && (KekDataSize >= CertList->SignatureListSize)) {
1903 CertCount = (CertList->SignatureListSize - sizeof (EFI_SIGNATURE_LIST) - CertList->SignatureHeaderSize) / CertList->SignatureSize;
1904 DEBUG ((DEBUG_ERROR, " CertCount = %x\n", CertCount));
1905 if (CertCount != 0) {
1906 CopyMem (OldData + Offset, CertList, CertList->SignatureListSize);
1907 Offset += CertList->SignatureListSize;
1908 }
1909 KekDataSize -= CertList->SignatureListSize;
1910 CertList = (EFI_SIGNATURE_LIST *) ((UINT8 *) CertList + CertList->SignatureListSize);
1911 }
1912
1913 DataSize = Offset;
1914 if ((Attr & EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS) != 0) {
1915 Status = CreateTimeBasedPayload (&DataSize, &OldData);
1916 if (EFI_ERROR (Status)) {
1917 DEBUG ((EFI_D_ERROR, "Fail to create time-based data payload: %r", Status));
1918 goto ON_EXIT;
1919 }
1920 }
1921
1922 Status = gRT->SetVariable(
1923 EFI_KEY_EXCHANGE_KEY_NAME,
1924 &gEfiGlobalVariableGuid,
1925 Attr,
1926 DataSize,
1927 OldData
1928 );
1929 if (EFI_ERROR (Status)) {
1930 DEBUG ((DEBUG_ERROR, "Failed to set variable, Status = %r\n", Status));
1931 goto ON_EXIT;
1932 }
1933
1934 ON_EXIT:
1935 if (Data != NULL) {
1936 FreePool(Data);
1937 }
1938
1939 if (OldData != NULL) {
1940 FreePool(OldData);
1941 }
1942
1943 return UpdateDeletePage (
1944 PrivateData,
1945 EFI_KEY_EXCHANGE_KEY_NAME,
1946 &gEfiGlobalVariableGuid,
1947 LABEL_KEK_DELETE,
1948 FORMID_DELETE_KEK_FORM,
1949 OPTION_DEL_KEK_QUESTION_ID
1950 );
1951 }
1952
1953 /**
1954 Delete a signature entry from siganture database.
1955
1956 @param[in] PrivateData Module's private data.
1957 @param[in] VariableName The variable name of the vendor's signature database.
1958 @param[in] VendorGuid A unique identifier for the vendor.
1959 @param[in] LabelNumber Label number to insert opcodes.
1960 @param[in] FormId Form ID of current page.
1961 @param[in] QuestionIdBase Base question id of the signature list.
1962 @param[in] DeleteIndex Signature index to delete.
1963
1964 @retval EFI_SUCCESS Delete siganture successfully.
1965 @retval EFI_NOT_FOUND Can't find the signature item,
1966 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
1967 **/
1968 EFI_STATUS
1969 DeleteSignature (
1970 IN SECUREBOOT_CONFIG_PRIVATE_DATA *PrivateData,
1971 IN CHAR16 *VariableName,
1972 IN EFI_GUID *VendorGuid,
1973 IN UINT16 LabelNumber,
1974 IN EFI_FORM_ID FormId,
1975 IN EFI_QUESTION_ID QuestionIdBase,
1976 IN UINTN DeleteIndex
1977 )
1978 {
1979 EFI_STATUS Status;
1980 UINTN DataSize;
1981 UINT8 *Data;
1982 UINT8 *OldData;
1983 UINT32 Attr;
1984 UINT32 Index;
1985 EFI_SIGNATURE_LIST *CertList;
1986 EFI_SIGNATURE_LIST *NewCertList;
1987 EFI_SIGNATURE_DATA *Cert;
1988 UINTN CertCount;
1989 UINT32 Offset;
1990 BOOLEAN IsItemFound;
1991 UINT32 ItemDataSize;
1992 UINTN GuidIndex;
1993
1994 Data = NULL;
1995 OldData = NULL;
1996 CertList = NULL;
1997 Cert = NULL;
1998 Attr = 0;
1999
2000 Status = SetSecureBootMode(CUSTOM_SECURE_BOOT_MODE);
2001 if (EFI_ERROR (Status)) {
2002 return Status;
2003 }
2004
2005 //
2006 // Get original signature list data.
2007 //
2008 DataSize = 0;
2009 Status = gRT->GetVariable (VariableName, VendorGuid, NULL, &DataSize, NULL);
2010 if (EFI_ERROR (Status) && Status != EFI_BUFFER_TOO_SMALL) {
2011 goto ON_EXIT;
2012 }
2013
2014 OldData = (UINT8 *) AllocateZeroPool (DataSize);
2015 if (OldData == NULL) {
2016 Status = EFI_OUT_OF_RESOURCES;
2017 goto ON_EXIT;
2018 }
2019
2020 Status = gRT->GetVariable (VariableName, VendorGuid, &Attr, &DataSize, OldData);
2021 if (EFI_ERROR(Status)) {
2022 goto ON_EXIT;
2023 }
2024
2025 //
2026 // Allocate space for new variable.
2027 //
2028 Data = (UINT8*) AllocateZeroPool (DataSize);
2029 if (Data == NULL) {
2030 Status = EFI_OUT_OF_RESOURCES;
2031 goto ON_EXIT;
2032 }
2033
2034 //
2035 // Enumerate all signature data and erasing the target item.
2036 //
2037 IsItemFound = FALSE;
2038 ItemDataSize = (UINT32) DataSize;
2039 CertList = (EFI_SIGNATURE_LIST *) OldData;
2040 Offset = 0;
2041 GuidIndex = 0;
2042 while ((ItemDataSize > 0) && (ItemDataSize >= CertList->SignatureListSize)) {
2043 if (CompareGuid (&CertList->SignatureType, &gEfiCertRsa2048Guid) ||
2044 CompareGuid (&CertList->SignatureType, &gEfiCertX509Guid) ||
2045 CompareGuid (&CertList->SignatureType, &gEfiCertSha1Guid) ||
2046 CompareGuid (&CertList->SignatureType, &gEfiCertSha256Guid)
2047 ) {
2048 //
2049 // Copy EFI_SIGNATURE_LIST header then calculate the signature count in this list.
2050 //
2051 CopyMem (Data + Offset, CertList, (sizeof(EFI_SIGNATURE_LIST) + CertList->SignatureHeaderSize));
2052 NewCertList = (EFI_SIGNATURE_LIST*) (Data + Offset);
2053 Offset += (sizeof(EFI_SIGNATURE_LIST) + CertList->SignatureHeaderSize);
2054 Cert = (EFI_SIGNATURE_DATA *) ((UINT8 *) CertList + sizeof (EFI_SIGNATURE_LIST) + CertList->SignatureHeaderSize);
2055 CertCount = (CertList->SignatureListSize - sizeof (EFI_SIGNATURE_LIST) - CertList->SignatureHeaderSize) / CertList->SignatureSize;
2056 for (Index = 0; Index < CertCount; Index++) {
2057 if (GuidIndex == DeleteIndex) {
2058 //
2059 // Find it! Skip it!
2060 //
2061 NewCertList->SignatureListSize -= CertList->SignatureSize;
2062 IsItemFound = TRUE;
2063 } else {
2064 //
2065 // This item doesn't match. Copy it to the Data buffer.
2066 //
2067 CopyMem (Data + Offset, (UINT8*)(Cert), CertList->SignatureSize);
2068 Offset += CertList->SignatureSize;
2069 }
2070 GuidIndex++;
2071 Cert = (EFI_SIGNATURE_DATA *) ((UINT8 *) Cert + CertList->SignatureSize);
2072 }
2073 } else {
2074 //
2075 // This List doesn't match. Just copy it to the Data buffer.
2076 //
2077 CopyMem (Data + Offset, (UINT8*)(CertList), CertList->SignatureListSize);
2078 Offset += CertList->SignatureListSize;
2079 }
2080
2081 ItemDataSize -= CertList->SignatureListSize;
2082 CertList = (EFI_SIGNATURE_LIST *) ((UINT8 *) CertList + CertList->SignatureListSize);
2083 }
2084
2085 if (!IsItemFound) {
2086 //
2087 // Doesn't find the signature Item!
2088 //
2089 Status = EFI_NOT_FOUND;
2090 goto ON_EXIT;
2091 }
2092
2093 //
2094 // Delete the EFI_SIGNATURE_LIST header if there is no signature in the list.
2095 //
2096 ItemDataSize = Offset;
2097 CertList = (EFI_SIGNATURE_LIST *) Data;
2098 Offset = 0;
2099 ZeroMem (OldData, ItemDataSize);
2100 while ((ItemDataSize > 0) && (ItemDataSize >= CertList->SignatureListSize)) {
2101 CertCount = (CertList->SignatureListSize - sizeof (EFI_SIGNATURE_LIST) - CertList->SignatureHeaderSize) / CertList->SignatureSize;
2102 DEBUG ((DEBUG_ERROR, " CertCount = %x\n", CertCount));
2103 if (CertCount != 0) {
2104 CopyMem (OldData + Offset, (UINT8*)(CertList), CertList->SignatureListSize);
2105 Offset += CertList->SignatureListSize;
2106 }
2107 ItemDataSize -= CertList->SignatureListSize;
2108 CertList = (EFI_SIGNATURE_LIST *) ((UINT8 *) CertList + CertList->SignatureListSize);
2109 }
2110
2111 DataSize = Offset;
2112 if ((Attr & EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS) != 0) {
2113 Status = CreateTimeBasedPayload (&DataSize, &OldData);
2114 if (EFI_ERROR (Status)) {
2115 DEBUG ((EFI_D_ERROR, "Fail to create time-based data payload: %r", Status));
2116 goto ON_EXIT;
2117 }
2118 }
2119
2120 Status = gRT->SetVariable(
2121 VariableName,
2122 VendorGuid,
2123 Attr,
2124 DataSize,
2125 OldData
2126 );
2127 if (EFI_ERROR (Status)) {
2128 DEBUG ((DEBUG_ERROR, "Failed to set variable, Status = %r\n", Status));
2129 goto ON_EXIT;
2130 }
2131
2132 ON_EXIT:
2133 if (Data != NULL) {
2134 FreePool(Data);
2135 }
2136
2137 if (OldData != NULL) {
2138 FreePool(OldData);
2139 }
2140
2141 return UpdateDeletePage (
2142 PrivateData,
2143 VariableName,
2144 VendorGuid,
2145 LabelNumber,
2146 FormId,
2147 QuestionIdBase
2148 );
2149 }
2150
2151 /**
2152 This function extracts configuration from variable.
2153
2154 @param[in, out] ConfigData Point to SecureBoot configuration private data.
2155
2156 **/
2157 VOID
2158 SecureBootExtractConfigFromVariable (
2159 IN OUT SECUREBOOT_CONFIGURATION *ConfigData
2160 )
2161 {
2162 UINT8 *SecureBootEnable;
2163 UINT8 *SetupMode;
2164 UINT8 *SecureBootMode;
2165
2166 SecureBootEnable = NULL;
2167 SetupMode = NULL;
2168 SecureBootMode = NULL;
2169
2170 //
2171 // If the SecureBootEnable Variable doesn't exist, hide the SecureBoot Enable/Disable
2172 // Checkbox.
2173 //
2174 ConfigData->AttemptSecureBoot = FALSE;
2175 GetVariable2 (EFI_SECURE_BOOT_ENABLE_NAME, &gEfiSecureBootEnableDisableGuid, (VOID**)&SecureBootEnable, NULL);
2176 if (SecureBootEnable == NULL) {
2177 ConfigData->HideSecureBoot = TRUE;
2178 } else {
2179 ConfigData->HideSecureBoot = FALSE;
2180 if ((*SecureBootEnable) == SECURE_BOOT_ENABLE) {
2181 ConfigData->AttemptSecureBoot = TRUE;
2182 }
2183 }
2184
2185 //
2186 // If it is Physical Presence User, set the PhysicalPresent to true.
2187 //
2188 if (UserPhysicalPresent()) {
2189 ConfigData->PhysicalPresent = TRUE;
2190 } else {
2191 ConfigData->PhysicalPresent = FALSE;
2192 }
2193
2194 //
2195 // If there is no PK then the Delete Pk button will be gray.
2196 //
2197 GetVariable2 (EFI_SETUP_MODE_NAME, &gEfiGlobalVariableGuid, (VOID**)&SetupMode, NULL);
2198 if (SetupMode == NULL || (*SetupMode) == SETUP_MODE) {
2199 ConfigData->HasPk = FALSE;
2200 } else {
2201 ConfigData->HasPk = TRUE;
2202 }
2203
2204 //
2205 // Get the SecureBootMode from CustomMode variable.
2206 //
2207 GetVariable2 (EFI_CUSTOM_MODE_NAME, &gEfiCustomModeEnableGuid, (VOID**)&SecureBootMode, NULL);
2208 if (SecureBootMode == NULL) {
2209 ConfigData->SecureBootMode = STANDARD_SECURE_BOOT_MODE;
2210 } else {
2211 ConfigData->SecureBootMode = *(SecureBootMode);
2212 }
2213
2214 if (SecureBootEnable != NULL) {
2215 FreePool (SecureBootEnable);
2216 }
2217 if (SetupMode != NULL) {
2218 FreePool (SetupMode);
2219 }
2220 if (SecureBootMode != NULL) {
2221 FreePool (SecureBootMode);
2222 }
2223 }
2224
2225 /**
2226 This function allows a caller to extract the current configuration for one
2227 or more named elements from the target driver.
2228
2229 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
2230 @param[in] Request A null-terminated Unicode string in
2231 <ConfigRequest> format.
2232 @param[out] Progress On return, points to a character in the Request
2233 string. Points to the string's null terminator if
2234 request was successful. Points to the most recent
2235 '&' before the first failing name/value pair (or
2236 the beginning of the string if the failure is in
2237 the first name/value pair) if the request was not
2238 successful.
2239 @param[out] Results A null-terminated Unicode string in
2240 <ConfigAltResp> format which has all values filled
2241 in for the names in the Request string. String to
2242 be allocated by the called function.
2243
2244 @retval EFI_SUCCESS The Results is filled with the requested values.
2245 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
2246 @retval EFI_INVALID_PARAMETER Request is illegal syntax, or unknown name.
2247 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
2248 driver.
2249
2250 **/
2251 EFI_STATUS
2252 EFIAPI
2253 SecureBootExtractConfig (
2254 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
2255 IN CONST EFI_STRING Request,
2256 OUT EFI_STRING *Progress,
2257 OUT EFI_STRING *Results
2258 )
2259 {
2260 EFI_STATUS Status;
2261 UINTN BufferSize;
2262 UINTN Size;
2263 SECUREBOOT_CONFIGURATION Configuration;
2264 EFI_STRING ConfigRequest;
2265 EFI_STRING ConfigRequestHdr;
2266 SECUREBOOT_CONFIG_PRIVATE_DATA *PrivateData;
2267 BOOLEAN AllocatedRequest;
2268 UINT8 *SecureBoot;
2269
2270 if (Progress == NULL || Results == NULL) {
2271 return EFI_INVALID_PARAMETER;
2272 }
2273
2274 AllocatedRequest = FALSE;
2275 ConfigRequestHdr = NULL;
2276 ConfigRequest = NULL;
2277 Size = 0;
2278 SecureBoot = NULL;
2279
2280 ZeroMem (&Configuration, sizeof (Configuration));
2281 PrivateData = SECUREBOOT_CONFIG_PRIVATE_FROM_THIS (This);
2282 *Progress = Request;
2283
2284 if ((Request != NULL) && !HiiIsConfigHdrMatch (Request, &gSecureBootConfigFormSetGuid, mSecureBootStorageName)) {
2285 return EFI_NOT_FOUND;
2286 }
2287
2288 //
2289 // Get Configuration from Variable.
2290 //
2291 SecureBootExtractConfigFromVariable (&Configuration);
2292
2293 //
2294 // Update current secure boot state.
2295 //
2296 GetVariable2 (EFI_SECURE_BOOT_MODE_NAME, &gEfiGlobalVariableGuid, (VOID**)&SecureBoot, NULL);
2297 if (SecureBoot != NULL && *SecureBoot == SECURE_BOOT_MODE_ENABLE) {
2298 HiiSetString (PrivateData->HiiHandle, STRING_TOKEN (STR_SECURE_BOOT_STATE_CONTENT), L"Enabled", NULL);
2299 } else {
2300 HiiSetString (PrivateData->HiiHandle, STRING_TOKEN (STR_SECURE_BOOT_STATE_CONTENT), L"Disabled", NULL);
2301 }
2302 if (SecureBoot != NULL) {
2303 FreePool (SecureBoot);
2304 }
2305
2306 BufferSize = sizeof (SECUREBOOT_CONFIGURATION);
2307 ConfigRequest = Request;
2308 if ((Request == NULL) || (StrStr (Request, L"OFFSET") == NULL)) {
2309 //
2310 // Request is set to NULL or OFFSET is NULL, construct full request string.
2311 //
2312 // Allocate and fill a buffer large enough to hold the <ConfigHdr> template
2313 // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator
2314 //
2315 ConfigRequestHdr = HiiConstructConfigHdr (&gSecureBootConfigFormSetGuid, mSecureBootStorageName, PrivateData->DriverHandle);
2316 Size = (StrLen (ConfigRequestHdr) + 32 + 1) * sizeof (CHAR16);
2317 ConfigRequest = AllocateZeroPool (Size);
2318 ASSERT (ConfigRequest != NULL);
2319 AllocatedRequest = TRUE;
2320 UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr, (UINT64)BufferSize);
2321 FreePool (ConfigRequestHdr);
2322 ConfigRequestHdr = NULL;
2323 }
2324
2325 Status = gHiiConfigRouting->BlockToConfig (
2326 gHiiConfigRouting,
2327 ConfigRequest,
2328 (UINT8 *) &Configuration,
2329 BufferSize,
2330 Results,
2331 Progress
2332 );
2333
2334 //
2335 // Free the allocated config request string.
2336 //
2337 if (AllocatedRequest) {
2338 FreePool (ConfigRequest);
2339 }
2340
2341 //
2342 // Set Progress string to the original request string.
2343 //
2344 if (Request == NULL) {
2345 *Progress = NULL;
2346 } else if (StrStr (Request, L"OFFSET") == NULL) {
2347 *Progress = Request + StrLen (Request);
2348 }
2349
2350 return Status;
2351 }
2352
2353 /**
2354 This function processes the results of changes in configuration.
2355
2356 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
2357 @param[in] Configuration A null-terminated Unicode string in <ConfigResp>
2358 format.
2359 @param[out] Progress A pointer to a string filled in with the offset of
2360 the most recent '&' before the first failing
2361 name/value pair (or the beginning of the string if
2362 the failure is in the first name/value pair) or
2363 the terminating NULL if all was successful.
2364
2365 @retval EFI_SUCCESS The Results is processed successfully.
2366 @retval EFI_INVALID_PARAMETER Configuration is NULL.
2367 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
2368 driver.
2369
2370 **/
2371 EFI_STATUS
2372 EFIAPI
2373 SecureBootRouteConfig (
2374 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
2375 IN CONST EFI_STRING Configuration,
2376 OUT EFI_STRING *Progress
2377 )
2378 {
2379 if (Configuration == NULL || Progress == NULL) {
2380 return EFI_INVALID_PARAMETER;
2381 }
2382
2383 *Progress = Configuration;
2384 if (!HiiIsConfigHdrMatch (Configuration, &gSecureBootConfigFormSetGuid, mSecureBootStorageName)) {
2385 return EFI_NOT_FOUND;
2386 }
2387
2388 *Progress = Configuration + StrLen (Configuration);
2389 return EFI_SUCCESS;
2390 }
2391
2392 /**
2393 This function is called to provide results data to the driver.
2394
2395 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
2396 @param[in] Action Specifies the type of action taken by the browser.
2397 @param[in] QuestionId A unique value which is sent to the original
2398 exporting driver so that it can identify the type
2399 of data to expect.
2400 @param[in] Type The type of value for the question.
2401 @param[in] Value A pointer to the data being sent to the original
2402 exporting driver.
2403 @param[out] ActionRequest On return, points to the action requested by the
2404 callback function.
2405
2406 @retval EFI_SUCCESS The callback successfully handled the action.
2407 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the
2408 variable and its data.
2409 @retval EFI_DEVICE_ERROR The variable could not be saved.
2410 @retval EFI_UNSUPPORTED The specified Action is not supported by the
2411 callback.
2412
2413 **/
2414 EFI_STATUS
2415 EFIAPI
2416 SecureBootCallback (
2417 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
2418 IN EFI_BROWSER_ACTION Action,
2419 IN EFI_QUESTION_ID QuestionId,
2420 IN UINT8 Type,
2421 IN EFI_IFR_TYPE_VALUE *Value,
2422 OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest
2423 )
2424 {
2425 EFI_INPUT_KEY Key;
2426 EFI_STATUS Status;
2427 SECUREBOOT_CONFIG_PRIVATE_DATA *Private;
2428 UINTN BufferSize;
2429 SECUREBOOT_CONFIGURATION *IfrNvData;
2430 UINT16 LabelId;
2431 UINT8 *SecureBootEnable;
2432 UINT8 *SecureBootMode;
2433 UINT8 *SetupMode;
2434 CHAR16 PromptString[100];
2435
2436 SecureBootEnable = NULL;
2437 SecureBootMode = NULL;
2438 SetupMode = NULL;
2439
2440 if ((This == NULL) || (Value == NULL) || (ActionRequest == NULL)) {
2441 return EFI_INVALID_PARAMETER;
2442 }
2443
2444 if ((Action != EFI_BROWSER_ACTION_CHANGED) &&
2445 (Action != EFI_BROWSER_ACTION_CHANGING) &&
2446 (Action != EFI_BROWSER_ACTION_FORM_CLOSE)) {
2447 return EFI_UNSUPPORTED;
2448 }
2449
2450 Private = SECUREBOOT_CONFIG_PRIVATE_FROM_THIS (This);
2451
2452 //
2453 // Retrieve uncommitted data from Browser
2454 //
2455 BufferSize = sizeof (SECUREBOOT_CONFIGURATION);
2456 IfrNvData = AllocateZeroPool (BufferSize);
2457 if (IfrNvData == NULL) {
2458 return EFI_OUT_OF_RESOURCES;
2459 }
2460
2461 Status = EFI_SUCCESS;
2462
2463 HiiGetBrowserData (NULL, NULL, BufferSize, (UINT8 *) IfrNvData);
2464
2465 if (Action == EFI_BROWSER_ACTION_CHANGING) {
2466
2467 switch (QuestionId) {
2468 case KEY_SECURE_BOOT_ENABLE:
2469 GetVariable2 (EFI_SECURE_BOOT_ENABLE_NAME, &gEfiSecureBootEnableDisableGuid, (VOID**)&SecureBootEnable, NULL);
2470 if (NULL != SecureBootEnable) {
2471 FreePool (SecureBootEnable);
2472 if (EFI_ERROR (SaveSecureBootVariable (Value->u8))) {
2473 CreatePopUp (
2474 EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,
2475 &Key,
2476 L"Only Physical Presence User could disable secure boot!",
2477 NULL
2478 );
2479 Status = EFI_UNSUPPORTED;
2480 } else {
2481 CreatePopUp (
2482 EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,
2483 &Key,
2484 L"Configuration changed, please reset the platform to take effect!",
2485 NULL
2486 );
2487 }
2488 }
2489 break;
2490
2491 case KEY_SECURE_BOOT_OPTION:
2492 FreeMenu (&DirectoryMenu);
2493 FreeMenu (&FsOptionMenu);
2494 break;
2495
2496 case KEY_SECURE_BOOT_KEK_OPTION:
2497 case KEY_SECURE_BOOT_DB_OPTION:
2498 case KEY_SECURE_BOOT_DBX_OPTION:
2499 //
2500 // Clear Signature GUID.
2501 //
2502 ZeroMem (IfrNvData->SignatureGuid, sizeof (IfrNvData->SignatureGuid));
2503 if (Private->SignatureGUID == NULL) {
2504 Private->SignatureGUID = (EFI_GUID *) AllocateZeroPool (sizeof (EFI_GUID));
2505 if (Private->SignatureGUID == NULL) {
2506 return EFI_OUT_OF_RESOURCES;
2507 }
2508 }
2509
2510 if (QuestionId == KEY_SECURE_BOOT_DB_OPTION) {
2511 LabelId = SECUREBOOT_ENROLL_SIGNATURE_TO_DB;
2512 } else if (QuestionId == KEY_SECURE_BOOT_DBX_OPTION) {
2513 LabelId = SECUREBOOT_ENROLL_SIGNATURE_TO_DBX;
2514 } else {
2515 LabelId = FORMID_ENROLL_KEK_FORM;
2516 }
2517
2518 //
2519 // Refresh selected file.
2520 //
2521 CleanUpPage (LabelId, Private);
2522 break;
2523
2524 case SECUREBOOT_ADD_PK_FILE_FORM_ID:
2525 case FORMID_ENROLL_KEK_FORM:
2526 case SECUREBOOT_ENROLL_SIGNATURE_TO_DB:
2527 case SECUREBOOT_ENROLL_SIGNATURE_TO_DBX:
2528 if (QuestionId == SECUREBOOT_ADD_PK_FILE_FORM_ID) {
2529 Private->FeCurrentState = FileExplorerStateEnrollPkFile;
2530 } else if (QuestionId == FORMID_ENROLL_KEK_FORM) {
2531 Private->FeCurrentState = FileExplorerStateEnrollKekFile;
2532 } else if (QuestionId == SECUREBOOT_ENROLL_SIGNATURE_TO_DB) {
2533 Private->FeCurrentState = FileExplorerStateEnrollSignatureFileToDb;
2534 } else {
2535 Private->FeCurrentState = FileExplorerStateEnrollSignatureFileToDbx;
2536 }
2537
2538 Private->FeDisplayContext = FileExplorerDisplayUnknown;
2539 CleanUpPage (FORM_FILE_EXPLORER_ID, Private);
2540 UpdateFileExplorer (Private, 0);
2541 break;
2542
2543 case KEY_SECURE_BOOT_DELETE_PK:
2544 if (Value->u8) {
2545 CreatePopUp (
2546 EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,
2547 &Key,
2548 L"Are you sure you want to delete PK? Secure boot will be disabled!",
2549 L"Press 'Y' to delete PK and exit, 'N' to discard change and return",
2550 NULL
2551 );
2552 if (Key.UnicodeChar == 'y' || Key.UnicodeChar == 'Y') {
2553 Status = DeletePlatformKey ();
2554 if (EFI_ERROR (Status)) {
2555 CreatePopUp (
2556 EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,
2557 &Key,
2558 L"Only Physical Presence User could delete PK in custom mode!",
2559 NULL
2560 );
2561 }
2562 }
2563 }
2564 break;
2565
2566 case KEY_DELETE_KEK:
2567 UpdateDeletePage (
2568 Private,
2569 EFI_KEY_EXCHANGE_KEY_NAME,
2570 &gEfiGlobalVariableGuid,
2571 LABEL_KEK_DELETE,
2572 FORMID_DELETE_KEK_FORM,
2573 OPTION_DEL_KEK_QUESTION_ID
2574 );
2575 break;
2576
2577 case SECUREBOOT_DELETE_SIGNATURE_FROM_DB:
2578 UpdateDeletePage (
2579 Private,
2580 EFI_IMAGE_SECURITY_DATABASE,
2581 &gEfiImageSecurityDatabaseGuid,
2582 LABEL_DB_DELETE,
2583 SECUREBOOT_DELETE_SIGNATURE_FROM_DB,
2584 OPTION_DEL_DB_QUESTION_ID
2585 );
2586 break;
2587
2588 case SECUREBOOT_DELETE_SIGNATURE_FROM_DBX:
2589 UpdateDeletePage (
2590 Private,
2591 EFI_IMAGE_SECURITY_DATABASE1,
2592 &gEfiImageSecurityDatabaseGuid,
2593 LABEL_DBX_DELETE,
2594 SECUREBOOT_DELETE_SIGNATURE_FROM_DBX,
2595 OPTION_DEL_DBX_QUESTION_ID
2596 );
2597
2598 break;
2599
2600 case KEY_VALUE_SAVE_AND_EXIT_KEK:
2601 Status = EnrollKeyExchangeKey (Private);
2602 break;
2603
2604 case KEY_VALUE_SAVE_AND_EXIT_DB:
2605 Status = EnrollSignatureDatabase (Private, EFI_IMAGE_SECURITY_DATABASE);
2606 break;
2607
2608 case KEY_VALUE_SAVE_AND_EXIT_DBX:
2609 Status = EnrollSignatureDatabase (Private, EFI_IMAGE_SECURITY_DATABASE1);
2610 break;
2611
2612 default:
2613 if (QuestionId >= FILE_OPTION_OFFSET) {
2614 UpdateFileExplorer (Private, QuestionId);
2615 } else if ((QuestionId >= OPTION_DEL_KEK_QUESTION_ID) &&
2616 (QuestionId < (OPTION_DEL_KEK_QUESTION_ID + OPTION_CONFIG_RANGE))) {
2617 DeleteKeyExchangeKey (Private, QuestionId);
2618 } else if ((QuestionId >= OPTION_DEL_DB_QUESTION_ID) &&
2619 (QuestionId < (OPTION_DEL_DB_QUESTION_ID + OPTION_CONFIG_RANGE))) {
2620 DeleteSignature (
2621 Private,
2622 EFI_IMAGE_SECURITY_DATABASE,
2623 &gEfiImageSecurityDatabaseGuid,
2624 LABEL_DB_DELETE,
2625 SECUREBOOT_DELETE_SIGNATURE_FROM_DB,
2626 OPTION_DEL_DB_QUESTION_ID,
2627 QuestionId - OPTION_DEL_DB_QUESTION_ID
2628 );
2629 } else if ((QuestionId >= OPTION_DEL_DBX_QUESTION_ID) &&
2630 (QuestionId < (OPTION_DEL_DBX_QUESTION_ID + OPTION_CONFIG_RANGE))) {
2631 DeleteSignature (
2632 Private,
2633 EFI_IMAGE_SECURITY_DATABASE1,
2634 &gEfiImageSecurityDatabaseGuid,
2635 LABEL_DBX_DELETE,
2636 SECUREBOOT_DELETE_SIGNATURE_FROM_DBX,
2637 OPTION_DEL_DBX_QUESTION_ID,
2638 QuestionId - OPTION_DEL_DBX_QUESTION_ID
2639 );
2640 }
2641 break;
2642 }
2643 } else if (Action == EFI_BROWSER_ACTION_CHANGED) {
2644 switch (QuestionId) {
2645 case KEY_SECURE_BOOT_ENABLE:
2646 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY;
2647 break;
2648 case KEY_VALUE_SAVE_AND_EXIT_PK:
2649 Status = EnrollPlatformKey (Private);
2650 UnicodeSPrint (
2651 PromptString,
2652 sizeof (PromptString),
2653 L"Only DER encoded certificate file (%s) is supported.",
2654 mSupportX509Suffix
2655 );
2656 if (EFI_ERROR (Status)) {
2657 CreatePopUp (
2658 EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,
2659 &Key,
2660 L"ERROR: Unsupported file type!",
2661 PromptString,
2662 NULL
2663 );
2664 } else {
2665 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_RESET;
2666 }
2667 break;
2668
2669 case KEY_VALUE_NO_SAVE_AND_EXIT_PK:
2670 case KEY_VALUE_NO_SAVE_AND_EXIT_KEK:
2671 case KEY_VALUE_NO_SAVE_AND_EXIT_DB:
2672 case KEY_VALUE_NO_SAVE_AND_EXIT_DBX:
2673 if (Private->FileContext->FHandle != NULL) {
2674 CloseFile (Private->FileContext->FHandle);
2675 Private->FileContext->FHandle = NULL;
2676 Private->FileContext->FileName = NULL;
2677 }
2678
2679 if (Private->SignatureGUID != NULL) {
2680 FreePool (Private->SignatureGUID);
2681 Private->SignatureGUID = NULL;
2682 }
2683 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;
2684 break;
2685
2686 case KEY_SECURE_BOOT_MODE:
2687 GetVariable2 (EFI_CUSTOM_MODE_NAME, &gEfiCustomModeEnableGuid, (VOID**)&SecureBootMode, NULL);
2688 if (NULL != SecureBootMode) {
2689 Status = gRT->SetVariable (
2690 EFI_CUSTOM_MODE_NAME,
2691 &gEfiCustomModeEnableGuid,
2692 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,
2693 sizeof (UINT8),
2694 &Value->u8
2695 );
2696 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY;
2697 IfrNvData->SecureBootMode = Value->u8;
2698 FreePool (SecureBootMode);
2699 }
2700 break;
2701
2702 case KEY_SECURE_BOOT_KEK_GUID:
2703 case KEY_SECURE_BOOT_SIGNATURE_GUID_DB:
2704 case KEY_SECURE_BOOT_SIGNATURE_GUID_DBX:
2705 ASSERT (Private->SignatureGUID != NULL);
2706 Status = StringToGuid (
2707 IfrNvData->SignatureGuid,
2708 StrLen (IfrNvData->SignatureGuid),
2709 Private->SignatureGUID
2710 );
2711 if (EFI_ERROR (Status)) {
2712 break;
2713 }
2714
2715 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY;
2716 break;
2717
2718 case KEY_SECURE_BOOT_DELETE_PK:
2719 GetVariable2 (EFI_SETUP_MODE_NAME, &gEfiGlobalVariableGuid, (VOID**)&SetupMode, NULL);
2720 if (SetupMode == NULL || (*SetupMode) == SETUP_MODE) {
2721 IfrNvData->DeletePk = TRUE;
2722 IfrNvData->HasPk = FALSE;
2723 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_SUBMIT;
2724 } else {
2725 IfrNvData->DeletePk = FALSE;
2726 IfrNvData->HasPk = TRUE;
2727 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY;
2728 }
2729 if (SetupMode != NULL) {
2730 FreePool (SetupMode);
2731 }
2732 break;
2733 }
2734 } else if (Action == EFI_BROWSER_ACTION_FORM_CLOSE) {
2735 //
2736 // Force the platform back to Standard Mode once user leave the setup screen.
2737 //
2738 GetVariable2 (EFI_CUSTOM_MODE_NAME, &gEfiCustomModeEnableGuid, (VOID**)&SecureBootMode, NULL);
2739 if (NULL != SecureBootMode && *SecureBootMode == CUSTOM_SECURE_BOOT_MODE) {
2740 IfrNvData->SecureBootMode = STANDARD_SECURE_BOOT_MODE;
2741 SetSecureBootMode(STANDARD_SECURE_BOOT_MODE);
2742 }
2743 if (SecureBootMode != NULL) {
2744 FreePool (SecureBootMode);
2745 }
2746 }
2747
2748 if (!EFI_ERROR (Status)) {
2749 BufferSize = sizeof (SECUREBOOT_CONFIGURATION);
2750 HiiSetBrowserData (NULL, NULL, BufferSize, (UINT8*) IfrNvData, NULL);
2751 }
2752 FreePool (IfrNvData);
2753
2754 return EFI_SUCCESS;
2755 }
2756
2757 /**
2758 This function publish the SecureBoot configuration Form.
2759
2760 @param[in, out] PrivateData Points to SecureBoot configuration private data.
2761
2762 @retval EFI_SUCCESS HII Form is installed successfully.
2763 @retval EFI_OUT_OF_RESOURCES Not enough resource for HII Form installation.
2764 @retval Others Other errors as indicated.
2765
2766 **/
2767 EFI_STATUS
2768 InstallSecureBootConfigForm (
2769 IN OUT SECUREBOOT_CONFIG_PRIVATE_DATA *PrivateData
2770 )
2771 {
2772 EFI_STATUS Status;
2773 EFI_HII_HANDLE HiiHandle;
2774 EFI_HANDLE DriverHandle;
2775 EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess;
2776
2777 DriverHandle = NULL;
2778 ConfigAccess = &PrivateData->ConfigAccess;
2779 Status = gBS->InstallMultipleProtocolInterfaces (
2780 &DriverHandle,
2781 &gEfiDevicePathProtocolGuid,
2782 &mSecureBootHiiVendorDevicePath,
2783 &gEfiHiiConfigAccessProtocolGuid,
2784 ConfigAccess,
2785 NULL
2786 );
2787 if (EFI_ERROR (Status)) {
2788 return Status;
2789 }
2790
2791 PrivateData->DriverHandle = DriverHandle;
2792
2793 //
2794 // Publish the HII package list
2795 //
2796 HiiHandle = HiiAddPackages (
2797 &gSecureBootConfigFormSetGuid,
2798 DriverHandle,
2799 SecureBootConfigDxeStrings,
2800 SecureBootConfigBin,
2801 NULL
2802 );
2803 if (HiiHandle == NULL) {
2804 gBS->UninstallMultipleProtocolInterfaces (
2805 DriverHandle,
2806 &gEfiDevicePathProtocolGuid,
2807 &mSecureBootHiiVendorDevicePath,
2808 &gEfiHiiConfigAccessProtocolGuid,
2809 ConfigAccess,
2810 NULL
2811 );
2812 return EFI_OUT_OF_RESOURCES;
2813 }
2814
2815 PrivateData->HiiHandle = HiiHandle;
2816
2817 PrivateData->FileContext = AllocateZeroPool (sizeof (SECUREBOOT_FILE_CONTEXT));
2818 PrivateData->MenuEntry = AllocateZeroPool (sizeof (SECUREBOOT_MENU_ENTRY));
2819
2820 if (PrivateData->FileContext == NULL || PrivateData->MenuEntry == NULL) {
2821 UninstallSecureBootConfigForm (PrivateData);
2822 return EFI_OUT_OF_RESOURCES;
2823 }
2824
2825 PrivateData->FeCurrentState = FileExplorerStateInActive;
2826 PrivateData->FeDisplayContext = FileExplorerDisplayUnknown;
2827
2828 InitializeListHead (&FsOptionMenu.Head);
2829 InitializeListHead (&DirectoryMenu.Head);
2830
2831 //
2832 // Init OpCode Handle and Allocate space for creation of Buffer
2833 //
2834 mStartOpCodeHandle = HiiAllocateOpCodeHandle ();
2835 if (mStartOpCodeHandle == NULL) {
2836 UninstallSecureBootConfigForm (PrivateData);
2837 return EFI_OUT_OF_RESOURCES;
2838 }
2839
2840 mEndOpCodeHandle = HiiAllocateOpCodeHandle ();
2841 if (mEndOpCodeHandle == NULL) {
2842 UninstallSecureBootConfigForm (PrivateData);
2843 return EFI_OUT_OF_RESOURCES;
2844 }
2845
2846 //
2847 // Create Hii Extend Label OpCode as the start opcode
2848 //
2849 mStartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (
2850 mStartOpCodeHandle,
2851 &gEfiIfrTianoGuid,
2852 NULL,
2853 sizeof (EFI_IFR_GUID_LABEL)
2854 );
2855 mStartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
2856
2857 //
2858 // Create Hii Extend Label OpCode as the end opcode
2859 //
2860 mEndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (
2861 mEndOpCodeHandle,
2862 &gEfiIfrTianoGuid,
2863 NULL,
2864 sizeof (EFI_IFR_GUID_LABEL)
2865 );
2866 mEndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
2867 mEndLabel->Number = LABEL_END;
2868
2869 return EFI_SUCCESS;
2870 }
2871
2872 /**
2873 This function removes SecureBoot configuration Form.
2874
2875 @param[in, out] PrivateData Points to SecureBoot configuration private data.
2876
2877 **/
2878 VOID
2879 UninstallSecureBootConfigForm (
2880 IN OUT SECUREBOOT_CONFIG_PRIVATE_DATA *PrivateData
2881 )
2882 {
2883 //
2884 // Uninstall HII package list
2885 //
2886 if (PrivateData->HiiHandle != NULL) {
2887 HiiRemovePackages (PrivateData->HiiHandle);
2888 PrivateData->HiiHandle = NULL;
2889 }
2890
2891 //
2892 // Uninstall HII Config Access Protocol
2893 //
2894 if (PrivateData->DriverHandle != NULL) {
2895 gBS->UninstallMultipleProtocolInterfaces (
2896 PrivateData->DriverHandle,
2897 &gEfiDevicePathProtocolGuid,
2898 &mSecureBootHiiVendorDevicePath,
2899 &gEfiHiiConfigAccessProtocolGuid,
2900 &PrivateData->ConfigAccess,
2901 NULL
2902 );
2903 PrivateData->DriverHandle = NULL;
2904 }
2905
2906 if (PrivateData->SignatureGUID != NULL) {
2907 FreePool (PrivateData->SignatureGUID);
2908 }
2909
2910 if (PrivateData->MenuEntry != NULL) {
2911 FreePool (PrivateData->MenuEntry);
2912 }
2913
2914 if (PrivateData->FileContext != NULL) {
2915 FreePool (PrivateData->FileContext);
2916 }
2917
2918 FreePool (PrivateData);
2919
2920 FreeMenu (&DirectoryMenu);
2921 FreeMenu (&FsOptionMenu);
2922
2923 if (mStartOpCodeHandle != NULL) {
2924 HiiFreeOpCodeHandle (mStartOpCodeHandle);
2925 }
2926
2927 if (mEndOpCodeHandle != NULL) {
2928 HiiFreeOpCodeHandle (mEndOpCodeHandle);
2929 }
2930 }
EFI Development Kit II mirror for PVE