]> 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
SecurityPkg: remove PE/COFF header workaround for ELILO on IPF
[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 - 2018, Intel Corporation. All rights reserved.<BR>
5 (C) Copyright 2018 Hewlett Packard Enterprise Development LP<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
10
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13
14 **/
15
16 #include "SecureBootConfigImpl.h"
17 #include <Library/BaseCryptLib.h>
18
19 CHAR16 mSecureBootStorageName[] = L"SECUREBOOT_CONFIGURATION";
20
21 SECUREBOOT_CONFIG_PRIVATE_DATA mSecureBootConfigPrivateDateTemplate = {
22 SECUREBOOT_CONFIG_PRIVATE_DATA_SIGNATURE,
23 {
24 SecureBootExtractConfig,
25 SecureBootRouteConfig,
26 SecureBootCallback
27 }
28 };
29
30 HII_VENDOR_DEVICE_PATH mSecureBootHiiVendorDevicePath = {
31 {
32 {
33 HARDWARE_DEVICE_PATH,
34 HW_VENDOR_DP,
35 {
36 (UINT8) (sizeof (VENDOR_DEVICE_PATH)),
37 (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)
38 }
39 },
40 SECUREBOOT_CONFIG_FORM_SET_GUID
41 },
42 {
43 END_DEVICE_PATH_TYPE,
44 END_ENTIRE_DEVICE_PATH_SUBTYPE,
45 {
46 (UINT8) (END_DEVICE_PATH_LENGTH),
47 (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)
48 }
49 }
50 };
51
52
53 BOOLEAN mIsEnterSecureBootForm = FALSE;
54
55 //
56 // OID ASN.1 Value for Hash Algorithms
57 //
58 UINT8 mHashOidValue[] = {
59 0x2A, 0x86, 0x48, 0x86, 0xF7, 0x0D, 0x02, 0x05, // OBJ_md5
60 0x2B, 0x0E, 0x03, 0x02, 0x1A, // OBJ_sha1
61 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x04, // OBJ_sha224
62 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x01, // OBJ_sha256
63 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x02, // OBJ_sha384
64 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x03, // OBJ_sha512
65 };
66
67 HASH_TABLE mHash[] = {
68 { L"SHA224", 28, &mHashOidValue[13], 9, NULL, NULL, NULL, NULL },
69 { L"SHA256", 32, &mHashOidValue[22], 9, Sha256GetContextSize, Sha256Init, Sha256Update, Sha256Final},
70 { L"SHA384", 48, &mHashOidValue[31], 9, Sha384GetContextSize, Sha384Init, Sha384Update, Sha384Final},
71 { L"SHA512", 64, &mHashOidValue[40], 9, Sha512GetContextSize, Sha512Init, Sha512Update, Sha512Final}
72 };
73
74 //
75 // Variable Definitions
76 //
77 UINT32 mPeCoffHeaderOffset = 0;
78 WIN_CERTIFICATE *mCertificate = NULL;
79 IMAGE_TYPE mImageType;
80 UINT8 *mImageBase = NULL;
81 UINTN mImageSize = 0;
82 UINT8 mImageDigest[MAX_DIGEST_SIZE];
83 UINTN mImageDigestSize;
84 EFI_GUID mCertType;
85 EFI_IMAGE_SECURITY_DATA_DIRECTORY *mSecDataDir = NULL;
86 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION mNtHeader;
87
88 //
89 // Possible DER-encoded certificate file suffixes, end with NULL pointer.
90 //
91 CHAR16* mDerEncodedSuffix[] = {
92 L".cer",
93 L".der",
94 L".crt",
95 NULL
96 };
97 CHAR16* mSupportX509Suffix = L"*.cer/der/crt";
98
99 SECUREBOOT_CONFIG_PRIVATE_DATA *gSecureBootPrivateData = NULL;
100
101 /**
102 This code cleans up enrolled file by closing file & free related resources attached to
103 enrolled file.
104
105 @param[in] FileContext FileContext cached in SecureBootConfig driver
106
107 **/
108 VOID
109 CloseEnrolledFile(
110 IN SECUREBOOT_FILE_CONTEXT *FileContext
111 )
112 {
113 if (FileContext->FHandle != NULL) {
114 CloseFile (FileContext->FHandle);
115 FileContext->FHandle = NULL;
116 }
117
118 if (FileContext->FileName != NULL){
119 FreePool(FileContext->FileName);
120 FileContext->FileName = NULL;
121 }
122 FileContext->FileType = UNKNOWN_FILE_TYPE;
123
124 }
125
126 /**
127 This code checks if the FileSuffix is one of the possible DER-encoded certificate suffix.
128
129 @param[in] FileSuffix The suffix of the input certificate file
130
131 @retval TRUE It's a DER-encoded certificate.
132 @retval FALSE It's NOT a DER-encoded certificate.
133
134 **/
135 BOOLEAN
136 IsDerEncodeCertificate (
137 IN CONST CHAR16 *FileSuffix
138 )
139 {
140 UINTN Index;
141 for (Index = 0; mDerEncodedSuffix[Index] != NULL; Index++) {
142 if (StrCmp (FileSuffix, mDerEncodedSuffix[Index]) == 0) {
143 return TRUE;
144 }
145 }
146 return FALSE;
147 }
148
149 /**
150 This code checks if the file content complies with EFI_VARIABLE_AUTHENTICATION_2 format
151 The function reads file content but won't open/close given FileHandle.
152
153 @param[in] FileHandle The FileHandle to be checked
154
155 @retval TRUE The content is EFI_VARIABLE_AUTHENTICATION_2 format.
156 @retval FALSE The content is NOT a EFI_VARIABLE_AUTHENTICATION_2 format.
157
158 **/
159 BOOLEAN
160 IsAuthentication2Format (
161 IN EFI_FILE_HANDLE FileHandle
162 )
163 {
164 EFI_STATUS Status;
165 EFI_VARIABLE_AUTHENTICATION_2 *Auth2;
166 BOOLEAN IsAuth2Format;
167
168 IsAuth2Format = FALSE;
169
170 //
171 // Read the whole file content
172 //
173 Status = ReadFileContent(
174 FileHandle,
175 (VOID **) &mImageBase,
176 &mImageSize,
177 0
178 );
179 if (EFI_ERROR (Status)) {
180 goto ON_EXIT;
181 }
182
183 Auth2 = (EFI_VARIABLE_AUTHENTICATION_2 *)mImageBase;
184 if (Auth2->AuthInfo.Hdr.wCertificateType != WIN_CERT_TYPE_EFI_GUID) {
185 goto ON_EXIT;
186 }
187
188 if (CompareGuid(&gEfiCertPkcs7Guid, &Auth2->AuthInfo.CertType)) {
189 IsAuth2Format = TRUE;
190 }
191
192 ON_EXIT:
193 //
194 // Do not close File. simply check file content
195 //
196 if (mImageBase != NULL) {
197 FreePool (mImageBase);
198 mImageBase = NULL;
199 }
200
201 return IsAuth2Format;
202 }
203
204 /**
205 Set Secure Boot option into variable space.
206
207 @param[in] VarValue The option of Secure Boot.
208
209 @retval EFI_SUCCESS The operation is finished successfully.
210 @retval Others Other errors as indicated.
211
212 **/
213 EFI_STATUS
214 SaveSecureBootVariable (
215 IN UINT8 VarValue
216 )
217 {
218 EFI_STATUS Status;
219
220 Status = gRT->SetVariable (
221 EFI_SECURE_BOOT_ENABLE_NAME,
222 &gEfiSecureBootEnableDisableGuid,
223 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,
224 sizeof (UINT8),
225 &VarValue
226 );
227 return Status;
228 }
229
230 /**
231 Create a time based data payload by concatenating the EFI_VARIABLE_AUTHENTICATION_2
232 descriptor with the input data. NO authentication is required in this function.
233
234 @param[in, out] DataSize On input, the size of Data buffer in bytes.
235 On output, the size of data returned in Data
236 buffer in bytes.
237 @param[in, out] Data On input, Pointer to data buffer to be wrapped or
238 pointer to NULL to wrap an empty payload.
239 On output, Pointer to the new payload date buffer allocated from pool,
240 it's caller's responsibility to free the memory when finish using it.
241
242 @retval EFI_SUCCESS Create time based payload successfully.
243 @retval EFI_OUT_OF_RESOURCES There are not enough memory resourses to create time based payload.
244 @retval EFI_INVALID_PARAMETER The parameter is invalid.
245 @retval Others Unexpected error happens.
246
247 **/
248 EFI_STATUS
249 CreateTimeBasedPayload (
250 IN OUT UINTN *DataSize,
251 IN OUT UINT8 **Data
252 )
253 {
254 EFI_STATUS Status;
255 UINT8 *NewData;
256 UINT8 *Payload;
257 UINTN PayloadSize;
258 EFI_VARIABLE_AUTHENTICATION_2 *DescriptorData;
259 UINTN DescriptorSize;
260 EFI_TIME Time;
261
262 if (Data == NULL || DataSize == NULL) {
263 return EFI_INVALID_PARAMETER;
264 }
265
266 //
267 // In Setup mode or Custom mode, the variable does not need to be signed but the
268 // parameters to the SetVariable() call still need to be prepared as authenticated
269 // variable. So we create EFI_VARIABLE_AUTHENTICATED_2 descriptor without certificate
270 // data in it.
271 //
272 Payload = *Data;
273 PayloadSize = *DataSize;
274
275 DescriptorSize = OFFSET_OF (EFI_VARIABLE_AUTHENTICATION_2, AuthInfo) + OFFSET_OF (WIN_CERTIFICATE_UEFI_GUID, CertData);
276 NewData = (UINT8*) AllocateZeroPool (DescriptorSize + PayloadSize);
277 if (NewData == NULL) {
278 return EFI_OUT_OF_RESOURCES;
279 }
280
281 if ((Payload != NULL) && (PayloadSize != 0)) {
282 CopyMem (NewData + DescriptorSize, Payload, PayloadSize);
283 }
284
285 DescriptorData = (EFI_VARIABLE_AUTHENTICATION_2 *) (NewData);
286
287 ZeroMem (&Time, sizeof (EFI_TIME));
288 Status = gRT->GetTime (&Time, NULL);
289 if (EFI_ERROR (Status)) {
290 FreePool(NewData);
291 return Status;
292 }
293 Time.Pad1 = 0;
294 Time.Nanosecond = 0;
295 Time.TimeZone = 0;
296 Time.Daylight = 0;
297 Time.Pad2 = 0;
298 CopyMem (&DescriptorData->TimeStamp, &Time, sizeof (EFI_TIME));
299
300 DescriptorData->AuthInfo.Hdr.dwLength = OFFSET_OF (WIN_CERTIFICATE_UEFI_GUID, CertData);
301 DescriptorData->AuthInfo.Hdr.wRevision = 0x0200;
302 DescriptorData->AuthInfo.Hdr.wCertificateType = WIN_CERT_TYPE_EFI_GUID;
303 CopyGuid (&DescriptorData->AuthInfo.CertType, &gEfiCertPkcs7Guid);
304
305 if (Payload != NULL) {
306 FreePool(Payload);
307 }
308
309 *DataSize = DescriptorSize + PayloadSize;
310 *Data = NewData;
311 return EFI_SUCCESS;
312 }
313
314 /**
315 Internal helper function to delete a Variable given its name and GUID, NO authentication
316 required.
317
318 @param[in] VariableName Name of the Variable.
319 @param[in] VendorGuid GUID of the Variable.
320
321 @retval EFI_SUCCESS Variable deleted successfully.
322 @retval Others The driver failed to start the device.
323
324 **/
325 EFI_STATUS
326 DeleteVariable (
327 IN CHAR16 *VariableName,
328 IN EFI_GUID *VendorGuid
329 )
330 {
331 EFI_STATUS Status;
332 VOID* Variable;
333 UINT8 *Data;
334 UINTN DataSize;
335 UINT32 Attr;
336
337 GetVariable2 (VariableName, VendorGuid, &Variable, NULL);
338 if (Variable == NULL) {
339 return EFI_SUCCESS;
340 }
341 FreePool (Variable);
342
343 Data = NULL;
344 DataSize = 0;
345 Attr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS
346 | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;
347
348 Status = CreateTimeBasedPayload (&DataSize, &Data);
349 if (EFI_ERROR (Status)) {
350 DEBUG ((EFI_D_ERROR, "Fail to create time-based data payload: %r", Status));
351 return Status;
352 }
353
354 Status = gRT->SetVariable (
355 VariableName,
356 VendorGuid,
357 Attr,
358 DataSize,
359 Data
360 );
361 if (Data != NULL) {
362 FreePool (Data);
363 }
364 return Status;
365 }
366
367 /**
368
369 Set the platform secure boot mode into "Custom" or "Standard" mode.
370
371 @param[in] SecureBootMode New secure boot mode: STANDARD_SECURE_BOOT_MODE or
372 CUSTOM_SECURE_BOOT_MODE.
373
374 @return EFI_SUCCESS The platform has switched to the special mode successfully.
375 @return other Fail to operate the secure boot mode.
376
377 **/
378 EFI_STATUS
379 SetSecureBootMode (
380 IN UINT8 SecureBootMode
381 )
382 {
383 return gRT->SetVariable (
384 EFI_CUSTOM_MODE_NAME,
385 &gEfiCustomModeEnableGuid,
386 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,
387 sizeof (UINT8),
388 &SecureBootMode
389 );
390 }
391
392 /**
393 Generate the PK signature list from the X509 Certificate storing file (.cer)
394
395 @param[in] X509File FileHandle of X509 Certificate storing file.
396 @param[out] PkCert Point to the data buffer to store the signature list.
397
398 @return EFI_UNSUPPORTED Unsupported Key Length.
399 @return EFI_OUT_OF_RESOURCES There are not enough memory resourses to form the signature list.
400
401 **/
402 EFI_STATUS
403 CreatePkX509SignatureList (
404 IN EFI_FILE_HANDLE X509File,
405 OUT EFI_SIGNATURE_LIST **PkCert
406 )
407 {
408 EFI_STATUS Status;
409 UINT8 *X509Data;
410 UINTN X509DataSize;
411 EFI_SIGNATURE_DATA *PkCertData;
412
413 X509Data = NULL;
414 PkCertData = NULL;
415 X509DataSize = 0;
416
417 Status = ReadFileContent (X509File, (VOID**) &X509Data, &X509DataSize, 0);
418 if (EFI_ERROR (Status)) {
419 goto ON_EXIT;
420 }
421 ASSERT (X509Data != NULL);
422
423 //
424 // Allocate space for PK certificate list and initialize it.
425 // Create PK database entry with SignatureHeaderSize equals 0.
426 //
427 *PkCert = (EFI_SIGNATURE_LIST*) AllocateZeroPool (
428 sizeof(EFI_SIGNATURE_LIST) + sizeof(EFI_SIGNATURE_DATA) - 1
429 + X509DataSize
430 );
431 if (*PkCert == NULL) {
432 Status = EFI_OUT_OF_RESOURCES;
433 goto ON_EXIT;
434 }
435
436 (*PkCert)->SignatureListSize = (UINT32) (sizeof(EFI_SIGNATURE_LIST)
437 + sizeof(EFI_SIGNATURE_DATA) - 1
438 + X509DataSize);
439 (*PkCert)->SignatureSize = (UINT32) (sizeof(EFI_SIGNATURE_DATA) - 1 + X509DataSize);
440 (*PkCert)->SignatureHeaderSize = 0;
441 CopyGuid (&(*PkCert)->SignatureType, &gEfiCertX509Guid);
442 PkCertData = (EFI_SIGNATURE_DATA*) ((UINTN)(*PkCert)
443 + sizeof(EFI_SIGNATURE_LIST)
444 + (*PkCert)->SignatureHeaderSize);
445 CopyGuid (&PkCertData->SignatureOwner, &gEfiGlobalVariableGuid);
446 //
447 // Fill the PK database with PKpub data from X509 certificate file.
448 //
449 CopyMem (&(PkCertData->SignatureData[0]), X509Data, X509DataSize);
450
451 ON_EXIT:
452
453 if (X509Data != NULL) {
454 FreePool (X509Data);
455 }
456
457 if (EFI_ERROR(Status) && *PkCert != NULL) {
458 FreePool (*PkCert);
459 *PkCert = NULL;
460 }
461
462 return Status;
463 }
464
465 /**
466 Enroll new PK into the System without original PK's authentication.
467
468 The SignatureOwner GUID will be the same with PK's vendorguid.
469
470 @param[in] PrivateData The module's private data.
471
472 @retval EFI_SUCCESS New PK enrolled successfully.
473 @retval EFI_INVALID_PARAMETER The parameter is invalid.
474 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
475
476 **/
477 EFI_STATUS
478 EnrollPlatformKey (
479 IN SECUREBOOT_CONFIG_PRIVATE_DATA* Private
480 )
481 {
482 EFI_STATUS Status;
483 UINT32 Attr;
484 UINTN DataSize;
485 EFI_SIGNATURE_LIST *PkCert;
486 UINT16* FilePostFix;
487 UINTN NameLength;
488
489 if (Private->FileContext->FileName == NULL) {
490 return EFI_INVALID_PARAMETER;
491 }
492
493 PkCert = NULL;
494
495 Status = SetSecureBootMode(CUSTOM_SECURE_BOOT_MODE);
496 if (EFI_ERROR (Status)) {
497 return Status;
498 }
499
500 //
501 // Parse the file's postfix. Only support DER encoded X.509 certificate files.
502 //
503 NameLength = StrLen (Private->FileContext->FileName);
504 if (NameLength <= 4) {
505 return EFI_INVALID_PARAMETER;
506 }
507 FilePostFix = Private->FileContext->FileName + NameLength - 4;
508 if (!IsDerEncodeCertificate(FilePostFix)) {
509 DEBUG ((EFI_D_ERROR, "Unsupported file type, only DER encoded certificate (%s) is supported.", mSupportX509Suffix));
510 return EFI_INVALID_PARAMETER;
511 }
512 DEBUG ((EFI_D_INFO, "FileName= %s\n", Private->FileContext->FileName));
513 DEBUG ((EFI_D_INFO, "FilePostFix = %s\n", FilePostFix));
514
515 //
516 // Prase the selected PK file and generature PK certificate list.
517 //
518 Status = CreatePkX509SignatureList (
519 Private->FileContext->FHandle,
520 &PkCert
521 );
522 if (EFI_ERROR (Status)) {
523 goto ON_EXIT;
524 }
525 ASSERT (PkCert != NULL);
526
527 //
528 // Set Platform Key variable.
529 //
530 Attr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS
531 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;
532 DataSize = PkCert->SignatureListSize;
533 Status = CreateTimeBasedPayload (&DataSize, (UINT8**) &PkCert);
534 if (EFI_ERROR (Status)) {
535 DEBUG ((EFI_D_ERROR, "Fail to create time-based data payload: %r", Status));
536 goto ON_EXIT;
537 }
538
539 Status = gRT->SetVariable(
540 EFI_PLATFORM_KEY_NAME,
541 &gEfiGlobalVariableGuid,
542 Attr,
543 DataSize,
544 PkCert
545 );
546 if (EFI_ERROR (Status)) {
547 if (Status == EFI_OUT_OF_RESOURCES) {
548 DEBUG ((EFI_D_ERROR, "Enroll PK failed with out of resource.\n"));
549 }
550 goto ON_EXIT;
551 }
552
553 ON_EXIT:
554
555 if (PkCert != NULL) {
556 FreePool(PkCert);
557 }
558
559 CloseEnrolledFile(Private->FileContext);
560
561 return Status;
562 }
563
564 /**
565 Remove the PK variable.
566
567 @retval EFI_SUCCESS Delete PK successfully.
568 @retval Others Could not allow to delete PK.
569
570 **/
571 EFI_STATUS
572 DeletePlatformKey (
573 VOID
574 )
575 {
576 EFI_STATUS Status;
577
578 Status = SetSecureBootMode(CUSTOM_SECURE_BOOT_MODE);
579 if (EFI_ERROR (Status)) {
580 return Status;
581 }
582
583 Status = DeleteVariable (
584 EFI_PLATFORM_KEY_NAME,
585 &gEfiGlobalVariableGuid
586 );
587 return Status;
588 }
589
590 /**
591 Enroll a new KEK item from public key storing file (*.pbk).
592
593 @param[in] PrivateData The module's private data.
594
595 @retval EFI_SUCCESS New KEK enrolled successfully.
596 @retval EFI_INVALID_PARAMETER The parameter is invalid.
597 @retval EFI_UNSUPPORTED Unsupported command.
598 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
599
600 **/
601 EFI_STATUS
602 EnrollRsa2048ToKek (
603 IN SECUREBOOT_CONFIG_PRIVATE_DATA *Private
604 )
605 {
606 EFI_STATUS Status;
607 UINT32 Attr;
608 UINTN DataSize;
609 EFI_SIGNATURE_LIST *KekSigList;
610 UINTN KeyBlobSize;
611 UINT8 *KeyBlob;
612 CPL_KEY_INFO *KeyInfo;
613 EFI_SIGNATURE_DATA *KEKSigData;
614 UINTN KekSigListSize;
615 UINT8 *KeyBuffer;
616 UINTN KeyLenInBytes;
617
618 Attr = 0;
619 DataSize = 0;
620 KeyBuffer = NULL;
621 KeyBlobSize = 0;
622 KeyBlob = NULL;
623 KeyInfo = NULL;
624 KEKSigData = NULL;
625 KekSigList = NULL;
626 KekSigListSize = 0;
627
628 //
629 // Form the KeKpub certificate list into EFI_SIGNATURE_LIST type.
630 // First, We have to parse out public key data from the pbk key file.
631 //
632 Status = ReadFileContent (
633 Private->FileContext->FHandle,
634 (VOID**) &KeyBlob,
635 &KeyBlobSize,
636 0
637 );
638 if (EFI_ERROR (Status)) {
639 goto ON_EXIT;
640 }
641 ASSERT (KeyBlob != NULL);
642 KeyInfo = (CPL_KEY_INFO *) KeyBlob;
643 if (KeyInfo->KeyLengthInBits / 8 != WIN_CERT_UEFI_RSA2048_SIZE) {
644 DEBUG ((DEBUG_ERROR, "Unsupported key length, Only RSA2048 is supported.\n"));
645 Status = EFI_UNSUPPORTED;
646 goto ON_EXIT;
647 }
648
649 //
650 // Convert the Public key to fix octet string format represented in RSA PKCS#1.
651 //
652 KeyLenInBytes = KeyInfo->KeyLengthInBits / 8;
653 KeyBuffer = AllocateZeroPool (KeyLenInBytes);
654 if (KeyBuffer == NULL) {
655 Status = EFI_OUT_OF_RESOURCES;
656 goto ON_EXIT;
657 }
658 Int2OctStr (
659 (UINTN*) (KeyBlob + sizeof (CPL_KEY_INFO)),
660 KeyLenInBytes / sizeof (UINTN),
661 KeyBuffer,
662 KeyLenInBytes
663 );
664 CopyMem(KeyBlob + sizeof(CPL_KEY_INFO), KeyBuffer, KeyLenInBytes);
665
666 //
667 // Form an new EFI_SIGNATURE_LIST.
668 //
669 KekSigListSize = sizeof(EFI_SIGNATURE_LIST)
670 + sizeof(EFI_SIGNATURE_DATA) - 1
671 + WIN_CERT_UEFI_RSA2048_SIZE;
672
673 KekSigList = (EFI_SIGNATURE_LIST*) AllocateZeroPool (KekSigListSize);
674 if (KekSigList == NULL) {
675 Status = EFI_OUT_OF_RESOURCES;
676 goto ON_EXIT;
677 }
678
679 KekSigList->SignatureListSize = sizeof(EFI_SIGNATURE_LIST)
680 + sizeof(EFI_SIGNATURE_DATA) - 1
681 + WIN_CERT_UEFI_RSA2048_SIZE;
682 KekSigList->SignatureHeaderSize = 0;
683 KekSigList->SignatureSize = sizeof(EFI_SIGNATURE_DATA) - 1 + WIN_CERT_UEFI_RSA2048_SIZE;
684 CopyGuid (&KekSigList->SignatureType, &gEfiCertRsa2048Guid);
685
686 KEKSigData = (EFI_SIGNATURE_DATA*)((UINT8*)KekSigList + sizeof(EFI_SIGNATURE_LIST));
687 CopyGuid (&KEKSigData->SignatureOwner, Private->SignatureGUID);
688 CopyMem (
689 KEKSigData->SignatureData,
690 KeyBlob + sizeof(CPL_KEY_INFO),
691 WIN_CERT_UEFI_RSA2048_SIZE
692 );
693
694 //
695 // Check if KEK entry has been already existed.
696 // If true, use EFI_VARIABLE_APPEND_WRITE attribute to append the
697 // new KEK to original variable.
698 //
699 Attr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS
700 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;
701 Status = CreateTimeBasedPayload (&KekSigListSize, (UINT8**) &KekSigList);
702 if (EFI_ERROR (Status)) {
703 DEBUG ((EFI_D_ERROR, "Fail to create time-based data payload: %r", Status));
704 goto ON_EXIT;
705 }
706
707 Status = gRT->GetVariable(
708 EFI_KEY_EXCHANGE_KEY_NAME,
709 &gEfiGlobalVariableGuid,
710 NULL,
711 &DataSize,
712 NULL
713 );
714 if (Status == EFI_BUFFER_TOO_SMALL) {
715 Attr |= EFI_VARIABLE_APPEND_WRITE;
716 } else if (Status != EFI_NOT_FOUND) {
717 goto ON_EXIT;
718 }
719
720 //
721 // Done. Now we have formed the correct KEKpub database item, just set it into variable storage,
722 //
723 Status = gRT->SetVariable(
724 EFI_KEY_EXCHANGE_KEY_NAME,
725 &gEfiGlobalVariableGuid,
726 Attr,
727 KekSigListSize,
728 KekSigList
729 );
730 if (EFI_ERROR (Status)) {
731 goto ON_EXIT;
732 }
733
734 ON_EXIT:
735
736 CloseEnrolledFile(Private->FileContext);
737
738 if (Private->SignatureGUID != NULL) {
739 FreePool (Private->SignatureGUID);
740 Private->SignatureGUID = NULL;
741 }
742
743 if (KeyBlob != NULL) {
744 FreePool (KeyBlob);
745 }
746 if (KeyBuffer != NULL) {
747 FreePool (KeyBuffer);
748 }
749 if (KekSigList != NULL) {
750 FreePool (KekSigList);
751 }
752
753 return Status;
754 }
755
756 /**
757 Enroll a new KEK item from X509 certificate file.
758
759 @param[in] PrivateData The module's private data.
760
761 @retval EFI_SUCCESS New X509 is enrolled successfully.
762 @retval EFI_INVALID_PARAMETER The parameter is invalid.
763 @retval EFI_UNSUPPORTED Unsupported command.
764 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
765
766 **/
767 EFI_STATUS
768 EnrollX509ToKek (
769 IN SECUREBOOT_CONFIG_PRIVATE_DATA *Private
770 )
771 {
772 EFI_STATUS Status;
773 UINTN X509DataSize;
774 VOID *X509Data;
775 EFI_SIGNATURE_DATA *KEKSigData;
776 EFI_SIGNATURE_LIST *KekSigList;
777 UINTN DataSize;
778 UINTN KekSigListSize;
779 UINT32 Attr;
780
781 X509Data = NULL;
782 X509DataSize = 0;
783 KekSigList = NULL;
784 KekSigListSize = 0;
785 DataSize = 0;
786 KEKSigData = NULL;
787
788 Status = ReadFileContent (
789 Private->FileContext->FHandle,
790 &X509Data,
791 &X509DataSize,
792 0
793 );
794 if (EFI_ERROR (Status)) {
795 goto ON_EXIT;
796 }
797 ASSERT (X509Data != NULL);
798
799 KekSigListSize = sizeof(EFI_SIGNATURE_LIST) + sizeof(EFI_SIGNATURE_DATA) - 1 + X509DataSize;
800 KekSigList = (EFI_SIGNATURE_LIST*) AllocateZeroPool (KekSigListSize);
801 if (KekSigList == NULL) {
802 Status = EFI_OUT_OF_RESOURCES;
803 goto ON_EXIT;
804 }
805
806 //
807 // Fill Certificate Database parameters.
808 //
809 KekSigList->SignatureListSize = (UINT32) KekSigListSize;
810 KekSigList->SignatureHeaderSize = 0;
811 KekSigList->SignatureSize = (UINT32) (sizeof(EFI_SIGNATURE_DATA) - 1 + X509DataSize);
812 CopyGuid (&KekSigList->SignatureType, &gEfiCertX509Guid);
813
814 KEKSigData = (EFI_SIGNATURE_DATA*) ((UINT8*) KekSigList + sizeof (EFI_SIGNATURE_LIST));
815 CopyGuid (&KEKSigData->SignatureOwner, Private->SignatureGUID);
816 CopyMem (KEKSigData->SignatureData, X509Data, X509DataSize);
817
818 //
819 // Check if KEK been already existed.
820 // If true, use EFI_VARIABLE_APPEND_WRITE attribute to append the
821 // new kek to original variable
822 //
823 Attr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS
824 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;
825 Status = CreateTimeBasedPayload (&KekSigListSize, (UINT8**) &KekSigList);
826 if (EFI_ERROR (Status)) {
827 DEBUG ((EFI_D_ERROR, "Fail to create time-based data payload: %r", Status));
828 goto ON_EXIT;
829 }
830
831 Status = gRT->GetVariable(
832 EFI_KEY_EXCHANGE_KEY_NAME,
833 &gEfiGlobalVariableGuid,
834 NULL,
835 &DataSize,
836 NULL
837 );
838 if (Status == EFI_BUFFER_TOO_SMALL) {
839 Attr |= EFI_VARIABLE_APPEND_WRITE;
840 } else if (Status != EFI_NOT_FOUND) {
841 goto ON_EXIT;
842 }
843
844 Status = gRT->SetVariable(
845 EFI_KEY_EXCHANGE_KEY_NAME,
846 &gEfiGlobalVariableGuid,
847 Attr,
848 KekSigListSize,
849 KekSigList
850 );
851 if (EFI_ERROR (Status)) {
852 goto ON_EXIT;
853 }
854
855 ON_EXIT:
856
857 CloseEnrolledFile(Private->FileContext);
858
859 if (Private->SignatureGUID != NULL) {
860 FreePool (Private->SignatureGUID);
861 Private->SignatureGUID = NULL;
862 }
863
864 if (KekSigList != NULL) {
865 FreePool (KekSigList);
866 }
867
868 return Status;
869 }
870
871 /**
872 Enroll new KEK into the System without PK's authentication.
873 The SignatureOwner GUID will be Private->SignatureGUID.
874
875 @param[in] PrivateData The module's private data.
876
877 @retval EFI_SUCCESS New KEK enrolled successful.
878 @retval EFI_INVALID_PARAMETER The parameter is invalid.
879 @retval others Fail to enroll KEK data.
880
881 **/
882 EFI_STATUS
883 EnrollKeyExchangeKey (
884 IN SECUREBOOT_CONFIG_PRIVATE_DATA *Private
885 )
886 {
887 UINT16* FilePostFix;
888 EFI_STATUS Status;
889 UINTN NameLength;
890
891 if ((Private->FileContext->FHandle == NULL) || (Private->FileContext->FileName == NULL) || (Private->SignatureGUID == NULL)) {
892 return EFI_INVALID_PARAMETER;
893 }
894
895 Status = SetSecureBootMode(CUSTOM_SECURE_BOOT_MODE);
896 if (EFI_ERROR (Status)) {
897 return Status;
898 }
899
900 //
901 // Parse the file's postfix. Supports DER-encoded X509 certificate,
902 // and .pbk as RSA public key file.
903 //
904 NameLength = StrLen (Private->FileContext->FileName);
905 if (NameLength <= 4) {
906 return EFI_INVALID_PARAMETER;
907 }
908 FilePostFix = Private->FileContext->FileName + NameLength - 4;
909 if (IsDerEncodeCertificate(FilePostFix)) {
910 return EnrollX509ToKek (Private);
911 } else if (CompareMem (FilePostFix, L".pbk",4) == 0) {
912 return EnrollRsa2048ToKek (Private);
913 } else {
914 //
915 // File type is wrong, simply close it
916 //
917 CloseEnrolledFile(Private->FileContext);
918
919 return EFI_INVALID_PARAMETER;
920 }
921 }
922
923 /**
924 Enroll a new X509 certificate into Signature Database (DB or DBX or DBT) without
925 KEK's authentication.
926
927 @param[in] PrivateData The module's private data.
928 @param[in] VariableName Variable name of signature database, must be
929 EFI_IMAGE_SECURITY_DATABASE or EFI_IMAGE_SECURITY_DATABASE1.
930
931 @retval EFI_SUCCESS New X509 is enrolled successfully.
932 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
933
934 **/
935 EFI_STATUS
936 EnrollX509toSigDB (
937 IN SECUREBOOT_CONFIG_PRIVATE_DATA *Private,
938 IN CHAR16 *VariableName
939 )
940 {
941 EFI_STATUS Status;
942 UINTN X509DataSize;
943 VOID *X509Data;
944 EFI_SIGNATURE_LIST *SigDBCert;
945 EFI_SIGNATURE_DATA *SigDBCertData;
946 VOID *Data;
947 UINTN DataSize;
948 UINTN SigDBSize;
949 UINT32 Attr;
950
951 X509DataSize = 0;
952 SigDBSize = 0;
953 DataSize = 0;
954 X509Data = NULL;
955 SigDBCert = NULL;
956 SigDBCertData = NULL;
957 Data = NULL;
958
959 Status = ReadFileContent (
960 Private->FileContext->FHandle,
961 &X509Data,
962 &X509DataSize,
963 0
964 );
965 if (EFI_ERROR (Status)) {
966 goto ON_EXIT;
967 }
968 ASSERT (X509Data != NULL);
969
970 SigDBSize = sizeof(EFI_SIGNATURE_LIST) + sizeof(EFI_SIGNATURE_DATA) - 1 + X509DataSize;
971
972 Data = AllocateZeroPool (SigDBSize);
973 if (Data == NULL) {
974 Status = EFI_OUT_OF_RESOURCES;
975 goto ON_EXIT;
976 }
977
978 //
979 // Fill Certificate Database parameters.
980 //
981 SigDBCert = (EFI_SIGNATURE_LIST*) Data;
982 SigDBCert->SignatureListSize = (UINT32) SigDBSize;
983 SigDBCert->SignatureHeaderSize = 0;
984 SigDBCert->SignatureSize = (UINT32) (sizeof(EFI_SIGNATURE_DATA) - 1 + X509DataSize);
985 CopyGuid (&SigDBCert->SignatureType, &gEfiCertX509Guid);
986
987 SigDBCertData = (EFI_SIGNATURE_DATA*) ((UINT8* ) SigDBCert + sizeof (EFI_SIGNATURE_LIST));
988 CopyGuid (&SigDBCertData->SignatureOwner, Private->SignatureGUID);
989 CopyMem ((UINT8* ) (SigDBCertData->SignatureData), X509Data, X509DataSize);
990
991 //
992 // Check if signature database entry has been already existed.
993 // If true, use EFI_VARIABLE_APPEND_WRITE attribute to append the
994 // new signature data to original variable
995 //
996 Attr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS
997 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;
998 Status = CreateTimeBasedPayload (&SigDBSize, (UINT8**) &Data);
999 if (EFI_ERROR (Status)) {
1000 DEBUG ((EFI_D_ERROR, "Fail to create time-based data payload: %r", Status));
1001 goto ON_EXIT;
1002 }
1003
1004 Status = gRT->GetVariable(
1005 VariableName,
1006 &gEfiImageSecurityDatabaseGuid,
1007 NULL,
1008 &DataSize,
1009 NULL
1010 );
1011 if (Status == EFI_BUFFER_TOO_SMALL) {
1012 Attr |= EFI_VARIABLE_APPEND_WRITE;
1013 } else if (Status != EFI_NOT_FOUND) {
1014 goto ON_EXIT;
1015 }
1016
1017 Status = gRT->SetVariable(
1018 VariableName,
1019 &gEfiImageSecurityDatabaseGuid,
1020 Attr,
1021 SigDBSize,
1022 Data
1023 );
1024 if (EFI_ERROR (Status)) {
1025 goto ON_EXIT;
1026 }
1027
1028 ON_EXIT:
1029
1030 CloseEnrolledFile(Private->FileContext);
1031
1032 if (Private->SignatureGUID != NULL) {
1033 FreePool (Private->SignatureGUID);
1034 Private->SignatureGUID = NULL;
1035 }
1036
1037 if (Data != NULL) {
1038 FreePool (Data);
1039 }
1040
1041 if (X509Data != NULL) {
1042 FreePool (X509Data);
1043 }
1044
1045 return Status;
1046 }
1047
1048 /**
1049 Check whether signature is in specified database.
1050
1051 @param[in] VariableName Name of database variable that is searched in.
1052 @param[in] Signature Pointer to signature that is searched for.
1053 @param[in] SignatureSize Size of Signature.
1054
1055 @return TRUE Found the signature in the variable database.
1056 @return FALSE Not found the signature in the variable database.
1057
1058 **/
1059 BOOLEAN
1060 IsSignatureFoundInDatabase (
1061 IN CHAR16 *VariableName,
1062 IN UINT8 *Signature,
1063 IN UINTN SignatureSize
1064 )
1065 {
1066 EFI_STATUS Status;
1067 EFI_SIGNATURE_LIST *CertList;
1068 EFI_SIGNATURE_DATA *Cert;
1069 UINTN DataSize;
1070 UINT8 *Data;
1071 UINTN Index;
1072 UINTN CertCount;
1073 BOOLEAN IsFound;
1074
1075 //
1076 // Read signature database variable.
1077 //
1078 IsFound = FALSE;
1079 Data = NULL;
1080 DataSize = 0;
1081 Status = gRT->GetVariable (VariableName, &gEfiImageSecurityDatabaseGuid, NULL, &DataSize, NULL);
1082 if (Status != EFI_BUFFER_TOO_SMALL) {
1083 return FALSE;
1084 }
1085
1086 Data = (UINT8 *) AllocateZeroPool (DataSize);
1087 if (Data == NULL) {
1088 return FALSE;
1089 }
1090
1091 Status = gRT->GetVariable (VariableName, &gEfiImageSecurityDatabaseGuid, NULL, &DataSize, Data);
1092 if (EFI_ERROR (Status)) {
1093 goto Done;
1094 }
1095
1096 //
1097 // Enumerate all signature data in SigDB to check if executable's signature exists.
1098 //
1099 CertList = (EFI_SIGNATURE_LIST *) Data;
1100 while ((DataSize > 0) && (DataSize >= CertList->SignatureListSize)) {
1101 CertCount = (CertList->SignatureListSize - sizeof (EFI_SIGNATURE_LIST) - CertList->SignatureHeaderSize) / CertList->SignatureSize;
1102 Cert = (EFI_SIGNATURE_DATA *) ((UINT8 *) CertList + sizeof (EFI_SIGNATURE_LIST) + CertList->SignatureHeaderSize);
1103 if ((CertList->SignatureSize == sizeof(EFI_SIGNATURE_DATA) - 1 + SignatureSize) && (CompareGuid(&CertList->SignatureType, &gEfiCertX509Guid))) {
1104 for (Index = 0; Index < CertCount; Index++) {
1105 if (CompareMem (Cert->SignatureData, Signature, SignatureSize) == 0) {
1106 //
1107 // Find the signature in database.
1108 //
1109 IsFound = TRUE;
1110 break;
1111 }
1112 Cert = (EFI_SIGNATURE_DATA *) ((UINT8 *) Cert + CertList->SignatureSize);
1113 }
1114
1115 if (IsFound) {
1116 break;
1117 }
1118 }
1119
1120 DataSize -= CertList->SignatureListSize;
1121 CertList = (EFI_SIGNATURE_LIST *) ((UINT8 *) CertList + CertList->SignatureListSize);
1122 }
1123
1124 Done:
1125 if (Data != NULL) {
1126 FreePool (Data);
1127 }
1128
1129 return IsFound;
1130 }
1131
1132 /**
1133 Calculate the hash of a certificate data with the specified hash algorithm.
1134
1135 @param[in] CertData The certificate data to be hashed.
1136 @param[in] CertSize The certificate size in bytes.
1137 @param[in] HashAlg The specified hash algorithm.
1138 @param[out] CertHash The output digest of the certificate
1139
1140 @retval TRUE Successfully got the hash of the CertData.
1141 @retval FALSE Failed to get the hash of CertData.
1142
1143 **/
1144 BOOLEAN
1145 CalculateCertHash (
1146 IN UINT8 *CertData,
1147 IN UINTN CertSize,
1148 IN UINT32 HashAlg,
1149 OUT UINT8 *CertHash
1150 )
1151 {
1152 BOOLEAN Status;
1153 VOID *HashCtx;
1154 UINTN CtxSize;
1155 UINT8 *TBSCert;
1156 UINTN TBSCertSize;
1157
1158 HashCtx = NULL;
1159 Status = FALSE;
1160
1161 if (HashAlg >= HASHALG_MAX) {
1162 return FALSE;
1163 }
1164
1165 //
1166 // Retrieve the TBSCertificate for Hash Calculation.
1167 //
1168 if (!X509GetTBSCert (CertData, CertSize, &TBSCert, &TBSCertSize)) {
1169 return FALSE;
1170 }
1171
1172 //
1173 // 1. Initialize context of hash.
1174 //
1175 CtxSize = mHash[HashAlg].GetContextSize ();
1176 HashCtx = AllocatePool (CtxSize);
1177 ASSERT (HashCtx != NULL);
1178
1179 //
1180 // 2. Initialize a hash context.
1181 //
1182 Status = mHash[HashAlg].HashInit (HashCtx);
1183 if (!Status) {
1184 goto Done;
1185 }
1186
1187 //
1188 // 3. Calculate the hash.
1189 //
1190 Status = mHash[HashAlg].HashUpdate (HashCtx, TBSCert, TBSCertSize);
1191 if (!Status) {
1192 goto Done;
1193 }
1194
1195 //
1196 // 4. Get the hash result.
1197 //
1198 ZeroMem (CertHash, mHash[HashAlg].DigestLength);
1199 Status = mHash[HashAlg].HashFinal (HashCtx, CertHash);
1200
1201 Done:
1202 if (HashCtx != NULL) {
1203 FreePool (HashCtx);
1204 }
1205
1206 return Status;
1207 }
1208
1209 /**
1210 Check whether the hash of an X.509 certificate is in forbidden database (DBX).
1211
1212 @param[in] Certificate Pointer to X.509 Certificate that is searched for.
1213 @param[in] CertSize Size of X.509 Certificate.
1214
1215 @return TRUE Found the certificate hash in the forbidden database.
1216 @return FALSE Certificate hash is Not found in the forbidden database.
1217
1218 **/
1219 BOOLEAN
1220 IsCertHashFoundInDbx (
1221 IN UINT8 *Certificate,
1222 IN UINTN CertSize
1223 )
1224 {
1225 BOOLEAN IsFound;
1226 EFI_STATUS Status;
1227 EFI_SIGNATURE_LIST *DbxList;
1228 EFI_SIGNATURE_DATA *CertHash;
1229 UINTN CertHashCount;
1230 UINTN Index;
1231 UINT32 HashAlg;
1232 UINT8 CertDigest[MAX_DIGEST_SIZE];
1233 UINT8 *DbxCertHash;
1234 UINTN SiglistHeaderSize;
1235 UINT8 *Data;
1236 UINTN DataSize;
1237
1238 IsFound = FALSE;
1239 HashAlg = HASHALG_MAX;
1240 Data = NULL;
1241
1242 //
1243 // Read signature database variable.
1244 //
1245 DataSize = 0;
1246 Status = gRT->GetVariable (EFI_IMAGE_SECURITY_DATABASE1, &gEfiImageSecurityDatabaseGuid, NULL, &DataSize, NULL);
1247 if (Status != EFI_BUFFER_TOO_SMALL) {
1248 return FALSE;
1249 }
1250
1251 Data = (UINT8 *) AllocateZeroPool (DataSize);
1252 if (Data == NULL) {
1253 return FALSE;
1254 }
1255
1256 Status = gRT->GetVariable (EFI_IMAGE_SECURITY_DATABASE1, &gEfiImageSecurityDatabaseGuid, NULL, &DataSize, Data);
1257 if (EFI_ERROR (Status)) {
1258 goto Done;
1259 }
1260
1261 //
1262 // Check whether the certificate hash exists in the forbidden database.
1263 //
1264 DbxList = (EFI_SIGNATURE_LIST *) Data;
1265 while ((DataSize > 0) && (DataSize >= DbxList->SignatureListSize)) {
1266 //
1267 // Determine Hash Algorithm of Certificate in the forbidden database.
1268 //
1269 if (CompareGuid (&DbxList->SignatureType, &gEfiCertX509Sha256Guid)) {
1270 HashAlg = HASHALG_SHA256;
1271 } else if (CompareGuid (&DbxList->SignatureType, &gEfiCertX509Sha384Guid)) {
1272 HashAlg = HASHALG_SHA384;
1273 } else if (CompareGuid (&DbxList->SignatureType, &gEfiCertX509Sha512Guid)) {
1274 HashAlg = HASHALG_SHA512;
1275 } else {
1276 DataSize -= DbxList->SignatureListSize;
1277 DbxList = (EFI_SIGNATURE_LIST *) ((UINT8 *) DbxList + DbxList->SignatureListSize);
1278 continue;
1279 }
1280
1281 //
1282 // Calculate the hash value of current db certificate for comparision.
1283 //
1284 if (!CalculateCertHash (Certificate, CertSize, HashAlg, CertDigest)) {
1285 goto Done;
1286 }
1287
1288 SiglistHeaderSize = sizeof (EFI_SIGNATURE_LIST) + DbxList->SignatureHeaderSize;
1289 CertHash = (EFI_SIGNATURE_DATA *) ((UINT8 *) DbxList + SiglistHeaderSize);
1290 CertHashCount = (DbxList->SignatureListSize - SiglistHeaderSize) / DbxList->SignatureSize;
1291 for (Index = 0; Index < CertHashCount; Index++) {
1292 //
1293 // Iterate each Signature Data Node within this CertList for verify.
1294 //
1295 DbxCertHash = CertHash->SignatureData;
1296 if (CompareMem (DbxCertHash, CertDigest, mHash[HashAlg].DigestLength) == 0) {
1297 //
1298 // Hash of Certificate is found in forbidden database.
1299 //
1300 IsFound = TRUE;
1301 goto Done;
1302 }
1303 CertHash = (EFI_SIGNATURE_DATA *) ((UINT8 *) CertHash + DbxList->SignatureSize);
1304 }
1305
1306 DataSize -= DbxList->SignatureListSize;
1307 DbxList = (EFI_SIGNATURE_LIST *) ((UINT8 *) DbxList + DbxList->SignatureListSize);
1308 }
1309
1310 Done:
1311 if (Data != NULL) {
1312 FreePool (Data);
1313 }
1314
1315 return IsFound;
1316 }
1317
1318 /**
1319 Check whether the signature list exists in given variable data.
1320
1321 It searches the signature list for the ceritificate hash by CertType.
1322 If the signature list is found, get the offset of Database for the
1323 next hash of a certificate.
1324
1325 @param[in] Database Variable data to save signature list.
1326 @param[in] DatabaseSize Variable size.
1327 @param[in] SignatureType The type of the signature.
1328 @param[out] Offset The offset to save a new hash of certificate.
1329
1330 @return TRUE The signature list is found in the forbidden database.
1331 @return FALSE The signature list is not found in the forbidden database.
1332 **/
1333 BOOLEAN
1334 GetSignaturelistOffset (
1335 IN EFI_SIGNATURE_LIST *Database,
1336 IN UINTN DatabaseSize,
1337 IN EFI_GUID *SignatureType,
1338 OUT UINTN *Offset
1339 )
1340 {
1341 EFI_SIGNATURE_LIST *SigList;
1342 UINTN SiglistSize;
1343
1344 if ((Database == NULL) || (DatabaseSize == 0)) {
1345 *Offset = 0;
1346 return FALSE;
1347 }
1348
1349 SigList = Database;
1350 SiglistSize = DatabaseSize;
1351 while ((SiglistSize > 0) && (SiglistSize >= SigList->SignatureListSize)) {
1352 if (CompareGuid (&SigList->SignatureType, SignatureType)) {
1353 *Offset = DatabaseSize - SiglistSize;
1354 return TRUE;
1355 }
1356 SiglistSize -= SigList->SignatureListSize;
1357 SigList = (EFI_SIGNATURE_LIST *) ((UINT8 *) SigList + SigList->SignatureListSize);
1358 }
1359 *Offset = 0;
1360 return FALSE;
1361 }
1362
1363 /**
1364 Enroll a new X509 certificate hash into Signature Database (dbx) without
1365 KEK's authentication.
1366
1367 @param[in] PrivateData The module's private data.
1368 @param[in] HashAlg The hash algorithm to enroll the certificate.
1369 @param[in] RevocationDate The revocation date of the certificate.
1370 @param[in] RevocationTime The revocation time of the certificate.
1371 @param[in] AlwaysRevocation Indicate whether the certificate is always revoked.
1372
1373 @retval EFI_SUCCESS New X509 is enrolled successfully.
1374 @retval EFI_INVALID_PARAMETER The parameter is invalid.
1375 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
1376
1377 **/
1378 EFI_STATUS
1379 EnrollX509HashtoSigDB (
1380 IN SECUREBOOT_CONFIG_PRIVATE_DATA *Private,
1381 IN UINT32 HashAlg,
1382 IN EFI_HII_DATE *RevocationDate,
1383 IN EFI_HII_TIME *RevocationTime,
1384 IN BOOLEAN AlwaysRevocation
1385 )
1386 {
1387 EFI_STATUS Status;
1388 UINTN X509DataSize;
1389 VOID *X509Data;
1390 EFI_SIGNATURE_LIST *SignatureList;
1391 UINTN SignatureListSize;
1392 UINT8 *Data;
1393 UINT8 *NewData;
1394 UINTN DataSize;
1395 UINTN DbSize;
1396 UINT32 Attr;
1397 EFI_SIGNATURE_DATA *SignatureData;
1398 UINTN SignatureSize;
1399 EFI_GUID SignatureType;
1400 UINTN Offset;
1401 UINT8 CertHash[MAX_DIGEST_SIZE];
1402 UINT16* FilePostFix;
1403 UINTN NameLength;
1404 EFI_TIME *Time;
1405
1406 X509DataSize = 0;
1407 DbSize = 0;
1408 X509Data = NULL;
1409 SignatureData = NULL;
1410 SignatureList = NULL;
1411 Data = NULL;
1412 NewData = NULL;
1413
1414 if ((Private->FileContext->FileName == NULL) || (Private->FileContext->FHandle == NULL) || (Private->SignatureGUID == NULL)) {
1415 return EFI_INVALID_PARAMETER;
1416 }
1417
1418 Status = SetSecureBootMode (CUSTOM_SECURE_BOOT_MODE);
1419 if (EFI_ERROR (Status)) {
1420 return Status;
1421 }
1422
1423 //
1424 // Parse the file's postfix.
1425 //
1426 NameLength = StrLen (Private->FileContext->FileName);
1427 if (NameLength <= 4) {
1428 return EFI_INVALID_PARAMETER;
1429 }
1430 FilePostFix = Private->FileContext->FileName + NameLength - 4;
1431 if (!IsDerEncodeCertificate(FilePostFix)) {
1432 //
1433 // Only supports DER-encoded X509 certificate.
1434 //
1435 return EFI_INVALID_PARAMETER;
1436 }
1437
1438 //
1439 // Get the certificate from file and calculate its hash.
1440 //
1441 Status = ReadFileContent (
1442 Private->FileContext->FHandle,
1443 &X509Data,
1444 &X509DataSize,
1445 0
1446 );
1447 if (EFI_ERROR (Status)) {
1448 goto ON_EXIT;
1449 }
1450 ASSERT (X509Data != NULL);
1451
1452 if (!CalculateCertHash (X509Data, X509DataSize, HashAlg, CertHash)) {
1453 goto ON_EXIT;
1454 }
1455
1456 //
1457 // Get the variable for enrollment.
1458 //
1459 DataSize = 0;
1460 Status = gRT->GetVariable (EFI_IMAGE_SECURITY_DATABASE1, &gEfiImageSecurityDatabaseGuid, NULL, &DataSize, NULL);
1461 if (Status == EFI_BUFFER_TOO_SMALL) {
1462 Data = (UINT8 *) AllocateZeroPool (DataSize);
1463 if (Data == NULL) {
1464 return EFI_OUT_OF_RESOURCES;
1465 }
1466
1467 Status = gRT->GetVariable (EFI_IMAGE_SECURITY_DATABASE1, &gEfiImageSecurityDatabaseGuid, NULL, &DataSize, Data);
1468 if (EFI_ERROR (Status)) {
1469 goto ON_EXIT;
1470 }
1471 }
1472
1473 //
1474 // Allocate memory for Signature and fill the Signature
1475 //
1476 SignatureSize = sizeof(EFI_SIGNATURE_DATA) - 1 + sizeof (EFI_TIME) + mHash[HashAlg].DigestLength;
1477 SignatureData = (EFI_SIGNATURE_DATA *) AllocateZeroPool (SignatureSize);
1478 if (SignatureData == NULL) {
1479 return EFI_OUT_OF_RESOURCES;
1480 }
1481 CopyGuid (&SignatureData->SignatureOwner, Private->SignatureGUID);
1482 CopyMem (SignatureData->SignatureData, CertHash, mHash[HashAlg].DigestLength);
1483
1484 //
1485 // Fill the time.
1486 //
1487 if (!AlwaysRevocation) {
1488 Time = (EFI_TIME *)(&SignatureData->SignatureData + mHash[HashAlg].DigestLength);
1489 Time->Year = RevocationDate->Year;
1490 Time->Month = RevocationDate->Month;
1491 Time->Day = RevocationDate->Day;
1492 Time->Hour = RevocationTime->Hour;
1493 Time->Minute = RevocationTime->Minute;
1494 Time->Second = RevocationTime->Second;
1495 }
1496
1497 //
1498 // Determine the GUID for certificate hash.
1499 //
1500 switch (HashAlg) {
1501 case HASHALG_SHA256:
1502 SignatureType = gEfiCertX509Sha256Guid;
1503 break;
1504 case HASHALG_SHA384:
1505 SignatureType = gEfiCertX509Sha384Guid;
1506 break;
1507 case HASHALG_SHA512:
1508 SignatureType = gEfiCertX509Sha512Guid;
1509 break;
1510 default:
1511 return FALSE;
1512 }
1513
1514 //
1515 // Add signature into the new variable data buffer
1516 //
1517 if (GetSignaturelistOffset((EFI_SIGNATURE_LIST *)Data, DataSize, &SignatureType, &Offset)) {
1518 //
1519 // Add the signature to the found signaturelist.
1520 //
1521 DbSize = DataSize + SignatureSize;
1522 NewData = AllocateZeroPool (DbSize);
1523 if (NewData == NULL) {
1524 Status = EFI_OUT_OF_RESOURCES;
1525 goto ON_EXIT;
1526 }
1527
1528 SignatureList = (EFI_SIGNATURE_LIST *)(Data + Offset);
1529 SignatureListSize = (UINTN) ReadUnaligned32 ((UINT32 *)&SignatureList->SignatureListSize);
1530 CopyMem (NewData, Data, Offset + SignatureListSize);
1531
1532 SignatureList = (EFI_SIGNATURE_LIST *)(NewData + Offset);
1533 WriteUnaligned32 ((UINT32 *) &SignatureList->SignatureListSize, (UINT32)(SignatureListSize + SignatureSize));
1534
1535 Offset += SignatureListSize;
1536 CopyMem (NewData + Offset, SignatureData, SignatureSize);
1537 CopyMem (NewData + Offset + SignatureSize, Data + Offset, DataSize - Offset);
1538
1539 FreePool (Data);
1540 Data = NewData;
1541 DataSize = DbSize;
1542 } else {
1543 //
1544 // Create a new signaturelist, and add the signature into the signaturelist.
1545 //
1546 DbSize = DataSize + sizeof(EFI_SIGNATURE_LIST) + SignatureSize;
1547 NewData = AllocateZeroPool (DbSize);
1548 if (NewData == NULL) {
1549 Status = EFI_OUT_OF_RESOURCES;
1550 goto ON_EXIT;
1551 }
1552 //
1553 // Fill Certificate Database parameters.
1554 //
1555 SignatureList = (EFI_SIGNATURE_LIST*) (NewData + DataSize);
1556 SignatureListSize = sizeof(EFI_SIGNATURE_LIST) + SignatureSize;
1557 WriteUnaligned32 ((UINT32 *) &SignatureList->SignatureListSize, (UINT32) SignatureListSize);
1558 WriteUnaligned32 ((UINT32 *) &SignatureList->SignatureSize, (UINT32) SignatureSize);
1559 CopyGuid (&SignatureList->SignatureType, &SignatureType);
1560 CopyMem ((UINT8* ) SignatureList + sizeof (EFI_SIGNATURE_LIST), SignatureData, SignatureSize);
1561 if ((DataSize != 0) && (Data != NULL)) {
1562 CopyMem (NewData, Data, DataSize);
1563 FreePool (Data);
1564 }
1565 Data = NewData;
1566 DataSize = DbSize;
1567 }
1568
1569 Status = CreateTimeBasedPayload (&DataSize, (UINT8**) &Data);
1570 if (EFI_ERROR (Status)) {
1571 goto ON_EXIT;
1572 }
1573
1574 Attr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS
1575 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;
1576 Status = gRT->SetVariable(
1577 EFI_IMAGE_SECURITY_DATABASE1,
1578 &gEfiImageSecurityDatabaseGuid,
1579 Attr,
1580 DataSize,
1581 Data
1582 );
1583 if (EFI_ERROR (Status)) {
1584 goto ON_EXIT;
1585 }
1586
1587 ON_EXIT:
1588
1589 CloseEnrolledFile(Private->FileContext);
1590
1591 if (Private->SignatureGUID != NULL) {
1592 FreePool (Private->SignatureGUID);
1593 Private->SignatureGUID = NULL;
1594 }
1595
1596 if (Data != NULL) {
1597 FreePool (Data);
1598 }
1599
1600 if (SignatureData != NULL) {
1601 FreePool (SignatureData);
1602 }
1603
1604 if (X509Data != NULL) {
1605 FreePool (X509Data);
1606 }
1607
1608 return Status;
1609 }
1610
1611 /**
1612 Check whether a certificate from a file exists in dbx.
1613
1614 @param[in] PrivateData The module's private data.
1615 @param[in] VariableName Variable name of signature database, must be
1616 EFI_IMAGE_SECURITY_DATABASE1.
1617
1618 @retval TRUE The X509 certificate is found in dbx successfully.
1619 @retval FALSE The X509 certificate is not found in dbx.
1620 **/
1621 BOOLEAN
1622 IsX509CertInDbx (
1623 IN SECUREBOOT_CONFIG_PRIVATE_DATA *Private,
1624 IN CHAR16 *VariableName
1625 )
1626 {
1627 EFI_STATUS Status;
1628 UINTN X509DataSize;
1629 VOID *X509Data;
1630 BOOLEAN IsFound;
1631
1632 //
1633 // Read the certificate from file
1634 //
1635 X509DataSize = 0;
1636 X509Data = NULL;
1637 Status = ReadFileContent (
1638 Private->FileContext->FHandle,
1639 &X509Data,
1640 &X509DataSize,
1641 0
1642 );
1643 if (EFI_ERROR (Status)) {
1644 return FALSE;
1645 }
1646
1647 //
1648 // Check the raw certificate.
1649 //
1650 IsFound = FALSE;
1651 if (IsSignatureFoundInDatabase (EFI_IMAGE_SECURITY_DATABASE1, X509Data, X509DataSize)) {
1652 IsFound = TRUE;
1653 goto ON_EXIT;
1654 }
1655
1656 //
1657 // Check the hash of certificate.
1658 //
1659 if (IsCertHashFoundInDbx (X509Data, X509DataSize)) {
1660 IsFound = TRUE;
1661 goto ON_EXIT;
1662 }
1663
1664 ON_EXIT:
1665 if (X509Data != NULL) {
1666 FreePool (X509Data);
1667 }
1668
1669 return IsFound;
1670 }
1671
1672 /**
1673 Reads contents of a PE/COFF image in memory buffer.
1674
1675 Caution: This function may receive untrusted input.
1676 PE/COFF image is external input, so this function will make sure the PE/COFF image content
1677 read is within the image buffer.
1678
1679 @param FileHandle Pointer to the file handle to read the PE/COFF image.
1680 @param FileOffset Offset into the PE/COFF image to begin the read operation.
1681 @param ReadSize On input, the size in bytes of the requested read operation.
1682 On output, the number of bytes actually read.
1683 @param Buffer Output buffer that contains the data read from the PE/COFF image.
1684
1685 @retval EFI_SUCCESS The specified portion of the PE/COFF image was read and the size
1686 **/
1687 EFI_STATUS
1688 EFIAPI
1689 SecureBootConfigImageRead (
1690 IN VOID *FileHandle,
1691 IN UINTN FileOffset,
1692 IN OUT UINTN *ReadSize,
1693 OUT VOID *Buffer
1694 )
1695 {
1696 UINTN EndPosition;
1697
1698 if (FileHandle == NULL || ReadSize == NULL || Buffer == NULL) {
1699 return EFI_INVALID_PARAMETER;
1700 }
1701
1702 if (MAX_ADDRESS - FileOffset < *ReadSize) {
1703 return EFI_INVALID_PARAMETER;
1704 }
1705
1706 EndPosition = FileOffset + *ReadSize;
1707 if (EndPosition > mImageSize) {
1708 *ReadSize = (UINT32)(mImageSize - FileOffset);
1709 }
1710
1711 if (FileOffset >= mImageSize) {
1712 *ReadSize = 0;
1713 }
1714
1715 CopyMem (Buffer, (UINT8 *)((UINTN) FileHandle + FileOffset), *ReadSize);
1716
1717 return EFI_SUCCESS;
1718 }
1719
1720 /**
1721 Load PE/COFF image information into internal buffer and check its validity.
1722
1723 @retval EFI_SUCCESS Successful
1724 @retval EFI_UNSUPPORTED Invalid PE/COFF file
1725 @retval EFI_ABORTED Serious error occurs, like file I/O error etc.
1726
1727 **/
1728 EFI_STATUS
1729 LoadPeImage (
1730 VOID
1731 )
1732 {
1733 EFI_IMAGE_DOS_HEADER *DosHdr;
1734 EFI_IMAGE_NT_HEADERS32 *NtHeader32;
1735 EFI_IMAGE_NT_HEADERS64 *NtHeader64;
1736 PE_COFF_LOADER_IMAGE_CONTEXT ImageContext;
1737 EFI_STATUS Status;
1738
1739 NtHeader32 = NULL;
1740 NtHeader64 = NULL;
1741
1742 ZeroMem (&ImageContext, sizeof (ImageContext));
1743 ImageContext.Handle = (VOID *) mImageBase;
1744 ImageContext.ImageRead = (PE_COFF_LOADER_READ_FILE) SecureBootConfigImageRead;
1745
1746 //
1747 // Get information about the image being loaded
1748 //
1749 Status = PeCoffLoaderGetImageInfo (&ImageContext);
1750 if (EFI_ERROR (Status)) {
1751 //
1752 // The information can't be got from the invalid PeImage
1753 //
1754 DEBUG ((DEBUG_INFO, "SecureBootConfigDxe: PeImage invalid. \n"));
1755 return Status;
1756 }
1757
1758 //
1759 // Read the Dos header
1760 //
1761 DosHdr = (EFI_IMAGE_DOS_HEADER*)(mImageBase);
1762 if (DosHdr->e_magic == EFI_IMAGE_DOS_SIGNATURE)
1763 {
1764 //
1765 // DOS image header is present,
1766 // So read the PE header after the DOS image header
1767 //
1768 mPeCoffHeaderOffset = DosHdr->e_lfanew;
1769 }
1770 else
1771 {
1772 mPeCoffHeaderOffset = 0;
1773 }
1774
1775 //
1776 // Read PE header and check the signature validity and machine compatibility
1777 //
1778 NtHeader32 = (EFI_IMAGE_NT_HEADERS32*) (mImageBase + mPeCoffHeaderOffset);
1779 if (NtHeader32->Signature != EFI_IMAGE_NT_SIGNATURE)
1780 {
1781 return EFI_UNSUPPORTED;
1782 }
1783
1784 mNtHeader.Pe32 = NtHeader32;
1785
1786 //
1787 // Check the architecture field of PE header and get the Certificate Data Directory data
1788 // Note the size of FileHeader field is constant for both IA32 and X64 arch
1789 //
1790 if ((NtHeader32->FileHeader.Machine == EFI_IMAGE_MACHINE_IA32)
1791 || (NtHeader32->FileHeader.Machine == EFI_IMAGE_MACHINE_EBC)
1792 || (NtHeader32->FileHeader.Machine == EFI_IMAGE_MACHINE_ARMTHUMB_MIXED)) {
1793 //
1794 // 32-bits Architecture
1795 //
1796 mImageType = ImageType_IA32;
1797 mSecDataDir = (EFI_IMAGE_SECURITY_DATA_DIRECTORY*) &(NtHeader32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY]);
1798 }
1799 else if ((NtHeader32->FileHeader.Machine == EFI_IMAGE_MACHINE_IA64)
1800 || (NtHeader32->FileHeader.Machine == EFI_IMAGE_MACHINE_X64)
1801 || (NtHeader32->FileHeader.Machine == EFI_IMAGE_MACHINE_AARCH64)) {
1802 //
1803 // 64-bits Architecture
1804 //
1805 mImageType = ImageType_X64;
1806 NtHeader64 = (EFI_IMAGE_NT_HEADERS64 *) (mImageBase + mPeCoffHeaderOffset);
1807 mSecDataDir = (EFI_IMAGE_SECURITY_DATA_DIRECTORY*) &(NtHeader64->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY]);
1808 } else {
1809 return EFI_UNSUPPORTED;
1810 }
1811
1812 return EFI_SUCCESS;
1813 }
1814
1815 /**
1816 Calculate hash of Pe/Coff image based on the authenticode image hashing in
1817 PE/COFF Specification 8.0 Appendix A
1818
1819 Notes: PE/COFF image has been checked by BasePeCoffLib PeCoffLoaderGetImageInfo() in
1820 the function LoadPeImage ().
1821
1822 @param[in] HashAlg Hash algorithm type.
1823
1824 @retval TRUE Successfully hash image.
1825 @retval FALSE Fail in hash image.
1826
1827 **/
1828 BOOLEAN
1829 HashPeImage (
1830 IN UINT32 HashAlg
1831 )
1832 {
1833 BOOLEAN Status;
1834 EFI_IMAGE_SECTION_HEADER *Section;
1835 VOID *HashCtx;
1836 UINTN CtxSize;
1837 UINT8 *HashBase;
1838 UINTN HashSize;
1839 UINTN SumOfBytesHashed;
1840 EFI_IMAGE_SECTION_HEADER *SectionHeader;
1841 UINTN Index;
1842 UINTN Pos;
1843
1844 HashCtx = NULL;
1845 SectionHeader = NULL;
1846 Status = FALSE;
1847
1848 if (HashAlg != HASHALG_SHA256) {
1849 return FALSE;
1850 }
1851
1852 //
1853 // Initialize context of hash.
1854 //
1855 ZeroMem (mImageDigest, MAX_DIGEST_SIZE);
1856
1857 mImageDigestSize = SHA256_DIGEST_SIZE;
1858 mCertType = gEfiCertSha256Guid;
1859
1860 CtxSize = mHash[HashAlg].GetContextSize();
1861
1862 HashCtx = AllocatePool (CtxSize);
1863 ASSERT (HashCtx != NULL);
1864
1865 // 1. Load the image header into memory.
1866
1867 // 2. Initialize a SHA hash context.
1868 Status = mHash[HashAlg].HashInit(HashCtx);
1869 if (!Status) {
1870 goto Done;
1871 }
1872 //
1873 // Measuring PE/COFF Image Header;
1874 // But CheckSum field and SECURITY data directory (certificate) are excluded
1875 //
1876
1877 //
1878 // 3. Calculate the distance from the base of the image header to the image checksum address.
1879 // 4. Hash the image header from its base to beginning of the image checksum.
1880 //
1881 HashBase = mImageBase;
1882 if (mNtHeader.Pe32->OptionalHeader.Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
1883 //
1884 // Use PE32 offset.
1885 //
1886 HashSize = (UINTN) (&mNtHeader.Pe32->OptionalHeader.CheckSum) - (UINTN) HashBase;
1887 } else {
1888 //
1889 // Use PE32+ offset.
1890 //
1891 HashSize = (UINTN) (&mNtHeader.Pe32Plus->OptionalHeader.CheckSum) - (UINTN) HashBase;
1892 }
1893
1894 Status = mHash[HashAlg].HashUpdate(HashCtx, HashBase, HashSize);
1895 if (!Status) {
1896 goto Done;
1897 }
1898 //
1899 // 5. Skip over the image checksum (it occupies a single ULONG).
1900 // 6. Get the address of the beginning of the Cert Directory.
1901 // 7. Hash everything from the end of the checksum to the start of the Cert Directory.
1902 //
1903 if (mNtHeader.Pe32->OptionalHeader.Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
1904 //
1905 // Use PE32 offset.
1906 //
1907 HashBase = (UINT8 *) &mNtHeader.Pe32->OptionalHeader.CheckSum + sizeof (UINT32);
1908 HashSize = (UINTN) (&mNtHeader.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY]) - (UINTN) HashBase;
1909 } else {
1910 //
1911 // Use PE32+ offset.
1912 //
1913 HashBase = (UINT8 *) &mNtHeader.Pe32Plus->OptionalHeader.CheckSum + sizeof (UINT32);
1914 HashSize = (UINTN) (&mNtHeader.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY]) - (UINTN) HashBase;
1915 }
1916
1917 Status = mHash[HashAlg].HashUpdate(HashCtx, HashBase, HashSize);
1918 if (!Status) {
1919 goto Done;
1920 }
1921 //
1922 // 8. Skip over the Cert Directory. (It is sizeof(IMAGE_DATA_DIRECTORY) bytes.)
1923 // 9. Hash everything from the end of the Cert Directory to the end of image header.
1924 //
1925 if (mNtHeader.Pe32->OptionalHeader.Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
1926 //
1927 // Use PE32 offset
1928 //
1929 HashBase = (UINT8 *) &mNtHeader.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY + 1];
1930 HashSize = mNtHeader.Pe32->OptionalHeader.SizeOfHeaders - ((UINTN) (&mNtHeader.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY + 1]) - (UINTN) mImageBase);
1931 } else {
1932 //
1933 // Use PE32+ offset.
1934 //
1935 HashBase = (UINT8 *) &mNtHeader.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY + 1];
1936 HashSize = mNtHeader.Pe32Plus->OptionalHeader.SizeOfHeaders - ((UINTN) (&mNtHeader.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY + 1]) - (UINTN) mImageBase);
1937 }
1938
1939 Status = mHash[HashAlg].HashUpdate(HashCtx, HashBase, HashSize);
1940 if (!Status) {
1941 goto Done;
1942 }
1943 //
1944 // 10. Set the SUM_OF_BYTES_HASHED to the size of the header.
1945 //
1946 if (mNtHeader.Pe32->OptionalHeader.Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
1947 //
1948 // Use PE32 offset.
1949 //
1950 SumOfBytesHashed = mNtHeader.Pe32->OptionalHeader.SizeOfHeaders;
1951 } else {
1952 //
1953 // Use PE32+ offset
1954 //
1955 SumOfBytesHashed = mNtHeader.Pe32Plus->OptionalHeader.SizeOfHeaders;
1956 }
1957
1958 //
1959 // 11. Build a temporary table of pointers to all the IMAGE_SECTION_HEADER
1960 // structures in the image. The 'NumberOfSections' field of the image
1961 // header indicates how big the table should be. Do not include any
1962 // IMAGE_SECTION_HEADERs in the table whose 'SizeOfRawData' field is zero.
1963 //
1964 SectionHeader = (EFI_IMAGE_SECTION_HEADER *) AllocateZeroPool (sizeof (EFI_IMAGE_SECTION_HEADER) * mNtHeader.Pe32->FileHeader.NumberOfSections);
1965 ASSERT (SectionHeader != NULL);
1966 //
1967 // 12. Using the 'PointerToRawData' in the referenced section headers as
1968 // a key, arrange the elements in the table in ascending order. In other
1969 // words, sort the section headers according to the disk-file offset of
1970 // the section.
1971 //
1972 Section = (EFI_IMAGE_SECTION_HEADER *) (
1973 mImageBase +
1974 mPeCoffHeaderOffset +
1975 sizeof (UINT32) +
1976 sizeof (EFI_IMAGE_FILE_HEADER) +
1977 mNtHeader.Pe32->FileHeader.SizeOfOptionalHeader
1978 );
1979 for (Index = 0; Index < mNtHeader.Pe32->FileHeader.NumberOfSections; Index++) {
1980 Pos = Index;
1981 while ((Pos > 0) && (Section->PointerToRawData < SectionHeader[Pos - 1].PointerToRawData)) {
1982 CopyMem (&SectionHeader[Pos], &SectionHeader[Pos - 1], sizeof (EFI_IMAGE_SECTION_HEADER));
1983 Pos--;
1984 }
1985 CopyMem (&SectionHeader[Pos], Section, sizeof (EFI_IMAGE_SECTION_HEADER));
1986 Section += 1;
1987 }
1988
1989 //
1990 // 13. Walk through the sorted table, bring the corresponding section
1991 // into memory, and hash the entire section (using the 'SizeOfRawData'
1992 // field in the section header to determine the amount of data to hash).
1993 // 14. Add the section's 'SizeOfRawData' to SUM_OF_BYTES_HASHED .
1994 // 15. Repeat steps 13 and 14 for all the sections in the sorted table.
1995 //
1996 for (Index = 0; Index < mNtHeader.Pe32->FileHeader.NumberOfSections; Index++) {
1997 Section = &SectionHeader[Index];
1998 if (Section->SizeOfRawData == 0) {
1999 continue;
2000 }
2001 HashBase = mImageBase + Section->PointerToRawData;
2002 HashSize = (UINTN) Section->SizeOfRawData;
2003
2004 Status = mHash[HashAlg].HashUpdate(HashCtx, HashBase, HashSize);
2005 if (!Status) {
2006 goto Done;
2007 }
2008
2009 SumOfBytesHashed += HashSize;
2010 }
2011
2012 //
2013 // 16. If the file size is greater than SUM_OF_BYTES_HASHED, there is extra
2014 // data in the file that needs to be added to the hash. This data begins
2015 // at file offset SUM_OF_BYTES_HASHED and its length is:
2016 // FileSize - (CertDirectory->Size)
2017 //
2018 if (mImageSize > SumOfBytesHashed) {
2019 HashBase = mImageBase + SumOfBytesHashed;
2020 if (mNtHeader.Pe32->OptionalHeader.Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {
2021 //
2022 // Use PE32 offset.
2023 //
2024 HashSize = (UINTN)(
2025 mImageSize -
2026 mNtHeader.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY].Size -
2027 SumOfBytesHashed);
2028 } else {
2029 //
2030 // Use PE32+ offset.
2031 //
2032 HashSize = (UINTN)(
2033 mImageSize -
2034 mNtHeader.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY].Size -
2035 SumOfBytesHashed);
2036 }
2037
2038 Status = mHash[HashAlg].HashUpdate(HashCtx, HashBase, HashSize);
2039 if (!Status) {
2040 goto Done;
2041 }
2042 }
2043
2044 Status = mHash[HashAlg].HashFinal(HashCtx, mImageDigest);
2045
2046 Done:
2047 if (HashCtx != NULL) {
2048 FreePool (HashCtx);
2049 }
2050 if (SectionHeader != NULL) {
2051 FreePool (SectionHeader);
2052 }
2053 return Status;
2054 }
2055
2056 /**
2057 Recognize the Hash algorithm in PE/COFF Authenticode and calculate hash of
2058 Pe/Coff image based on the authenticated image hashing in PE/COFF Specification
2059 8.0 Appendix A
2060
2061 @retval EFI_UNSUPPORTED Hash algorithm is not supported.
2062 @retval EFI_SUCCESS Hash successfully.
2063
2064 **/
2065 EFI_STATUS
2066 HashPeImageByType (
2067 VOID
2068 )
2069 {
2070 UINT8 Index;
2071 WIN_CERTIFICATE_EFI_PKCS *PkcsCertData;
2072
2073 PkcsCertData = (WIN_CERTIFICATE_EFI_PKCS *) (mImageBase + mSecDataDir->Offset);
2074
2075 for (Index = 0; Index < HASHALG_MAX; Index++) {
2076 //
2077 // Check the Hash algorithm in PE/COFF Authenticode.
2078 // According to PKCS#7 Definition:
2079 // SignedData ::= SEQUENCE {
2080 // version Version,
2081 // digestAlgorithms DigestAlgorithmIdentifiers,
2082 // contentInfo ContentInfo,
2083 // .... }
2084 // The DigestAlgorithmIdentifiers can be used to determine the hash algorithm in PE/COFF hashing
2085 // This field has the fixed offset (+32) in final Authenticode ASN.1 data.
2086 // Fixed offset (+32) is calculated based on two bytes of length encoding.
2087 //
2088 if ((*(PkcsCertData->CertData + 1) & TWO_BYTE_ENCODE) != TWO_BYTE_ENCODE) {
2089 //
2090 // Only support two bytes of Long Form of Length Encoding.
2091 //
2092 continue;
2093 }
2094
2095 //
2096 if (CompareMem (PkcsCertData->CertData + 32, mHash[Index].OidValue, mHash[Index].OidLength) == 0) {
2097 break;
2098 }
2099 }
2100
2101 if (Index == HASHALG_MAX) {
2102 return EFI_UNSUPPORTED;
2103 }
2104
2105 //
2106 // HASH PE Image based on Hash algorithm in PE/COFF Authenticode.
2107 //
2108 if (!HashPeImage(Index)) {
2109 return EFI_UNSUPPORTED;
2110 }
2111
2112 return EFI_SUCCESS;
2113 }
2114
2115 /**
2116 Enroll a new executable's signature into Signature Database.
2117
2118 @param[in] PrivateData The module's private data.
2119 @param[in] VariableName Variable name of signature database, must be
2120 EFI_IMAGE_SECURITY_DATABASE, EFI_IMAGE_SECURITY_DATABASE1
2121 or EFI_IMAGE_SECURITY_DATABASE2.
2122
2123 @retval EFI_SUCCESS New signature is enrolled successfully.
2124 @retval EFI_INVALID_PARAMETER The parameter is invalid.
2125 @retval EFI_UNSUPPORTED Unsupported command.
2126 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
2127
2128 **/
2129 EFI_STATUS
2130 EnrollAuthentication2Descriptor (
2131 IN SECUREBOOT_CONFIG_PRIVATE_DATA *Private,
2132 IN CHAR16 *VariableName
2133 )
2134 {
2135 EFI_STATUS Status;
2136 VOID *Data;
2137 UINTN DataSize;
2138 UINT32 Attr;
2139
2140 Data = NULL;
2141
2142 //
2143 // DBT only support DER-X509 Cert Enrollment
2144 //
2145 if (StrCmp (VariableName, EFI_IMAGE_SECURITY_DATABASE2) == 0) {
2146 return EFI_UNSUPPORTED;
2147 }
2148
2149 //
2150 // Read the whole file content
2151 //
2152 Status = ReadFileContent(
2153 Private->FileContext->FHandle,
2154 (VOID **) &mImageBase,
2155 &mImageSize,
2156 0
2157 );
2158 if (EFI_ERROR (Status)) {
2159 goto ON_EXIT;
2160 }
2161 ASSERT (mImageBase != NULL);
2162
2163 Attr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS
2164 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;
2165
2166 //
2167 // Check if SigDB variable has been already existed.
2168 // If true, use EFI_VARIABLE_APPEND_WRITE attribute to append the
2169 // new signature data to original variable
2170 //
2171 DataSize = 0;
2172 Status = gRT->GetVariable(
2173 VariableName,
2174 &gEfiImageSecurityDatabaseGuid,
2175 NULL,
2176 &DataSize,
2177 NULL
2178 );
2179 if (Status == EFI_BUFFER_TOO_SMALL) {
2180 Attr |= EFI_VARIABLE_APPEND_WRITE;
2181 } else if (Status != EFI_NOT_FOUND) {
2182 goto ON_EXIT;
2183 }
2184
2185 //
2186 // Diretly set AUTHENTICATION_2 data to SetVariable
2187 //
2188 Status = gRT->SetVariable(
2189 VariableName,
2190 &gEfiImageSecurityDatabaseGuid,
2191 Attr,
2192 mImageSize,
2193 mImageBase
2194 );
2195
2196 DEBUG((DEBUG_INFO, "Enroll AUTH_2 data to Var:%s Status: %x\n", VariableName, Status));
2197
2198 ON_EXIT:
2199
2200 CloseEnrolledFile(Private->FileContext);
2201
2202 if (Data != NULL) {
2203 FreePool (Data);
2204 }
2205
2206 if (mImageBase != NULL) {
2207 FreePool (mImageBase);
2208 mImageBase = NULL;
2209 }
2210
2211 return Status;
2212
2213 }
2214
2215
2216 /**
2217 Enroll a new executable's signature into Signature Database.
2218
2219 @param[in] PrivateData The module's private data.
2220 @param[in] VariableName Variable name of signature database, must be
2221 EFI_IMAGE_SECURITY_DATABASE, EFI_IMAGE_SECURITY_DATABASE1
2222 or EFI_IMAGE_SECURITY_DATABASE2.
2223
2224 @retval EFI_SUCCESS New signature is enrolled successfully.
2225 @retval EFI_INVALID_PARAMETER The parameter is invalid.
2226 @retval EFI_UNSUPPORTED Unsupported command.
2227 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
2228
2229 **/
2230 EFI_STATUS
2231 EnrollImageSignatureToSigDB (
2232 IN SECUREBOOT_CONFIG_PRIVATE_DATA *Private,
2233 IN CHAR16 *VariableName
2234 )
2235 {
2236 EFI_STATUS Status;
2237 EFI_SIGNATURE_LIST *SigDBCert;
2238 EFI_SIGNATURE_DATA *SigDBCertData;
2239 VOID *Data;
2240 UINTN DataSize;
2241 UINTN SigDBSize;
2242 UINT32 Attr;
2243 WIN_CERTIFICATE_UEFI_GUID *GuidCertData;
2244
2245 Data = NULL;
2246 GuidCertData = NULL;
2247
2248 if (StrCmp (VariableName, EFI_IMAGE_SECURITY_DATABASE2) == 0) {
2249 return EFI_UNSUPPORTED;
2250 }
2251
2252 //
2253 // Form the SigDB certificate list.
2254 // Format the data item into EFI_SIGNATURE_LIST type.
2255 //
2256 // We need to parse executable's signature data from specified signed executable file.
2257 // In current implementation, we simply trust the pass-in signed executable file.
2258 // In reality, it's OS's responsibility to verify the signed executable file.
2259 //
2260
2261 //
2262 // Read the whole file content
2263 //
2264 Status = ReadFileContent(
2265 Private->FileContext->FHandle,
2266 (VOID **) &mImageBase,
2267 &mImageSize,
2268 0
2269 );
2270 if (EFI_ERROR (Status)) {
2271 goto ON_EXIT;
2272 }
2273 ASSERT (mImageBase != NULL);
2274
2275 Status = LoadPeImage ();
2276 if (EFI_ERROR (Status)) {
2277 goto ON_EXIT;
2278 }
2279
2280 if (mSecDataDir->SizeOfCert == 0) {
2281 if (!HashPeImage (HASHALG_SHA256)) {
2282 Status = EFI_SECURITY_VIOLATION;
2283 goto ON_EXIT;
2284 }
2285 } else {
2286
2287 //
2288 // Read the certificate data
2289 //
2290 mCertificate = (WIN_CERTIFICATE *)(mImageBase + mSecDataDir->Offset);
2291
2292 if (mCertificate->wCertificateType == WIN_CERT_TYPE_EFI_GUID) {
2293 GuidCertData = (WIN_CERTIFICATE_UEFI_GUID*) mCertificate;
2294 if (CompareMem (&GuidCertData->CertType, &gEfiCertTypeRsa2048Sha256Guid, sizeof(EFI_GUID)) != 0) {
2295 Status = EFI_ABORTED;
2296 goto ON_EXIT;
2297 }
2298
2299 if (!HashPeImage (HASHALG_SHA256)) {
2300 Status = EFI_ABORTED;
2301 goto ON_EXIT;;
2302 }
2303
2304 } else if (mCertificate->wCertificateType == WIN_CERT_TYPE_PKCS_SIGNED_DATA) {
2305
2306 Status = HashPeImageByType ();
2307 if (EFI_ERROR (Status)) {
2308 goto ON_EXIT;;
2309 }
2310 } else {
2311 Status = EFI_ABORTED;
2312 goto ON_EXIT;
2313 }
2314 }
2315
2316 //
2317 // Create a new SigDB entry.
2318 //
2319 SigDBSize = sizeof(EFI_SIGNATURE_LIST)
2320 + sizeof(EFI_SIGNATURE_DATA) - 1
2321 + (UINT32) mImageDigestSize;
2322
2323 Data = (UINT8*) AllocateZeroPool (SigDBSize);
2324 if (Data == NULL) {
2325 Status = EFI_OUT_OF_RESOURCES;
2326 goto ON_EXIT;
2327 }
2328
2329 //
2330 // Adjust the Certificate Database parameters.
2331 //
2332 SigDBCert = (EFI_SIGNATURE_LIST*) Data;
2333 SigDBCert->SignatureListSize = (UINT32) SigDBSize;
2334 SigDBCert->SignatureHeaderSize = 0;
2335 SigDBCert->SignatureSize = sizeof(EFI_SIGNATURE_DATA) - 1 + (UINT32) mImageDigestSize;
2336 CopyGuid (&SigDBCert->SignatureType, &mCertType);
2337
2338 SigDBCertData = (EFI_SIGNATURE_DATA*)((UINT8*)SigDBCert + sizeof(EFI_SIGNATURE_LIST));
2339 CopyGuid (&SigDBCertData->SignatureOwner, Private->SignatureGUID);
2340 CopyMem (SigDBCertData->SignatureData, mImageDigest, mImageDigestSize);
2341
2342 Attr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS
2343 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;
2344 Status = CreateTimeBasedPayload (&SigDBSize, (UINT8**) &Data);
2345 if (EFI_ERROR (Status)) {
2346 DEBUG ((EFI_D_ERROR, "Fail to create time-based data payload: %r", Status));
2347 goto ON_EXIT;
2348 }
2349
2350 //
2351 // Check if SigDB variable has been already existed.
2352 // If true, use EFI_VARIABLE_APPEND_WRITE attribute to append the
2353 // new signature data to original variable
2354 //
2355 DataSize = 0;
2356 Status = gRT->GetVariable(
2357 VariableName,
2358 &gEfiImageSecurityDatabaseGuid,
2359 NULL,
2360 &DataSize,
2361 NULL
2362 );
2363 if (Status == EFI_BUFFER_TOO_SMALL) {
2364 Attr |= EFI_VARIABLE_APPEND_WRITE;
2365 } else if (Status != EFI_NOT_FOUND) {
2366 goto ON_EXIT;
2367 }
2368
2369 //
2370 // Enroll the variable.
2371 //
2372 Status = gRT->SetVariable(
2373 VariableName,
2374 &gEfiImageSecurityDatabaseGuid,
2375 Attr,
2376 SigDBSize,
2377 Data
2378 );
2379 if (EFI_ERROR (Status)) {
2380 goto ON_EXIT;
2381 }
2382
2383 ON_EXIT:
2384
2385 CloseEnrolledFile(Private->FileContext);
2386
2387 if (Private->SignatureGUID != NULL) {
2388 FreePool (Private->SignatureGUID);
2389 Private->SignatureGUID = NULL;
2390 }
2391
2392 if (Data != NULL) {
2393 FreePool (Data);
2394 }
2395
2396 if (mImageBase != NULL) {
2397 FreePool (mImageBase);
2398 mImageBase = NULL;
2399 }
2400
2401 return Status;
2402 }
2403
2404 /**
2405 Enroll signature into DB/DBX/DBT without KEK's authentication.
2406 The SignatureOwner GUID will be Private->SignatureGUID.
2407
2408 @param[in] PrivateData The module's private data.
2409 @param[in] VariableName Variable name of signature database, must be
2410 EFI_IMAGE_SECURITY_DATABASE or EFI_IMAGE_SECURITY_DATABASE1.
2411
2412 @retval EFI_SUCCESS New signature enrolled successfully.
2413 @retval EFI_INVALID_PARAMETER The parameter is invalid.
2414 @retval others Fail to enroll signature data.
2415
2416 **/
2417 EFI_STATUS
2418 EnrollSignatureDatabase (
2419 IN SECUREBOOT_CONFIG_PRIVATE_DATA *Private,
2420 IN CHAR16 *VariableName
2421 )
2422 {
2423 UINT16* FilePostFix;
2424 EFI_STATUS Status;
2425 UINTN NameLength;
2426
2427 if ((Private->FileContext->FileName == NULL) || (Private->FileContext->FHandle == NULL) || (Private->SignatureGUID == NULL)) {
2428 return EFI_INVALID_PARAMETER;
2429 }
2430
2431 Status = SetSecureBootMode (CUSTOM_SECURE_BOOT_MODE);
2432 if (EFI_ERROR (Status)) {
2433 return Status;
2434 }
2435
2436 //
2437 // Parse the file's postfix.
2438 //
2439 NameLength = StrLen (Private->FileContext->FileName);
2440 if (NameLength <= 4) {
2441 return EFI_INVALID_PARAMETER;
2442 }
2443 FilePostFix = Private->FileContext->FileName + NameLength - 4;
2444 if (IsDerEncodeCertificate (FilePostFix)) {
2445 //
2446 // Supports DER-encoded X509 certificate.
2447 //
2448 return EnrollX509toSigDB (Private, VariableName);
2449 } else if (IsAuthentication2Format(Private->FileContext->FHandle)){
2450 return EnrollAuthentication2Descriptor(Private, VariableName);
2451 } else {
2452 return EnrollImageSignatureToSigDB (Private, VariableName);
2453 }
2454 }
2455
2456 /**
2457 List all signatures in specified signature database (e.g. KEK/DB/DBX/DBT)
2458 by GUID in the page for user to select and delete as needed.
2459
2460 @param[in] PrivateData Module's private data.
2461 @param[in] VariableName The variable name of the vendor's signature database.
2462 @param[in] VendorGuid A unique identifier for the vendor.
2463 @param[in] LabelNumber Label number to insert opcodes.
2464 @param[in] FormId Form ID of current page.
2465 @param[in] QuestionIdBase Base question id of the signature list.
2466
2467 @retval EFI_SUCCESS Success to update the signature list page
2468 @retval EFI_OUT_OF_RESOURCES Unable to allocate required resources.
2469
2470 **/
2471 EFI_STATUS
2472 UpdateDeletePage (
2473 IN SECUREBOOT_CONFIG_PRIVATE_DATA *PrivateData,
2474 IN CHAR16 *VariableName,
2475 IN EFI_GUID *VendorGuid,
2476 IN UINT16 LabelNumber,
2477 IN EFI_FORM_ID FormId,
2478 IN EFI_QUESTION_ID QuestionIdBase
2479 )
2480 {
2481 EFI_STATUS Status;
2482 UINT32 Index;
2483 UINTN CertCount;
2484 UINTN GuidIndex;
2485 VOID *StartOpCodeHandle;
2486 VOID *EndOpCodeHandle;
2487 EFI_IFR_GUID_LABEL *StartLabel;
2488 EFI_IFR_GUID_LABEL *EndLabel;
2489 UINTN DataSize;
2490 UINT8 *Data;
2491 EFI_SIGNATURE_LIST *CertList;
2492 EFI_SIGNATURE_DATA *Cert;
2493 UINT32 ItemDataSize;
2494 CHAR16 *GuidStr;
2495 EFI_STRING_ID GuidID;
2496 EFI_STRING_ID Help;
2497
2498 Data = NULL;
2499 CertList = NULL;
2500 Cert = NULL;
2501 GuidStr = NULL;
2502 StartOpCodeHandle = NULL;
2503 EndOpCodeHandle = NULL;
2504
2505 //
2506 // Initialize the container for dynamic opcodes.
2507 //
2508 StartOpCodeHandle = HiiAllocateOpCodeHandle ();
2509 if (StartOpCodeHandle == NULL) {
2510 Status = EFI_OUT_OF_RESOURCES;
2511 goto ON_EXIT;
2512 }
2513
2514 EndOpCodeHandle = HiiAllocateOpCodeHandle ();
2515 if (EndOpCodeHandle == NULL) {
2516 Status = EFI_OUT_OF_RESOURCES;
2517 goto ON_EXIT;
2518 }
2519
2520 //
2521 // Create Hii Extend Label OpCode.
2522 //
2523 StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (
2524 StartOpCodeHandle,
2525 &gEfiIfrTianoGuid,
2526 NULL,
2527 sizeof (EFI_IFR_GUID_LABEL)
2528 );
2529 StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
2530 StartLabel->Number = LabelNumber;
2531
2532 EndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (
2533 EndOpCodeHandle,
2534 &gEfiIfrTianoGuid,
2535 NULL,
2536 sizeof (EFI_IFR_GUID_LABEL)
2537 );
2538 EndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
2539 EndLabel->Number = LABEL_END;
2540
2541 //
2542 // Read Variable.
2543 //
2544 DataSize = 0;
2545 Status = gRT->GetVariable (VariableName, VendorGuid, NULL, &DataSize, Data);
2546 if (EFI_ERROR (Status) && Status != EFI_BUFFER_TOO_SMALL) {
2547 goto ON_EXIT;
2548 }
2549
2550 Data = (UINT8 *) AllocateZeroPool (DataSize);
2551 if (Data == NULL) {
2552 Status = EFI_OUT_OF_RESOURCES;
2553 goto ON_EXIT;
2554 }
2555
2556 Status = gRT->GetVariable (VariableName, VendorGuid, NULL, &DataSize, Data);
2557 if (EFI_ERROR (Status)) {
2558 goto ON_EXIT;
2559 }
2560
2561 GuidStr = AllocateZeroPool (100);
2562 if (GuidStr == NULL) {
2563 Status = EFI_OUT_OF_RESOURCES;
2564 goto ON_EXIT;
2565 }
2566
2567 //
2568 // Enumerate all KEK pub data.
2569 //
2570 ItemDataSize = (UINT32) DataSize;
2571 CertList = (EFI_SIGNATURE_LIST *) Data;
2572 GuidIndex = 0;
2573
2574 while ((ItemDataSize > 0) && (ItemDataSize >= CertList->SignatureListSize)) {
2575
2576 if (CompareGuid (&CertList->SignatureType, &gEfiCertRsa2048Guid)) {
2577 Help = STRING_TOKEN (STR_CERT_TYPE_RSA2048_SHA256_GUID);
2578 } else if (CompareGuid (&CertList->SignatureType, &gEfiCertX509Guid)) {
2579 Help = STRING_TOKEN (STR_CERT_TYPE_PCKS7_GUID);
2580 } else if (CompareGuid (&CertList->SignatureType, &gEfiCertSha1Guid)) {
2581 Help = STRING_TOKEN (STR_CERT_TYPE_SHA1_GUID);
2582 } else if (CompareGuid (&CertList->SignatureType, &gEfiCertSha256Guid)) {
2583 Help = STRING_TOKEN (STR_CERT_TYPE_SHA256_GUID);
2584 } else if (CompareGuid (&CertList->SignatureType, &gEfiCertX509Sha256Guid)) {
2585 Help = STRING_TOKEN (STR_CERT_TYPE_X509_SHA256_GUID);
2586 } else if (CompareGuid (&CertList->SignatureType, &gEfiCertX509Sha384Guid)) {
2587 Help = STRING_TOKEN (STR_CERT_TYPE_X509_SHA384_GUID);
2588 } else if (CompareGuid (&CertList->SignatureType, &gEfiCertX509Sha512Guid)) {
2589 Help = STRING_TOKEN (STR_CERT_TYPE_X509_SHA512_GUID);
2590 } else {
2591 //
2592 // The signature type is not supported in current implementation.
2593 //
2594 ItemDataSize -= CertList->SignatureListSize;
2595 CertList = (EFI_SIGNATURE_LIST *) ((UINT8 *) CertList + CertList->SignatureListSize);
2596 continue;
2597 }
2598
2599 CertCount = (CertList->SignatureListSize - sizeof (EFI_SIGNATURE_LIST) - CertList->SignatureHeaderSize) / CertList->SignatureSize;
2600 for (Index = 0; Index < CertCount; Index++) {
2601 Cert = (EFI_SIGNATURE_DATA *) ((UINT8 *) CertList
2602 + sizeof (EFI_SIGNATURE_LIST)
2603 + CertList->SignatureHeaderSize
2604 + Index * CertList->SignatureSize);
2605 //
2606 // Display GUID and help
2607 //
2608 GuidToString (&Cert->SignatureOwner, GuidStr, 100);
2609 GuidID = HiiSetString (PrivateData->HiiHandle, 0, GuidStr, NULL);
2610 HiiCreateCheckBoxOpCode (
2611 StartOpCodeHandle,
2612 (EFI_QUESTION_ID) (QuestionIdBase + GuidIndex++),
2613 0,
2614 0,
2615 GuidID,
2616 Help,
2617 EFI_IFR_FLAG_CALLBACK,
2618 0,
2619 NULL
2620 );
2621 }
2622
2623 ItemDataSize -= CertList->SignatureListSize;
2624 CertList = (EFI_SIGNATURE_LIST *) ((UINT8 *) CertList + CertList->SignatureListSize);
2625 }
2626
2627 ON_EXIT:
2628 HiiUpdateForm (
2629 PrivateData->HiiHandle,
2630 &gSecureBootConfigFormSetGuid,
2631 FormId,
2632 StartOpCodeHandle,
2633 EndOpCodeHandle
2634 );
2635
2636 if (StartOpCodeHandle != NULL) {
2637 HiiFreeOpCodeHandle (StartOpCodeHandle);
2638 }
2639
2640 if (EndOpCodeHandle != NULL) {
2641 HiiFreeOpCodeHandle (EndOpCodeHandle);
2642 }
2643
2644 if (Data != NULL) {
2645 FreePool (Data);
2646 }
2647
2648 if (GuidStr != NULL) {
2649 FreePool (GuidStr);
2650 }
2651
2652 return EFI_SUCCESS;
2653 }
2654
2655 /**
2656 Delete a KEK entry from KEK database.
2657
2658 @param[in] PrivateData Module's private data.
2659 @param[in] QuestionId Question id of the KEK item to delete.
2660
2661 @retval EFI_SUCCESS Delete kek item successfully.
2662 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
2663
2664 **/
2665 EFI_STATUS
2666 DeleteKeyExchangeKey (
2667 IN SECUREBOOT_CONFIG_PRIVATE_DATA *PrivateData,
2668 IN EFI_QUESTION_ID QuestionId
2669 )
2670 {
2671 EFI_STATUS Status;
2672 UINTN DataSize;
2673 UINT8 *Data;
2674 UINT8 *OldData;
2675 UINT32 Attr;
2676 UINT32 Index;
2677 EFI_SIGNATURE_LIST *CertList;
2678 EFI_SIGNATURE_LIST *NewCertList;
2679 EFI_SIGNATURE_DATA *Cert;
2680 UINTN CertCount;
2681 UINT32 Offset;
2682 BOOLEAN IsKEKItemFound;
2683 UINT32 KekDataSize;
2684 UINTN DeleteKekIndex;
2685 UINTN GuidIndex;
2686
2687 Data = NULL;
2688 OldData = NULL;
2689 CertList = NULL;
2690 Cert = NULL;
2691 Attr = 0;
2692 DeleteKekIndex = QuestionId - OPTION_DEL_KEK_QUESTION_ID;
2693
2694 Status = SetSecureBootMode(CUSTOM_SECURE_BOOT_MODE);
2695 if (EFI_ERROR (Status)) {
2696 return Status;
2697 }
2698
2699 //
2700 // Get original KEK variable.
2701 //
2702 DataSize = 0;
2703 Status = gRT->GetVariable (EFI_KEY_EXCHANGE_KEY_NAME, &gEfiGlobalVariableGuid, NULL, &DataSize, NULL);
2704 if (EFI_ERROR(Status) && Status != EFI_BUFFER_TOO_SMALL) {
2705 goto ON_EXIT;
2706 }
2707
2708 OldData = (UINT8*)AllocateZeroPool(DataSize);
2709 if (OldData == NULL) {
2710 Status = EFI_OUT_OF_RESOURCES;
2711 goto ON_EXIT;
2712 }
2713
2714 Status = gRT->GetVariable (EFI_KEY_EXCHANGE_KEY_NAME, &gEfiGlobalVariableGuid, &Attr, &DataSize, OldData);
2715 if (EFI_ERROR(Status)) {
2716 goto ON_EXIT;
2717 }
2718
2719 //
2720 // Allocate space for new variable.
2721 //
2722 Data = (UINT8*) AllocateZeroPool (DataSize);
2723 if (Data == NULL) {
2724 Status = EFI_OUT_OF_RESOURCES;
2725 goto ON_EXIT;
2726 }
2727
2728 //
2729 // Enumerate all KEK pub data and erasing the target item.
2730 //
2731 IsKEKItemFound = FALSE;
2732 KekDataSize = (UINT32) DataSize;
2733 CertList = (EFI_SIGNATURE_LIST *) OldData;
2734 Offset = 0;
2735 GuidIndex = 0;
2736 while ((KekDataSize > 0) && (KekDataSize >= CertList->SignatureListSize)) {
2737 if (CompareGuid (&CertList->SignatureType, &gEfiCertRsa2048Guid) ||
2738 CompareGuid (&CertList->SignatureType, &gEfiCertX509Guid)) {
2739 CopyMem (Data + Offset, CertList, (sizeof(EFI_SIGNATURE_LIST) + CertList->SignatureHeaderSize));
2740 NewCertList = (EFI_SIGNATURE_LIST *)(Data + Offset);
2741 Offset += (sizeof(EFI_SIGNATURE_LIST) + CertList->SignatureHeaderSize);
2742 Cert = (EFI_SIGNATURE_DATA *) ((UINT8 *) CertList + sizeof (EFI_SIGNATURE_LIST) + CertList->SignatureHeaderSize);
2743 CertCount = (CertList->SignatureListSize - sizeof (EFI_SIGNATURE_LIST) - CertList->SignatureHeaderSize) / CertList->SignatureSize;
2744 for (Index = 0; Index < CertCount; Index++) {
2745 if (GuidIndex == DeleteKekIndex ) {
2746 //
2747 // Find it! Skip it!
2748 //
2749 NewCertList->SignatureListSize -= CertList->SignatureSize;
2750 IsKEKItemFound = TRUE;
2751 } else {
2752 //
2753 // This item doesn't match. Copy it to the Data buffer.
2754 //
2755 CopyMem (Data + Offset, Cert, CertList->SignatureSize);
2756 Offset += CertList->SignatureSize;
2757 }
2758 GuidIndex++;
2759 Cert = (EFI_SIGNATURE_DATA *) ((UINT8*) Cert + CertList->SignatureSize);
2760 }
2761 } else {
2762 //
2763 // This List doesn't match. Copy it to the Data buffer.
2764 //
2765 CopyMem (Data + Offset, CertList, CertList->SignatureListSize);
2766 Offset += CertList->SignatureListSize;
2767 }
2768
2769 KekDataSize -= CertList->SignatureListSize;
2770 CertList = (EFI_SIGNATURE_LIST*) ((UINT8*) CertList + CertList->SignatureListSize);
2771 }
2772
2773 if (!IsKEKItemFound) {
2774 //
2775 // Doesn't find the Kek Item!
2776 //
2777 Status = EFI_NOT_FOUND;
2778 goto ON_EXIT;
2779 }
2780
2781 //
2782 // Delete the Signature header if there is no signature in the list.
2783 //
2784 KekDataSize = Offset;
2785 CertList = (EFI_SIGNATURE_LIST*) Data;
2786 Offset = 0;
2787 ZeroMem (OldData, KekDataSize);
2788 while ((KekDataSize > 0) && (KekDataSize >= CertList->SignatureListSize)) {
2789 CertCount = (CertList->SignatureListSize - sizeof (EFI_SIGNATURE_LIST) - CertList->SignatureHeaderSize) / CertList->SignatureSize;
2790 DEBUG ((DEBUG_INFO, " CertCount = %x\n", CertCount));
2791 if (CertCount != 0) {
2792 CopyMem (OldData + Offset, CertList, CertList->SignatureListSize);
2793 Offset += CertList->SignatureListSize;
2794 }
2795 KekDataSize -= CertList->SignatureListSize;
2796 CertList = (EFI_SIGNATURE_LIST *) ((UINT8 *) CertList + CertList->SignatureListSize);
2797 }
2798
2799 DataSize = Offset;
2800 if ((Attr & EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS) != 0) {
2801 Status = CreateTimeBasedPayload (&DataSize, &OldData);
2802 if (EFI_ERROR (Status)) {
2803 DEBUG ((EFI_D_ERROR, "Fail to create time-based data payload: %r", Status));
2804 goto ON_EXIT;
2805 }
2806 }
2807
2808 Status = gRT->SetVariable(
2809 EFI_KEY_EXCHANGE_KEY_NAME,
2810 &gEfiGlobalVariableGuid,
2811 Attr,
2812 DataSize,
2813 OldData
2814 );
2815 if (EFI_ERROR (Status)) {
2816 DEBUG ((DEBUG_ERROR, "Failed to set variable, Status = %r\n", Status));
2817 goto ON_EXIT;
2818 }
2819
2820 ON_EXIT:
2821 if (Data != NULL) {
2822 FreePool(Data);
2823 }
2824
2825 if (OldData != NULL) {
2826 FreePool(OldData);
2827 }
2828
2829 return UpdateDeletePage (
2830 PrivateData,
2831 EFI_KEY_EXCHANGE_KEY_NAME,
2832 &gEfiGlobalVariableGuid,
2833 LABEL_KEK_DELETE,
2834 FORMID_DELETE_KEK_FORM,
2835 OPTION_DEL_KEK_QUESTION_ID
2836 );
2837 }
2838
2839 /**
2840 Delete a signature entry from signature database.
2841
2842 @param[in] PrivateData Module's private data.
2843 @param[in] VariableName The variable name of the vendor's signature database.
2844 @param[in] VendorGuid A unique identifier for the vendor.
2845 @param[in] LabelNumber Label number to insert opcodes.
2846 @param[in] FormId Form ID of current page.
2847 @param[in] QuestionIdBase Base question id of the signature list.
2848 @param[in] DeleteIndex Signature index to delete.
2849
2850 @retval EFI_SUCCESS Delete signature successfully.
2851 @retval EFI_NOT_FOUND Can't find the signature item,
2852 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
2853 **/
2854 EFI_STATUS
2855 DeleteSignature (
2856 IN SECUREBOOT_CONFIG_PRIVATE_DATA *PrivateData,
2857 IN CHAR16 *VariableName,
2858 IN EFI_GUID *VendorGuid,
2859 IN UINT16 LabelNumber,
2860 IN EFI_FORM_ID FormId,
2861 IN EFI_QUESTION_ID QuestionIdBase,
2862 IN UINTN DeleteIndex
2863 )
2864 {
2865 EFI_STATUS Status;
2866 UINTN DataSize;
2867 UINT8 *Data;
2868 UINT8 *OldData;
2869 UINT32 Attr;
2870 UINT32 Index;
2871 EFI_SIGNATURE_LIST *CertList;
2872 EFI_SIGNATURE_LIST *NewCertList;
2873 EFI_SIGNATURE_DATA *Cert;
2874 UINTN CertCount;
2875 UINT32 Offset;
2876 BOOLEAN IsItemFound;
2877 UINT32 ItemDataSize;
2878 UINTN GuidIndex;
2879
2880 Data = NULL;
2881 OldData = NULL;
2882 CertList = NULL;
2883 Cert = NULL;
2884 Attr = 0;
2885
2886 Status = SetSecureBootMode(CUSTOM_SECURE_BOOT_MODE);
2887 if (EFI_ERROR (Status)) {
2888 return Status;
2889 }
2890
2891 //
2892 // Get original signature list data.
2893 //
2894 DataSize = 0;
2895 Status = gRT->GetVariable (VariableName, VendorGuid, NULL, &DataSize, NULL);
2896 if (EFI_ERROR (Status) && Status != EFI_BUFFER_TOO_SMALL) {
2897 goto ON_EXIT;
2898 }
2899
2900 OldData = (UINT8 *) AllocateZeroPool (DataSize);
2901 if (OldData == NULL) {
2902 Status = EFI_OUT_OF_RESOURCES;
2903 goto ON_EXIT;
2904 }
2905
2906 Status = gRT->GetVariable (VariableName, VendorGuid, &Attr, &DataSize, OldData);
2907 if (EFI_ERROR(Status)) {
2908 goto ON_EXIT;
2909 }
2910
2911 //
2912 // Allocate space for new variable.
2913 //
2914 Data = (UINT8*) AllocateZeroPool (DataSize);
2915 if (Data == NULL) {
2916 Status = EFI_OUT_OF_RESOURCES;
2917 goto ON_EXIT;
2918 }
2919
2920 //
2921 // Enumerate all signature data and erasing the target item.
2922 //
2923 IsItemFound = FALSE;
2924 ItemDataSize = (UINT32) DataSize;
2925 CertList = (EFI_SIGNATURE_LIST *) OldData;
2926 Offset = 0;
2927 GuidIndex = 0;
2928 while ((ItemDataSize > 0) && (ItemDataSize >= CertList->SignatureListSize)) {
2929 if (CompareGuid (&CertList->SignatureType, &gEfiCertRsa2048Guid) ||
2930 CompareGuid (&CertList->SignatureType, &gEfiCertX509Guid) ||
2931 CompareGuid (&CertList->SignatureType, &gEfiCertSha1Guid) ||
2932 CompareGuid (&CertList->SignatureType, &gEfiCertSha256Guid) ||
2933 CompareGuid (&CertList->SignatureType, &gEfiCertX509Sha256Guid) ||
2934 CompareGuid (&CertList->SignatureType, &gEfiCertX509Sha384Guid) ||
2935 CompareGuid (&CertList->SignatureType, &gEfiCertX509Sha512Guid)
2936 ) {
2937 //
2938 // Copy EFI_SIGNATURE_LIST header then calculate the signature count in this list.
2939 //
2940 CopyMem (Data + Offset, CertList, (sizeof(EFI_SIGNATURE_LIST) + CertList->SignatureHeaderSize));
2941 NewCertList = (EFI_SIGNATURE_LIST*) (Data + Offset);
2942 Offset += (sizeof(EFI_SIGNATURE_LIST) + CertList->SignatureHeaderSize);
2943 Cert = (EFI_SIGNATURE_DATA *) ((UINT8 *) CertList + sizeof (EFI_SIGNATURE_LIST) + CertList->SignatureHeaderSize);
2944 CertCount = (CertList->SignatureListSize - sizeof (EFI_SIGNATURE_LIST) - CertList->SignatureHeaderSize) / CertList->SignatureSize;
2945 for (Index = 0; Index < CertCount; Index++) {
2946 if (GuidIndex == DeleteIndex) {
2947 //
2948 // Find it! Skip it!
2949 //
2950 NewCertList->SignatureListSize -= CertList->SignatureSize;
2951 IsItemFound = TRUE;
2952 } else {
2953 //
2954 // This item doesn't match. Copy it to the Data buffer.
2955 //
2956 CopyMem (Data + Offset, (UINT8*)(Cert), CertList->SignatureSize);
2957 Offset += CertList->SignatureSize;
2958 }
2959 GuidIndex++;
2960 Cert = (EFI_SIGNATURE_DATA *) ((UINT8 *) Cert + CertList->SignatureSize);
2961 }
2962 } else {
2963 //
2964 // This List doesn't match. Just copy it to the Data buffer.
2965 //
2966 CopyMem (Data + Offset, (UINT8*)(CertList), CertList->SignatureListSize);
2967 Offset += CertList->SignatureListSize;
2968 }
2969
2970 ItemDataSize -= CertList->SignatureListSize;
2971 CertList = (EFI_SIGNATURE_LIST *) ((UINT8 *) CertList + CertList->SignatureListSize);
2972 }
2973
2974 if (!IsItemFound) {
2975 //
2976 // Doesn't find the signature Item!
2977 //
2978 Status = EFI_NOT_FOUND;
2979 goto ON_EXIT;
2980 }
2981
2982 //
2983 // Delete the EFI_SIGNATURE_LIST header if there is no signature in the list.
2984 //
2985 ItemDataSize = Offset;
2986 CertList = (EFI_SIGNATURE_LIST *) Data;
2987 Offset = 0;
2988 ZeroMem (OldData, ItemDataSize);
2989 while ((ItemDataSize > 0) && (ItemDataSize >= CertList->SignatureListSize)) {
2990 CertCount = (CertList->SignatureListSize - sizeof (EFI_SIGNATURE_LIST) - CertList->SignatureHeaderSize) / CertList->SignatureSize;
2991 DEBUG ((DEBUG_INFO, " CertCount = %x\n", CertCount));
2992 if (CertCount != 0) {
2993 CopyMem (OldData + Offset, (UINT8*)(CertList), CertList->SignatureListSize);
2994 Offset += CertList->SignatureListSize;
2995 }
2996 ItemDataSize -= CertList->SignatureListSize;
2997 CertList = (EFI_SIGNATURE_LIST *) ((UINT8 *) CertList + CertList->SignatureListSize);
2998 }
2999
3000 DataSize = Offset;
3001 if ((Attr & EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS) != 0) {
3002 Status = CreateTimeBasedPayload (&DataSize, &OldData);
3003 if (EFI_ERROR (Status)) {
3004 DEBUG ((EFI_D_ERROR, "Fail to create time-based data payload: %r", Status));
3005 goto ON_EXIT;
3006 }
3007 }
3008
3009 Status = gRT->SetVariable(
3010 VariableName,
3011 VendorGuid,
3012 Attr,
3013 DataSize,
3014 OldData
3015 );
3016 if (EFI_ERROR (Status)) {
3017 DEBUG ((DEBUG_ERROR, "Failed to set variable, Status = %r\n", Status));
3018 goto ON_EXIT;
3019 }
3020
3021 ON_EXIT:
3022 if (Data != NULL) {
3023 FreePool(Data);
3024 }
3025
3026 if (OldData != NULL) {
3027 FreePool(OldData);
3028 }
3029
3030 return UpdateDeletePage (
3031 PrivateData,
3032 VariableName,
3033 VendorGuid,
3034 LabelNumber,
3035 FormId,
3036 QuestionIdBase
3037 );
3038 }
3039
3040 /**
3041 This function to delete signature list or data, according by DelType.
3042
3043 @param[in] PrivateData Module's private data.
3044 @param[in] DelType Indicate delete signature list or data.
3045 @param[in] CheckedCount Indicate how many signature data have
3046 been checked in current signature list.
3047
3048 @retval EFI_SUCCESS Success to update the signature list page
3049 @retval EFI_OUT_OF_RESOURCES Unable to allocate required resources.
3050 **/
3051 EFI_STATUS
3052 DeleteSignatureEx (
3053 IN SECUREBOOT_CONFIG_PRIVATE_DATA *PrivateData,
3054 IN SIGNATURE_DELETE_TYPE DelType,
3055 IN UINT32 CheckedCount
3056 )
3057 {
3058 EFI_STATUS Status;
3059 EFI_SIGNATURE_LIST *ListWalker;
3060 EFI_SIGNATURE_LIST *NewCertList;
3061 EFI_SIGNATURE_DATA *DataWalker;
3062 CHAR16 VariableName[BUFFER_MAX_SIZE];
3063 UINT32 VariableAttr;
3064 UINTN VariableDataSize;
3065 UINTN RemainingSize;
3066 UINTN ListIndex;
3067 UINTN Index;
3068 UINTN Offset;
3069 UINT8 *VariableData;
3070 UINT8 *NewVariableData;
3071
3072 Status = EFI_SUCCESS;
3073 VariableAttr = 0;
3074 VariableDataSize = 0;
3075 ListIndex = 0;
3076 Offset = 0;
3077 VariableData = NULL;
3078 NewVariableData = NULL;
3079
3080 if (PrivateData->VariableName == Variable_DB) {
3081 UnicodeSPrint (VariableName, sizeof (VariableName), EFI_IMAGE_SECURITY_DATABASE);
3082 } else if (PrivateData->VariableName == Variable_DBX) {
3083 UnicodeSPrint (VariableName, sizeof (VariableName), EFI_IMAGE_SECURITY_DATABASE1);
3084 } else if (PrivateData->VariableName == Variable_DBT) {
3085 UnicodeSPrint (VariableName, sizeof (VariableName), EFI_IMAGE_SECURITY_DATABASE2);
3086 } else {
3087 goto ON_EXIT;
3088 }
3089
3090 Status = gRT->GetVariable (
3091 VariableName,
3092 &gEfiImageSecurityDatabaseGuid,
3093 &VariableAttr,
3094 &VariableDataSize,
3095 VariableData
3096 );
3097 if (EFI_ERROR (Status) && Status != EFI_BUFFER_TOO_SMALL) {
3098 goto ON_EXIT;
3099 }
3100
3101 VariableData = AllocateZeroPool (VariableDataSize);
3102 if (VariableData == NULL) {
3103 Status = EFI_OUT_OF_RESOURCES;
3104 goto ON_EXIT;
3105 }
3106
3107 Status = gRT->GetVariable (
3108 VariableName,
3109 &gEfiImageSecurityDatabaseGuid,
3110 &VariableAttr,
3111 &VariableDataSize,
3112 VariableData
3113 );
3114 if (EFI_ERROR (Status)) {
3115 goto ON_EXIT;
3116 }
3117
3118 Status = SetSecureBootMode (CUSTOM_SECURE_BOOT_MODE);
3119 if (EFI_ERROR (Status)) {
3120 goto ON_EXIT;
3121 }
3122
3123 NewVariableData = AllocateZeroPool (VariableDataSize);
3124 if (NewVariableData == NULL) {
3125 Status = EFI_OUT_OF_RESOURCES;
3126 goto ON_EXIT;
3127 }
3128
3129 RemainingSize = VariableDataSize;
3130 ListWalker = (EFI_SIGNATURE_LIST *)(VariableData);
3131 if (DelType == Delete_Signature_List_All) {
3132 VariableDataSize = 0;
3133 } else {
3134 //
3135 // Traverse to target EFI_SIGNATURE_LIST but others will be skipped.
3136 //
3137 while ((RemainingSize > 0) && (RemainingSize >= ListWalker->SignatureListSize) && ListIndex < PrivateData->ListIndex) {
3138 CopyMem ((UINT8 *)NewVariableData + Offset, ListWalker, ListWalker->SignatureListSize);
3139 Offset += ListWalker->SignatureListSize;
3140
3141 RemainingSize -= ListWalker->SignatureListSize;
3142 ListWalker = (EFI_SIGNATURE_LIST *)((UINT8 *)ListWalker + ListWalker->SignatureListSize);
3143 ListIndex++;
3144 }
3145
3146 //
3147 // Handle the target EFI_SIGNATURE_LIST.
3148 // If CheckedCount == SIGNATURE_DATA_COUNTS (ListWalker) or DelType == Delete_Signature_List_One
3149 // it means delete the whole EFI_SIGNATURE_LIST, So we just skip this EFI_SIGNATURE_LIST.
3150 //
3151 if (CheckedCount < SIGNATURE_DATA_COUNTS (ListWalker) && DelType == Delete_Signature_Data) {
3152 NewCertList = (EFI_SIGNATURE_LIST *)(NewVariableData + Offset);
3153 //
3154 // Copy header.
3155 //
3156 CopyMem ((UINT8 *)NewVariableData + Offset, ListWalker, sizeof (EFI_SIGNATURE_LIST) + ListWalker->SignatureHeaderSize);
3157 Offset += sizeof (EFI_SIGNATURE_LIST) + ListWalker->SignatureHeaderSize;
3158
3159 DataWalker = (EFI_SIGNATURE_DATA *)((UINT8 *)ListWalker + sizeof(EFI_SIGNATURE_LIST) + ListWalker->SignatureHeaderSize);
3160 for (Index = 0; Index < SIGNATURE_DATA_COUNTS(ListWalker); Index = Index + 1) {
3161 if (PrivateData->CheckArray[Index]) {
3162 //
3163 // Delete checked signature data, and update the size of whole signature list.
3164 //
3165 NewCertList->SignatureListSize -= NewCertList->SignatureSize;
3166 } else {
3167 //
3168 // Remain the unchecked signature data.
3169 //
3170 CopyMem ((UINT8 *)NewVariableData + Offset, DataWalker, ListWalker->SignatureSize);
3171 Offset += ListWalker->SignatureSize;
3172 }
3173 DataWalker = (EFI_SIGNATURE_DATA *)((UINT8 *)DataWalker + ListWalker->SignatureSize);
3174 }
3175 }
3176
3177 RemainingSize -= ListWalker->SignatureListSize;
3178 ListWalker = (EFI_SIGNATURE_LIST *)((UINT8 *)ListWalker + ListWalker->SignatureListSize);
3179
3180 //
3181 // Copy remaining data, maybe 0.
3182 //
3183 CopyMem((UINT8 *)NewVariableData + Offset, ListWalker, RemainingSize);
3184 Offset += RemainingSize;
3185
3186 VariableDataSize = Offset;
3187 }
3188
3189 if ((VariableAttr & EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS) != 0) {
3190 Status = CreateTimeBasedPayload (&VariableDataSize, &NewVariableData);
3191 if (EFI_ERROR (Status)) {
3192 DEBUG ((DEBUG_ERROR, "Fail to create time-based data payload: %r", Status));
3193 goto ON_EXIT;
3194 }
3195 }
3196
3197 Status = gRT->SetVariable (
3198 VariableName,
3199 &gEfiImageSecurityDatabaseGuid,
3200 VariableAttr,
3201 VariableDataSize,
3202 NewVariableData
3203 );
3204 if (EFI_ERROR (Status)) {
3205 DEBUG ((DEBUG_ERROR, "Failed to set variable, Status = %r", Status));
3206 goto ON_EXIT;
3207 }
3208
3209 ON_EXIT:
3210 SECUREBOOT_FREE_NON_NULL (VariableData);
3211 SECUREBOOT_FREE_NON_NULL (NewVariableData);
3212
3213 return Status;
3214 }
3215
3216 /**
3217
3218 Update SecureBoot strings based on new Secure Boot Mode State. String includes STR_SECURE_BOOT_STATE_CONTENT
3219 and STR_CUR_SECURE_BOOT_MODE_CONTENT.
3220
3221 @param[in] PrivateData Module's private data.
3222
3223 @return EFI_SUCCESS Update secure boot strings successfully.
3224 @return other Fail to update secure boot strings.
3225
3226 **/
3227 EFI_STATUS
3228 UpdateSecureBootString(
3229 IN SECUREBOOT_CONFIG_PRIVATE_DATA *Private
3230 )
3231 {
3232 UINT8 *SecureBoot;
3233
3234 SecureBoot = NULL;
3235
3236 //
3237 // Get current secure boot state.
3238 //
3239 GetVariable2 (EFI_SECURE_BOOT_MODE_NAME, &gEfiGlobalVariableGuid, (VOID**)&SecureBoot, NULL);
3240 if (SecureBoot == NULL) {
3241 return EFI_NOT_FOUND;
3242 }
3243
3244 if (*SecureBoot == SECURE_BOOT_MODE_ENABLE) {
3245 HiiSetString (Private->HiiHandle, STRING_TOKEN (STR_SECURE_BOOT_STATE_CONTENT), L"Enabled", NULL);
3246 } else {
3247 HiiSetString (Private->HiiHandle, STRING_TOKEN (STR_SECURE_BOOT_STATE_CONTENT), L"Disabled", NULL);
3248 }
3249
3250 FreePool(SecureBoot);
3251
3252 return EFI_SUCCESS;
3253 }
3254
3255 /**
3256 This function extracts configuration from variable.
3257
3258 @param[in] Private Point to SecureBoot configuration driver private data.
3259 @param[in, out] ConfigData Point to SecureBoot configuration private data.
3260
3261 **/
3262 VOID
3263 SecureBootExtractConfigFromVariable (
3264 IN SECUREBOOT_CONFIG_PRIVATE_DATA *Private,
3265 IN OUT SECUREBOOT_CONFIGURATION *ConfigData
3266 )
3267 {
3268 UINT8 *SecureBootEnable;
3269 UINT8 *SetupMode;
3270 UINT8 *SecureBootMode;
3271 EFI_TIME CurrTime;
3272
3273 SecureBootEnable = NULL;
3274 SetupMode = NULL;
3275 SecureBootMode = NULL;
3276
3277 //
3278 // Initilize the Date and Time using system time.
3279 //
3280 ConfigData->CertificateFormat = HASHALG_RAW;
3281 ConfigData->AlwaysRevocation = TRUE;
3282 gRT->GetTime (&CurrTime, NULL);
3283 ConfigData->RevocationDate.Year = CurrTime.Year;
3284 ConfigData->RevocationDate.Month = CurrTime.Month;
3285 ConfigData->RevocationDate.Day = CurrTime.Day;
3286 ConfigData->RevocationTime.Hour = CurrTime.Hour;
3287 ConfigData->RevocationTime.Minute = CurrTime.Minute;
3288 ConfigData->RevocationTime.Second = 0;
3289 if (Private->FileContext->FHandle != NULL) {
3290 ConfigData->FileEnrollType = Private->FileContext->FileType;
3291 } else {
3292 ConfigData->FileEnrollType = UNKNOWN_FILE_TYPE;
3293 }
3294
3295 //
3296 // If it is Physical Presence User, set the PhysicalPresent to true.
3297 //
3298 if (UserPhysicalPresent()) {
3299 ConfigData->PhysicalPresent = TRUE;
3300 } else {
3301 ConfigData->PhysicalPresent = FALSE;
3302 }
3303
3304 //
3305 // If there is no PK then the Delete Pk button will be gray.
3306 //
3307 GetVariable2 (EFI_SETUP_MODE_NAME, &gEfiGlobalVariableGuid, (VOID**)&SetupMode, NULL);
3308 if (SetupMode == NULL || (*SetupMode) == SETUP_MODE) {
3309 ConfigData->HasPk = FALSE;
3310 } else {
3311 ConfigData->HasPk = TRUE;
3312 }
3313
3314 //
3315 // Check SecureBootEnable & Pk status, fix the inconsistence.
3316 // If the SecureBootEnable Variable doesn't exist, hide the SecureBoot Enable/Disable
3317 // Checkbox.
3318 //
3319 ConfigData->AttemptSecureBoot = FALSE;
3320 GetVariable2 (EFI_SECURE_BOOT_ENABLE_NAME, &gEfiSecureBootEnableDisableGuid, (VOID**)&SecureBootEnable, NULL);
3321
3322 //
3323 // Fix Pk, SecureBootEnable inconsistence
3324 //
3325 if ((SetupMode != NULL) && (*SetupMode) == USER_MODE) {
3326 ConfigData->HideSecureBoot = FALSE;
3327 if ((SecureBootEnable != NULL) && (*SecureBootEnable == SECURE_BOOT_ENABLE)) {
3328 ConfigData->AttemptSecureBoot = TRUE;
3329 }
3330 } else {
3331 ConfigData->HideSecureBoot = TRUE;
3332 }
3333
3334 //
3335 // Get the SecureBootMode from CustomMode variable.
3336 //
3337 GetVariable2 (EFI_CUSTOM_MODE_NAME, &gEfiCustomModeEnableGuid, (VOID**)&SecureBootMode, NULL);
3338 if (SecureBootMode == NULL) {
3339 ConfigData->SecureBootMode = STANDARD_SECURE_BOOT_MODE;
3340 } else {
3341 ConfigData->SecureBootMode = *(SecureBootMode);
3342 }
3343
3344 if (SecureBootEnable != NULL) {
3345 FreePool (SecureBootEnable);
3346 }
3347 if (SetupMode != NULL) {
3348 FreePool (SetupMode);
3349 }
3350 if (SecureBootMode != NULL) {
3351 FreePool (SecureBootMode);
3352 }
3353 }
3354
3355 /**
3356 This function allows a caller to extract the current configuration for one
3357 or more named elements from the target driver.
3358
3359 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
3360 @param[in] Request A null-terminated Unicode string in
3361 <ConfigRequest> format.
3362 @param[out] Progress On return, points to a character in the Request
3363 string. Points to the string's null terminator if
3364 request was successful. Points to the most recent
3365 '&' before the first failing name/value pair (or
3366 the beginning of the string if the failure is in
3367 the first name/value pair) if the request was not
3368 successful.
3369 @param[out] Results A null-terminated Unicode string in
3370 <ConfigAltResp> format which has all values filled
3371 in for the names in the Request string. String to
3372 be allocated by the called function.
3373
3374 @retval EFI_SUCCESS The Results is filled with the requested values.
3375 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
3376 @retval EFI_INVALID_PARAMETER Request is illegal syntax, or unknown name.
3377 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
3378 driver.
3379
3380 **/
3381 EFI_STATUS
3382 EFIAPI
3383 SecureBootExtractConfig (
3384 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
3385 IN CONST EFI_STRING Request,
3386 OUT EFI_STRING *Progress,
3387 OUT EFI_STRING *Results
3388 )
3389 {
3390 EFI_STATUS Status;
3391 UINTN BufferSize;
3392 UINTN Size;
3393 SECUREBOOT_CONFIGURATION Configuration;
3394 EFI_STRING ConfigRequest;
3395 EFI_STRING ConfigRequestHdr;
3396 SECUREBOOT_CONFIG_PRIVATE_DATA *PrivateData;
3397 BOOLEAN AllocatedRequest;
3398
3399 if (Progress == NULL || Results == NULL) {
3400 return EFI_INVALID_PARAMETER;
3401 }
3402
3403 AllocatedRequest = FALSE;
3404 ConfigRequestHdr = NULL;
3405 ConfigRequest = NULL;
3406 Size = 0;
3407
3408 ZeroMem (&Configuration, sizeof (Configuration));
3409 PrivateData = SECUREBOOT_CONFIG_PRIVATE_FROM_THIS (This);
3410 *Progress = Request;
3411
3412 if ((Request != NULL) && !HiiIsConfigHdrMatch (Request, &gSecureBootConfigFormSetGuid, mSecureBootStorageName)) {
3413 return EFI_NOT_FOUND;
3414 }
3415
3416 ZeroMem(&Configuration, sizeof(SECUREBOOT_CONFIGURATION));
3417
3418 //
3419 // Get Configuration from Variable.
3420 //
3421 SecureBootExtractConfigFromVariable (PrivateData, &Configuration);
3422
3423 BufferSize = sizeof (SECUREBOOT_CONFIGURATION);
3424 ConfigRequest = Request;
3425 if ((Request == NULL) || (StrStr (Request, L"OFFSET") == NULL)) {
3426 //
3427 // Request is set to NULL or OFFSET is NULL, construct full request string.
3428 //
3429 // Allocate and fill a buffer large enough to hold the <ConfigHdr> template
3430 // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator
3431 //
3432 ConfigRequestHdr = HiiConstructConfigHdr (&gSecureBootConfigFormSetGuid, mSecureBootStorageName, PrivateData->DriverHandle);
3433 Size = (StrLen (ConfigRequestHdr) + 32 + 1) * sizeof (CHAR16);
3434 ConfigRequest = AllocateZeroPool (Size);
3435 ASSERT (ConfigRequest != NULL);
3436 AllocatedRequest = TRUE;
3437 UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr, (UINT64)BufferSize);
3438 FreePool (ConfigRequestHdr);
3439 ConfigRequestHdr = NULL;
3440 }
3441
3442 Status = gHiiConfigRouting->BlockToConfig (
3443 gHiiConfigRouting,
3444 ConfigRequest,
3445 (UINT8 *) &Configuration,
3446 BufferSize,
3447 Results,
3448 Progress
3449 );
3450
3451 //
3452 // Free the allocated config request string.
3453 //
3454 if (AllocatedRequest) {
3455 FreePool (ConfigRequest);
3456 }
3457
3458 //
3459 // Set Progress string to the original request string.
3460 //
3461 if (Request == NULL) {
3462 *Progress = NULL;
3463 } else if (StrStr (Request, L"OFFSET") == NULL) {
3464 *Progress = Request + StrLen (Request);
3465 }
3466
3467 return Status;
3468 }
3469
3470 /**
3471 This function processes the results of changes in configuration.
3472
3473 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
3474 @param[in] Configuration A null-terminated Unicode string in <ConfigResp>
3475 format.
3476 @param[out] Progress A pointer to a string filled in with the offset of
3477 the most recent '&' before the first failing
3478 name/value pair (or the beginning of the string if
3479 the failure is in the first name/value pair) or
3480 the terminating NULL if all was successful.
3481
3482 @retval EFI_SUCCESS The Results is processed successfully.
3483 @retval EFI_INVALID_PARAMETER Configuration is NULL.
3484 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
3485 driver.
3486
3487 **/
3488 EFI_STATUS
3489 EFIAPI
3490 SecureBootRouteConfig (
3491 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
3492 IN CONST EFI_STRING Configuration,
3493 OUT EFI_STRING *Progress
3494 )
3495 {
3496 SECUREBOOT_CONFIGURATION IfrNvData;
3497 UINTN BufferSize;
3498 SECUREBOOT_CONFIG_PRIVATE_DATA *PrivateData;
3499 EFI_STATUS Status;
3500
3501 if (Configuration == NULL || Progress == NULL) {
3502 return EFI_INVALID_PARAMETER;
3503 }
3504
3505 *Progress = Configuration;
3506 if (!HiiIsConfigHdrMatch (Configuration, &gSecureBootConfigFormSetGuid, mSecureBootStorageName)) {
3507 return EFI_NOT_FOUND;
3508 }
3509
3510 PrivateData = SECUREBOOT_CONFIG_PRIVATE_FROM_THIS (This);
3511
3512 //
3513 // Get Configuration from Variable.
3514 //
3515 SecureBootExtractConfigFromVariable (PrivateData, &IfrNvData);
3516
3517 //
3518 // Map the Configuration to the configuration block.
3519 //
3520 BufferSize = sizeof (SECUREBOOT_CONFIGURATION);
3521 Status = gHiiConfigRouting->ConfigToBlock (
3522 gHiiConfigRouting,
3523 Configuration,
3524 (UINT8 *)&IfrNvData,
3525 &BufferSize,
3526 Progress
3527 );
3528 if (EFI_ERROR (Status)) {
3529 return Status;
3530 }
3531
3532 //
3533 // Store Buffer Storage back to EFI variable if needed
3534 //
3535 if (!IfrNvData.HideSecureBoot) {
3536 Status = SaveSecureBootVariable (IfrNvData.AttemptSecureBoot);
3537 if (EFI_ERROR (Status)) {
3538 return Status;
3539 }
3540 }
3541
3542 *Progress = Configuration + StrLen (Configuration);
3543 return EFI_SUCCESS;
3544 }
3545
3546 /**
3547 This function to load signature list, the update the menu page.
3548
3549 @param[in] PrivateData Module's private data.
3550 @param[in] LabelId Label number to insert opcodes.
3551 @param[in] FormId Form ID of current page.
3552 @param[in] QuestionIdBase Base question id of the signature list.
3553
3554 @retval EFI_SUCCESS Success to update the signature list page
3555 @retval EFI_OUT_OF_RESOURCES Unable to allocate required resources.
3556 **/
3557 EFI_STATUS
3558 LoadSignatureList (
3559 IN SECUREBOOT_CONFIG_PRIVATE_DATA *PrivateData,
3560 IN UINT16 LabelId,
3561 IN EFI_FORM_ID FormId,
3562 IN EFI_QUESTION_ID QuestionIdBase
3563 )
3564 {
3565 EFI_STATUS Status;
3566 EFI_STRING_ID ListType;
3567 EFI_STRING FormatNameString;
3568 EFI_STRING FormatHelpString;
3569 EFI_STRING FormatTypeString;
3570 EFI_SIGNATURE_LIST *ListWalker;
3571 EFI_IFR_GUID_LABEL *StartLabel;
3572 EFI_IFR_GUID_LABEL *EndLabel;
3573 EFI_IFR_GUID_LABEL *StartGoto;
3574 EFI_IFR_GUID_LABEL *EndGoto;
3575 EFI_FORM_ID DstFormId;
3576 VOID *StartOpCodeHandle;
3577 VOID *EndOpCodeHandle;
3578 VOID *StartGotoHandle;
3579 VOID *EndGotoHandle;
3580 UINTN DataSize;
3581 UINTN RemainingSize;
3582 UINT16 Index;
3583 UINT8 *VariableData;
3584 CHAR16 VariableName[BUFFER_MAX_SIZE];
3585 CHAR16 NameBuffer[BUFFER_MAX_SIZE];
3586 CHAR16 HelpBuffer[BUFFER_MAX_SIZE];
3587
3588 Status = EFI_SUCCESS;
3589 FormatNameString = NULL;
3590 FormatHelpString = NULL;
3591 StartOpCodeHandle = NULL;
3592 EndOpCodeHandle = NULL;
3593 StartGotoHandle = NULL;
3594 EndGotoHandle = NULL;
3595 Index = 0;
3596 VariableData = NULL;
3597
3598 //
3599 // Initialize the container for dynamic opcodes.
3600 //
3601 StartOpCodeHandle = HiiAllocateOpCodeHandle ();
3602 if (StartOpCodeHandle == NULL) {
3603 Status = EFI_OUT_OF_RESOURCES;
3604 goto ON_EXIT;
3605 }
3606
3607 EndOpCodeHandle = HiiAllocateOpCodeHandle ();
3608 if (EndOpCodeHandle == NULL) {
3609 Status = EFI_OUT_OF_RESOURCES;
3610 goto ON_EXIT;
3611 }
3612
3613 StartGotoHandle = HiiAllocateOpCodeHandle ();
3614 if (StartGotoHandle == NULL) {
3615 Status = EFI_OUT_OF_RESOURCES;
3616 goto ON_EXIT;
3617 }
3618
3619 EndGotoHandle = HiiAllocateOpCodeHandle ();
3620 if (EndGotoHandle == NULL) {
3621 Status = EFI_OUT_OF_RESOURCES;
3622 goto ON_EXIT;
3623 }
3624
3625 //
3626 // Create Hii Extend Label OpCode.
3627 //
3628 StartLabel = (EFI_IFR_GUID_LABEL *)HiiCreateGuidOpCode (
3629 StartOpCodeHandle,
3630 &gEfiIfrTianoGuid,
3631 NULL,
3632 sizeof (EFI_IFR_GUID_LABEL)
3633 );
3634 StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
3635 StartLabel->Number = LabelId;
3636
3637 EndLabel = (EFI_IFR_GUID_LABEL *)HiiCreateGuidOpCode (
3638 EndOpCodeHandle,
3639 &gEfiIfrTianoGuid,
3640 NULL,
3641 sizeof (EFI_IFR_GUID_LABEL)
3642 );
3643 EndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
3644 EndLabel->Number = LABEL_END;
3645
3646 StartGoto = (EFI_IFR_GUID_LABEL *)HiiCreateGuidOpCode(
3647 StartGotoHandle,
3648 &gEfiIfrTianoGuid,
3649 NULL,
3650 sizeof(EFI_IFR_GUID_LABEL)
3651 );
3652 StartGoto->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
3653 StartGoto->Number = LABEL_DELETE_ALL_LIST_BUTTON;
3654
3655 EndGoto = (EFI_IFR_GUID_LABEL *)HiiCreateGuidOpCode(
3656 EndGotoHandle,
3657 &gEfiIfrTianoGuid,
3658 NULL,
3659 sizeof(EFI_IFR_GUID_LABEL)
3660 );
3661 EndGoto->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
3662 EndGoto->Number = LABEL_END;
3663
3664 if (PrivateData->VariableName == Variable_DB) {
3665 UnicodeSPrint (VariableName, sizeof (VariableName), EFI_IMAGE_SECURITY_DATABASE);
3666 DstFormId = FORMID_SECURE_BOOT_DB_OPTION_FORM;
3667 } else if (PrivateData->VariableName == Variable_DBX) {
3668 UnicodeSPrint (VariableName, sizeof (VariableName), EFI_IMAGE_SECURITY_DATABASE1);
3669 DstFormId = FORMID_SECURE_BOOT_DBX_OPTION_FORM;
3670 } else if (PrivateData->VariableName == Variable_DBT) {
3671 UnicodeSPrint (VariableName, sizeof (VariableName), EFI_IMAGE_SECURITY_DATABASE2);
3672 DstFormId = FORMID_SECURE_BOOT_DBT_OPTION_FORM;
3673 } else {
3674 goto ON_EXIT;
3675 }
3676
3677 HiiCreateGotoOpCode (
3678 StartGotoHandle,
3679 DstFormId,
3680 STRING_TOKEN (STR_SECURE_BOOT_DELETE_ALL_LIST),
3681 STRING_TOKEN (STR_SECURE_BOOT_DELETE_ALL_LIST),
3682 EFI_IFR_FLAG_CALLBACK,
3683 KEY_SECURE_BOOT_DELETE_ALL_LIST
3684 );
3685
3686 //
3687 // Read Variable, the variable name save in the PrivateData->VariableName.
3688 //
3689 DataSize = 0;
3690 Status = gRT->GetVariable (VariableName, &gEfiImageSecurityDatabaseGuid, NULL, &DataSize, VariableData);
3691 if (EFI_ERROR (Status) && Status != EFI_BUFFER_TOO_SMALL) {
3692 goto ON_EXIT;
3693 }
3694
3695 VariableData = AllocateZeroPool (DataSize);
3696 if (VariableData == NULL) {
3697 Status = EFI_OUT_OF_RESOURCES;
3698 goto ON_EXIT;
3699 }
3700 Status = gRT->GetVariable (VariableName, &gEfiImageSecurityDatabaseGuid, NULL, &DataSize, VariableData);
3701 if (EFI_ERROR (Status)) {
3702 goto ON_EXIT;
3703 }
3704
3705 FormatNameString = HiiGetString (PrivateData->HiiHandle, STRING_TOKEN (STR_SIGNATURE_LIST_NAME_FORMAT), NULL);
3706 FormatHelpString = HiiGetString (PrivateData->HiiHandle, STRING_TOKEN (STR_SIGNATURE_LIST_HELP_FORMAT), NULL);
3707 if (FormatNameString == NULL || FormatHelpString == NULL) {
3708 goto ON_EXIT;
3709 }
3710
3711 RemainingSize = DataSize;
3712 ListWalker = (EFI_SIGNATURE_LIST *)VariableData;
3713 while ((RemainingSize > 0) && (RemainingSize >= ListWalker->SignatureListSize)) {
3714 if (CompareGuid (&ListWalker->SignatureType, &gEfiCertRsa2048Guid)) {
3715 ListType = STRING_TOKEN (STR_LIST_TYPE_RSA2048_SHA256);
3716 } else if (CompareGuid (&ListWalker->SignatureType, &gEfiCertX509Guid)) {
3717 ListType = STRING_TOKEN (STR_LIST_TYPE_X509);
3718 } else if (CompareGuid (&ListWalker->SignatureType, &gEfiCertSha1Guid)) {
3719 ListType = STRING_TOKEN (STR_LIST_TYPE_SHA1);
3720 } else if (CompareGuid (&ListWalker->SignatureType, &gEfiCertSha256Guid)) {
3721 ListType = STRING_TOKEN (STR_LIST_TYPE_SHA256);
3722 } else if (CompareGuid (&ListWalker->SignatureType, &gEfiCertX509Sha256Guid)) {
3723 ListType = STRING_TOKEN (STR_LIST_TYPE_X509_SHA256);
3724 } else if (CompareGuid (&ListWalker->SignatureType, &gEfiCertX509Sha384Guid)) {
3725 ListType = STRING_TOKEN (STR_LIST_TYPE_X509_SHA384);
3726 } else if (CompareGuid (&ListWalker->SignatureType, &gEfiCertX509Sha512Guid)) {
3727 ListType = STRING_TOKEN (STR_LIST_TYPE_X509_SHA512);
3728 } else {
3729 ListType = STRING_TOKEN (STR_LIST_TYPE_UNKNOWN);
3730 }
3731 FormatTypeString = HiiGetString (PrivateData->HiiHandle, ListType, NULL);
3732 if (FormatTypeString == NULL) {
3733 goto ON_EXIT;
3734 }
3735
3736 ZeroMem (NameBuffer, sizeof (NameBuffer));
3737 UnicodeSPrint (NameBuffer, sizeof (NameBuffer), FormatNameString, Index + 1);
3738
3739 ZeroMem (HelpBuffer, sizeof (HelpBuffer));
3740 UnicodeSPrint (HelpBuffer,
3741 sizeof (HelpBuffer),
3742 FormatHelpString,
3743 FormatTypeString,
3744 SIGNATURE_DATA_COUNTS (ListWalker)
3745 );
3746 SECUREBOOT_FREE_NON_NULL (FormatTypeString);
3747 FormatTypeString = NULL;
3748
3749 HiiCreateGotoOpCode (
3750 StartOpCodeHandle,
3751 SECUREBOOT_DELETE_SIGNATURE_DATA_FORM,
3752 HiiSetString (PrivateData->HiiHandle, 0, NameBuffer, NULL),
3753 HiiSetString (PrivateData->HiiHandle, 0, HelpBuffer, NULL),
3754 EFI_IFR_FLAG_CALLBACK,
3755 QuestionIdBase + Index++
3756 );
3757
3758 RemainingSize -= ListWalker->SignatureListSize;
3759 ListWalker = (EFI_SIGNATURE_LIST *)((UINT8 *)ListWalker + ListWalker->SignatureListSize);
3760 }
3761
3762 ON_EXIT:
3763 HiiUpdateForm (
3764 PrivateData->HiiHandle,
3765 &gSecureBootConfigFormSetGuid,
3766 FormId,
3767 StartOpCodeHandle,
3768 EndOpCodeHandle
3769 );
3770
3771 HiiUpdateForm (
3772 PrivateData->HiiHandle,
3773 &gSecureBootConfigFormSetGuid,
3774 FormId,
3775 StartGotoHandle,
3776 EndGotoHandle
3777 );
3778
3779 SECUREBOOT_FREE_NON_OPCODE (StartOpCodeHandle);
3780 SECUREBOOT_FREE_NON_OPCODE (EndOpCodeHandle);
3781 SECUREBOOT_FREE_NON_OPCODE (StartGotoHandle);
3782 SECUREBOOT_FREE_NON_OPCODE (EndGotoHandle);
3783
3784 SECUREBOOT_FREE_NON_NULL (VariableData);
3785 SECUREBOOT_FREE_NON_NULL (FormatNameString);
3786 SECUREBOOT_FREE_NON_NULL (FormatHelpString);
3787
3788 PrivateData->ListCount = Index;
3789
3790 return Status;
3791 }
3792
3793 /**
3794 Parse hash value from EFI_SIGNATURE_DATA, and save in the CHAR16 type array.
3795 The buffer is callee allocated and should be freed by the caller.
3796
3797 @param[in] ListEntry The pointer point to the signature list.
3798 @param[in] DataEntry The signature data we are processing.
3799 @param[out] BufferToReturn Buffer to save the hash value.
3800
3801 @retval EFI_INVALID_PARAMETER Invalid List or Data or Buffer.
3802 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
3803 @retval EFI_SUCCESS Operation success.
3804 **/
3805 EFI_STATUS
3806 ParseHashValue (
3807 IN EFI_SIGNATURE_LIST *ListEntry,
3808 IN EFI_SIGNATURE_DATA *DataEntry,
3809 OUT CHAR16 **BufferToReturn
3810 )
3811 {
3812 UINTN Index;
3813 UINTN BufferIndex;
3814 UINTN TotalSize;
3815 UINTN DataSize;
3816 UINTN Line;
3817 UINTN OneLineBytes;
3818
3819 //
3820 // Assume that, display 8 bytes in one line.
3821 //
3822 OneLineBytes = 8;
3823
3824 if (ListEntry == NULL || DataEntry == NULL || BufferToReturn == NULL) {
3825 return EFI_INVALID_PARAMETER;
3826 }
3827
3828 DataSize = ListEntry->SignatureSize - sizeof(EFI_GUID);
3829 Line = (DataSize + OneLineBytes - 1) / OneLineBytes;
3830
3831 //
3832 // Each byte will split two Hex-number, and each line need additional memory to save '\r\n'.
3833 //
3834 TotalSize = ((DataSize + Line) * 2 * sizeof(CHAR16));
3835
3836 *BufferToReturn = AllocateZeroPool(TotalSize);
3837 if (*BufferToReturn == NULL) {
3838 return EFI_OUT_OF_RESOURCES;
3839 }
3840
3841 for (Index = 0, BufferIndex = 0; Index < DataSize; Index = Index + 1) {
3842 if ((Index > 0) && (Index % OneLineBytes == 0)) {
3843 BufferIndex += UnicodeSPrint(&(*BufferToReturn)[BufferIndex], TotalSize - sizeof(CHAR16) * BufferIndex, L"\n");
3844 }
3845 BufferIndex += UnicodeSPrint(&(*BufferToReturn)[BufferIndex], TotalSize - sizeof(CHAR16) * BufferIndex, L"%02x", DataEntry->SignatureData[Index]);
3846 }
3847 BufferIndex += UnicodeSPrint(&(*BufferToReturn)[BufferIndex], TotalSize - sizeof(CHAR16) * BufferIndex, L"\n");
3848
3849 return EFI_SUCCESS;
3850 }
3851
3852 /**
3853 Function to get the common name from the X509 format certificate.
3854 The buffer is callee allocated and should be freed by the caller.
3855
3856 @param[in] ListEntry The pointer point to the signature list.
3857 @param[in] DataEntry The signature data we are processing.
3858 @param[out] BufferToReturn Buffer to save the CN of X509 certificate.
3859
3860 @retval EFI_INVALID_PARAMETER Invalid List or Data or Buffer.
3861 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
3862 @retval EFI_SUCCESS Operation success.
3863 @retval EFI_NOT_FOUND Not found CN field in the X509 certificate.
3864 **/
3865 EFI_STATUS
3866 GetCommonNameFromX509 (
3867 IN EFI_SIGNATURE_LIST *ListEntry,
3868 IN EFI_SIGNATURE_DATA *DataEntry,
3869 OUT CHAR16 **BufferToReturn
3870 )
3871 {
3872 EFI_STATUS Status;
3873 CHAR8 *CNBuffer;
3874 UINTN CNBufferSize;
3875
3876 Status = EFI_SUCCESS;
3877 CNBuffer = NULL;
3878
3879 CNBuffer = AllocateZeroPool(256);
3880 if (CNBuffer == NULL) {
3881 Status = EFI_OUT_OF_RESOURCES;
3882 goto ON_EXIT;
3883 }
3884
3885 CNBufferSize = 256;
3886 X509GetCommonName (
3887 (UINT8 *)DataEntry + sizeof(EFI_GUID),
3888 ListEntry->SignatureSize - sizeof(EFI_GUID),
3889 CNBuffer,
3890 &CNBufferSize
3891 );
3892
3893 *BufferToReturn = AllocateZeroPool(256 * sizeof(CHAR16));
3894 if (*BufferToReturn == NULL) {
3895 Status = EFI_OUT_OF_RESOURCES;
3896 goto ON_EXIT;
3897 }
3898
3899 AsciiStrToUnicodeStrS (CNBuffer, *BufferToReturn, 256);
3900
3901 ON_EXIT:
3902 SECUREBOOT_FREE_NON_NULL (CNBuffer);
3903
3904 return Status;
3905 }
3906
3907 /**
3908 Format the help info for the signature data, each help info contain 3 parts.
3909 1. Onwer Guid.
3910 2. Content, depends on the type of the signature list.
3911 3. Revocation time.
3912
3913 @param[in] PrivateData Module's private data.
3914 @param[in] ListEntry Point to the signature list.
3915 @param[in] DataEntry Point to the signature data we are processing.
3916 @param[out] StringId Save the string id of help info.
3917
3918 @retval EFI_SUCCESS Operation success.
3919 @retval EFI_OUT_OF_RESOURCES Unable to allocate required resources.
3920 **/
3921 EFI_STATUS
3922 FormatHelpInfo (
3923 IN SECUREBOOT_CONFIG_PRIVATE_DATA *PrivateData,
3924 IN EFI_SIGNATURE_LIST *ListEntry,
3925 IN EFI_SIGNATURE_DATA *DataEntry,
3926 OUT EFI_STRING_ID *StringId
3927 )
3928 {
3929 EFI_STATUS Status;
3930 EFI_TIME *Time;
3931 EFI_STRING_ID ListTypeId;
3932 EFI_STRING FormatHelpString;
3933 EFI_STRING FormatTypeString;
3934 UINTN DataSize;
3935 UINTN HelpInfoIndex;
3936 UINTN TotalSize;
3937 CHAR16 GuidString[BUFFER_MAX_SIZE];
3938 CHAR16 TimeString[BUFFER_MAX_SIZE];
3939 CHAR16 *DataString;
3940 CHAR16 *HelpInfoString;
3941 BOOLEAN IsCert;
3942
3943 Status = EFI_SUCCESS;
3944 Time = NULL;
3945 FormatTypeString = NULL;
3946 HelpInfoIndex = 0;
3947 DataString = NULL;
3948 HelpInfoString = NULL;
3949 IsCert = FALSE;
3950
3951 if (CompareGuid(&ListEntry->SignatureType, &gEfiCertRsa2048Guid)) {
3952 ListTypeId = STRING_TOKEN(STR_LIST_TYPE_RSA2048_SHA256);
3953 DataSize = ListEntry->SignatureSize - sizeof(EFI_GUID);
3954 IsCert = TRUE;
3955 } else if (CompareGuid(&ListEntry->SignatureType, &gEfiCertX509Guid)) {
3956 ListTypeId = STRING_TOKEN(STR_LIST_TYPE_X509);
3957 DataSize = ListEntry->SignatureSize - sizeof(EFI_GUID);
3958 IsCert = TRUE;
3959 } else if (CompareGuid(&ListEntry->SignatureType, &gEfiCertSha1Guid)) {
3960 ListTypeId = STRING_TOKEN(STR_LIST_TYPE_SHA1);
3961 DataSize = 20;
3962 } else if (CompareGuid(&ListEntry->SignatureType, &gEfiCertSha256Guid)) {
3963 ListTypeId = STRING_TOKEN(STR_LIST_TYPE_SHA256);
3964 DataSize = 32;
3965 } else if (CompareGuid(&ListEntry->SignatureType, &gEfiCertX509Sha256Guid)) {
3966 ListTypeId = STRING_TOKEN(STR_LIST_TYPE_X509_SHA256);
3967 DataSize = 32;
3968 Time = (EFI_TIME *)(DataEntry->SignatureData + DataSize);
3969 } else if (CompareGuid(&ListEntry->SignatureType, &gEfiCertX509Sha384Guid)) {
3970 ListTypeId = STRING_TOKEN(STR_LIST_TYPE_X509_SHA384);
3971 DataSize = 48;
3972 Time = (EFI_TIME *)(DataEntry->SignatureData + DataSize);
3973 } else if (CompareGuid(&ListEntry->SignatureType, &gEfiCertX509Sha512Guid)) {
3974 ListTypeId = STRING_TOKEN(STR_LIST_TYPE_X509_SHA512);
3975 DataSize = 64;
3976 Time = (EFI_TIME *)(DataEntry->SignatureData + DataSize);
3977 } else {
3978 Status = EFI_UNSUPPORTED;
3979 goto ON_EXIT;
3980 }
3981
3982 FormatTypeString = HiiGetString (PrivateData->HiiHandle, ListTypeId, NULL);
3983 if (FormatTypeString == NULL) {
3984 goto ON_EXIT;
3985 }
3986
3987 TotalSize = 1024;
3988 HelpInfoString = AllocateZeroPool (TotalSize);
3989 if (HelpInfoString == NULL) {
3990 Status = EFI_OUT_OF_RESOURCES;
3991 goto ON_EXIT;
3992 }
3993
3994 //
3995 // Format GUID part.
3996 //
3997 ZeroMem (GuidString, sizeof (GuidString));
3998 GuidToString(&DataEntry->SignatureOwner, GuidString, BUFFER_MAX_SIZE);
3999 FormatHelpString = HiiGetString (PrivateData->HiiHandle, STRING_TOKEN (STR_SIGNATURE_DATA_HELP_FORMAT_GUID), NULL);
4000 if (FormatHelpString == NULL) {
4001 goto ON_EXIT;
4002 }
4003 HelpInfoIndex += UnicodeSPrint (
4004 &HelpInfoString[HelpInfoIndex],
4005 TotalSize - sizeof(CHAR16) * HelpInfoIndex,
4006 FormatHelpString,
4007 GuidString
4008 );
4009 SECUREBOOT_FREE_NON_NULL (FormatHelpString);
4010 FormatHelpString = NULL;
4011
4012 //
4013 // Format content part, it depends on the type of signature list, hash value or CN.
4014 //
4015 if (IsCert) {
4016 GetCommonNameFromX509 (ListEntry, DataEntry, &DataString);
4017 FormatHelpString = HiiGetString (PrivateData->HiiHandle, STRING_TOKEN (STR_SIGNATURE_DATA_HELP_FORMAT_CN), NULL);
4018 } else {
4019 //
4020 // Format hash value for each signature data entry.
4021 //
4022 ParseHashValue (ListEntry, DataEntry, &DataString);
4023 FormatHelpString = HiiGetString (PrivateData->HiiHandle, STRING_TOKEN (STR_SIGNATURE_DATA_HELP_FORMAT_HASH), NULL);
4024 }
4025 if (FormatHelpString == NULL) {
4026 goto ON_EXIT;
4027 }
4028 HelpInfoIndex += UnicodeSPrint (
4029 &HelpInfoString[HelpInfoIndex],
4030 TotalSize - sizeof (CHAR16) * HelpInfoIndex,
4031 FormatHelpString,
4032 FormatTypeString,
4033 DataSize,
4034 DataString
4035 );
4036 SECUREBOOT_FREE_NON_NULL (FormatHelpString);
4037 FormatHelpString = NULL;
4038
4039 //
4040 // Format revocation time part.
4041 //
4042 if (Time != NULL) {
4043 ZeroMem (TimeString, sizeof (TimeString));
4044 UnicodeSPrint (
4045 TimeString,
4046 sizeof (TimeString),
4047 L"%d-%d-%d %d:%d:%d",
4048 Time->Year,
4049 Time->Month,
4050 Time->Day,
4051 Time->Hour,
4052 Time->Minute,
4053 Time->Second
4054 );
4055 FormatHelpString = HiiGetString (PrivateData->HiiHandle, STRING_TOKEN (STR_SIGNATURE_DATA_HELP_FORMAT_TIME), NULL);
4056 if (FormatHelpString == NULL) {
4057 goto ON_EXIT;
4058 }
4059 UnicodeSPrint (
4060 &HelpInfoString[HelpInfoIndex],
4061 TotalSize - sizeof (CHAR16) * HelpInfoIndex,
4062 FormatHelpString,
4063 TimeString
4064 );
4065 SECUREBOOT_FREE_NON_NULL (FormatHelpString);
4066 FormatHelpString = NULL;
4067 }
4068
4069 *StringId = HiiSetString (PrivateData->HiiHandle, 0, HelpInfoString, NULL);
4070 ON_EXIT:
4071 SECUREBOOT_FREE_NON_NULL (DataString);
4072 SECUREBOOT_FREE_NON_NULL (HelpInfoString);
4073
4074 SECUREBOOT_FREE_NON_NULL (FormatTypeString);
4075
4076 return Status;
4077 }
4078
4079 /**
4080 This functino to load signature data under the signature list.
4081
4082 @param[in] PrivateData Module's private data.
4083 @param[in] LabelId Label number to insert opcodes.
4084 @param[in] FormId Form ID of current page.
4085 @param[in] QuestionIdBase Base question id of the signature list.
4086 @param[in] ListIndex Indicate to load which signature list.
4087
4088 @retval EFI_SUCCESS Success to update the signature list page
4089 @retval EFI_OUT_OF_RESOURCES Unable to allocate required resources.
4090 **/
4091 EFI_STATUS
4092 LoadSignatureData (
4093 IN SECUREBOOT_CONFIG_PRIVATE_DATA *PrivateData,
4094 IN UINT16 LabelId,
4095 IN EFI_FORM_ID FormId,
4096 IN EFI_QUESTION_ID QuestionIdBase,
4097 IN UINT16 ListIndex
4098 )
4099 {
4100 EFI_STATUS Status;
4101 EFI_SIGNATURE_LIST *ListWalker;
4102 EFI_SIGNATURE_DATA *DataWalker;
4103 EFI_IFR_GUID_LABEL *StartLabel;
4104 EFI_IFR_GUID_LABEL *EndLabel;
4105 EFI_STRING_ID HelpStringId;
4106 EFI_STRING FormatNameString;
4107 VOID *StartOpCodeHandle;
4108 VOID *EndOpCodeHandle;
4109 UINTN DataSize;
4110 UINTN RemainingSize;
4111 UINT16 Index;
4112 UINT8 *VariableData;
4113 CHAR16 VariableName[BUFFER_MAX_SIZE];
4114 CHAR16 NameBuffer[BUFFER_MAX_SIZE];
4115
4116 Status = EFI_SUCCESS;
4117 FormatNameString = NULL;
4118 StartOpCodeHandle = NULL;
4119 EndOpCodeHandle = NULL;
4120 Index = 0;
4121 VariableData = NULL;
4122
4123 //
4124 // Initialize the container for dynamic opcodes.
4125 //
4126 StartOpCodeHandle = HiiAllocateOpCodeHandle ();
4127 if (StartOpCodeHandle == NULL) {
4128 Status = EFI_OUT_OF_RESOURCES;
4129 goto ON_EXIT;
4130 }
4131
4132 EndOpCodeHandle = HiiAllocateOpCodeHandle ();
4133 if (EndOpCodeHandle == NULL) {
4134 Status = EFI_OUT_OF_RESOURCES;
4135 goto ON_EXIT;
4136 }
4137
4138 //
4139 // Create Hii Extend Label OpCode.
4140 //
4141 StartLabel = (EFI_IFR_GUID_LABEL *)HiiCreateGuidOpCode (
4142 StartOpCodeHandle,
4143 &gEfiIfrTianoGuid,
4144 NULL,
4145 sizeof (EFI_IFR_GUID_LABEL)
4146 );
4147 StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
4148 StartLabel->Number = LabelId;
4149
4150 EndLabel = (EFI_IFR_GUID_LABEL *)HiiCreateGuidOpCode (
4151 EndOpCodeHandle,
4152 &gEfiIfrTianoGuid,
4153 NULL,
4154 sizeof (EFI_IFR_GUID_LABEL)
4155 );
4156 EndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
4157 EndLabel->Number = LABEL_END;
4158
4159 if (PrivateData->VariableName == Variable_DB) {
4160 UnicodeSPrint (VariableName, sizeof (VariableName), EFI_IMAGE_SECURITY_DATABASE);
4161 } else if (PrivateData->VariableName == Variable_DBX) {
4162 UnicodeSPrint (VariableName, sizeof (VariableName), EFI_IMAGE_SECURITY_DATABASE1);
4163 } else if (PrivateData->VariableName == Variable_DBT) {
4164 UnicodeSPrint (VariableName, sizeof (VariableName), EFI_IMAGE_SECURITY_DATABASE2);
4165 } else {
4166 goto ON_EXIT;
4167 }
4168
4169 //
4170 // Read Variable, the variable name save in the PrivateData->VariableName.
4171 //
4172 DataSize = 0;
4173 Status = gRT->GetVariable (VariableName, &gEfiImageSecurityDatabaseGuid, NULL, &DataSize, VariableData);
4174 if (EFI_ERROR (Status) && Status != EFI_BUFFER_TOO_SMALL) {
4175 goto ON_EXIT;
4176 }
4177
4178 VariableData = AllocateZeroPool (DataSize);
4179 if (VariableData == NULL) {
4180 Status = EFI_OUT_OF_RESOURCES;
4181 goto ON_EXIT;
4182 }
4183 Status = gRT->GetVariable (VariableName, &gEfiImageSecurityDatabaseGuid, NULL, &DataSize, VariableData);
4184 if (EFI_ERROR (Status)) {
4185 goto ON_EXIT;
4186 }
4187
4188 RemainingSize = DataSize;
4189 ListWalker = (EFI_SIGNATURE_LIST *)VariableData;
4190
4191 //
4192 // Skip signature list.
4193 //
4194 while ((RemainingSize > 0) && (RemainingSize >= ListWalker->SignatureListSize) && ListIndex-- > 0) {
4195 RemainingSize -= ListWalker->SignatureListSize;
4196 ListWalker = (EFI_SIGNATURE_LIST *)((UINT8 *)ListWalker + ListWalker->SignatureListSize);
4197 }
4198
4199 FormatNameString = HiiGetString (PrivateData->HiiHandle, STRING_TOKEN (STR_SIGNATURE_DATA_NAME_FORMAT), NULL);
4200 if (FormatNameString == NULL) {
4201 goto ON_EXIT;
4202 }
4203
4204 DataWalker = (EFI_SIGNATURE_DATA *)((UINT8 *)ListWalker + sizeof(EFI_SIGNATURE_LIST) + ListWalker->SignatureHeaderSize);
4205 for (Index = 0; Index < SIGNATURE_DATA_COUNTS(ListWalker); Index = Index + 1) {
4206 //
4207 // Format name buffer.
4208 //
4209 ZeroMem (NameBuffer, sizeof (NameBuffer));
4210 UnicodeSPrint (NameBuffer, sizeof (NameBuffer), FormatNameString, Index + 1);
4211
4212 //
4213 // Format help info buffer.
4214 //
4215 Status = FormatHelpInfo (PrivateData, ListWalker, DataWalker, &HelpStringId);
4216 if (EFI_ERROR (Status)) {
4217 goto ON_EXIT;
4218 }
4219
4220 HiiCreateCheckBoxOpCode (
4221 StartOpCodeHandle,
4222 (EFI_QUESTION_ID)(QuestionIdBase + Index),
4223 0,
4224 0,
4225 HiiSetString (PrivateData->HiiHandle, 0, NameBuffer, NULL),
4226 HelpStringId,
4227 EFI_IFR_FLAG_CALLBACK,
4228 0,
4229 NULL
4230 );
4231
4232 ZeroMem(NameBuffer, 100);
4233 DataWalker = (EFI_SIGNATURE_DATA *)((UINT8 *)DataWalker + ListWalker->SignatureSize);
4234 }
4235
4236 //
4237 // Allocate a buffer to record which signature data will be checked.
4238 // This memory buffer will be freed when exit from the SECUREBOOT_DELETE_SIGNATURE_DATA_FORM form.
4239 //
4240 PrivateData->CheckArray = AllocateZeroPool (SIGNATURE_DATA_COUNTS (ListWalker) * sizeof (BOOLEAN));
4241 ON_EXIT:
4242 HiiUpdateForm (
4243 PrivateData->HiiHandle,
4244 &gSecureBootConfigFormSetGuid,
4245 FormId,
4246 StartOpCodeHandle,
4247 EndOpCodeHandle
4248 );
4249
4250 SECUREBOOT_FREE_NON_OPCODE (StartOpCodeHandle);
4251 SECUREBOOT_FREE_NON_OPCODE (EndOpCodeHandle);
4252
4253 SECUREBOOT_FREE_NON_NULL (VariableData);
4254 SECUREBOOT_FREE_NON_NULL (FormatNameString);
4255
4256 return Status;
4257 }
4258
4259 /**
4260 This function is called to provide results data to the driver.
4261
4262 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
4263 @param[in] Action Specifies the type of action taken by the browser.
4264 @param[in] QuestionId A unique value which is sent to the original
4265 exporting driver so that it can identify the type
4266 of data to expect.
4267 @param[in] Type The type of value for the question.
4268 @param[in] Value A pointer to the data being sent to the original
4269 exporting driver.
4270 @param[out] ActionRequest On return, points to the action requested by the
4271 callback function.
4272
4273 @retval EFI_SUCCESS The callback successfully handled the action.
4274 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the
4275 variable and its data.
4276 @retval EFI_DEVICE_ERROR The variable could not be saved.
4277 @retval EFI_UNSUPPORTED The specified Action is not supported by the
4278 callback.
4279
4280 **/
4281 EFI_STATUS
4282 EFIAPI
4283 SecureBootCallback (
4284 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,
4285 IN EFI_BROWSER_ACTION Action,
4286 IN EFI_QUESTION_ID QuestionId,
4287 IN UINT8 Type,
4288 IN EFI_IFR_TYPE_VALUE *Value,
4289 OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest
4290 )
4291 {
4292 EFI_INPUT_KEY Key;
4293 EFI_STATUS Status;
4294 RETURN_STATUS RStatus;
4295 SECUREBOOT_CONFIG_PRIVATE_DATA *Private;
4296 UINTN BufferSize;
4297 SECUREBOOT_CONFIGURATION *IfrNvData;
4298 UINT16 LabelId;
4299 UINT8 *SecureBootEnable;
4300 UINT8 *Pk;
4301 UINT8 *SecureBootMode;
4302 UINT8 *SetupMode;
4303 CHAR16 PromptString[100];
4304 EFI_DEVICE_PATH_PROTOCOL *File;
4305 UINTN NameLength;
4306 UINT16 *FilePostFix;
4307 SECUREBOOT_CONFIG_PRIVATE_DATA *PrivateData;
4308 BOOLEAN GetBrowserDataResult;
4309
4310 Status = EFI_SUCCESS;
4311 SecureBootEnable = NULL;
4312 SecureBootMode = NULL;
4313 SetupMode = NULL;
4314 File = NULL;
4315
4316 if ((This == NULL) || (Value == NULL) || (ActionRequest == NULL)) {
4317 return EFI_INVALID_PARAMETER;
4318 }
4319
4320 Private = SECUREBOOT_CONFIG_PRIVATE_FROM_THIS (This);
4321
4322 gSecureBootPrivateData = Private;
4323
4324 //
4325 // Retrieve uncommitted data from Browser
4326 //
4327 BufferSize = sizeof (SECUREBOOT_CONFIGURATION);
4328 IfrNvData = AllocateZeroPool (BufferSize);
4329 if (IfrNvData == NULL) {
4330 return EFI_OUT_OF_RESOURCES;
4331 }
4332
4333 GetBrowserDataResult = HiiGetBrowserData (&gSecureBootConfigFormSetGuid, mSecureBootStorageName, BufferSize, (UINT8 *) IfrNvData);
4334
4335 if (Action == EFI_BROWSER_ACTION_FORM_OPEN) {
4336 if (QuestionId == KEY_SECURE_BOOT_MODE) {
4337 //
4338 // Update secure boot strings when opening this form
4339 //
4340 Status = UpdateSecureBootString(Private);
4341 SecureBootExtractConfigFromVariable (Private, IfrNvData);
4342 mIsEnterSecureBootForm = TRUE;
4343 } else {
4344 //
4345 // When entering SecureBoot OPTION Form
4346 // always close opened file & free resource
4347 //
4348 if ((QuestionId == KEY_SECURE_BOOT_PK_OPTION) ||
4349 (QuestionId == KEY_SECURE_BOOT_KEK_OPTION) ||
4350 (QuestionId == KEY_SECURE_BOOT_DB_OPTION) ||
4351 (QuestionId == KEY_SECURE_BOOT_DBX_OPTION) ||
4352 (QuestionId == KEY_SECURE_BOOT_DBT_OPTION)) {
4353 CloseEnrolledFile(Private->FileContext);
4354 } else if (QuestionId == KEY_SECURE_BOOT_DELETE_ALL_LIST) {
4355 //
4356 // Update ListCount field in varstore
4357 // Button "Delete All Signature List" is
4358 // enable when ListCount is greater than 0.
4359 //
4360 IfrNvData->ListCount = Private->ListCount;
4361 }
4362 }
4363 goto EXIT;
4364 }
4365
4366 if (Action == EFI_BROWSER_ACTION_RETRIEVE) {
4367 Status = EFI_UNSUPPORTED;
4368 if (QuestionId == KEY_SECURE_BOOT_MODE) {
4369 if (mIsEnterSecureBootForm) {
4370 Value->u8 = SECURE_BOOT_MODE_STANDARD;
4371 Status = EFI_SUCCESS;
4372 }
4373 }
4374 goto EXIT;
4375 }
4376
4377 if ((Action != EFI_BROWSER_ACTION_CHANGED) &&
4378 (Action != EFI_BROWSER_ACTION_CHANGING) &&
4379 (Action != EFI_BROWSER_ACTION_FORM_CLOSE) &&
4380 (Action != EFI_BROWSER_ACTION_DEFAULT_STANDARD)) {
4381 Status = EFI_UNSUPPORTED;
4382 goto EXIT;
4383 }
4384
4385 if (Action == EFI_BROWSER_ACTION_CHANGING) {
4386
4387 switch (QuestionId) {
4388 case KEY_SECURE_BOOT_ENABLE:
4389 GetVariable2 (EFI_SECURE_BOOT_ENABLE_NAME, &gEfiSecureBootEnableDisableGuid, (VOID**)&SecureBootEnable, NULL);
4390 if (NULL != SecureBootEnable) {
4391 FreePool (SecureBootEnable);
4392 if (EFI_ERROR (SaveSecureBootVariable (Value->u8))) {
4393 CreatePopUp (
4394 EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,
4395 &Key,
4396 L"Only Physical Presence User could disable secure boot!",
4397 NULL
4398 );
4399 Status = EFI_UNSUPPORTED;
4400 } else {
4401 CreatePopUp (
4402 EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,
4403 &Key,
4404 L"Configuration changed, please reset the platform to take effect!",
4405 NULL
4406 );
4407 }
4408 }
4409 break;
4410
4411 case KEY_SECURE_BOOT_KEK_OPTION:
4412 case KEY_SECURE_BOOT_DB_OPTION:
4413 case KEY_SECURE_BOOT_DBX_OPTION:
4414 case KEY_SECURE_BOOT_DBT_OPTION:
4415 PrivateData = SECUREBOOT_CONFIG_PRIVATE_FROM_THIS (This);
4416 //
4417 // Clear Signature GUID.
4418 //
4419 ZeroMem (IfrNvData->SignatureGuid, sizeof (IfrNvData->SignatureGuid));
4420 if (Private->SignatureGUID == NULL) {
4421 Private->SignatureGUID = (EFI_GUID *) AllocateZeroPool (sizeof (EFI_GUID));
4422 if (Private->SignatureGUID == NULL) {
4423 return EFI_OUT_OF_RESOURCES;
4424 }
4425 }
4426
4427 //
4428 // Cleanup VFRData once leaving PK/KEK/DB/DBX/DBT enroll/delete page
4429 //
4430 SecureBootExtractConfigFromVariable (PrivateData, IfrNvData);
4431
4432 if (QuestionId == KEY_SECURE_BOOT_DB_OPTION) {
4433 LabelId = SECUREBOOT_ENROLL_SIGNATURE_TO_DB;
4434 } else if (QuestionId == KEY_SECURE_BOOT_DBX_OPTION) {
4435 LabelId = SECUREBOOT_ENROLL_SIGNATURE_TO_DBX;
4436 } else if (QuestionId == KEY_SECURE_BOOT_DBT_OPTION) {
4437 LabelId = SECUREBOOT_ENROLL_SIGNATURE_TO_DBT;
4438 } else {
4439 LabelId = FORMID_ENROLL_KEK_FORM;
4440 }
4441
4442 //
4443 // Refresh selected file.
4444 //
4445 CleanUpPage (LabelId, Private);
4446 break;
4447 case KEY_SECURE_BOOT_PK_OPTION:
4448 LabelId = FORMID_ENROLL_PK_FORM;
4449 //
4450 // Refresh selected file.
4451 //
4452 CleanUpPage (LabelId, Private);
4453 break;
4454
4455 case FORMID_ENROLL_PK_FORM:
4456 ChooseFile (NULL, NULL, UpdatePKFromFile, &File);
4457 break;
4458
4459 case FORMID_ENROLL_KEK_FORM:
4460 ChooseFile (NULL, NULL, UpdateKEKFromFile, &File);
4461 break;
4462
4463 case SECUREBOOT_ENROLL_SIGNATURE_TO_DB:
4464 ChooseFile (NULL, NULL, UpdateDBFromFile, &File);
4465 break;
4466
4467 case SECUREBOOT_ENROLL_SIGNATURE_TO_DBX:
4468 ChooseFile (NULL, NULL, UpdateDBXFromFile, &File);
4469
4470 if (Private->FileContext->FHandle != NULL) {
4471 //
4472 // Parse the file's postfix.
4473 //
4474 NameLength = StrLen (Private->FileContext->FileName);
4475 if (NameLength <= 4) {
4476 return FALSE;
4477 }
4478 FilePostFix = Private->FileContext->FileName + NameLength - 4;
4479
4480 if (IsDerEncodeCertificate (FilePostFix)) {
4481 //
4482 // Supports DER-encoded X509 certificate.
4483 //
4484 IfrNvData->FileEnrollType = X509_CERT_FILE_TYPE;
4485 } else if (IsAuthentication2Format(Private->FileContext->FHandle)){
4486 IfrNvData->FileEnrollType = AUTHENTICATION_2_FILE_TYPE;
4487 } else {
4488 IfrNvData->FileEnrollType = PE_IMAGE_FILE_TYPE;
4489 }
4490 Private->FileContext->FileType = IfrNvData->FileEnrollType;
4491
4492 //
4493 // Clean up Certificate Format if File type is not X509 DER
4494 //
4495 if (IfrNvData->FileEnrollType != X509_CERT_FILE_TYPE) {
4496 IfrNvData->CertificateFormat = HASHALG_RAW;
4497 }
4498 DEBUG((DEBUG_ERROR, "IfrNvData->FileEnrollType %d\n", Private->FileContext->FileType));
4499 }
4500
4501 break;
4502
4503 case SECUREBOOT_ENROLL_SIGNATURE_TO_DBT:
4504 ChooseFile (NULL, NULL, UpdateDBTFromFile, &File);
4505 break;
4506
4507 case KEY_SECURE_BOOT_DELETE_PK:
4508 if (Value->u8) {
4509 CreatePopUp (
4510 EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,
4511 &Key,
4512 L"Are you sure you want to delete PK? Secure boot will be disabled!",
4513 L"Press 'Y' to delete PK and exit, 'N' to discard change and return",
4514 NULL
4515 );
4516 if (Key.UnicodeChar == 'y' || Key.UnicodeChar == 'Y') {
4517 Status = DeletePlatformKey ();
4518 if (EFI_ERROR (Status)) {
4519 CreatePopUp (
4520 EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,
4521 &Key,
4522 L"Only Physical Presence User could delete PK in custom mode!",
4523 NULL
4524 );
4525 }
4526 }
4527 }
4528 break;
4529
4530 case KEY_DELETE_KEK:
4531 UpdateDeletePage (
4532 Private,
4533 EFI_KEY_EXCHANGE_KEY_NAME,
4534 &gEfiGlobalVariableGuid,
4535 LABEL_KEK_DELETE,
4536 FORMID_DELETE_KEK_FORM,
4537 OPTION_DEL_KEK_QUESTION_ID
4538 );
4539 break;
4540
4541 case SECUREBOOT_DELETE_SIGNATURE_FROM_DB:
4542 UpdateDeletePage (
4543 Private,
4544 EFI_IMAGE_SECURITY_DATABASE,
4545 &gEfiImageSecurityDatabaseGuid,
4546 LABEL_DB_DELETE,
4547 SECUREBOOT_DELETE_SIGNATURE_FROM_DB,
4548 OPTION_DEL_DB_QUESTION_ID
4549 );
4550 break;
4551
4552 //
4553 // From DBX option to the level-1 form, display signature list.
4554 //
4555 case KEY_VALUE_FROM_DBX_TO_LIST_FORM:
4556 Private->VariableName = Variable_DBX;
4557 LoadSignatureList (
4558 Private,
4559 LABEL_SIGNATURE_LIST_START,
4560 SECUREBOOT_DELETE_SIGNATURE_LIST_FORM,
4561 OPTION_SIGNATURE_LIST_QUESTION_ID
4562 );
4563 break;
4564
4565 //
4566 // Delete all signature list and reload.
4567 //
4568 case KEY_SECURE_BOOT_DELETE_ALL_LIST:
4569 CreatePopUp(
4570 EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,
4571 &Key,
4572 L"Press 'Y' to delete signature list.",
4573 L"Press other key to cancel and exit.",
4574 NULL
4575 );
4576
4577 if (Key.UnicodeChar == L'Y' || Key.UnicodeChar == L'y') {
4578 DeleteSignatureEx (Private, Delete_Signature_List_All, IfrNvData->CheckedDataCount);
4579 }
4580
4581 LoadSignatureList (
4582 Private,
4583 LABEL_SIGNATURE_LIST_START,
4584 SECUREBOOT_DELETE_SIGNATURE_LIST_FORM,
4585 OPTION_SIGNATURE_LIST_QUESTION_ID
4586 );
4587 break;
4588
4589 //
4590 // Delete one signature list and reload.
4591 //
4592 case KEY_SECURE_BOOT_DELETE_ALL_DATA:
4593 CreatePopUp(
4594 EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,
4595 &Key,
4596 L"Press 'Y' to delete signature data.",
4597 L"Press other key to cancel and exit.",
4598 NULL
4599 );
4600
4601 if (Key.UnicodeChar == L'Y' || Key.UnicodeChar == L'y') {
4602 DeleteSignatureEx (Private, Delete_Signature_List_One, IfrNvData->CheckedDataCount);
4603 }
4604
4605 LoadSignatureList (
4606 Private,
4607 LABEL_SIGNATURE_LIST_START,
4608 SECUREBOOT_DELETE_SIGNATURE_LIST_FORM,
4609 OPTION_SIGNATURE_LIST_QUESTION_ID
4610 );
4611 break;
4612
4613 //
4614 // Delete checked signature data and reload.
4615 //
4616 case KEY_SECURE_BOOT_DELETE_CHECK_DATA:
4617 CreatePopUp(
4618 EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,
4619 &Key,
4620 L"Press 'Y' to delete signature data.",
4621 L"Press other key to cancel and exit.",
4622 NULL
4623 );
4624
4625 if (Key.UnicodeChar == L'Y' || Key.UnicodeChar == L'y') {
4626 DeleteSignatureEx (Private, Delete_Signature_Data, IfrNvData->CheckedDataCount);
4627 }
4628
4629 LoadSignatureList (
4630 Private,
4631 LABEL_SIGNATURE_LIST_START,
4632 SECUREBOOT_DELETE_SIGNATURE_LIST_FORM,
4633 OPTION_SIGNATURE_LIST_QUESTION_ID
4634 );
4635 break;
4636
4637 case SECUREBOOT_DELETE_SIGNATURE_FROM_DBT:
4638 UpdateDeletePage (
4639 Private,
4640 EFI_IMAGE_SECURITY_DATABASE2,
4641 &gEfiImageSecurityDatabaseGuid,
4642 LABEL_DBT_DELETE,
4643 SECUREBOOT_DELETE_SIGNATURE_FROM_DBT,
4644 OPTION_DEL_DBT_QUESTION_ID
4645 );
4646
4647 break;
4648
4649 case KEY_VALUE_SAVE_AND_EXIT_KEK:
4650 Status = EnrollKeyExchangeKey (Private);
4651 if (EFI_ERROR (Status)) {
4652 CreatePopUp (
4653 EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,
4654 &Key,
4655 L"ERROR: Unsupported file type!",
4656 L"Only supports DER-encoded X509 certificate",
4657 NULL
4658 );
4659 }
4660 break;
4661
4662 case KEY_VALUE_SAVE_AND_EXIT_DB:
4663 Status = EnrollSignatureDatabase (Private, EFI_IMAGE_SECURITY_DATABASE);
4664 if (EFI_ERROR (Status)) {
4665 CreatePopUp (
4666 EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,
4667 &Key,
4668 L"ERROR: Unsupported file type!",
4669 L"Only supports DER-encoded X509 certificate and executable EFI image",
4670 NULL
4671 );
4672 }
4673 break;
4674
4675 case KEY_VALUE_SAVE_AND_EXIT_DBX:
4676 if (IsX509CertInDbx (Private, EFI_IMAGE_SECURITY_DATABASE1)) {
4677 CreatePopUp (
4678 EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,
4679 &Key,
4680 L"Enrollment failed! Same certificate had already been in the dbx!",
4681 NULL
4682 );
4683
4684 //
4685 // Cert already exists in DBX. Close opened file before exit.
4686 //
4687 CloseEnrolledFile(Private->FileContext);
4688 break;
4689 }
4690
4691 if ((IfrNvData != NULL) && (IfrNvData->CertificateFormat < HASHALG_MAX)) {
4692 Status = EnrollX509HashtoSigDB (
4693 Private,
4694 IfrNvData->CertificateFormat,
4695 &IfrNvData->RevocationDate,
4696 &IfrNvData->RevocationTime,
4697 IfrNvData->AlwaysRevocation
4698 );
4699 IfrNvData->CertificateFormat = HASHALG_RAW;
4700 } else {
4701 Status = EnrollSignatureDatabase (Private, EFI_IMAGE_SECURITY_DATABASE1);
4702 }
4703 if (EFI_ERROR (Status)) {
4704 CreatePopUp (
4705 EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,
4706 &Key,
4707 L"ERROR: Unsupported file type!",
4708 L"Only supports DER-encoded X509 certificate, AUTH_2 format data & executable EFI image",
4709 NULL
4710 );
4711 }
4712 break;
4713
4714 case KEY_VALUE_SAVE_AND_EXIT_DBT:
4715 Status = EnrollSignatureDatabase (Private, EFI_IMAGE_SECURITY_DATABASE2);
4716 if (EFI_ERROR (Status)) {
4717 CreatePopUp (
4718 EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,
4719 &Key,
4720 L"ERROR: Unsupported file type!",
4721 L"Only supports DER-encoded X509 certificate.",
4722 NULL
4723 );
4724 }
4725 break;
4726 case KEY_VALUE_SAVE_AND_EXIT_PK:
4727 Status = EnrollPlatformKey (Private);
4728 if (EFI_ERROR (Status)) {
4729 UnicodeSPrint (
4730 PromptString,
4731 sizeof (PromptString),
4732 L"Only DER encoded certificate file (%s) is supported.",
4733 mSupportX509Suffix
4734 );
4735 CreatePopUp (
4736 EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,
4737 &Key,
4738 L"ERROR: Unsupported file type!",
4739 PromptString,
4740 NULL
4741 );
4742 }
4743 break;
4744 default:
4745 if ((QuestionId >= OPTION_DEL_KEK_QUESTION_ID) &&
4746 (QuestionId < (OPTION_DEL_KEK_QUESTION_ID + OPTION_CONFIG_RANGE))) {
4747 DeleteKeyExchangeKey (Private, QuestionId);
4748 } else if ((QuestionId >= OPTION_DEL_DB_QUESTION_ID) &&
4749 (QuestionId < (OPTION_DEL_DB_QUESTION_ID + OPTION_CONFIG_RANGE))) {
4750 DeleteSignature (
4751 Private,
4752 EFI_IMAGE_SECURITY_DATABASE,
4753 &gEfiImageSecurityDatabaseGuid,
4754 LABEL_DB_DELETE,
4755 SECUREBOOT_DELETE_SIGNATURE_FROM_DB,
4756 OPTION_DEL_DB_QUESTION_ID,
4757 QuestionId - OPTION_DEL_DB_QUESTION_ID
4758 );
4759 } else if ((QuestionId >= OPTION_SIGNATURE_LIST_QUESTION_ID) &&
4760 (QuestionId < (OPTION_SIGNATURE_LIST_QUESTION_ID + OPTION_CONFIG_RANGE))) {
4761 LoadSignatureData (
4762 Private,
4763 LABEL_SIGNATURE_DATA_START,
4764 SECUREBOOT_DELETE_SIGNATURE_DATA_FORM,
4765 OPTION_SIGNATURE_DATA_QUESTION_ID,
4766 QuestionId - OPTION_SIGNATURE_LIST_QUESTION_ID
4767 );
4768 Private->ListIndex = QuestionId - OPTION_SIGNATURE_LIST_QUESTION_ID;
4769 } else if ((QuestionId >= OPTION_SIGNATURE_DATA_QUESTION_ID) &&
4770 (QuestionId < (OPTION_SIGNATURE_DATA_QUESTION_ID + OPTION_CONFIG_RANGE))) {
4771 if (Private->CheckArray[QuestionId - OPTION_SIGNATURE_DATA_QUESTION_ID]) {
4772 IfrNvData->CheckedDataCount--;
4773 Private->CheckArray[QuestionId - OPTION_SIGNATURE_DATA_QUESTION_ID] = FALSE;
4774 } else {
4775 IfrNvData->CheckedDataCount++;
4776 Private->CheckArray[QuestionId - OPTION_SIGNATURE_DATA_QUESTION_ID] = TRUE;
4777 }
4778 } else if ((QuestionId >= OPTION_DEL_DBT_QUESTION_ID) &&
4779 (QuestionId < (OPTION_DEL_DBT_QUESTION_ID + OPTION_CONFIG_RANGE))) {
4780 DeleteSignature (
4781 Private,
4782 EFI_IMAGE_SECURITY_DATABASE2,
4783 &gEfiImageSecurityDatabaseGuid,
4784 LABEL_DBT_DELETE,
4785 SECUREBOOT_DELETE_SIGNATURE_FROM_DBT,
4786 OPTION_DEL_DBT_QUESTION_ID,
4787 QuestionId - OPTION_DEL_DBT_QUESTION_ID
4788 );
4789 }
4790 break;
4791
4792 case KEY_VALUE_NO_SAVE_AND_EXIT_PK:
4793 case KEY_VALUE_NO_SAVE_AND_EXIT_KEK:
4794 case KEY_VALUE_NO_SAVE_AND_EXIT_DB:
4795 case KEY_VALUE_NO_SAVE_AND_EXIT_DBX:
4796 case KEY_VALUE_NO_SAVE_AND_EXIT_DBT:
4797 CloseEnrolledFile(Private->FileContext);
4798
4799 if (Private->SignatureGUID != NULL) {
4800 FreePool (Private->SignatureGUID);
4801 Private->SignatureGUID = NULL;
4802 }
4803 break;
4804 }
4805 } else if (Action == EFI_BROWSER_ACTION_CHANGED) {
4806 switch (QuestionId) {
4807 case KEY_SECURE_BOOT_ENABLE:
4808 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY;
4809 break;
4810 case KEY_SECURE_BOOT_MODE:
4811 mIsEnterSecureBootForm = FALSE;
4812 break;
4813 case KEY_SECURE_BOOT_KEK_GUID:
4814 case KEY_SECURE_BOOT_SIGNATURE_GUID_DB:
4815 case KEY_SECURE_BOOT_SIGNATURE_GUID_DBX:
4816 case KEY_SECURE_BOOT_SIGNATURE_GUID_DBT:
4817 ASSERT (Private->SignatureGUID != NULL);
4818 RStatus = StrToGuid (IfrNvData->SignatureGuid, Private->SignatureGUID);
4819 if (RETURN_ERROR (RStatus) || (IfrNvData->SignatureGuid[GUID_STRING_LENGTH] != L'\0')) {
4820 Status = EFI_INVALID_PARAMETER;
4821 break;
4822 }
4823
4824 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY;
4825 break;
4826 case KEY_SECURE_BOOT_DELETE_PK:
4827 GetVariable2 (EFI_SETUP_MODE_NAME, &gEfiGlobalVariableGuid, (VOID**)&SetupMode, NULL);
4828 if (SetupMode == NULL || (*SetupMode) == SETUP_MODE) {
4829 IfrNvData->DeletePk = TRUE;
4830 IfrNvData->HasPk = FALSE;
4831 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_SUBMIT;
4832 } else {
4833 IfrNvData->DeletePk = FALSE;
4834 IfrNvData->HasPk = TRUE;
4835 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY;
4836 }
4837 if (SetupMode != NULL) {
4838 FreePool (SetupMode);
4839 }
4840 break;
4841 default:
4842 break;
4843 }
4844 } else if (Action == EFI_BROWSER_ACTION_DEFAULT_STANDARD) {
4845 if (QuestionId == KEY_HIDE_SECURE_BOOT) {
4846 GetVariable2 (EFI_PLATFORM_KEY_NAME, &gEfiGlobalVariableGuid, (VOID**)&Pk, NULL);
4847 if (Pk == NULL) {
4848 IfrNvData->HideSecureBoot = TRUE;
4849 } else {
4850 FreePool (Pk);
4851 IfrNvData->HideSecureBoot = FALSE;
4852 }
4853 Value->b = IfrNvData->HideSecureBoot;
4854 }
4855 } else if (Action == EFI_BROWSER_ACTION_FORM_CLOSE) {
4856 //
4857 // Force the platform back to Standard Mode once user leave the setup screen.
4858 //
4859 GetVariable2 (EFI_CUSTOM_MODE_NAME, &gEfiCustomModeEnableGuid, (VOID**)&SecureBootMode, NULL);
4860 if (NULL != SecureBootMode && *SecureBootMode == CUSTOM_SECURE_BOOT_MODE) {
4861 IfrNvData->SecureBootMode = STANDARD_SECURE_BOOT_MODE;
4862 SetSecureBootMode(STANDARD_SECURE_BOOT_MODE);
4863 }
4864 if (SecureBootMode != NULL) {
4865 FreePool (SecureBootMode);
4866 }
4867
4868 if (QuestionId == KEY_SECURE_BOOT_DELETE_ALL_DATA) {
4869 //
4870 // Free memory when exit from the SECUREBOOT_DELETE_SIGNATURE_DATA_FORM form.
4871 //
4872 SECUREBOOT_FREE_NON_NULL (Private->CheckArray);
4873 IfrNvData->CheckedDataCount = 0;
4874 }
4875 }
4876
4877 EXIT:
4878
4879 if (!EFI_ERROR (Status) && GetBrowserDataResult) {
4880 BufferSize = sizeof (SECUREBOOT_CONFIGURATION);
4881 HiiSetBrowserData (&gSecureBootConfigFormSetGuid, mSecureBootStorageName, BufferSize, (UINT8*) IfrNvData, NULL);
4882 }
4883
4884 FreePool (IfrNvData);
4885
4886 if (File != NULL){
4887 FreePool(File);
4888 File = NULL;
4889 }
4890
4891 return EFI_SUCCESS;
4892 }
4893
4894 /**
4895 This function publish the SecureBoot configuration Form.
4896
4897 @param[in, out] PrivateData Points to SecureBoot configuration private data.
4898
4899 @retval EFI_SUCCESS HII Form is installed successfully.
4900 @retval EFI_OUT_OF_RESOURCES Not enough resource for HII Form installation.
4901 @retval Others Other errors as indicated.
4902
4903 **/
4904 EFI_STATUS
4905 InstallSecureBootConfigForm (
4906 IN OUT SECUREBOOT_CONFIG_PRIVATE_DATA *PrivateData
4907 )
4908 {
4909 EFI_STATUS Status;
4910 EFI_HII_HANDLE HiiHandle;
4911 EFI_HANDLE DriverHandle;
4912 EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess;
4913
4914 DriverHandle = NULL;
4915 ConfigAccess = &PrivateData->ConfigAccess;
4916 Status = gBS->InstallMultipleProtocolInterfaces (
4917 &DriverHandle,
4918 &gEfiDevicePathProtocolGuid,
4919 &mSecureBootHiiVendorDevicePath,
4920 &gEfiHiiConfigAccessProtocolGuid,
4921 ConfigAccess,
4922 NULL
4923 );
4924 if (EFI_ERROR (Status)) {
4925 return Status;
4926 }
4927
4928 PrivateData->DriverHandle = DriverHandle;
4929
4930 //
4931 // Publish the HII package list
4932 //
4933 HiiHandle = HiiAddPackages (
4934 &gSecureBootConfigFormSetGuid,
4935 DriverHandle,
4936 SecureBootConfigDxeStrings,
4937 SecureBootConfigBin,
4938 NULL
4939 );
4940 if (HiiHandle == NULL) {
4941 gBS->UninstallMultipleProtocolInterfaces (
4942 DriverHandle,
4943 &gEfiDevicePathProtocolGuid,
4944 &mSecureBootHiiVendorDevicePath,
4945 &gEfiHiiConfigAccessProtocolGuid,
4946 ConfigAccess,
4947 NULL
4948 );
4949 return EFI_OUT_OF_RESOURCES;
4950 }
4951
4952 PrivateData->HiiHandle = HiiHandle;
4953
4954 PrivateData->FileContext = AllocateZeroPool (sizeof (SECUREBOOT_FILE_CONTEXT));
4955
4956 if (PrivateData->FileContext == NULL) {
4957 UninstallSecureBootConfigForm (PrivateData);
4958 return EFI_OUT_OF_RESOURCES;
4959 }
4960
4961 //
4962 // Init OpCode Handle and Allocate space for creation of Buffer
4963 //
4964 mStartOpCodeHandle = HiiAllocateOpCodeHandle ();
4965 if (mStartOpCodeHandle == NULL) {
4966 UninstallSecureBootConfigForm (PrivateData);
4967 return EFI_OUT_OF_RESOURCES;
4968 }
4969
4970 mEndOpCodeHandle = HiiAllocateOpCodeHandle ();
4971 if (mEndOpCodeHandle == NULL) {
4972 UninstallSecureBootConfigForm (PrivateData);
4973 return EFI_OUT_OF_RESOURCES;
4974 }
4975
4976 //
4977 // Create Hii Extend Label OpCode as the start opcode
4978 //
4979 mStartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (
4980 mStartOpCodeHandle,
4981 &gEfiIfrTianoGuid,
4982 NULL,
4983 sizeof (EFI_IFR_GUID_LABEL)
4984 );
4985 mStartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
4986
4987 //
4988 // Create Hii Extend Label OpCode as the end opcode
4989 //
4990 mEndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (
4991 mEndOpCodeHandle,
4992 &gEfiIfrTianoGuid,
4993 NULL,
4994 sizeof (EFI_IFR_GUID_LABEL)
4995 );
4996 mEndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;
4997 mEndLabel->Number = LABEL_END;
4998
4999 return EFI_SUCCESS;
5000 }
5001
5002 /**
5003 This function removes SecureBoot configuration Form.
5004
5005 @param[in, out] PrivateData Points to SecureBoot configuration private data.
5006
5007 **/
5008 VOID
5009 UninstallSecureBootConfigForm (
5010 IN OUT SECUREBOOT_CONFIG_PRIVATE_DATA *PrivateData
5011 )
5012 {
5013 //
5014 // Uninstall HII package list
5015 //
5016 if (PrivateData->HiiHandle != NULL) {
5017 HiiRemovePackages (PrivateData->HiiHandle);
5018 PrivateData->HiiHandle = NULL;
5019 }
5020
5021 //
5022 // Uninstall HII Config Access Protocol
5023 //
5024 if (PrivateData->DriverHandle != NULL) {
5025 gBS->UninstallMultipleProtocolInterfaces (
5026 PrivateData->DriverHandle,
5027 &gEfiDevicePathProtocolGuid,
5028 &mSecureBootHiiVendorDevicePath,
5029 &gEfiHiiConfigAccessProtocolGuid,
5030 &PrivateData->ConfigAccess,
5031 NULL
5032 );
5033 PrivateData->DriverHandle = NULL;
5034 }
5035
5036 if (PrivateData->SignatureGUID != NULL) {
5037 FreePool (PrivateData->SignatureGUID);
5038 }
5039
5040 if (PrivateData->FileContext != NULL) {
5041 FreePool (PrivateData->FileContext);
5042 }
5043
5044 FreePool (PrivateData);
5045
5046 if (mStartOpCodeHandle != NULL) {
5047 HiiFreeOpCodeHandle (mStartOpCodeHandle);
5048 }
5049
5050 if (mEndOpCodeHandle != NULL) {
5051 HiiFreeOpCodeHandle (mEndOpCodeHandle);
5052 }
5053 }
EFI Development Kit II mirror for PVE