2 HII Config Access protocol implementation of SecureBoot configuration module.
4 Copyright (c) 2011 - 2016, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "SecureBootConfigImpl.h"
17 CHAR16 mSecureBootStorageName
[] = L
"SECUREBOOT_CONFIGURATION";
19 SECUREBOOT_CONFIG_PRIVATE_DATA mSecureBootConfigPrivateDateTemplate
= {
20 SECUREBOOT_CONFIG_PRIVATE_DATA_SIGNATURE
,
22 SecureBootExtractConfig
,
23 SecureBootRouteConfig
,
28 HII_VENDOR_DEVICE_PATH mSecureBootHiiVendorDevicePath
= {
34 (UINT8
) (sizeof (VENDOR_DEVICE_PATH
)),
35 (UINT8
) ((sizeof (VENDOR_DEVICE_PATH
)) >> 8)
38 SECUREBOOT_CONFIG_FORM_SET_GUID
42 END_ENTIRE_DEVICE_PATH_SUBTYPE
,
44 (UINT8
) (END_DEVICE_PATH_LENGTH
),
45 (UINT8
) ((END_DEVICE_PATH_LENGTH
) >> 8)
51 BOOLEAN mIsEnterSecureBootForm
= FALSE
;
54 // OID ASN.1 Value for Hash Algorithms
56 UINT8 mHashOidValue
[] = {
57 0x2A, 0x86, 0x48, 0x86, 0xF7, 0x0D, 0x02, 0x05, // OBJ_md5
58 0x2B, 0x0E, 0x03, 0x02, 0x1A, // OBJ_sha1
59 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x04, // OBJ_sha224
60 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x01, // OBJ_sha256
61 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x02, // OBJ_sha384
62 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x03, // OBJ_sha512
65 HASH_TABLE mHash
[] = {
66 { L
"SHA1", 20, &mHashOidValue
[8], 5, Sha1GetContextSize
, Sha1Init
, Sha1Update
, Sha1Final
},
67 { L
"SHA224", 28, &mHashOidValue
[13], 9, NULL
, NULL
, NULL
, NULL
},
68 { L
"SHA256", 32, &mHashOidValue
[22], 9, Sha256GetContextSize
, Sha256Init
, Sha256Update
, Sha256Final
},
69 { L
"SHA384", 48, &mHashOidValue
[31], 9, Sha384GetContextSize
, Sha384Init
, Sha384Update
, Sha384Final
},
70 { L
"SHA512", 64, &mHashOidValue
[40], 9, Sha512GetContextSize
, Sha512Init
, Sha512Update
, Sha512Final
}
74 // Variable Definitions
76 UINT32 mPeCoffHeaderOffset
= 0;
77 WIN_CERTIFICATE
*mCertificate
= NULL
;
78 IMAGE_TYPE mImageType
;
79 UINT8
*mImageBase
= NULL
;
81 UINT8 mImageDigest
[MAX_DIGEST_SIZE
];
82 UINTN mImageDigestSize
;
84 EFI_IMAGE_SECURITY_DATA_DIRECTORY
*mSecDataDir
= NULL
;
85 EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION mNtHeader
;
88 // Possible DER-encoded certificate file suffixes, end with NULL pointer.
90 CHAR16
* mDerEncodedSuffix
[] = {
96 CHAR16
* mSupportX509Suffix
= L
"*.cer/der/crt";
98 SECUREBOOT_CONFIG_PRIVATE_DATA
*gSecureBootPrivateData
= NULL
;
101 This code checks if the FileSuffix is one of the possible DER-encoded certificate suffix.
103 @param[in] FileSuffix The suffix of the input certificate file
105 @retval TRUE It's a DER-encoded certificate.
106 @retval FALSE It's NOT a DER-encoded certificate.
110 IsDerEncodeCertificate (
111 IN CONST CHAR16
*FileSuffix
115 for (Index
= 0; mDerEncodedSuffix
[Index
] != NULL
; Index
++) {
116 if (StrCmp (FileSuffix
, mDerEncodedSuffix
[Index
]) == 0) {
124 Set Secure Boot option into variable space.
126 @param[in] VarValue The option of Secure Boot.
128 @retval EFI_SUCCESS The operation is finished successfully.
129 @retval Others Other errors as indicated.
133 SaveSecureBootVariable (
139 Status
= gRT
->SetVariable (
140 EFI_SECURE_BOOT_ENABLE_NAME
,
141 &gEfiSecureBootEnableDisableGuid
,
142 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
150 Create a time based data payload by concatenating the EFI_VARIABLE_AUTHENTICATION_2
151 descriptor with the input data. NO authentication is required in this function.
153 @param[in, out] DataSize On input, the size of Data buffer in bytes.
154 On output, the size of data returned in Data
156 @param[in, out] Data On input, Pointer to data buffer to be wrapped or
157 pointer to NULL to wrap an empty payload.
158 On output, Pointer to the new payload date buffer allocated from pool,
159 it's caller's responsibility to free the memory when finish using it.
161 @retval EFI_SUCCESS Create time based payload successfully.
162 @retval EFI_OUT_OF_RESOURCES There are not enough memory resourses to create time based payload.
163 @retval EFI_INVALID_PARAMETER The parameter is invalid.
164 @retval Others Unexpected error happens.
168 CreateTimeBasedPayload (
169 IN OUT UINTN
*DataSize
,
177 EFI_VARIABLE_AUTHENTICATION_2
*DescriptorData
;
178 UINTN DescriptorSize
;
181 if (Data
== NULL
|| DataSize
== NULL
) {
182 return EFI_INVALID_PARAMETER
;
186 // In Setup mode or Custom mode, the variable does not need to be signed but the
187 // parameters to the SetVariable() call still need to be prepared as authenticated
188 // variable. So we create EFI_VARIABLE_AUTHENTICATED_2 descriptor without certificate
192 PayloadSize
= *DataSize
;
194 DescriptorSize
= OFFSET_OF (EFI_VARIABLE_AUTHENTICATION_2
, AuthInfo
) + OFFSET_OF (WIN_CERTIFICATE_UEFI_GUID
, CertData
);
195 NewData
= (UINT8
*) AllocateZeroPool (DescriptorSize
+ PayloadSize
);
196 if (NewData
== NULL
) {
197 return EFI_OUT_OF_RESOURCES
;
200 if ((Payload
!= NULL
) && (PayloadSize
!= 0)) {
201 CopyMem (NewData
+ DescriptorSize
, Payload
, PayloadSize
);
204 DescriptorData
= (EFI_VARIABLE_AUTHENTICATION_2
*) (NewData
);
206 ZeroMem (&Time
, sizeof (EFI_TIME
));
207 Status
= gRT
->GetTime (&Time
, NULL
);
208 if (EFI_ERROR (Status
)) {
217 CopyMem (&DescriptorData
->TimeStamp
, &Time
, sizeof (EFI_TIME
));
219 DescriptorData
->AuthInfo
.Hdr
.dwLength
= OFFSET_OF (WIN_CERTIFICATE_UEFI_GUID
, CertData
);
220 DescriptorData
->AuthInfo
.Hdr
.wRevision
= 0x0200;
221 DescriptorData
->AuthInfo
.Hdr
.wCertificateType
= WIN_CERT_TYPE_EFI_GUID
;
222 CopyGuid (&DescriptorData
->AuthInfo
.CertType
, &gEfiCertPkcs7Guid
);
224 if (Payload
!= NULL
) {
228 *DataSize
= DescriptorSize
+ PayloadSize
;
234 Internal helper function to delete a Variable given its name and GUID, NO authentication
237 @param[in] VariableName Name of the Variable.
238 @param[in] VendorGuid GUID of the Variable.
240 @retval EFI_SUCCESS Variable deleted successfully.
241 @retval Others The driver failed to start the device.
246 IN CHAR16
*VariableName
,
247 IN EFI_GUID
*VendorGuid
256 GetVariable2 (VariableName
, VendorGuid
, &Variable
, NULL
);
257 if (Variable
== NULL
) {
264 Attr
= EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_BOOTSERVICE_ACCESS
265 | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
;
267 Status
= CreateTimeBasedPayload (&DataSize
, &Data
);
268 if (EFI_ERROR (Status
)) {
269 DEBUG ((EFI_D_ERROR
, "Fail to create time-based data payload: %r", Status
));
273 Status
= gRT
->SetVariable (
288 Set the platform secure boot mode into "Custom" or "Standard" mode.
290 @param[in] SecureBootMode New secure boot mode: STANDARD_SECURE_BOOT_MODE or
291 CUSTOM_SECURE_BOOT_MODE.
293 @return EFI_SUCCESS The platform has switched to the special mode successfully.
294 @return other Fail to operate the secure boot mode.
299 IN UINT8 SecureBootMode
302 return gRT
->SetVariable (
303 EFI_CUSTOM_MODE_NAME
,
304 &gEfiCustomModeEnableGuid
,
305 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,
312 Generate the PK signature list from the X509 Certificate storing file (.cer)
314 @param[in] X509File FileHandle of X509 Certificate storing file.
315 @param[out] PkCert Point to the data buffer to store the signature list.
317 @return EFI_UNSUPPORTED Unsupported Key Length.
318 @return EFI_OUT_OF_RESOURCES There are not enough memory resourses to form the signature list.
322 CreatePkX509SignatureList (
323 IN EFI_FILE_HANDLE X509File
,
324 OUT EFI_SIGNATURE_LIST
**PkCert
330 EFI_SIGNATURE_DATA
*PkCertData
;
336 Status
= ReadFileContent (X509File
, (VOID
**) &X509Data
, &X509DataSize
, 0);
337 if (EFI_ERROR (Status
)) {
340 ASSERT (X509Data
!= NULL
);
343 // Allocate space for PK certificate list and initialize it.
344 // Create PK database entry with SignatureHeaderSize equals 0.
346 *PkCert
= (EFI_SIGNATURE_LIST
*) AllocateZeroPool (
347 sizeof(EFI_SIGNATURE_LIST
) + sizeof(EFI_SIGNATURE_DATA
) - 1
350 if (*PkCert
== NULL
) {
351 Status
= EFI_OUT_OF_RESOURCES
;
355 (*PkCert
)->SignatureListSize
= (UINT32
) (sizeof(EFI_SIGNATURE_LIST
)
356 + sizeof(EFI_SIGNATURE_DATA
) - 1
358 (*PkCert
)->SignatureSize
= (UINT32
) (sizeof(EFI_SIGNATURE_DATA
) - 1 + X509DataSize
);
359 (*PkCert
)->SignatureHeaderSize
= 0;
360 CopyGuid (&(*PkCert
)->SignatureType
, &gEfiCertX509Guid
);
361 PkCertData
= (EFI_SIGNATURE_DATA
*) ((UINTN
)(*PkCert
)
362 + sizeof(EFI_SIGNATURE_LIST
)
363 + (*PkCert
)->SignatureHeaderSize
);
364 CopyGuid (&PkCertData
->SignatureOwner
, &gEfiGlobalVariableGuid
);
366 // Fill the PK database with PKpub data from X509 certificate file.
368 CopyMem (&(PkCertData
->SignatureData
[0]), X509Data
, X509DataSize
);
372 if (X509Data
!= NULL
) {
376 if (EFI_ERROR(Status
) && *PkCert
!= NULL
) {
385 Enroll new PK into the System without original PK's authentication.
387 The SignatureOwner GUID will be the same with PK's vendorguid.
389 @param[in] PrivateData The module's private data.
391 @retval EFI_SUCCESS New PK enrolled successfully.
392 @retval EFI_INVALID_PARAMETER The parameter is invalid.
393 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
398 IN SECUREBOOT_CONFIG_PRIVATE_DATA
* Private
404 EFI_SIGNATURE_LIST
*PkCert
;
408 if (Private
->FileContext
->FileName
== NULL
) {
409 return EFI_INVALID_PARAMETER
;
414 Status
= SetSecureBootMode(CUSTOM_SECURE_BOOT_MODE
);
415 if (EFI_ERROR (Status
)) {
420 // Parse the file's postfix. Only support DER encoded X.509 certificate files.
422 NameLength
= StrLen (Private
->FileContext
->FileName
);
423 if (NameLength
<= 4) {
424 return EFI_INVALID_PARAMETER
;
426 FilePostFix
= Private
->FileContext
->FileName
+ NameLength
- 4;
427 if (!IsDerEncodeCertificate(FilePostFix
)) {
428 DEBUG ((EFI_D_ERROR
, "Unsupported file type, only DER encoded certificate (%s) is supported.", mSupportX509Suffix
));
429 return EFI_INVALID_PARAMETER
;
431 DEBUG ((EFI_D_INFO
, "FileName= %s\n", Private
->FileContext
->FileName
));
432 DEBUG ((EFI_D_INFO
, "FilePostFix = %s\n", FilePostFix
));
435 // Prase the selected PK file and generature PK certificate list.
437 Status
= CreatePkX509SignatureList (
438 Private
->FileContext
->FHandle
,
441 if (EFI_ERROR (Status
)) {
444 ASSERT (PkCert
!= NULL
);
447 // Set Platform Key variable.
449 Attr
= EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_RUNTIME_ACCESS
450 | EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
;
451 DataSize
= PkCert
->SignatureListSize
;
452 Status
= CreateTimeBasedPayload (&DataSize
, (UINT8
**) &PkCert
);
453 if (EFI_ERROR (Status
)) {
454 DEBUG ((EFI_D_ERROR
, "Fail to create time-based data payload: %r", Status
));
458 Status
= gRT
->SetVariable(
459 EFI_PLATFORM_KEY_NAME
,
460 &gEfiGlobalVariableGuid
,
465 if (EFI_ERROR (Status
)) {
466 if (Status
== EFI_OUT_OF_RESOURCES
) {
467 DEBUG ((EFI_D_ERROR
, "Enroll PK failed with out of resource.\n"));
474 if (PkCert
!= NULL
) {
478 if (Private
->FileContext
->FHandle
!= NULL
) {
479 CloseFile (Private
->FileContext
->FHandle
);
480 Private
->FileContext
->FHandle
= NULL
;
487 Remove the PK variable.
489 @retval EFI_SUCCESS Delete PK successfully.
490 @retval Others Could not allow to delete PK.
500 Status
= SetSecureBootMode(CUSTOM_SECURE_BOOT_MODE
);
501 if (EFI_ERROR (Status
)) {
505 Status
= DeleteVariable (
506 EFI_PLATFORM_KEY_NAME
,
507 &gEfiGlobalVariableGuid
513 Enroll a new KEK item from public key storing file (*.pbk).
515 @param[in] PrivateData The module's private data.
517 @retval EFI_SUCCESS New KEK enrolled successfully.
518 @retval EFI_INVALID_PARAMETER The parameter is invalid.
519 @retval EFI_UNSUPPORTED Unsupported command.
520 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
525 IN SECUREBOOT_CONFIG_PRIVATE_DATA
*Private
531 EFI_SIGNATURE_LIST
*KekSigList
;
534 CPL_KEY_INFO
*KeyInfo
;
535 EFI_SIGNATURE_DATA
*KEKSigData
;
536 UINTN KekSigListSize
;
551 // Form the KeKpub certificate list into EFI_SIGNATURE_LIST type.
552 // First, We have to parse out public key data from the pbk key file.
554 Status
= ReadFileContent (
555 Private
->FileContext
->FHandle
,
560 if (EFI_ERROR (Status
)) {
563 ASSERT (KeyBlob
!= NULL
);
564 KeyInfo
= (CPL_KEY_INFO
*) KeyBlob
;
565 if (KeyInfo
->KeyLengthInBits
/ 8 != WIN_CERT_UEFI_RSA2048_SIZE
) {
566 DEBUG ((DEBUG_ERROR
, "Unsupported key length, Only RSA2048 is supported.\n"));
567 Status
= EFI_UNSUPPORTED
;
572 // Convert the Public key to fix octet string format represented in RSA PKCS#1.
574 KeyLenInBytes
= KeyInfo
->KeyLengthInBits
/ 8;
575 KeyBuffer
= AllocateZeroPool (KeyLenInBytes
);
576 if (KeyBuffer
== NULL
) {
577 Status
= EFI_OUT_OF_RESOURCES
;
581 (UINTN
*) (KeyBlob
+ sizeof (CPL_KEY_INFO
)),
582 KeyLenInBytes
/ sizeof (UINTN
),
586 CopyMem(KeyBlob
+ sizeof(CPL_KEY_INFO
), KeyBuffer
, KeyLenInBytes
);
589 // Form an new EFI_SIGNATURE_LIST.
591 KekSigListSize
= sizeof(EFI_SIGNATURE_LIST
)
592 + sizeof(EFI_SIGNATURE_DATA
) - 1
593 + WIN_CERT_UEFI_RSA2048_SIZE
;
595 KekSigList
= (EFI_SIGNATURE_LIST
*) AllocateZeroPool (KekSigListSize
);
596 if (KekSigList
== NULL
) {
597 Status
= EFI_OUT_OF_RESOURCES
;
601 KekSigList
->SignatureListSize
= sizeof(EFI_SIGNATURE_LIST
)
602 + sizeof(EFI_SIGNATURE_DATA
) - 1
603 + WIN_CERT_UEFI_RSA2048_SIZE
;
604 KekSigList
->SignatureHeaderSize
= 0;
605 KekSigList
->SignatureSize
= sizeof(EFI_SIGNATURE_DATA
) - 1 + WIN_CERT_UEFI_RSA2048_SIZE
;
606 CopyGuid (&KekSigList
->SignatureType
, &gEfiCertRsa2048Guid
);
608 KEKSigData
= (EFI_SIGNATURE_DATA
*)((UINT8
*)KekSigList
+ sizeof(EFI_SIGNATURE_LIST
));
609 CopyGuid (&KEKSigData
->SignatureOwner
, Private
->SignatureGUID
);
611 KEKSigData
->SignatureData
,
612 KeyBlob
+ sizeof(CPL_KEY_INFO
),
613 WIN_CERT_UEFI_RSA2048_SIZE
617 // Check if KEK entry has been already existed.
618 // If true, use EFI_VARIABLE_APPEND_WRITE attribute to append the
619 // new KEK to original variable.
621 Attr
= EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_RUNTIME_ACCESS
622 | EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
;
623 Status
= CreateTimeBasedPayload (&KekSigListSize
, (UINT8
**) &KekSigList
);
624 if (EFI_ERROR (Status
)) {
625 DEBUG ((EFI_D_ERROR
, "Fail to create time-based data payload: %r", Status
));
629 Status
= gRT
->GetVariable(
630 EFI_KEY_EXCHANGE_KEY_NAME
,
631 &gEfiGlobalVariableGuid
,
636 if (Status
== EFI_BUFFER_TOO_SMALL
) {
637 Attr
|= EFI_VARIABLE_APPEND_WRITE
;
638 } else if (Status
!= EFI_NOT_FOUND
) {
643 // Done. Now we have formed the correct KEKpub database item, just set it into variable storage,
645 Status
= gRT
->SetVariable(
646 EFI_KEY_EXCHANGE_KEY_NAME
,
647 &gEfiGlobalVariableGuid
,
652 if (EFI_ERROR (Status
)) {
658 CloseFile (Private
->FileContext
->FHandle
);
659 Private
->FileContext
->FHandle
= NULL
;
661 if (Private
->FileContext
->FileName
!= NULL
){
662 FreePool(Private
->FileContext
->FileName
);
663 Private
->FileContext
->FileName
= NULL
;
666 if (Private
->SignatureGUID
!= NULL
) {
667 FreePool (Private
->SignatureGUID
);
668 Private
->SignatureGUID
= NULL
;
671 if (KeyBlob
!= NULL
) {
674 if (KeyBuffer
!= NULL
) {
675 FreePool (KeyBuffer
);
677 if (KekSigList
!= NULL
) {
678 FreePool (KekSigList
);
685 Enroll a new KEK item from X509 certificate file.
687 @param[in] PrivateData The module's private data.
689 @retval EFI_SUCCESS New X509 is enrolled successfully.
690 @retval EFI_INVALID_PARAMETER The parameter is invalid.
691 @retval EFI_UNSUPPORTED Unsupported command.
692 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
697 IN SECUREBOOT_CONFIG_PRIVATE_DATA
*Private
703 EFI_SIGNATURE_DATA
*KEKSigData
;
704 EFI_SIGNATURE_LIST
*KekSigList
;
706 UINTN KekSigListSize
;
716 Status
= ReadFileContent (
717 Private
->FileContext
->FHandle
,
722 if (EFI_ERROR (Status
)) {
725 ASSERT (X509Data
!= NULL
);
727 KekSigListSize
= sizeof(EFI_SIGNATURE_LIST
) + sizeof(EFI_SIGNATURE_DATA
) - 1 + X509DataSize
;
728 KekSigList
= (EFI_SIGNATURE_LIST
*) AllocateZeroPool (KekSigListSize
);
729 if (KekSigList
== NULL
) {
730 Status
= EFI_OUT_OF_RESOURCES
;
735 // Fill Certificate Database parameters.
737 KekSigList
->SignatureListSize
= (UINT32
) KekSigListSize
;
738 KekSigList
->SignatureHeaderSize
= 0;
739 KekSigList
->SignatureSize
= (UINT32
) (sizeof(EFI_SIGNATURE_DATA
) - 1 + X509DataSize
);
740 CopyGuid (&KekSigList
->SignatureType
, &gEfiCertX509Guid
);
742 KEKSigData
= (EFI_SIGNATURE_DATA
*) ((UINT8
*) KekSigList
+ sizeof (EFI_SIGNATURE_LIST
));
743 CopyGuid (&KEKSigData
->SignatureOwner
, Private
->SignatureGUID
);
744 CopyMem (KEKSigData
->SignatureData
, X509Data
, X509DataSize
);
747 // Check if KEK been already existed.
748 // If true, use EFI_VARIABLE_APPEND_WRITE attribute to append the
749 // new kek to original variable
751 Attr
= EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_RUNTIME_ACCESS
752 | EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
;
753 Status
= CreateTimeBasedPayload (&KekSigListSize
, (UINT8
**) &KekSigList
);
754 if (EFI_ERROR (Status
)) {
755 DEBUG ((EFI_D_ERROR
, "Fail to create time-based data payload: %r", Status
));
759 Status
= gRT
->GetVariable(
760 EFI_KEY_EXCHANGE_KEY_NAME
,
761 &gEfiGlobalVariableGuid
,
766 if (Status
== EFI_BUFFER_TOO_SMALL
) {
767 Attr
|= EFI_VARIABLE_APPEND_WRITE
;
768 } else if (Status
!= EFI_NOT_FOUND
) {
772 Status
= gRT
->SetVariable(
773 EFI_KEY_EXCHANGE_KEY_NAME
,
774 &gEfiGlobalVariableGuid
,
779 if (EFI_ERROR (Status
)) {
785 CloseFile (Private
->FileContext
->FHandle
);
786 if (Private
->FileContext
->FileName
!= NULL
){
787 FreePool(Private
->FileContext
->FileName
);
788 Private
->FileContext
->FileName
= NULL
;
791 Private
->FileContext
->FHandle
= NULL
;
793 if (Private
->SignatureGUID
!= NULL
) {
794 FreePool (Private
->SignatureGUID
);
795 Private
->SignatureGUID
= NULL
;
798 if (KekSigList
!= NULL
) {
799 FreePool (KekSigList
);
806 Enroll new KEK into the System without PK's authentication.
807 The SignatureOwner GUID will be Private->SignatureGUID.
809 @param[in] PrivateData The module's private data.
811 @retval EFI_SUCCESS New KEK enrolled successful.
812 @retval EFI_INVALID_PARAMETER The parameter is invalid.
813 @retval others Fail to enroll KEK data.
817 EnrollKeyExchangeKey (
818 IN SECUREBOOT_CONFIG_PRIVATE_DATA
*Private
825 if ((Private
->FileContext
->FileName
== NULL
) || (Private
->SignatureGUID
== NULL
)) {
826 return EFI_INVALID_PARAMETER
;
829 Status
= SetSecureBootMode(CUSTOM_SECURE_BOOT_MODE
);
830 if (EFI_ERROR (Status
)) {
835 // Parse the file's postfix. Supports DER-encoded X509 certificate,
836 // and .pbk as RSA public key file.
838 NameLength
= StrLen (Private
->FileContext
->FileName
);
839 if (NameLength
<= 4) {
840 return EFI_INVALID_PARAMETER
;
842 FilePostFix
= Private
->FileContext
->FileName
+ NameLength
- 4;
843 if (IsDerEncodeCertificate(FilePostFix
)) {
844 return EnrollX509ToKek (Private
);
845 } else if (CompareMem (FilePostFix
, L
".pbk",4) == 0) {
846 return EnrollRsa2048ToKek (Private
);
848 return EFI_INVALID_PARAMETER
;
853 Enroll a new X509 certificate into Signature Database (DB or DBX or DBT) without
854 KEK's authentication.
856 @param[in] PrivateData The module's private data.
857 @param[in] VariableName Variable name of signature database, must be
858 EFI_IMAGE_SECURITY_DATABASE or EFI_IMAGE_SECURITY_DATABASE1.
860 @retval EFI_SUCCESS New X509 is enrolled successfully.
861 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
866 IN SECUREBOOT_CONFIG_PRIVATE_DATA
*Private
,
867 IN CHAR16
*VariableName
873 EFI_SIGNATURE_LIST
*SigDBCert
;
874 EFI_SIGNATURE_DATA
*SigDBCertData
;
885 SigDBCertData
= NULL
;
888 Status
= ReadFileContent (
889 Private
->FileContext
->FHandle
,
894 if (EFI_ERROR (Status
)) {
897 ASSERT (X509Data
!= NULL
);
899 SigDBSize
= sizeof(EFI_SIGNATURE_LIST
) + sizeof(EFI_SIGNATURE_DATA
) - 1 + X509DataSize
;
901 Data
= AllocateZeroPool (SigDBSize
);
903 Status
= EFI_OUT_OF_RESOURCES
;
908 // Fill Certificate Database parameters.
910 SigDBCert
= (EFI_SIGNATURE_LIST
*) Data
;
911 SigDBCert
->SignatureListSize
= (UINT32
) SigDBSize
;
912 SigDBCert
->SignatureHeaderSize
= 0;
913 SigDBCert
->SignatureSize
= (UINT32
) (sizeof(EFI_SIGNATURE_DATA
) - 1 + X509DataSize
);
914 CopyGuid (&SigDBCert
->SignatureType
, &gEfiCertX509Guid
);
916 SigDBCertData
= (EFI_SIGNATURE_DATA
*) ((UINT8
* ) SigDBCert
+ sizeof (EFI_SIGNATURE_LIST
));
917 CopyGuid (&SigDBCertData
->SignatureOwner
, Private
->SignatureGUID
);
918 CopyMem ((UINT8
* ) (SigDBCertData
->SignatureData
), X509Data
, X509DataSize
);
921 // Check if signature database entry has been already existed.
922 // If true, use EFI_VARIABLE_APPEND_WRITE attribute to append the
923 // new signature data to original variable
925 Attr
= EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_RUNTIME_ACCESS
926 | EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
;
927 Status
= CreateTimeBasedPayload (&SigDBSize
, (UINT8
**) &Data
);
928 if (EFI_ERROR (Status
)) {
929 DEBUG ((EFI_D_ERROR
, "Fail to create time-based data payload: %r", Status
));
933 Status
= gRT
->GetVariable(
935 &gEfiImageSecurityDatabaseGuid
,
940 if (Status
== EFI_BUFFER_TOO_SMALL
) {
941 Attr
|= EFI_VARIABLE_APPEND_WRITE
;
942 } else if (Status
!= EFI_NOT_FOUND
) {
946 Status
= gRT
->SetVariable(
948 &gEfiImageSecurityDatabaseGuid
,
953 if (EFI_ERROR (Status
)) {
959 CloseFile (Private
->FileContext
->FHandle
);
960 if (Private
->FileContext
->FileName
!= NULL
){
961 FreePool(Private
->FileContext
->FileName
);
962 Private
->FileContext
->FileName
= NULL
;
965 Private
->FileContext
->FHandle
= NULL
;
967 if (Private
->SignatureGUID
!= NULL
) {
968 FreePool (Private
->SignatureGUID
);
969 Private
->SignatureGUID
= NULL
;
976 if (X509Data
!= NULL
) {
984 Check whether signature is in specified database.
986 @param[in] VariableName Name of database variable that is searched in.
987 @param[in] Signature Pointer to signature that is searched for.
988 @param[in] SignatureSize Size of Signature.
990 @return TRUE Found the signature in the variable database.
991 @return FALSE Not found the signature in the variable database.
995 IsSignatureFoundInDatabase (
996 IN CHAR16
*VariableName
,
998 IN UINTN SignatureSize
1002 EFI_SIGNATURE_LIST
*CertList
;
1003 EFI_SIGNATURE_DATA
*Cert
;
1011 // Read signature database variable.
1016 Status
= gRT
->GetVariable (VariableName
, &gEfiImageSecurityDatabaseGuid
, NULL
, &DataSize
, NULL
);
1017 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
1021 Data
= (UINT8
*) AllocateZeroPool (DataSize
);
1026 Status
= gRT
->GetVariable (VariableName
, &gEfiImageSecurityDatabaseGuid
, NULL
, &DataSize
, Data
);
1027 if (EFI_ERROR (Status
)) {
1032 // Enumerate all signature data in SigDB to check if executable's signature exists.
1034 CertList
= (EFI_SIGNATURE_LIST
*) Data
;
1035 while ((DataSize
> 0) && (DataSize
>= CertList
->SignatureListSize
)) {
1036 CertCount
= (CertList
->SignatureListSize
- sizeof (EFI_SIGNATURE_LIST
) - CertList
->SignatureHeaderSize
) / CertList
->SignatureSize
;
1037 Cert
= (EFI_SIGNATURE_DATA
*) ((UINT8
*) CertList
+ sizeof (EFI_SIGNATURE_LIST
) + CertList
->SignatureHeaderSize
);
1038 if ((CertList
->SignatureSize
== sizeof(EFI_SIGNATURE_DATA
) - 1 + SignatureSize
) && (CompareGuid(&CertList
->SignatureType
, &gEfiCertX509Guid
))) {
1039 for (Index
= 0; Index
< CertCount
; Index
++) {
1040 if (CompareMem (Cert
->SignatureData
, Signature
, SignatureSize
) == 0) {
1042 // Find the signature in database.
1047 Cert
= (EFI_SIGNATURE_DATA
*) ((UINT8
*) Cert
+ CertList
->SignatureSize
);
1055 DataSize
-= CertList
->SignatureListSize
;
1056 CertList
= (EFI_SIGNATURE_LIST
*) ((UINT8
*) CertList
+ CertList
->SignatureListSize
);
1068 Calculate the hash of a certificate data with the specified hash algorithm.
1070 @param[in] CertData The certificate data to be hashed.
1071 @param[in] CertSize The certificate size in bytes.
1072 @param[in] HashAlg The specified hash algorithm.
1073 @param[out] CertHash The output digest of the certificate
1075 @retval TRUE Successfully got the hash of the CertData.
1076 @retval FALSE Failed to get the hash of CertData.
1096 if (HashAlg
>= HASHALG_MAX
) {
1101 // Retrieve the TBSCertificate for Hash Calculation.
1103 if (!X509GetTBSCert (CertData
, CertSize
, &TBSCert
, &TBSCertSize
)) {
1108 // 1. Initialize context of hash.
1110 CtxSize
= mHash
[HashAlg
].GetContextSize ();
1111 HashCtx
= AllocatePool (CtxSize
);
1112 ASSERT (HashCtx
!= NULL
);
1115 // 2. Initialize a hash context.
1117 Status
= mHash
[HashAlg
].HashInit (HashCtx
);
1123 // 3. Calculate the hash.
1125 Status
= mHash
[HashAlg
].HashUpdate (HashCtx
, TBSCert
, TBSCertSize
);
1131 // 4. Get the hash result.
1133 ZeroMem (CertHash
, mHash
[HashAlg
].DigestLength
);
1134 Status
= mHash
[HashAlg
].HashFinal (HashCtx
, CertHash
);
1137 if (HashCtx
!= NULL
) {
1145 Check whether the hash of an X.509 certificate is in forbidden database (DBX).
1147 @param[in] Certificate Pointer to X.509 Certificate that is searched for.
1148 @param[in] CertSize Size of X.509 Certificate.
1150 @return TRUE Found the certificate hash in the forbidden database.
1151 @return FALSE Certificate hash is Not found in the forbidden database.
1155 IsCertHashFoundInDbx (
1156 IN UINT8
*Certificate
,
1162 EFI_SIGNATURE_LIST
*DbxList
;
1163 EFI_SIGNATURE_DATA
*CertHash
;
1164 UINTN CertHashCount
;
1167 UINT8 CertDigest
[MAX_DIGEST_SIZE
];
1169 UINTN SiglistHeaderSize
;
1174 HashAlg
= HASHALG_MAX
;
1178 // Read signature database variable.
1181 Status
= gRT
->GetVariable (EFI_IMAGE_SECURITY_DATABASE1
, &gEfiImageSecurityDatabaseGuid
, NULL
, &DataSize
, NULL
);
1182 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
1186 Data
= (UINT8
*) AllocateZeroPool (DataSize
);
1191 Status
= gRT
->GetVariable (EFI_IMAGE_SECURITY_DATABASE1
, &gEfiImageSecurityDatabaseGuid
, NULL
, &DataSize
, Data
);
1192 if (EFI_ERROR (Status
)) {
1197 // Check whether the certificate hash exists in the forbidden database.
1199 DbxList
= (EFI_SIGNATURE_LIST
*) Data
;
1200 while ((DataSize
> 0) && (DataSize
>= DbxList
->SignatureListSize
)) {
1202 // Determine Hash Algorithm of Certificate in the forbidden database.
1204 if (CompareGuid (&DbxList
->SignatureType
, &gEfiCertX509Sha256Guid
)) {
1205 HashAlg
= HASHALG_SHA256
;
1206 } else if (CompareGuid (&DbxList
->SignatureType
, &gEfiCertX509Sha384Guid
)) {
1207 HashAlg
= HASHALG_SHA384
;
1208 } else if (CompareGuid (&DbxList
->SignatureType
, &gEfiCertX509Sha512Guid
)) {
1209 HashAlg
= HASHALG_SHA512
;
1211 DataSize
-= DbxList
->SignatureListSize
;
1212 DbxList
= (EFI_SIGNATURE_LIST
*) ((UINT8
*) DbxList
+ DbxList
->SignatureListSize
);
1217 // Calculate the hash value of current db certificate for comparision.
1219 if (!CalculateCertHash (Certificate
, CertSize
, HashAlg
, CertDigest
)) {
1223 SiglistHeaderSize
= sizeof (EFI_SIGNATURE_LIST
) + DbxList
->SignatureHeaderSize
;
1224 CertHash
= (EFI_SIGNATURE_DATA
*) ((UINT8
*) DbxList
+ SiglistHeaderSize
);
1225 CertHashCount
= (DbxList
->SignatureListSize
- SiglistHeaderSize
) / DbxList
->SignatureSize
;
1226 for (Index
= 0; Index
< CertHashCount
; Index
++) {
1228 // Iterate each Signature Data Node within this CertList for verify.
1230 DbxCertHash
= CertHash
->SignatureData
;
1231 if (CompareMem (DbxCertHash
, CertDigest
, mHash
[HashAlg
].DigestLength
) == 0) {
1233 // Hash of Certificate is found in forbidden database.
1238 CertHash
= (EFI_SIGNATURE_DATA
*) ((UINT8
*) CertHash
+ DbxList
->SignatureSize
);
1241 DataSize
-= DbxList
->SignatureListSize
;
1242 DbxList
= (EFI_SIGNATURE_LIST
*) ((UINT8
*) DbxList
+ DbxList
->SignatureListSize
);
1254 Check whether the signature list exists in given variable data.
1256 It searches the signature list for the ceritificate hash by CertType.
1257 If the signature list is found, get the offset of Database for the
1258 next hash of a certificate.
1260 @param[in] Database Variable data to save signature list.
1261 @param[in] DatabaseSize Variable size.
1262 @param[in] SignatureType The type of the signature.
1263 @param[out] Offset The offset to save a new hash of certificate.
1265 @return TRUE The signature list is found in the forbidden database.
1266 @return FALSE The signature list is not found in the forbidden database.
1269 GetSignaturelistOffset (
1270 IN EFI_SIGNATURE_LIST
*Database
,
1271 IN UINTN DatabaseSize
,
1272 IN EFI_GUID
*SignatureType
,
1276 EFI_SIGNATURE_LIST
*SigList
;
1279 if ((Database
== NULL
) || (DatabaseSize
== 0)) {
1285 SiglistSize
= DatabaseSize
;
1286 while ((SiglistSize
> 0) && (SiglistSize
>= SigList
->SignatureListSize
)) {
1287 if (CompareGuid (&SigList
->SignatureType
, SignatureType
)) {
1288 *Offset
= DatabaseSize
- SiglistSize
;
1291 SiglistSize
-= SigList
->SignatureListSize
;
1292 SigList
= (EFI_SIGNATURE_LIST
*) ((UINT8
*) SigList
+ SigList
->SignatureListSize
);
1299 Enroll a new X509 certificate hash into Signature Database (dbx) without
1300 KEK's authentication.
1302 @param[in] PrivateData The module's private data.
1303 @param[in] HashAlg The hash algorithm to enroll the certificate.
1304 @param[in] RevocationDate The revocation date of the certificate.
1305 @param[in] RevocationTime The revocation time of the certificate.
1306 @param[in] AlwaysRevocation Indicate whether the certificate is always revoked.
1308 @retval EFI_SUCCESS New X509 is enrolled successfully.
1309 @retval EFI_INVALID_PARAMETER The parameter is invalid.
1310 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
1314 EnrollX509HashtoSigDB (
1315 IN SECUREBOOT_CONFIG_PRIVATE_DATA
*Private
,
1317 IN EFI_HII_DATE
*RevocationDate
,
1318 IN EFI_HII_TIME
*RevocationTime
,
1319 IN BOOLEAN AlwaysRevocation
1325 EFI_SIGNATURE_LIST
*SignatureList
;
1326 UINTN SignatureListSize
;
1332 EFI_SIGNATURE_DATA
*SignatureData
;
1333 UINTN SignatureSize
;
1334 EFI_GUID SignatureType
;
1336 UINT8 CertHash
[MAX_DIGEST_SIZE
];
1337 UINT16
* FilePostFix
;
1344 SignatureData
= NULL
;
1345 SignatureList
= NULL
;
1349 if ((Private
->FileContext
->FileName
== NULL
) || (Private
->FileContext
->FHandle
== NULL
) || (Private
->SignatureGUID
== NULL
)) {
1350 return EFI_INVALID_PARAMETER
;
1353 Status
= SetSecureBootMode (CUSTOM_SECURE_BOOT_MODE
);
1354 if (EFI_ERROR (Status
)) {
1359 // Parse the file's postfix.
1361 NameLength
= StrLen (Private
->FileContext
->FileName
);
1362 if (NameLength
<= 4) {
1363 return EFI_INVALID_PARAMETER
;
1365 FilePostFix
= Private
->FileContext
->FileName
+ NameLength
- 4;
1366 if (!IsDerEncodeCertificate(FilePostFix
)) {
1368 // Only supports DER-encoded X509 certificate.
1370 return EFI_INVALID_PARAMETER
;
1374 // Get the certificate from file and calculate its hash.
1376 Status
= ReadFileContent (
1377 Private
->FileContext
->FHandle
,
1382 if (EFI_ERROR (Status
)) {
1385 ASSERT (X509Data
!= NULL
);
1387 if (!CalculateCertHash (X509Data
, X509DataSize
, HashAlg
, CertHash
)) {
1392 // Get the variable for enrollment.
1395 Status
= gRT
->GetVariable (EFI_IMAGE_SECURITY_DATABASE1
, &gEfiImageSecurityDatabaseGuid
, NULL
, &DataSize
, NULL
);
1396 if (Status
== EFI_BUFFER_TOO_SMALL
) {
1397 Data
= (UINT8
*) AllocateZeroPool (DataSize
);
1399 return EFI_OUT_OF_RESOURCES
;
1402 Status
= gRT
->GetVariable (EFI_IMAGE_SECURITY_DATABASE1
, &gEfiImageSecurityDatabaseGuid
, NULL
, &DataSize
, Data
);
1403 if (EFI_ERROR (Status
)) {
1409 // Allocate memory for Signature and fill the Signature
1411 SignatureSize
= sizeof(EFI_SIGNATURE_DATA
) - 1 + sizeof (EFI_TIME
) + mHash
[HashAlg
].DigestLength
;
1412 SignatureData
= (EFI_SIGNATURE_DATA
*) AllocateZeroPool (SignatureSize
);
1413 if (SignatureData
== NULL
) {
1414 return EFI_OUT_OF_RESOURCES
;
1416 CopyGuid (&SignatureData
->SignatureOwner
, Private
->SignatureGUID
);
1417 CopyMem (SignatureData
->SignatureData
, CertHash
, mHash
[HashAlg
].DigestLength
);
1422 if (!AlwaysRevocation
) {
1423 Time
= (EFI_TIME
*)(&SignatureData
->SignatureData
+ mHash
[HashAlg
].DigestLength
);
1424 Time
->Year
= RevocationDate
->Year
;
1425 Time
->Month
= RevocationDate
->Month
;
1426 Time
->Day
= RevocationDate
->Day
;
1427 Time
->Hour
= RevocationTime
->Hour
;
1428 Time
->Minute
= RevocationTime
->Minute
;
1429 Time
->Second
= RevocationTime
->Second
;
1433 // Determine the GUID for certificate hash.
1436 case HASHALG_SHA256
:
1437 SignatureType
= gEfiCertX509Sha256Guid
;
1439 case HASHALG_SHA384
:
1440 SignatureType
= gEfiCertX509Sha384Guid
;
1442 case HASHALG_SHA512
:
1443 SignatureType
= gEfiCertX509Sha512Guid
;
1450 // Add signature into the new variable data buffer
1452 if (GetSignaturelistOffset((EFI_SIGNATURE_LIST
*)Data
, DataSize
, &SignatureType
, &Offset
)) {
1454 // Add the signature to the found signaturelist.
1456 DbSize
= DataSize
+ SignatureSize
;
1457 NewData
= AllocateZeroPool (DbSize
);
1458 if (NewData
== NULL
) {
1459 Status
= EFI_OUT_OF_RESOURCES
;
1463 SignatureList
= (EFI_SIGNATURE_LIST
*)(Data
+ Offset
);
1464 SignatureListSize
= (UINTN
) ReadUnaligned32 ((UINT32
*)&SignatureList
->SignatureListSize
);
1465 CopyMem (NewData
, Data
, Offset
+ SignatureListSize
);
1467 SignatureList
= (EFI_SIGNATURE_LIST
*)(NewData
+ Offset
);
1468 WriteUnaligned32 ((UINT32
*) &SignatureList
->SignatureListSize
, (UINT32
)(SignatureListSize
+ SignatureSize
));
1470 Offset
+= SignatureListSize
;
1471 CopyMem (NewData
+ Offset
, SignatureData
, SignatureSize
);
1472 CopyMem (NewData
+ Offset
+ SignatureSize
, Data
+ Offset
, DataSize
- Offset
);
1479 // Create a new signaturelist, and add the signature into the signaturelist.
1481 DbSize
= DataSize
+ sizeof(EFI_SIGNATURE_LIST
) + SignatureSize
;
1482 NewData
= AllocateZeroPool (DbSize
);
1483 if (NewData
== NULL
) {
1484 Status
= EFI_OUT_OF_RESOURCES
;
1488 // Fill Certificate Database parameters.
1490 SignatureList
= (EFI_SIGNATURE_LIST
*) (NewData
+ DataSize
);
1491 SignatureListSize
= sizeof(EFI_SIGNATURE_LIST
) + SignatureSize
;
1492 WriteUnaligned32 ((UINT32
*) &SignatureList
->SignatureListSize
, (UINT32
) SignatureListSize
);
1493 WriteUnaligned32 ((UINT32
*) &SignatureList
->SignatureSize
, (UINT32
) SignatureSize
);
1494 CopyGuid (&SignatureList
->SignatureType
, &SignatureType
);
1495 CopyMem ((UINT8
* ) SignatureList
+ sizeof (EFI_SIGNATURE_LIST
), SignatureData
, SignatureSize
);
1496 if ((DataSize
!= 0) && (Data
!= NULL
)) {
1497 CopyMem (NewData
, Data
, DataSize
);
1504 Status
= CreateTimeBasedPayload (&DataSize
, (UINT8
**) &Data
);
1505 if (EFI_ERROR (Status
)) {
1509 Attr
= EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_RUNTIME_ACCESS
1510 | EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
;
1511 Status
= gRT
->SetVariable(
1512 EFI_IMAGE_SECURITY_DATABASE1
,
1513 &gEfiImageSecurityDatabaseGuid
,
1518 if (EFI_ERROR (Status
)) {
1523 CloseFile (Private
->FileContext
->FHandle
);
1524 if (Private
->FileContext
->FileName
!= NULL
){
1525 FreePool(Private
->FileContext
->FileName
);
1526 Private
->FileContext
->FileName
= NULL
;
1529 Private
->FileContext
->FHandle
= NULL
;
1531 if (Private
->SignatureGUID
!= NULL
) {
1532 FreePool (Private
->SignatureGUID
);
1533 Private
->SignatureGUID
= NULL
;
1540 if (SignatureData
!= NULL
) {
1541 FreePool (SignatureData
);
1544 if (X509Data
!= NULL
) {
1545 FreePool (X509Data
);
1552 Check whether a certificate from a file exists in dbx.
1554 @param[in] PrivateData The module's private data.
1555 @param[in] VariableName Variable name of signature database, must be
1556 EFI_IMAGE_SECURITY_DATABASE1.
1558 @retval TRUE The X509 certificate is found in dbx successfully.
1559 @retval FALSE The X509 certificate is not found in dbx.
1563 IN SECUREBOOT_CONFIG_PRIVATE_DATA
*Private
,
1564 IN CHAR16
*VariableName
1573 // Read the certificate from file
1577 Status
= ReadFileContent (
1578 Private
->FileContext
->FHandle
,
1583 if (EFI_ERROR (Status
)) {
1588 // Check the raw certificate.
1591 if (IsSignatureFoundInDatabase (EFI_IMAGE_SECURITY_DATABASE1
, X509Data
, X509DataSize
)) {
1597 // Check the hash of certificate.
1599 if (IsCertHashFoundInDbx (X509Data
, X509DataSize
)) {
1605 if (X509Data
!= NULL
) {
1606 FreePool (X509Data
);
1613 Load PE/COFF image information into internal buffer and check its validity.
1615 @retval EFI_SUCCESS Successful
1616 @retval EFI_UNSUPPORTED Invalid PE/COFF file
1617 @retval EFI_ABORTED Serious error occurs, like file I/O error etc.
1625 EFI_IMAGE_DOS_HEADER
*DosHdr
;
1626 EFI_IMAGE_NT_HEADERS32
*NtHeader32
;
1627 EFI_IMAGE_NT_HEADERS64
*NtHeader64
;
1632 // Read the Dos header
1634 DosHdr
= (EFI_IMAGE_DOS_HEADER
*)(mImageBase
);
1635 if (DosHdr
->e_magic
== EFI_IMAGE_DOS_SIGNATURE
)
1638 // DOS image header is present,
1639 // So read the PE header after the DOS image header
1641 mPeCoffHeaderOffset
= DosHdr
->e_lfanew
;
1645 mPeCoffHeaderOffset
= 0;
1649 // Read PE header and check the signature validity and machine compatibility
1651 NtHeader32
= (EFI_IMAGE_NT_HEADERS32
*) (mImageBase
+ mPeCoffHeaderOffset
);
1652 if (NtHeader32
->Signature
!= EFI_IMAGE_NT_SIGNATURE
)
1654 return EFI_UNSUPPORTED
;
1657 mNtHeader
.Pe32
= NtHeader32
;
1660 // Check the architecture field of PE header and get the Certificate Data Directory data
1661 // Note the size of FileHeader field is constant for both IA32 and X64 arch
1663 if ((NtHeader32
->FileHeader
.Machine
== EFI_IMAGE_MACHINE_IA32
)
1664 || (NtHeader32
->FileHeader
.Machine
== EFI_IMAGE_MACHINE_EBC
)
1665 || (NtHeader32
->FileHeader
.Machine
== EFI_IMAGE_MACHINE_ARMTHUMB_MIXED
)) {
1667 // 32-bits Architecture
1669 mImageType
= ImageType_IA32
;
1670 mSecDataDir
= (EFI_IMAGE_SECURITY_DATA_DIRECTORY
*) &(NtHeader32
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY
]);
1672 else if ((NtHeader32
->FileHeader
.Machine
== EFI_IMAGE_MACHINE_IA64
)
1673 || (NtHeader32
->FileHeader
.Machine
== EFI_IMAGE_MACHINE_X64
)
1674 || (NtHeader32
->FileHeader
.Machine
== EFI_IMAGE_MACHINE_AARCH64
)) {
1676 // 64-bits Architecture
1678 mImageType
= ImageType_X64
;
1679 NtHeader64
= (EFI_IMAGE_NT_HEADERS64
*) (mImageBase
+ mPeCoffHeaderOffset
);
1680 mSecDataDir
= (EFI_IMAGE_SECURITY_DATA_DIRECTORY
*) &(NtHeader64
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY
]);
1682 return EFI_UNSUPPORTED
;
1689 Calculate hash of Pe/Coff image based on the authenticode image hashing in
1690 PE/COFF Specification 8.0 Appendix A
1692 @param[in] HashAlg Hash algorithm type.
1694 @retval TRUE Successfully hash image.
1695 @retval FALSE Fail in hash image.
1705 EFI_IMAGE_SECTION_HEADER
*Section
;
1710 UINTN SumOfBytesHashed
;
1711 EFI_IMAGE_SECTION_HEADER
*SectionHeader
;
1716 SectionHeader
= NULL
;
1719 if ((HashAlg
!= HASHALG_SHA1
) && (HashAlg
!= HASHALG_SHA256
)) {
1724 // Initialize context of hash.
1726 ZeroMem (mImageDigest
, MAX_DIGEST_SIZE
);
1728 if (HashAlg
== HASHALG_SHA1
) {
1729 mImageDigestSize
= SHA1_DIGEST_SIZE
;
1730 mCertType
= gEfiCertSha1Guid
;
1731 } else if (HashAlg
== HASHALG_SHA256
) {
1732 mImageDigestSize
= SHA256_DIGEST_SIZE
;
1733 mCertType
= gEfiCertSha256Guid
;
1736 CtxSize
= mHash
[HashAlg
].GetContextSize();
1738 HashCtx
= AllocatePool (CtxSize
);
1739 ASSERT (HashCtx
!= NULL
);
1741 // 1. Load the image header into memory.
1743 // 2. Initialize a SHA hash context.
1744 Status
= mHash
[HashAlg
].HashInit(HashCtx
);
1749 // Measuring PE/COFF Image Header;
1750 // But CheckSum field and SECURITY data directory (certificate) are excluded
1752 if (mNtHeader
.Pe32
->FileHeader
.Machine
== IMAGE_FILE_MACHINE_IA64
&& mNtHeader
.Pe32
->OptionalHeader
.Magic
== EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
) {
1754 // NOTE: Some versions of Linux ELILO for Itanium have an incorrect magic value
1755 // in the PE/COFF Header. If the MachineType is Itanium(IA64) and the
1756 // Magic value in the OptionalHeader is EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
1757 // then override the magic value to EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
1759 Magic
= EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
;
1762 // Get the magic value from the PE/COFF Optional Header
1764 Magic
= mNtHeader
.Pe32
->OptionalHeader
.Magic
;
1768 // 3. Calculate the distance from the base of the image header to the image checksum address.
1769 // 4. Hash the image header from its base to beginning of the image checksum.
1771 HashBase
= mImageBase
;
1772 if (Magic
== EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
) {
1776 HashSize
= (UINTN
) ((UINT8
*) (&mNtHeader
.Pe32
->OptionalHeader
.CheckSum
) - HashBase
);
1779 // Use PE32+ offset.
1781 HashSize
= (UINTN
) ((UINT8
*) (&mNtHeader
.Pe32Plus
->OptionalHeader
.CheckSum
) - HashBase
);
1784 Status
= mHash
[HashAlg
].HashUpdate(HashCtx
, HashBase
, HashSize
);
1789 // 5. Skip over the image checksum (it occupies a single ULONG).
1790 // 6. Get the address of the beginning of the Cert Directory.
1791 // 7. Hash everything from the end of the checksum to the start of the Cert Directory.
1793 if (Magic
== EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
) {
1797 HashBase
= (UINT8
*) &mNtHeader
.Pe32
->OptionalHeader
.CheckSum
+ sizeof (UINT32
);
1798 HashSize
= (UINTN
) ((UINT8
*) (&mNtHeader
.Pe32
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY
]) - HashBase
);
1801 // Use PE32+ offset.
1803 HashBase
= (UINT8
*) &mNtHeader
.Pe32Plus
->OptionalHeader
.CheckSum
+ sizeof (UINT32
);
1804 HashSize
= (UINTN
) ((UINT8
*) (&mNtHeader
.Pe32Plus
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY
]) - HashBase
);
1807 Status
= mHash
[HashAlg
].HashUpdate(HashCtx
, HashBase
, HashSize
);
1812 // 8. Skip over the Cert Directory. (It is sizeof(IMAGE_DATA_DIRECTORY) bytes.)
1813 // 9. Hash everything from the end of the Cert Directory to the end of image header.
1815 if (Magic
== EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
) {
1819 HashBase
= (UINT8
*) &mNtHeader
.Pe32
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY
+ 1];
1820 HashSize
= mNtHeader
.Pe32
->OptionalHeader
.SizeOfHeaders
- (UINTN
) ((UINT8
*) (&mNtHeader
.Pe32
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY
+ 1]) - mImageBase
);
1823 // Use PE32+ offset.
1825 HashBase
= (UINT8
*) &mNtHeader
.Pe32Plus
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY
+ 1];
1826 HashSize
= mNtHeader
.Pe32Plus
->OptionalHeader
.SizeOfHeaders
- (UINTN
) ((UINT8
*) (&mNtHeader
.Pe32Plus
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY
+ 1]) - mImageBase
);
1829 Status
= mHash
[HashAlg
].HashUpdate(HashCtx
, HashBase
, HashSize
);
1834 // 10. Set the SUM_OF_BYTES_HASHED to the size of the header.
1836 if (Magic
== EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
) {
1840 SumOfBytesHashed
= mNtHeader
.Pe32
->OptionalHeader
.SizeOfHeaders
;
1845 SumOfBytesHashed
= mNtHeader
.Pe32Plus
->OptionalHeader
.SizeOfHeaders
;
1849 // 11. Build a temporary table of pointers to all the IMAGE_SECTION_HEADER
1850 // structures in the image. The 'NumberOfSections' field of the image
1851 // header indicates how big the table should be. Do not include any
1852 // IMAGE_SECTION_HEADERs in the table whose 'SizeOfRawData' field is zero.
1854 SectionHeader
= (EFI_IMAGE_SECTION_HEADER
*) AllocateZeroPool (sizeof (EFI_IMAGE_SECTION_HEADER
) * mNtHeader
.Pe32
->FileHeader
.NumberOfSections
);
1855 ASSERT (SectionHeader
!= NULL
);
1857 // 12. Using the 'PointerToRawData' in the referenced section headers as
1858 // a key, arrange the elements in the table in ascending order. In other
1859 // words, sort the section headers according to the disk-file offset of
1862 Section
= (EFI_IMAGE_SECTION_HEADER
*) (
1864 mPeCoffHeaderOffset
+
1866 sizeof (EFI_IMAGE_FILE_HEADER
) +
1867 mNtHeader
.Pe32
->FileHeader
.SizeOfOptionalHeader
1869 for (Index
= 0; Index
< mNtHeader
.Pe32
->FileHeader
.NumberOfSections
; Index
++) {
1871 while ((Pos
> 0) && (Section
->PointerToRawData
< SectionHeader
[Pos
- 1].PointerToRawData
)) {
1872 CopyMem (&SectionHeader
[Pos
], &SectionHeader
[Pos
- 1], sizeof (EFI_IMAGE_SECTION_HEADER
));
1875 CopyMem (&SectionHeader
[Pos
], Section
, sizeof (EFI_IMAGE_SECTION_HEADER
));
1880 // 13. Walk through the sorted table, bring the corresponding section
1881 // into memory, and hash the entire section (using the 'SizeOfRawData'
1882 // field in the section header to determine the amount of data to hash).
1883 // 14. Add the section's 'SizeOfRawData' to SUM_OF_BYTES_HASHED .
1884 // 15. Repeat steps 13 and 14 for all the sections in the sorted table.
1886 for (Index
= 0; Index
< mNtHeader
.Pe32
->FileHeader
.NumberOfSections
; Index
++) {
1887 Section
= &SectionHeader
[Index
];
1888 if (Section
->SizeOfRawData
== 0) {
1891 HashBase
= mImageBase
+ Section
->PointerToRawData
;
1892 HashSize
= (UINTN
) Section
->SizeOfRawData
;
1894 Status
= mHash
[HashAlg
].HashUpdate(HashCtx
, HashBase
, HashSize
);
1899 SumOfBytesHashed
+= HashSize
;
1903 // 16. If the file size is greater than SUM_OF_BYTES_HASHED, there is extra
1904 // data in the file that needs to be added to the hash. This data begins
1905 // at file offset SUM_OF_BYTES_HASHED and its length is:
1906 // FileSize - (CertDirectory->Size)
1908 if (mImageSize
> SumOfBytesHashed
) {
1909 HashBase
= mImageBase
+ SumOfBytesHashed
;
1910 if (Magic
== EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
) {
1916 mNtHeader
.Pe32
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY
].Size
-
1920 // Use PE32+ offset.
1924 mNtHeader
.Pe32Plus
->OptionalHeader
.DataDirectory
[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY
].Size
-
1928 Status
= mHash
[HashAlg
].HashUpdate(HashCtx
, HashBase
, HashSize
);
1934 Status
= mHash
[HashAlg
].HashFinal(HashCtx
, mImageDigest
);
1937 if (HashCtx
!= NULL
) {
1940 if (SectionHeader
!= NULL
) {
1941 FreePool (SectionHeader
);
1947 Recognize the Hash algorithm in PE/COFF Authenticode and calculate hash of
1948 Pe/Coff image based on the authenticated image hashing in PE/COFF Specification
1951 @retval EFI_UNSUPPORTED Hash algorithm is not supported.
1952 @retval EFI_SUCCESS Hash successfully.
1961 WIN_CERTIFICATE_EFI_PKCS
*PkcsCertData
;
1963 PkcsCertData
= (WIN_CERTIFICATE_EFI_PKCS
*) (mImageBase
+ mSecDataDir
->Offset
);
1965 for (Index
= 0; Index
< HASHALG_MAX
; Index
++) {
1967 // Check the Hash algorithm in PE/COFF Authenticode.
1968 // According to PKCS#7 Definition:
1969 // SignedData ::= SEQUENCE {
1971 // digestAlgorithms DigestAlgorithmIdentifiers,
1972 // contentInfo ContentInfo,
1974 // The DigestAlgorithmIdentifiers can be used to determine the hash algorithm in PE/COFF hashing
1975 // This field has the fixed offset (+32) in final Authenticode ASN.1 data.
1976 // Fixed offset (+32) is calculated based on two bytes of length encoding.
1978 if ((*(PkcsCertData
->CertData
+ 1) & TWO_BYTE_ENCODE
) != TWO_BYTE_ENCODE
) {
1980 // Only support two bytes of Long Form of Length Encoding.
1986 if (CompareMem (PkcsCertData
->CertData
+ 32, mHash
[Index
].OidValue
, mHash
[Index
].OidLength
) == 0) {
1991 if (Index
== HASHALG_MAX
) {
1992 return EFI_UNSUPPORTED
;
1996 // HASH PE Image based on Hash algorithm in PE/COFF Authenticode.
1998 if (!HashPeImage(Index
)) {
1999 return EFI_UNSUPPORTED
;
2006 Enroll a new executable's signature into Signature Database.
2008 @param[in] PrivateData The module's private data.
2009 @param[in] VariableName Variable name of signature database, must be
2010 EFI_IMAGE_SECURITY_DATABASE, EFI_IMAGE_SECURITY_DATABASE1
2011 or EFI_IMAGE_SECURITY_DATABASE2.
2013 @retval EFI_SUCCESS New signature is enrolled successfully.
2014 @retval EFI_INVALID_PARAMETER The parameter is invalid.
2015 @retval EFI_UNSUPPORTED Unsupported command.
2016 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
2020 EnrollImageSignatureToSigDB (
2021 IN SECUREBOOT_CONFIG_PRIVATE_DATA
*Private
,
2022 IN CHAR16
*VariableName
2026 EFI_SIGNATURE_LIST
*SigDBCert
;
2027 EFI_SIGNATURE_DATA
*SigDBCertData
;
2032 WIN_CERTIFICATE_UEFI_GUID
*GuidCertData
;
2035 GuidCertData
= NULL
;
2037 if (StrCmp (VariableName
, EFI_IMAGE_SECURITY_DATABASE2
) == 0) {
2038 return EFI_UNSUPPORTED
;
2042 // Form the SigDB certificate list.
2043 // Format the data item into EFI_SIGNATURE_LIST type.
2045 // We need to parse executable's signature data from specified signed executable file.
2046 // In current implementation, we simply trust the pass-in signed executable file.
2047 // In reality, it's OS's responsibility to verify the signed executable file.
2051 // Read the whole file content
2053 Status
= ReadFileContent(
2054 Private
->FileContext
->FHandle
,
2055 (VOID
**) &mImageBase
,
2059 if (EFI_ERROR (Status
)) {
2062 ASSERT (mImageBase
!= NULL
);
2064 Status
= LoadPeImage ();
2065 if (EFI_ERROR (Status
)) {
2069 if (mSecDataDir
->SizeOfCert
== 0) {
2070 if (!HashPeImage (HASHALG_SHA256
)) {
2071 Status
= EFI_SECURITY_VIOLATION
;
2077 // Read the certificate data
2079 mCertificate
= (WIN_CERTIFICATE
*)(mImageBase
+ mSecDataDir
->Offset
);
2081 if (mCertificate
->wCertificateType
== WIN_CERT_TYPE_EFI_GUID
) {
2082 GuidCertData
= (WIN_CERTIFICATE_UEFI_GUID
*) mCertificate
;
2083 if (CompareMem (&GuidCertData
->CertType
, &gEfiCertTypeRsa2048Sha256Guid
, sizeof(EFI_GUID
)) != 0) {
2084 Status
= EFI_ABORTED
;
2088 if (!HashPeImage (HASHALG_SHA256
)) {
2089 Status
= EFI_ABORTED
;
2093 } else if (mCertificate
->wCertificateType
== WIN_CERT_TYPE_PKCS_SIGNED_DATA
) {
2095 Status
= HashPeImageByType ();
2096 if (EFI_ERROR (Status
)) {
2100 Status
= EFI_ABORTED
;
2106 // Create a new SigDB entry.
2108 SigDBSize
= sizeof(EFI_SIGNATURE_LIST
)
2109 + sizeof(EFI_SIGNATURE_DATA
) - 1
2110 + (UINT32
) mImageDigestSize
;
2112 Data
= (UINT8
*) AllocateZeroPool (SigDBSize
);
2114 Status
= EFI_OUT_OF_RESOURCES
;
2119 // Adjust the Certificate Database parameters.
2121 SigDBCert
= (EFI_SIGNATURE_LIST
*) Data
;
2122 SigDBCert
->SignatureListSize
= (UINT32
) SigDBSize
;
2123 SigDBCert
->SignatureHeaderSize
= 0;
2124 SigDBCert
->SignatureSize
= sizeof(EFI_SIGNATURE_DATA
) - 1 + (UINT32
) mImageDigestSize
;
2125 CopyGuid (&SigDBCert
->SignatureType
, &mCertType
);
2127 SigDBCertData
= (EFI_SIGNATURE_DATA
*)((UINT8
*)SigDBCert
+ sizeof(EFI_SIGNATURE_LIST
));
2128 CopyGuid (&SigDBCertData
->SignatureOwner
, Private
->SignatureGUID
);
2129 CopyMem (SigDBCertData
->SignatureData
, mImageDigest
, mImageDigestSize
);
2131 Attr
= EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_RUNTIME_ACCESS
2132 | EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
;
2133 Status
= CreateTimeBasedPayload (&SigDBSize
, (UINT8
**) &Data
);
2134 if (EFI_ERROR (Status
)) {
2135 DEBUG ((EFI_D_ERROR
, "Fail to create time-based data payload: %r", Status
));
2140 // Check if SigDB variable has been already existed.
2141 // If true, use EFI_VARIABLE_APPEND_WRITE attribute to append the
2142 // new signature data to original variable
2145 Status
= gRT
->GetVariable(
2147 &gEfiImageSecurityDatabaseGuid
,
2152 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2153 Attr
|= EFI_VARIABLE_APPEND_WRITE
;
2154 } else if (Status
!= EFI_NOT_FOUND
) {
2159 // Enroll the variable.
2161 Status
= gRT
->SetVariable(
2163 &gEfiImageSecurityDatabaseGuid
,
2168 if (EFI_ERROR (Status
)) {
2174 CloseFile (Private
->FileContext
->FHandle
);
2175 Private
->FileContext
->FHandle
= NULL
;
2177 if (Private
->FileContext
->FileName
!= NULL
){
2178 FreePool(Private
->FileContext
->FileName
);
2179 Private
->FileContext
->FileName
= NULL
;
2182 if (Private
->SignatureGUID
!= NULL
) {
2183 FreePool (Private
->SignatureGUID
);
2184 Private
->SignatureGUID
= NULL
;
2191 if (mImageBase
!= NULL
) {
2192 FreePool (mImageBase
);
2200 Enroll signature into DB/DBX/DBT without KEK's authentication.
2201 The SignatureOwner GUID will be Private->SignatureGUID.
2203 @param[in] PrivateData The module's private data.
2204 @param[in] VariableName Variable name of signature database, must be
2205 EFI_IMAGE_SECURITY_DATABASE or EFI_IMAGE_SECURITY_DATABASE1.
2207 @retval EFI_SUCCESS New signature enrolled successfully.
2208 @retval EFI_INVALID_PARAMETER The parameter is invalid.
2209 @retval others Fail to enroll signature data.
2213 EnrollSignatureDatabase (
2214 IN SECUREBOOT_CONFIG_PRIVATE_DATA
*Private
,
2215 IN CHAR16
*VariableName
2218 UINT16
* FilePostFix
;
2222 if ((Private
->FileContext
->FileName
== NULL
) || (Private
->FileContext
->FHandle
== NULL
) || (Private
->SignatureGUID
== NULL
)) {
2223 return EFI_INVALID_PARAMETER
;
2226 Status
= SetSecureBootMode (CUSTOM_SECURE_BOOT_MODE
);
2227 if (EFI_ERROR (Status
)) {
2232 // Parse the file's postfix.
2234 NameLength
= StrLen (Private
->FileContext
->FileName
);
2235 if (NameLength
<= 4) {
2236 return EFI_INVALID_PARAMETER
;
2238 FilePostFix
= Private
->FileContext
->FileName
+ NameLength
- 4;
2239 if (IsDerEncodeCertificate (FilePostFix
)) {
2241 // Supports DER-encoded X509 certificate.
2243 return EnrollX509toSigDB (Private
, VariableName
);
2246 return EnrollImageSignatureToSigDB (Private
, VariableName
);
2250 List all signatures in specified signature database (e.g. KEK/DB/DBX/DBT)
2251 by GUID in the page for user to select and delete as needed.
2253 @param[in] PrivateData Module's private data.
2254 @param[in] VariableName The variable name of the vendor's signature database.
2255 @param[in] VendorGuid A unique identifier for the vendor.
2256 @param[in] LabelNumber Label number to insert opcodes.
2257 @param[in] FormId Form ID of current page.
2258 @param[in] QuestionIdBase Base question id of the signature list.
2260 @retval EFI_SUCCESS Success to update the signature list page
2261 @retval EFI_OUT_OF_RESOURCES Unable to allocate required resources.
2266 IN SECUREBOOT_CONFIG_PRIVATE_DATA
*PrivateData
,
2267 IN CHAR16
*VariableName
,
2268 IN EFI_GUID
*VendorGuid
,
2269 IN UINT16 LabelNumber
,
2270 IN EFI_FORM_ID FormId
,
2271 IN EFI_QUESTION_ID QuestionIdBase
2278 VOID
*StartOpCodeHandle
;
2279 VOID
*EndOpCodeHandle
;
2280 EFI_IFR_GUID_LABEL
*StartLabel
;
2281 EFI_IFR_GUID_LABEL
*EndLabel
;
2284 EFI_SIGNATURE_LIST
*CertList
;
2285 EFI_SIGNATURE_DATA
*Cert
;
2286 UINT32 ItemDataSize
;
2288 EFI_STRING_ID GuidID
;
2295 StartOpCodeHandle
= NULL
;
2296 EndOpCodeHandle
= NULL
;
2299 // Initialize the container for dynamic opcodes.
2301 StartOpCodeHandle
= HiiAllocateOpCodeHandle ();
2302 if (StartOpCodeHandle
== NULL
) {
2303 Status
= EFI_OUT_OF_RESOURCES
;
2307 EndOpCodeHandle
= HiiAllocateOpCodeHandle ();
2308 if (EndOpCodeHandle
== NULL
) {
2309 Status
= EFI_OUT_OF_RESOURCES
;
2314 // Create Hii Extend Label OpCode.
2316 StartLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (
2320 sizeof (EFI_IFR_GUID_LABEL
)
2322 StartLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
2323 StartLabel
->Number
= LabelNumber
;
2325 EndLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (
2329 sizeof (EFI_IFR_GUID_LABEL
)
2331 EndLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
2332 EndLabel
->Number
= LABEL_END
;
2338 Status
= gRT
->GetVariable (VariableName
, VendorGuid
, NULL
, &DataSize
, Data
);
2339 if (EFI_ERROR (Status
) && Status
!= EFI_BUFFER_TOO_SMALL
) {
2343 Data
= (UINT8
*) AllocateZeroPool (DataSize
);
2345 Status
= EFI_OUT_OF_RESOURCES
;
2349 Status
= gRT
->GetVariable (VariableName
, VendorGuid
, NULL
, &DataSize
, Data
);
2350 if (EFI_ERROR (Status
)) {
2354 GuidStr
= AllocateZeroPool (100);
2355 if (GuidStr
== NULL
) {
2356 Status
= EFI_OUT_OF_RESOURCES
;
2361 // Enumerate all KEK pub data.
2363 ItemDataSize
= (UINT32
) DataSize
;
2364 CertList
= (EFI_SIGNATURE_LIST
*) Data
;
2367 while ((ItemDataSize
> 0) && (ItemDataSize
>= CertList
->SignatureListSize
)) {
2369 if (CompareGuid (&CertList
->SignatureType
, &gEfiCertRsa2048Guid
)) {
2370 Help
= STRING_TOKEN (STR_CERT_TYPE_RSA2048_SHA256_GUID
);
2371 } else if (CompareGuid (&CertList
->SignatureType
, &gEfiCertX509Guid
)) {
2372 Help
= STRING_TOKEN (STR_CERT_TYPE_PCKS7_GUID
);
2373 } else if (CompareGuid (&CertList
->SignatureType
, &gEfiCertSha1Guid
)) {
2374 Help
= STRING_TOKEN (STR_CERT_TYPE_SHA1_GUID
);
2375 } else if (CompareGuid (&CertList
->SignatureType
, &gEfiCertSha256Guid
)) {
2376 Help
= STRING_TOKEN (STR_CERT_TYPE_SHA256_GUID
);
2377 } else if (CompareGuid (&CertList
->SignatureType
, &gEfiCertX509Sha256Guid
)) {
2378 Help
= STRING_TOKEN (STR_CERT_TYPE_X509_SHA256_GUID
);
2379 } else if (CompareGuid (&CertList
->SignatureType
, &gEfiCertX509Sha384Guid
)) {
2380 Help
= STRING_TOKEN (STR_CERT_TYPE_X509_SHA384_GUID
);
2381 } else if (CompareGuid (&CertList
->SignatureType
, &gEfiCertX509Sha512Guid
)) {
2382 Help
= STRING_TOKEN (STR_CERT_TYPE_X509_SHA512_GUID
);
2385 // The signature type is not supported in current implementation.
2387 ItemDataSize
-= CertList
->SignatureListSize
;
2388 CertList
= (EFI_SIGNATURE_LIST
*) ((UINT8
*) CertList
+ CertList
->SignatureListSize
);
2392 CertCount
= (CertList
->SignatureListSize
- sizeof (EFI_SIGNATURE_LIST
) - CertList
->SignatureHeaderSize
) / CertList
->SignatureSize
;
2393 for (Index
= 0; Index
< CertCount
; Index
++) {
2394 Cert
= (EFI_SIGNATURE_DATA
*) ((UINT8
*) CertList
2395 + sizeof (EFI_SIGNATURE_LIST
)
2396 + CertList
->SignatureHeaderSize
2397 + Index
* CertList
->SignatureSize
);
2399 // Display GUID and help
2401 GuidToString (&Cert
->SignatureOwner
, GuidStr
, 100);
2402 GuidID
= HiiSetString (PrivateData
->HiiHandle
, 0, GuidStr
, NULL
);
2403 HiiCreateCheckBoxOpCode (
2405 (EFI_QUESTION_ID
) (QuestionIdBase
+ GuidIndex
++),
2410 EFI_IFR_FLAG_CALLBACK
,
2416 ItemDataSize
-= CertList
->SignatureListSize
;
2417 CertList
= (EFI_SIGNATURE_LIST
*) ((UINT8
*) CertList
+ CertList
->SignatureListSize
);
2422 PrivateData
->HiiHandle
,
2423 &gSecureBootConfigFormSetGuid
,
2429 if (StartOpCodeHandle
!= NULL
) {
2430 HiiFreeOpCodeHandle (StartOpCodeHandle
);
2433 if (EndOpCodeHandle
!= NULL
) {
2434 HiiFreeOpCodeHandle (EndOpCodeHandle
);
2441 if (GuidStr
!= NULL
) {
2449 Delete a KEK entry from KEK database.
2451 @param[in] PrivateData Module's private data.
2452 @param[in] QuestionId Question id of the KEK item to delete.
2454 @retval EFI_SUCCESS Delete kek item successfully.
2455 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
2459 DeleteKeyExchangeKey (
2460 IN SECUREBOOT_CONFIG_PRIVATE_DATA
*PrivateData
,
2461 IN EFI_QUESTION_ID QuestionId
2470 EFI_SIGNATURE_LIST
*CertList
;
2471 EFI_SIGNATURE_LIST
*NewCertList
;
2472 EFI_SIGNATURE_DATA
*Cert
;
2475 BOOLEAN IsKEKItemFound
;
2477 UINTN DeleteKekIndex
;
2485 DeleteKekIndex
= QuestionId
- OPTION_DEL_KEK_QUESTION_ID
;
2487 Status
= SetSecureBootMode(CUSTOM_SECURE_BOOT_MODE
);
2488 if (EFI_ERROR (Status
)) {
2493 // Get original KEK variable.
2496 Status
= gRT
->GetVariable (EFI_KEY_EXCHANGE_KEY_NAME
, &gEfiGlobalVariableGuid
, NULL
, &DataSize
, NULL
);
2497 if (EFI_ERROR(Status
) && Status
!= EFI_BUFFER_TOO_SMALL
) {
2501 OldData
= (UINT8
*)AllocateZeroPool(DataSize
);
2502 if (OldData
== NULL
) {
2503 Status
= EFI_OUT_OF_RESOURCES
;
2507 Status
= gRT
->GetVariable (EFI_KEY_EXCHANGE_KEY_NAME
, &gEfiGlobalVariableGuid
, &Attr
, &DataSize
, OldData
);
2508 if (EFI_ERROR(Status
)) {
2513 // Allocate space for new variable.
2515 Data
= (UINT8
*) AllocateZeroPool (DataSize
);
2517 Status
= EFI_OUT_OF_RESOURCES
;
2522 // Enumerate all KEK pub data and erasing the target item.
2524 IsKEKItemFound
= FALSE
;
2525 KekDataSize
= (UINT32
) DataSize
;
2526 CertList
= (EFI_SIGNATURE_LIST
*) OldData
;
2529 while ((KekDataSize
> 0) && (KekDataSize
>= CertList
->SignatureListSize
)) {
2530 if (CompareGuid (&CertList
->SignatureType
, &gEfiCertRsa2048Guid
) ||
2531 CompareGuid (&CertList
->SignatureType
, &gEfiCertX509Guid
)) {
2532 CopyMem (Data
+ Offset
, CertList
, (sizeof(EFI_SIGNATURE_LIST
) + CertList
->SignatureHeaderSize
));
2533 NewCertList
= (EFI_SIGNATURE_LIST
*)(Data
+ Offset
);
2534 Offset
+= (sizeof(EFI_SIGNATURE_LIST
) + CertList
->SignatureHeaderSize
);
2535 Cert
= (EFI_SIGNATURE_DATA
*) ((UINT8
*) CertList
+ sizeof (EFI_SIGNATURE_LIST
) + CertList
->SignatureHeaderSize
);
2536 CertCount
= (CertList
->SignatureListSize
- sizeof (EFI_SIGNATURE_LIST
) - CertList
->SignatureHeaderSize
) / CertList
->SignatureSize
;
2537 for (Index
= 0; Index
< CertCount
; Index
++) {
2538 if (GuidIndex
== DeleteKekIndex
) {
2540 // Find it! Skip it!
2542 NewCertList
->SignatureListSize
-= CertList
->SignatureSize
;
2543 IsKEKItemFound
= TRUE
;
2546 // This item doesn't match. Copy it to the Data buffer.
2548 CopyMem (Data
+ Offset
, Cert
, CertList
->SignatureSize
);
2549 Offset
+= CertList
->SignatureSize
;
2552 Cert
= (EFI_SIGNATURE_DATA
*) ((UINT8
*) Cert
+ CertList
->SignatureSize
);
2556 // This List doesn't match. Copy it to the Data buffer.
2558 CopyMem (Data
+ Offset
, CertList
, CertList
->SignatureListSize
);
2559 Offset
+= CertList
->SignatureListSize
;
2562 KekDataSize
-= CertList
->SignatureListSize
;
2563 CertList
= (EFI_SIGNATURE_LIST
*) ((UINT8
*) CertList
+ CertList
->SignatureListSize
);
2566 if (!IsKEKItemFound
) {
2568 // Doesn't find the Kek Item!
2570 Status
= EFI_NOT_FOUND
;
2575 // Delete the Signature header if there is no signature in the list.
2577 KekDataSize
= Offset
;
2578 CertList
= (EFI_SIGNATURE_LIST
*) Data
;
2580 ZeroMem (OldData
, KekDataSize
);
2581 while ((KekDataSize
> 0) && (KekDataSize
>= CertList
->SignatureListSize
)) {
2582 CertCount
= (CertList
->SignatureListSize
- sizeof (EFI_SIGNATURE_LIST
) - CertList
->SignatureHeaderSize
) / CertList
->SignatureSize
;
2583 DEBUG ((DEBUG_INFO
, " CertCount = %x\n", CertCount
));
2584 if (CertCount
!= 0) {
2585 CopyMem (OldData
+ Offset
, CertList
, CertList
->SignatureListSize
);
2586 Offset
+= CertList
->SignatureListSize
;
2588 KekDataSize
-= CertList
->SignatureListSize
;
2589 CertList
= (EFI_SIGNATURE_LIST
*) ((UINT8
*) CertList
+ CertList
->SignatureListSize
);
2593 if ((Attr
& EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
) != 0) {
2594 Status
= CreateTimeBasedPayload (&DataSize
, &OldData
);
2595 if (EFI_ERROR (Status
)) {
2596 DEBUG ((EFI_D_ERROR
, "Fail to create time-based data payload: %r", Status
));
2601 Status
= gRT
->SetVariable(
2602 EFI_KEY_EXCHANGE_KEY_NAME
,
2603 &gEfiGlobalVariableGuid
,
2608 if (EFI_ERROR (Status
)) {
2609 DEBUG ((DEBUG_ERROR
, "Failed to set variable, Status = %r\n", Status
));
2618 if (OldData
!= NULL
) {
2622 return UpdateDeletePage (
2624 EFI_KEY_EXCHANGE_KEY_NAME
,
2625 &gEfiGlobalVariableGuid
,
2627 FORMID_DELETE_KEK_FORM
,
2628 OPTION_DEL_KEK_QUESTION_ID
2633 Delete a signature entry from siganture database.
2635 @param[in] PrivateData Module's private data.
2636 @param[in] VariableName The variable name of the vendor's signature database.
2637 @param[in] VendorGuid A unique identifier for the vendor.
2638 @param[in] LabelNumber Label number to insert opcodes.
2639 @param[in] FormId Form ID of current page.
2640 @param[in] QuestionIdBase Base question id of the signature list.
2641 @param[in] DeleteIndex Signature index to delete.
2643 @retval EFI_SUCCESS Delete siganture successfully.
2644 @retval EFI_NOT_FOUND Can't find the signature item,
2645 @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
2649 IN SECUREBOOT_CONFIG_PRIVATE_DATA
*PrivateData
,
2650 IN CHAR16
*VariableName
,
2651 IN EFI_GUID
*VendorGuid
,
2652 IN UINT16 LabelNumber
,
2653 IN EFI_FORM_ID FormId
,
2654 IN EFI_QUESTION_ID QuestionIdBase
,
2655 IN UINTN DeleteIndex
2664 EFI_SIGNATURE_LIST
*CertList
;
2665 EFI_SIGNATURE_LIST
*NewCertList
;
2666 EFI_SIGNATURE_DATA
*Cert
;
2669 BOOLEAN IsItemFound
;
2670 UINT32 ItemDataSize
;
2679 Status
= SetSecureBootMode(CUSTOM_SECURE_BOOT_MODE
);
2680 if (EFI_ERROR (Status
)) {
2685 // Get original signature list data.
2688 Status
= gRT
->GetVariable (VariableName
, VendorGuid
, NULL
, &DataSize
, NULL
);
2689 if (EFI_ERROR (Status
) && Status
!= EFI_BUFFER_TOO_SMALL
) {
2693 OldData
= (UINT8
*) AllocateZeroPool (DataSize
);
2694 if (OldData
== NULL
) {
2695 Status
= EFI_OUT_OF_RESOURCES
;
2699 Status
= gRT
->GetVariable (VariableName
, VendorGuid
, &Attr
, &DataSize
, OldData
);
2700 if (EFI_ERROR(Status
)) {
2705 // Allocate space for new variable.
2707 Data
= (UINT8
*) AllocateZeroPool (DataSize
);
2709 Status
= EFI_OUT_OF_RESOURCES
;
2714 // Enumerate all signature data and erasing the target item.
2716 IsItemFound
= FALSE
;
2717 ItemDataSize
= (UINT32
) DataSize
;
2718 CertList
= (EFI_SIGNATURE_LIST
*) OldData
;
2721 while ((ItemDataSize
> 0) && (ItemDataSize
>= CertList
->SignatureListSize
)) {
2722 if (CompareGuid (&CertList
->SignatureType
, &gEfiCertRsa2048Guid
) ||
2723 CompareGuid (&CertList
->SignatureType
, &gEfiCertX509Guid
) ||
2724 CompareGuid (&CertList
->SignatureType
, &gEfiCertSha1Guid
) ||
2725 CompareGuid (&CertList
->SignatureType
, &gEfiCertSha256Guid
) ||
2726 CompareGuid (&CertList
->SignatureType
, &gEfiCertX509Sha256Guid
) ||
2727 CompareGuid (&CertList
->SignatureType
, &gEfiCertX509Sha384Guid
) ||
2728 CompareGuid (&CertList
->SignatureType
, &gEfiCertX509Sha512Guid
)
2731 // Copy EFI_SIGNATURE_LIST header then calculate the signature count in this list.
2733 CopyMem (Data
+ Offset
, CertList
, (sizeof(EFI_SIGNATURE_LIST
) + CertList
->SignatureHeaderSize
));
2734 NewCertList
= (EFI_SIGNATURE_LIST
*) (Data
+ Offset
);
2735 Offset
+= (sizeof(EFI_SIGNATURE_LIST
) + CertList
->SignatureHeaderSize
);
2736 Cert
= (EFI_SIGNATURE_DATA
*) ((UINT8
*) CertList
+ sizeof (EFI_SIGNATURE_LIST
) + CertList
->SignatureHeaderSize
);
2737 CertCount
= (CertList
->SignatureListSize
- sizeof (EFI_SIGNATURE_LIST
) - CertList
->SignatureHeaderSize
) / CertList
->SignatureSize
;
2738 for (Index
= 0; Index
< CertCount
; Index
++) {
2739 if (GuidIndex
== DeleteIndex
) {
2741 // Find it! Skip it!
2743 NewCertList
->SignatureListSize
-= CertList
->SignatureSize
;
2747 // This item doesn't match. Copy it to the Data buffer.
2749 CopyMem (Data
+ Offset
, (UINT8
*)(Cert
), CertList
->SignatureSize
);
2750 Offset
+= CertList
->SignatureSize
;
2753 Cert
= (EFI_SIGNATURE_DATA
*) ((UINT8
*) Cert
+ CertList
->SignatureSize
);
2757 // This List doesn't match. Just copy it to the Data buffer.
2759 CopyMem (Data
+ Offset
, (UINT8
*)(CertList
), CertList
->SignatureListSize
);
2760 Offset
+= CertList
->SignatureListSize
;
2763 ItemDataSize
-= CertList
->SignatureListSize
;
2764 CertList
= (EFI_SIGNATURE_LIST
*) ((UINT8
*) CertList
+ CertList
->SignatureListSize
);
2769 // Doesn't find the signature Item!
2771 Status
= EFI_NOT_FOUND
;
2776 // Delete the EFI_SIGNATURE_LIST header if there is no signature in the list.
2778 ItemDataSize
= Offset
;
2779 CertList
= (EFI_SIGNATURE_LIST
*) Data
;
2781 ZeroMem (OldData
, ItemDataSize
);
2782 while ((ItemDataSize
> 0) && (ItemDataSize
>= CertList
->SignatureListSize
)) {
2783 CertCount
= (CertList
->SignatureListSize
- sizeof (EFI_SIGNATURE_LIST
) - CertList
->SignatureHeaderSize
) / CertList
->SignatureSize
;
2784 DEBUG ((DEBUG_INFO
, " CertCount = %x\n", CertCount
));
2785 if (CertCount
!= 0) {
2786 CopyMem (OldData
+ Offset
, (UINT8
*)(CertList
), CertList
->SignatureListSize
);
2787 Offset
+= CertList
->SignatureListSize
;
2789 ItemDataSize
-= CertList
->SignatureListSize
;
2790 CertList
= (EFI_SIGNATURE_LIST
*) ((UINT8
*) CertList
+ CertList
->SignatureListSize
);
2794 if ((Attr
& EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
) != 0) {
2795 Status
= CreateTimeBasedPayload (&DataSize
, &OldData
);
2796 if (EFI_ERROR (Status
)) {
2797 DEBUG ((EFI_D_ERROR
, "Fail to create time-based data payload: %r", Status
));
2802 Status
= gRT
->SetVariable(
2809 if (EFI_ERROR (Status
)) {
2810 DEBUG ((DEBUG_ERROR
, "Failed to set variable, Status = %r\n", Status
));
2819 if (OldData
!= NULL
) {
2823 return UpdateDeletePage (
2835 Update SecureBoot strings based on new Secure Boot Mode State. String includes STR_SECURE_BOOT_STATE_CONTENT
2836 and STR_CUR_SECURE_BOOT_MODE_CONTENT.
2838 @param[in] PrivateData Module's private data.
2840 @return EFI_SUCCESS Update secure boot strings successfully.
2841 @return other Fail to update secure boot strings.
2845 UpdateSecureBootString(
2846 IN SECUREBOOT_CONFIG_PRIVATE_DATA
*Private
2854 // Get current secure boot state.
2856 GetVariable2 (EFI_SECURE_BOOT_MODE_NAME
, &gEfiGlobalVariableGuid
, (VOID
**)&SecureBoot
, NULL
);
2857 if (SecureBoot
== NULL
) {
2858 return EFI_NOT_FOUND
;
2861 if (*SecureBoot
== SECURE_BOOT_MODE_ENABLE
) {
2862 HiiSetString (Private
->HiiHandle
, STRING_TOKEN (STR_SECURE_BOOT_STATE_CONTENT
), L
"Enabled", NULL
);
2864 HiiSetString (Private
->HiiHandle
, STRING_TOKEN (STR_SECURE_BOOT_STATE_CONTENT
), L
"Disabled", NULL
);
2867 FreePool(SecureBoot
);
2873 This function extracts configuration from variable.
2875 @param[in, out] ConfigData Point to SecureBoot configuration private data.
2879 SecureBootExtractConfigFromVariable (
2880 IN OUT SECUREBOOT_CONFIGURATION
*ConfigData
2883 UINT8
*SecureBootEnable
;
2885 UINT8
*SecureBootMode
;
2888 SecureBootEnable
= NULL
;
2890 SecureBootMode
= NULL
;
2893 // Initilize the Date and Time using system time.
2895 ConfigData
->CertificateFormat
= HASHALG_RAW
;
2896 ConfigData
->AlwaysRevocation
= TRUE
;
2897 gRT
->GetTime (&CurrTime
, NULL
);
2898 ConfigData
->RevocationDate
.Year
= CurrTime
.Year
;
2899 ConfigData
->RevocationDate
.Month
= CurrTime
.Month
;
2900 ConfigData
->RevocationDate
.Day
= CurrTime
.Day
;
2901 ConfigData
->RevocationTime
.Hour
= CurrTime
.Hour
;
2902 ConfigData
->RevocationTime
.Minute
= CurrTime
.Minute
;
2903 ConfigData
->RevocationTime
.Second
= 0;
2907 // If it is Physical Presence User, set the PhysicalPresent to true.
2909 if (UserPhysicalPresent()) {
2910 ConfigData
->PhysicalPresent
= TRUE
;
2912 ConfigData
->PhysicalPresent
= FALSE
;
2916 // If there is no PK then the Delete Pk button will be gray.
2918 GetVariable2 (EFI_SETUP_MODE_NAME
, &gEfiGlobalVariableGuid
, (VOID
**)&SetupMode
, NULL
);
2919 if (SetupMode
== NULL
|| (*SetupMode
) == SETUP_MODE
) {
2920 ConfigData
->HasPk
= FALSE
;
2922 ConfigData
->HasPk
= TRUE
;
2926 // Check SecureBootEnable & Pk status, fix the inconsistence.
2927 // If the SecureBootEnable Variable doesn't exist, hide the SecureBoot Enable/Disable
2930 ConfigData
->AttemptSecureBoot
= FALSE
;
2931 GetVariable2 (EFI_SECURE_BOOT_ENABLE_NAME
, &gEfiSecureBootEnableDisableGuid
, (VOID
**)&SecureBootEnable
, NULL
);
2934 // Fix Pk, SecureBootEnable inconsistence
2936 if ((*SetupMode
) == USER_MODE
) {
2937 ConfigData
->HideSecureBoot
= FALSE
;
2938 if ((SecureBootEnable
!= NULL
) && (*SecureBootEnable
== SECURE_BOOT_ENABLE
)) {
2939 ConfigData
->AttemptSecureBoot
= TRUE
;
2942 ConfigData
->HideSecureBoot
= TRUE
;
2946 // Get the SecureBootMode from CustomMode variable.
2948 GetVariable2 (EFI_CUSTOM_MODE_NAME
, &gEfiCustomModeEnableGuid
, (VOID
**)&SecureBootMode
, NULL
);
2949 if (SecureBootMode
== NULL
) {
2950 ConfigData
->SecureBootMode
= STANDARD_SECURE_BOOT_MODE
;
2952 ConfigData
->SecureBootMode
= *(SecureBootMode
);
2955 if (SecureBootEnable
!= NULL
) {
2956 FreePool (SecureBootEnable
);
2958 if (SetupMode
!= NULL
) {
2959 FreePool (SetupMode
);
2961 if (SecureBootMode
!= NULL
) {
2962 FreePool (SecureBootMode
);
2967 This function allows a caller to extract the current configuration for one
2968 or more named elements from the target driver.
2970 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
2971 @param[in] Request A null-terminated Unicode string in
2972 <ConfigRequest> format.
2973 @param[out] Progress On return, points to a character in the Request
2974 string. Points to the string's null terminator if
2975 request was successful. Points to the most recent
2976 '&' before the first failing name/value pair (or
2977 the beginning of the string if the failure is in
2978 the first name/value pair) if the request was not
2980 @param[out] Results A null-terminated Unicode string in
2981 <ConfigAltResp> format which has all values filled
2982 in for the names in the Request string. String to
2983 be allocated by the called function.
2985 @retval EFI_SUCCESS The Results is filled with the requested values.
2986 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
2987 @retval EFI_INVALID_PARAMETER Request is illegal syntax, or unknown name.
2988 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
2994 SecureBootExtractConfig (
2995 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
2996 IN CONST EFI_STRING Request
,
2997 OUT EFI_STRING
*Progress
,
2998 OUT EFI_STRING
*Results
3004 SECUREBOOT_CONFIGURATION Configuration
;
3005 EFI_STRING ConfigRequest
;
3006 EFI_STRING ConfigRequestHdr
;
3007 SECUREBOOT_CONFIG_PRIVATE_DATA
*PrivateData
;
3008 BOOLEAN AllocatedRequest
;
3010 if (Progress
== NULL
|| Results
== NULL
) {
3011 return EFI_INVALID_PARAMETER
;
3014 AllocatedRequest
= FALSE
;
3015 ConfigRequestHdr
= NULL
;
3016 ConfigRequest
= NULL
;
3019 ZeroMem (&Configuration
, sizeof (Configuration
));
3020 PrivateData
= SECUREBOOT_CONFIG_PRIVATE_FROM_THIS (This
);
3021 *Progress
= Request
;
3023 if ((Request
!= NULL
) && !HiiIsConfigHdrMatch (Request
, &gSecureBootConfigFormSetGuid
, mSecureBootStorageName
)) {
3024 return EFI_NOT_FOUND
;
3028 // Get Configuration from Variable.
3030 SecureBootExtractConfigFromVariable (&Configuration
);
3032 BufferSize
= sizeof (SECUREBOOT_CONFIGURATION
);
3033 ConfigRequest
= Request
;
3034 if ((Request
== NULL
) || (StrStr (Request
, L
"OFFSET") == NULL
)) {
3036 // Request is set to NULL or OFFSET is NULL, construct full request string.
3038 // Allocate and fill a buffer large enough to hold the <ConfigHdr> template
3039 // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator
3041 ConfigRequestHdr
= HiiConstructConfigHdr (&gSecureBootConfigFormSetGuid
, mSecureBootStorageName
, PrivateData
->DriverHandle
);
3042 Size
= (StrLen (ConfigRequestHdr
) + 32 + 1) * sizeof (CHAR16
);
3043 ConfigRequest
= AllocateZeroPool (Size
);
3044 ASSERT (ConfigRequest
!= NULL
);
3045 AllocatedRequest
= TRUE
;
3046 UnicodeSPrint (ConfigRequest
, Size
, L
"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr
, (UINT64
)BufferSize
);
3047 FreePool (ConfigRequestHdr
);
3048 ConfigRequestHdr
= NULL
;
3051 Status
= gHiiConfigRouting
->BlockToConfig (
3054 (UINT8
*) &Configuration
,
3061 // Free the allocated config request string.
3063 if (AllocatedRequest
) {
3064 FreePool (ConfigRequest
);
3068 // Set Progress string to the original request string.
3070 if (Request
== NULL
) {
3072 } else if (StrStr (Request
, L
"OFFSET") == NULL
) {
3073 *Progress
= Request
+ StrLen (Request
);
3080 This function processes the results of changes in configuration.
3082 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
3083 @param[in] Configuration A null-terminated Unicode string in <ConfigResp>
3085 @param[out] Progress A pointer to a string filled in with the offset of
3086 the most recent '&' before the first failing
3087 name/value pair (or the beginning of the string if
3088 the failure is in the first name/value pair) or
3089 the terminating NULL if all was successful.
3091 @retval EFI_SUCCESS The Results is processed successfully.
3092 @retval EFI_INVALID_PARAMETER Configuration is NULL.
3093 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this
3099 SecureBootRouteConfig (
3100 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
3101 IN CONST EFI_STRING Configuration
,
3102 OUT EFI_STRING
*Progress
3105 SECUREBOOT_CONFIGURATION IfrNvData
;
3109 if (Configuration
== NULL
|| Progress
== NULL
) {
3110 return EFI_INVALID_PARAMETER
;
3113 *Progress
= Configuration
;
3114 if (!HiiIsConfigHdrMatch (Configuration
, &gSecureBootConfigFormSetGuid
, mSecureBootStorageName
)) {
3115 return EFI_NOT_FOUND
;
3119 // Get Configuration from Variable.
3121 SecureBootExtractConfigFromVariable (&IfrNvData
);
3124 // Map the Configuration to the configuration block.
3126 BufferSize
= sizeof (SECUREBOOT_CONFIGURATION
);
3127 Status
= gHiiConfigRouting
->ConfigToBlock (
3130 (UINT8
*)&IfrNvData
,
3134 if (EFI_ERROR (Status
)) {
3139 // Store Buffer Storage back to EFI variable if needed
3141 if (!IfrNvData
.HideSecureBoot
) {
3142 Status
= SaveSecureBootVariable (IfrNvData
.AttemptSecureBoot
);
3143 if (EFI_ERROR (Status
)) {
3148 *Progress
= Configuration
+ StrLen (Configuration
);
3153 This function is called to provide results data to the driver.
3155 @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
3156 @param[in] Action Specifies the type of action taken by the browser.
3157 @param[in] QuestionId A unique value which is sent to the original
3158 exporting driver so that it can identify the type
3160 @param[in] Type The type of value for the question.
3161 @param[in] Value A pointer to the data being sent to the original
3163 @param[out] ActionRequest On return, points to the action requested by the
3166 @retval EFI_SUCCESS The callback successfully handled the action.
3167 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the
3168 variable and its data.
3169 @retval EFI_DEVICE_ERROR The variable could not be saved.
3170 @retval EFI_UNSUPPORTED The specified Action is not supported by the
3176 SecureBootCallback (
3177 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
3178 IN EFI_BROWSER_ACTION Action
,
3179 IN EFI_QUESTION_ID QuestionId
,
3181 IN EFI_IFR_TYPE_VALUE
*Value
,
3182 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
3187 SECUREBOOT_CONFIG_PRIVATE_DATA
*Private
;
3189 SECUREBOOT_CONFIGURATION
*IfrNvData
;
3191 UINT8
*SecureBootEnable
;
3193 UINT8
*SecureBootMode
;
3195 CHAR16 PromptString
[100];
3196 EFI_DEVICE_PATH_PROTOCOL
*File
;
3198 Status
= EFI_SUCCESS
;
3199 SecureBootEnable
= NULL
;
3200 SecureBootMode
= NULL
;
3204 if ((This
== NULL
) || (Value
== NULL
) || (ActionRequest
== NULL
)) {
3205 return EFI_INVALID_PARAMETER
;
3208 Private
= SECUREBOOT_CONFIG_PRIVATE_FROM_THIS (This
);
3210 gSecureBootPrivateData
= Private
;
3213 // Retrieve uncommitted data from Browser
3215 BufferSize
= sizeof (SECUREBOOT_CONFIGURATION
);
3216 IfrNvData
= AllocateZeroPool (BufferSize
);
3217 if (IfrNvData
== NULL
) {
3218 return EFI_OUT_OF_RESOURCES
;
3221 HiiGetBrowserData (&gSecureBootConfigFormSetGuid
, mSecureBootStorageName
, BufferSize
, (UINT8
*) IfrNvData
);
3223 if (Action
== EFI_BROWSER_ACTION_FORM_OPEN
) {
3224 if (QuestionId
== KEY_SECURE_BOOT_MODE
) {
3226 // Update secure boot strings when opening this form
3228 Status
= UpdateSecureBootString(Private
);
3229 SecureBootExtractConfigFromVariable (IfrNvData
);
3230 mIsEnterSecureBootForm
= TRUE
;
3235 if (Action
== EFI_BROWSER_ACTION_RETRIEVE
) {
3236 Status
= EFI_UNSUPPORTED
;
3237 if (QuestionId
== KEY_SECURE_BOOT_MODE
) {
3238 if (mIsEnterSecureBootForm
) {
3239 Value
->u8
= SECURE_BOOT_MODE_STANDARD
;
3240 Status
= EFI_SUCCESS
;
3246 if ((Action
!= EFI_BROWSER_ACTION_CHANGED
) &&
3247 (Action
!= EFI_BROWSER_ACTION_CHANGING
) &&
3248 (Action
!= EFI_BROWSER_ACTION_FORM_CLOSE
) &&
3249 (Action
!= EFI_BROWSER_ACTION_DEFAULT_STANDARD
)) {
3250 Status
= EFI_UNSUPPORTED
;
3254 if (Action
== EFI_BROWSER_ACTION_CHANGING
) {
3256 switch (QuestionId
) {
3257 case KEY_SECURE_BOOT_ENABLE
:
3258 GetVariable2 (EFI_SECURE_BOOT_ENABLE_NAME
, &gEfiSecureBootEnableDisableGuid
, (VOID
**)&SecureBootEnable
, NULL
);
3259 if (NULL
!= SecureBootEnable
) {
3260 FreePool (SecureBootEnable
);
3261 if (EFI_ERROR (SaveSecureBootVariable (Value
->u8
))) {
3263 EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
,
3265 L
"Only Physical Presence User could disable secure boot!",
3268 Status
= EFI_UNSUPPORTED
;
3271 EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
,
3273 L
"Configuration changed, please reset the platform to take effect!",
3280 case KEY_SECURE_BOOT_KEK_OPTION
:
3281 case KEY_SECURE_BOOT_DB_OPTION
:
3282 case KEY_SECURE_BOOT_DBX_OPTION
:
3283 case KEY_SECURE_BOOT_DBT_OPTION
:
3285 // Clear Signature GUID.
3287 ZeroMem (IfrNvData
->SignatureGuid
, sizeof (IfrNvData
->SignatureGuid
));
3288 if (Private
->SignatureGUID
== NULL
) {
3289 Private
->SignatureGUID
= (EFI_GUID
*) AllocateZeroPool (sizeof (EFI_GUID
));
3290 if (Private
->SignatureGUID
== NULL
) {
3291 return EFI_OUT_OF_RESOURCES
;
3295 if (QuestionId
== KEY_SECURE_BOOT_DB_OPTION
) {
3296 LabelId
= SECUREBOOT_ENROLL_SIGNATURE_TO_DB
;
3297 } else if (QuestionId
== KEY_SECURE_BOOT_DBX_OPTION
) {
3298 LabelId
= SECUREBOOT_ENROLL_SIGNATURE_TO_DBX
;
3299 } else if (QuestionId
== KEY_SECURE_BOOT_DBT_OPTION
) {
3300 LabelId
= SECUREBOOT_ENROLL_SIGNATURE_TO_DBT
;
3302 LabelId
= FORMID_ENROLL_KEK_FORM
;
3306 // Refresh selected file.
3308 CleanUpPage (LabelId
, Private
);
3310 case KEY_SECURE_BOOT_PK_OPTION
:
3311 LabelId
= FORMID_ENROLL_PK_FORM
;
3313 // Refresh selected file.
3315 CleanUpPage (LabelId
, Private
);
3318 case FORMID_ENROLL_PK_FORM
:
3319 ChooseFile (NULL
, NULL
, UpdatePKFromFile
, &File
);
3322 case FORMID_ENROLL_KEK_FORM
:
3323 ChooseFile (NULL
, NULL
, UpdateKEKFromFile
, &File
);
3326 case SECUREBOOT_ENROLL_SIGNATURE_TO_DB
:
3327 ChooseFile (NULL
, NULL
, UpdateDBFromFile
, &File
);
3330 case SECUREBOOT_ENROLL_SIGNATURE_TO_DBX
:
3331 ChooseFile (NULL
, NULL
, UpdateDBXFromFile
, &File
);
3334 case SECUREBOOT_ENROLL_SIGNATURE_TO_DBT
:
3335 ChooseFile (NULL
, NULL
, UpdateDBTFromFile
, &File
);
3338 case KEY_SECURE_BOOT_DELETE_PK
:
3341 EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
,
3343 L
"Are you sure you want to delete PK? Secure boot will be disabled!",
3344 L
"Press 'Y' to delete PK and exit, 'N' to discard change and return",
3347 if (Key
.UnicodeChar
== 'y' || Key
.UnicodeChar
== 'Y') {
3348 Status
= DeletePlatformKey ();
3349 if (EFI_ERROR (Status
)) {
3351 EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
,
3353 L
"Only Physical Presence User could delete PK in custom mode!",
3361 case KEY_DELETE_KEK
:
3364 EFI_KEY_EXCHANGE_KEY_NAME
,
3365 &gEfiGlobalVariableGuid
,
3367 FORMID_DELETE_KEK_FORM
,
3368 OPTION_DEL_KEK_QUESTION_ID
3372 case SECUREBOOT_DELETE_SIGNATURE_FROM_DB
:
3375 EFI_IMAGE_SECURITY_DATABASE
,
3376 &gEfiImageSecurityDatabaseGuid
,
3378 SECUREBOOT_DELETE_SIGNATURE_FROM_DB
,
3379 OPTION_DEL_DB_QUESTION_ID
3383 case SECUREBOOT_DELETE_SIGNATURE_FROM_DBX
:
3386 EFI_IMAGE_SECURITY_DATABASE1
,
3387 &gEfiImageSecurityDatabaseGuid
,
3389 SECUREBOOT_DELETE_SIGNATURE_FROM_DBX
,
3390 OPTION_DEL_DBX_QUESTION_ID
3395 case SECUREBOOT_DELETE_SIGNATURE_FROM_DBT
:
3398 EFI_IMAGE_SECURITY_DATABASE2
,
3399 &gEfiImageSecurityDatabaseGuid
,
3401 SECUREBOOT_DELETE_SIGNATURE_FROM_DBT
,
3402 OPTION_DEL_DBT_QUESTION_ID
3407 case KEY_VALUE_SAVE_AND_EXIT_KEK
:
3408 Status
= EnrollKeyExchangeKey (Private
);
3409 if (EFI_ERROR (Status
)) {
3411 EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
,
3413 L
"ERROR: Unsupported file type!",
3414 L
"Only supports DER-encoded X509 certificate",
3420 case KEY_VALUE_SAVE_AND_EXIT_DB
:
3421 Status
= EnrollSignatureDatabase (Private
, EFI_IMAGE_SECURITY_DATABASE
);
3422 if (EFI_ERROR (Status
)) {
3424 EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
,
3426 L
"ERROR: Unsupported file type!",
3427 L
"Only supports DER-encoded X509 certificate and executable EFI image",
3433 case KEY_VALUE_SAVE_AND_EXIT_DBX
:
3434 if (IsX509CertInDbx (Private
, EFI_IMAGE_SECURITY_DATABASE1
)) {
3436 EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
,
3438 L
"Enrollment failed! Same certificate had already been in the dbx!",
3444 if ((IfrNvData
!= NULL
) && (IfrNvData
->CertificateFormat
< HASHALG_MAX
)) {
3445 Status
= EnrollX509HashtoSigDB (
3447 IfrNvData
->CertificateFormat
,
3448 &IfrNvData
->RevocationDate
,
3449 &IfrNvData
->RevocationTime
,
3450 IfrNvData
->AlwaysRevocation
3453 Status
= EnrollSignatureDatabase (Private
, EFI_IMAGE_SECURITY_DATABASE1
);
3455 if (EFI_ERROR (Status
)) {
3457 EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
,
3459 L
"ERROR: Unsupported file type!",
3460 L
"Only supports DER-encoded X509 certificate and executable EFI image",
3466 case KEY_VALUE_SAVE_AND_EXIT_DBT
:
3467 Status
= EnrollSignatureDatabase (Private
, EFI_IMAGE_SECURITY_DATABASE2
);
3468 if (EFI_ERROR (Status
)) {
3470 EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
,
3472 L
"ERROR: Unsupported file type!",
3473 L
"Only supports DER-encoded X509 certificate.",
3478 case KEY_VALUE_SAVE_AND_EXIT_PK
:
3479 Status
= EnrollPlatformKey (Private
);
3480 if (EFI_ERROR (Status
)) {
3483 sizeof (PromptString
),
3484 L
"Only DER encoded certificate file (%s) is supported.",
3488 EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
,
3490 L
"ERROR: Unsupported file type!",
3497 if ((QuestionId
>= OPTION_DEL_KEK_QUESTION_ID
) &&
3498 (QuestionId
< (OPTION_DEL_KEK_QUESTION_ID
+ OPTION_CONFIG_RANGE
))) {
3499 DeleteKeyExchangeKey (Private
, QuestionId
);
3500 } else if ((QuestionId
>= OPTION_DEL_DB_QUESTION_ID
) &&
3501 (QuestionId
< (OPTION_DEL_DB_QUESTION_ID
+ OPTION_CONFIG_RANGE
))) {
3504 EFI_IMAGE_SECURITY_DATABASE
,
3505 &gEfiImageSecurityDatabaseGuid
,
3507 SECUREBOOT_DELETE_SIGNATURE_FROM_DB
,
3508 OPTION_DEL_DB_QUESTION_ID
,
3509 QuestionId
- OPTION_DEL_DB_QUESTION_ID
3511 } else if ((QuestionId
>= OPTION_DEL_DBX_QUESTION_ID
) &&
3512 (QuestionId
< (OPTION_DEL_DBX_QUESTION_ID
+ OPTION_CONFIG_RANGE
))) {
3515 EFI_IMAGE_SECURITY_DATABASE1
,
3516 &gEfiImageSecurityDatabaseGuid
,
3518 SECUREBOOT_DELETE_SIGNATURE_FROM_DBX
,
3519 OPTION_DEL_DBX_QUESTION_ID
,
3520 QuestionId
- OPTION_DEL_DBX_QUESTION_ID
3522 } else if ((QuestionId
>= OPTION_DEL_DBT_QUESTION_ID
) &&
3523 (QuestionId
< (OPTION_DEL_DBT_QUESTION_ID
+ OPTION_CONFIG_RANGE
))) {
3526 EFI_IMAGE_SECURITY_DATABASE2
,
3527 &gEfiImageSecurityDatabaseGuid
,
3529 SECUREBOOT_DELETE_SIGNATURE_FROM_DBT
,
3530 OPTION_DEL_DBT_QUESTION_ID
,
3531 QuestionId
- OPTION_DEL_DBT_QUESTION_ID
3536 case KEY_VALUE_NO_SAVE_AND_EXIT_PK
:
3537 case KEY_VALUE_NO_SAVE_AND_EXIT_KEK
:
3538 case KEY_VALUE_NO_SAVE_AND_EXIT_DB
:
3539 case KEY_VALUE_NO_SAVE_AND_EXIT_DBX
:
3540 case KEY_VALUE_NO_SAVE_AND_EXIT_DBT
:
3541 if (Private
->FileContext
->FHandle
!= NULL
) {
3542 CloseFile (Private
->FileContext
->FHandle
);
3543 Private
->FileContext
->FHandle
= NULL
;
3544 if (Private
->FileContext
->FileName
!= NULL
){
3545 FreePool(Private
->FileContext
->FileName
);
3546 Private
->FileContext
->FileName
= NULL
;
3550 if (Private
->SignatureGUID
!= NULL
) {
3551 FreePool (Private
->SignatureGUID
);
3552 Private
->SignatureGUID
= NULL
;
3556 } else if (Action
== EFI_BROWSER_ACTION_CHANGED
) {
3557 switch (QuestionId
) {
3558 case KEY_SECURE_BOOT_ENABLE
:
3559 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_FORM_APPLY
;
3561 case KEY_SECURE_BOOT_MODE
:
3562 mIsEnterSecureBootForm
= FALSE
;
3564 case KEY_SECURE_BOOT_KEK_GUID
:
3565 case KEY_SECURE_BOOT_SIGNATURE_GUID_DB
:
3566 case KEY_SECURE_BOOT_SIGNATURE_GUID_DBX
:
3567 case KEY_SECURE_BOOT_SIGNATURE_GUID_DBT
:
3568 ASSERT (Private
->SignatureGUID
!= NULL
);
3569 Status
= StringToGuid (
3570 IfrNvData
->SignatureGuid
,
3571 StrLen (IfrNvData
->SignatureGuid
),
3572 Private
->SignatureGUID
3574 if (EFI_ERROR (Status
)) {
3578 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_FORM_APPLY
;
3581 case KEY_SECURE_BOOT_DELETE_PK
:
3582 GetVariable2 (EFI_SETUP_MODE_NAME
, &gEfiGlobalVariableGuid
, (VOID
**)&SetupMode
, NULL
);
3583 if (SetupMode
== NULL
|| (*SetupMode
) == SETUP_MODE
) {
3584 IfrNvData
->DeletePk
= TRUE
;
3585 IfrNvData
->HasPk
= FALSE
;
3586 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_SUBMIT
;
3588 IfrNvData
->DeletePk
= FALSE
;
3589 IfrNvData
->HasPk
= TRUE
;
3590 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_FORM_APPLY
;
3592 if (SetupMode
!= NULL
) {
3593 FreePool (SetupMode
);
3599 } else if (Action
== EFI_BROWSER_ACTION_DEFAULT_STANDARD
) {
3600 if (QuestionId
== KEY_HIDE_SECURE_BOOT
) {
3601 GetVariable2 (EFI_PLATFORM_KEY_NAME
, &gEfiGlobalVariableGuid
, (VOID
**)&Pk
, NULL
);
3603 IfrNvData
->HideSecureBoot
= TRUE
;
3606 IfrNvData
->HideSecureBoot
= FALSE
;
3608 Value
->b
= IfrNvData
->HideSecureBoot
;
3610 } else if (Action
== EFI_BROWSER_ACTION_FORM_CLOSE
) {
3612 // Force the platform back to Standard Mode once user leave the setup screen.
3614 GetVariable2 (EFI_CUSTOM_MODE_NAME
, &gEfiCustomModeEnableGuid
, (VOID
**)&SecureBootMode
, NULL
);
3615 if (NULL
!= SecureBootMode
&& *SecureBootMode
== CUSTOM_SECURE_BOOT_MODE
) {
3616 IfrNvData
->SecureBootMode
= STANDARD_SECURE_BOOT_MODE
;
3617 SetSecureBootMode(STANDARD_SECURE_BOOT_MODE
);
3619 if (SecureBootMode
!= NULL
) {
3620 FreePool (SecureBootMode
);
3626 if (!EFI_ERROR (Status
)) {
3627 BufferSize
= sizeof (SECUREBOOT_CONFIGURATION
);
3628 HiiSetBrowserData (&gSecureBootConfigFormSetGuid
, mSecureBootStorageName
, BufferSize
, (UINT8
*) IfrNvData
, NULL
);
3631 FreePool (IfrNvData
);
3642 This function publish the SecureBoot configuration Form.
3644 @param[in, out] PrivateData Points to SecureBoot configuration private data.
3646 @retval EFI_SUCCESS HII Form is installed successfully.
3647 @retval EFI_OUT_OF_RESOURCES Not enough resource for HII Form installation.
3648 @retval Others Other errors as indicated.
3652 InstallSecureBootConfigForm (
3653 IN OUT SECUREBOOT_CONFIG_PRIVATE_DATA
*PrivateData
3657 EFI_HII_HANDLE HiiHandle
;
3658 EFI_HANDLE DriverHandle
;
3659 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
3661 DriverHandle
= NULL
;
3662 ConfigAccess
= &PrivateData
->ConfigAccess
;
3663 Status
= gBS
->InstallMultipleProtocolInterfaces (
3665 &gEfiDevicePathProtocolGuid
,
3666 &mSecureBootHiiVendorDevicePath
,
3667 &gEfiHiiConfigAccessProtocolGuid
,
3671 if (EFI_ERROR (Status
)) {
3675 PrivateData
->DriverHandle
= DriverHandle
;
3678 // Publish the HII package list
3680 HiiHandle
= HiiAddPackages (
3681 &gSecureBootConfigFormSetGuid
,
3683 SecureBootConfigDxeStrings
,
3684 SecureBootConfigBin
,
3687 if (HiiHandle
== NULL
) {
3688 gBS
->UninstallMultipleProtocolInterfaces (
3690 &gEfiDevicePathProtocolGuid
,
3691 &mSecureBootHiiVendorDevicePath
,
3692 &gEfiHiiConfigAccessProtocolGuid
,
3696 return EFI_OUT_OF_RESOURCES
;
3699 PrivateData
->HiiHandle
= HiiHandle
;
3701 PrivateData
->FileContext
= AllocateZeroPool (sizeof (SECUREBOOT_FILE_CONTEXT
));
3703 if (PrivateData
->FileContext
== NULL
) {
3704 UninstallSecureBootConfigForm (PrivateData
);
3705 return EFI_OUT_OF_RESOURCES
;
3709 // Init OpCode Handle and Allocate space for creation of Buffer
3711 mStartOpCodeHandle
= HiiAllocateOpCodeHandle ();
3712 if (mStartOpCodeHandle
== NULL
) {
3713 UninstallSecureBootConfigForm (PrivateData
);
3714 return EFI_OUT_OF_RESOURCES
;
3717 mEndOpCodeHandle
= HiiAllocateOpCodeHandle ();
3718 if (mEndOpCodeHandle
== NULL
) {
3719 UninstallSecureBootConfigForm (PrivateData
);
3720 return EFI_OUT_OF_RESOURCES
;
3724 // Create Hii Extend Label OpCode as the start opcode
3726 mStartLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (
3730 sizeof (EFI_IFR_GUID_LABEL
)
3732 mStartLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
3735 // Create Hii Extend Label OpCode as the end opcode
3737 mEndLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (
3741 sizeof (EFI_IFR_GUID_LABEL
)
3743 mEndLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
3744 mEndLabel
->Number
= LABEL_END
;
3750 This function removes SecureBoot configuration Form.
3752 @param[in, out] PrivateData Points to SecureBoot configuration private data.
3756 UninstallSecureBootConfigForm (
3757 IN OUT SECUREBOOT_CONFIG_PRIVATE_DATA
*PrivateData
3761 // Uninstall HII package list
3763 if (PrivateData
->HiiHandle
!= NULL
) {
3764 HiiRemovePackages (PrivateData
->HiiHandle
);
3765 PrivateData
->HiiHandle
= NULL
;
3769 // Uninstall HII Config Access Protocol
3771 if (PrivateData
->DriverHandle
!= NULL
) {
3772 gBS
->UninstallMultipleProtocolInterfaces (
3773 PrivateData
->DriverHandle
,
3774 &gEfiDevicePathProtocolGuid
,
3775 &mSecureBootHiiVendorDevicePath
,
3776 &gEfiHiiConfigAccessProtocolGuid
,
3777 &PrivateData
->ConfigAccess
,
3780 PrivateData
->DriverHandle
= NULL
;
3783 if (PrivateData
->SignatureGUID
!= NULL
) {
3784 FreePool (PrivateData
->SignatureGUID
);
3787 if (PrivateData
->FileContext
!= NULL
) {
3788 FreePool (PrivateData
->FileContext
);
3791 FreePool (PrivateData
);
3793 if (mStartOpCodeHandle
!= NULL
) {
3794 HiiFreeOpCodeHandle (mStartOpCodeHandle
);
3797 if (mEndOpCodeHandle
!= NULL
) {
3798 HiiFreeOpCodeHandle (mEndOpCodeHandle
);