2 Implement authentication services for the authenticated variables.
4 Caution: This module requires additional review when modified.
5 This driver will have external input - variable data. It may be input in SMM mode.
6 This external input must be validated carefully to avoid security issue like
7 buffer overflow, integer overflow.
8 Variable attribute should also be checked to avoid authentication bypass.
9 The whole SMM authentication variable design relies on the integrity of flash part and SMM.
10 which is assumed to be protected by platform. All variable code and metadata in flash/SMM Memory
11 may not be modified without authorization. If platform fails to protect these resources,
12 the authentication service provided in this driver will be broken, and the behavior is undefined.
14 ProcessVarWithPk(), ProcessVarWithKek() and ProcessVariable() are the function to do
15 variable authentication.
17 VerifyTimeBasedPayloadAndUpdate() and VerifyCounterBasedPayload() are sub function to do verification.
18 They will do basic validation for authentication data structure, then call crypto library
19 to verify the signature.
21 Copyright (c) 2009 - 2019, Intel Corporation. All rights reserved.<BR>
22 Copyright (c) Microsoft Corporation.
23 SPDX-License-Identifier: BSD-2-Clause-Patent
27 #include "AuthServiceInternal.h"
29 #include <Protocol/VariablePolicy.h>
30 #include <Library/VariablePolicyLib.h>
33 // Public Exponent of RSA Key.
35 CONST UINT8 mRsaE
[] = { 0x01, 0x00, 0x01 };
37 CONST UINT8 mSha256OidValue
[] = { 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x01 };
40 // Requirement for different signature type which have been defined in UEFI spec.
41 // These data are used to perform SignatureList format check while setting PK/KEK variable.
43 EFI_SIGNATURE_ITEM mSupportSigItem
[] = {
44 //{SigType, SigHeaderSize, SigDataSize }
45 {EFI_CERT_SHA256_GUID
, 0, 32 },
46 {EFI_CERT_RSA2048_GUID
, 0, 256 },
47 {EFI_CERT_RSA2048_SHA256_GUID
, 0, 256 },
48 {EFI_CERT_SHA1_GUID
, 0, 20 },
49 {EFI_CERT_RSA2048_SHA1_GUID
, 0, 256 },
50 {EFI_CERT_X509_GUID
, 0, ((UINT32
) ~0)},
51 {EFI_CERT_SHA224_GUID
, 0, 28 },
52 {EFI_CERT_SHA384_GUID
, 0, 48 },
53 {EFI_CERT_SHA512_GUID
, 0, 64 },
54 {EFI_CERT_X509_SHA256_GUID
, 0, 48 },
55 {EFI_CERT_X509_SHA384_GUID
, 0, 64 },
56 {EFI_CERT_X509_SHA512_GUID
, 0, 80 }
60 Finds variable in storage blocks of volatile and non-volatile storage areas.
62 This code finds variable in storage blocks of volatile and non-volatile storage areas.
63 If VariableName is an empty string, then we just return the first
64 qualified variable without comparing VariableName and VendorGuid.
66 @param[in] VariableName Name of the variable to be found.
67 @param[in] VendorGuid Variable vendor GUID to be found.
68 @param[out] Data Pointer to data address.
69 @param[out] DataSize Pointer to data size.
71 @retval EFI_INVALID_PARAMETER If VariableName is not an empty string,
72 while VendorGuid is NULL.
73 @retval EFI_SUCCESS Variable successfully found.
74 @retval EFI_NOT_FOUND Variable not found
78 AuthServiceInternalFindVariable (
79 IN CHAR16
*VariableName
,
80 IN EFI_GUID
*VendorGuid
,
86 AUTH_VARIABLE_INFO AuthVariableInfo
;
88 ZeroMem (&AuthVariableInfo
, sizeof (AuthVariableInfo
));
89 Status
= mAuthVarLibContextIn
->FindVariable (
94 *Data
= AuthVariableInfo
.Data
;
95 *DataSize
= AuthVariableInfo
.DataSize
;
100 Update the variable region with Variable information.
102 @param[in] VariableName Name of variable.
103 @param[in] VendorGuid Guid of variable.
104 @param[in] Data Data pointer.
105 @param[in] DataSize Size of Data.
106 @param[in] Attributes Attribute value of the variable.
108 @retval EFI_SUCCESS The update operation is success.
109 @retval EFI_INVALID_PARAMETER Invalid parameter.
110 @retval EFI_WRITE_PROTECTED Variable is write-protected.
111 @retval EFI_OUT_OF_RESOURCES There is not enough resource.
115 AuthServiceInternalUpdateVariable (
116 IN CHAR16
*VariableName
,
117 IN EFI_GUID
*VendorGuid
,
123 AUTH_VARIABLE_INFO AuthVariableInfo
;
125 ZeroMem (&AuthVariableInfo
, sizeof (AuthVariableInfo
));
126 AuthVariableInfo
.VariableName
= VariableName
;
127 AuthVariableInfo
.VendorGuid
= VendorGuid
;
128 AuthVariableInfo
.Data
= Data
;
129 AuthVariableInfo
.DataSize
= DataSize
;
130 AuthVariableInfo
.Attributes
= Attributes
;
132 return mAuthVarLibContextIn
->UpdateVariable (
138 Update the variable region with Variable information.
140 @param[in] VariableName Name of variable.
141 @param[in] VendorGuid Guid of variable.
142 @param[in] Data Data pointer.
143 @param[in] DataSize Size of Data.
144 @param[in] Attributes Attribute value of the variable.
145 @param[in] TimeStamp Value of associated TimeStamp.
147 @retval EFI_SUCCESS The update operation is success.
148 @retval EFI_INVALID_PARAMETER Invalid parameter.
149 @retval EFI_WRITE_PROTECTED Variable is write-protected.
150 @retval EFI_OUT_OF_RESOURCES There is not enough resource.
154 AuthServiceInternalUpdateVariableWithTimeStamp (
155 IN CHAR16
*VariableName
,
156 IN EFI_GUID
*VendorGuid
,
159 IN UINT32 Attributes
,
160 IN EFI_TIME
*TimeStamp
163 EFI_STATUS FindStatus
;
166 AUTH_VARIABLE_INFO AuthVariableInfo
;
168 FindStatus
= AuthServiceInternalFindVariable (
176 // EFI_VARIABLE_APPEND_WRITE attribute only effects for existing variable
178 if (!EFI_ERROR (FindStatus
) && ((Attributes
& EFI_VARIABLE_APPEND_WRITE
) != 0)) {
179 if ((CompareGuid (VendorGuid
, &gEfiImageSecurityDatabaseGuid
) &&
180 ((StrCmp (VariableName
, EFI_IMAGE_SECURITY_DATABASE
) == 0) || (StrCmp (VariableName
, EFI_IMAGE_SECURITY_DATABASE1
) == 0) ||
181 (StrCmp (VariableName
, EFI_IMAGE_SECURITY_DATABASE2
) == 0))) ||
182 (CompareGuid (VendorGuid
, &gEfiGlobalVariableGuid
) && (StrCmp (VariableName
, EFI_KEY_EXCHANGE_KEY_NAME
) == 0))) {
184 // For variables with formatted as EFI_SIGNATURE_LIST, the driver shall not perform an append of
185 // EFI_SIGNATURE_DATA values that are already part of the existing variable value.
187 FilterSignatureList (
196 ZeroMem (&AuthVariableInfo
, sizeof (AuthVariableInfo
));
197 AuthVariableInfo
.VariableName
= VariableName
;
198 AuthVariableInfo
.VendorGuid
= VendorGuid
;
199 AuthVariableInfo
.Data
= Data
;
200 AuthVariableInfo
.DataSize
= DataSize
;
201 AuthVariableInfo
.Attributes
= Attributes
;
202 AuthVariableInfo
.TimeStamp
= TimeStamp
;
203 return mAuthVarLibContextIn
->UpdateVariable (
209 Determine whether this operation needs a physical present user.
211 @param[in] VariableName Name of the Variable.
212 @param[in] VendorGuid GUID of the Variable.
214 @retval TRUE This variable is protected, only a physical present user could set this variable.
215 @retval FALSE This variable is not protected.
219 NeedPhysicallyPresent(
220 IN CHAR16
*VariableName
,
221 IN EFI_GUID
*VendorGuid
224 // If the VariablePolicy engine is disabled, allow deletion of any authenticated variables.
225 if (IsVariablePolicyEnabled()) {
226 if ((CompareGuid (VendorGuid
, &gEfiSecureBootEnableDisableGuid
) && (StrCmp (VariableName
, EFI_SECURE_BOOT_ENABLE_NAME
) == 0))
227 || (CompareGuid (VendorGuid
, &gEfiCustomModeEnableGuid
) && (StrCmp (VariableName
, EFI_CUSTOM_MODE_NAME
) == 0))) {
236 Determine whether the platform is operating in Custom Secure Boot mode.
238 @retval TRUE The platform is operating in Custom mode.
239 @retval FALSE The platform is operating in Standard mode.
251 Status
= AuthServiceInternalFindVariable (EFI_CUSTOM_MODE_NAME
, &gEfiCustomModeEnableGuid
, &Data
, &DataSize
);
252 if (!EFI_ERROR (Status
) && (*(UINT8
*) Data
== CUSTOM_SECURE_BOOT_MODE
)) {
260 Update platform mode.
262 @param[in] Mode SETUP_MODE or USER_MODE.
264 @return EFI_INVALID_PARAMETER Invalid parameter.
265 @return EFI_SUCCESS Update platform mode successfully.
276 UINT8 SecureBootMode
;
277 UINT8 SecureBootEnable
;
278 UINTN VariableDataSize
;
280 Status
= AuthServiceInternalFindVariable (
282 &gEfiGlobalVariableGuid
,
286 if (EFI_ERROR (Status
)) {
291 // Update the value of SetupMode variable by a simple mem copy, this could avoid possible
292 // variable storage reclaim at runtime.
294 mPlatformMode
= (UINT8
) Mode
;
295 CopyMem (Data
, &mPlatformMode
, sizeof(UINT8
));
297 if (mAuthVarLibContextIn
->AtRuntime ()) {
299 // SecureBoot Variable indicates whether the platform firmware is operating
300 // in Secure boot mode (1) or not (0), so we should not change SecureBoot
301 // Variable in runtime.
307 // Check "SecureBoot" variable's existence.
308 // If it doesn't exist, firmware has no capability to perform driver signing verification,
309 // then set "SecureBoot" to 0.
311 Status
= AuthServiceInternalFindVariable (
312 EFI_SECURE_BOOT_MODE_NAME
,
313 &gEfiGlobalVariableGuid
,
318 // If "SecureBoot" variable exists, then check "SetupMode" variable update.
319 // If "SetupMode" variable is USER_MODE, "SecureBoot" variable is set to 1.
320 // If "SetupMode" variable is SETUP_MODE, "SecureBoot" variable is set to 0.
322 if (EFI_ERROR (Status
)) {
323 SecureBootMode
= SECURE_BOOT_MODE_DISABLE
;
325 if (mPlatformMode
== USER_MODE
) {
326 SecureBootMode
= SECURE_BOOT_MODE_ENABLE
;
327 } else if (mPlatformMode
== SETUP_MODE
) {
328 SecureBootMode
= SECURE_BOOT_MODE_DISABLE
;
330 return EFI_NOT_FOUND
;
334 Status
= AuthServiceInternalUpdateVariable (
335 EFI_SECURE_BOOT_MODE_NAME
,
336 &gEfiGlobalVariableGuid
,
339 EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_BOOTSERVICE_ACCESS
341 if (EFI_ERROR (Status
)) {
346 // Check "SecureBootEnable" variable's existence. It can enable/disable secure boot feature.
348 Status
= AuthServiceInternalFindVariable (
349 EFI_SECURE_BOOT_ENABLE_NAME
,
350 &gEfiSecureBootEnableDisableGuid
,
355 if (SecureBootMode
== SECURE_BOOT_MODE_ENABLE
) {
357 // Create the "SecureBootEnable" variable as secure boot is enabled.
359 SecureBootEnable
= SECURE_BOOT_ENABLE
;
360 VariableDataSize
= sizeof (SecureBootEnable
);
363 // Delete the "SecureBootEnable" variable if this variable exist as "SecureBoot"
364 // variable is not in secure boot state.
366 if (EFI_ERROR (Status
)) {
369 SecureBootEnable
= SECURE_BOOT_DISABLE
;
370 VariableDataSize
= 0;
373 Status
= AuthServiceInternalUpdateVariable (
374 EFI_SECURE_BOOT_ENABLE_NAME
,
375 &gEfiSecureBootEnableDisableGuid
,
378 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
384 Check input data form to make sure it is a valid EFI_SIGNATURE_LIST for PK/KEK/db/dbx/dbt variable.
386 @param[in] VariableName Name of Variable to be check.
387 @param[in] VendorGuid Variable vendor GUID.
388 @param[in] Data Point to the variable data to be checked.
389 @param[in] DataSize Size of Data.
391 @return EFI_INVALID_PARAMETER Invalid signature list format.
392 @return EFI_SUCCESS Passed signature list format check successfully.
396 CheckSignatureListFormat(
397 IN CHAR16
*VariableName
,
398 IN EFI_GUID
*VendorGuid
,
403 EFI_SIGNATURE_LIST
*SigList
;
409 EFI_SIGNATURE_DATA
*CertData
;
416 ASSERT (VariableName
!= NULL
&& VendorGuid
!= NULL
&& Data
!= NULL
);
418 if (CompareGuid (VendorGuid
, &gEfiGlobalVariableGuid
) && (StrCmp (VariableName
, EFI_PLATFORM_KEY_NAME
) == 0)){
420 } else if ((CompareGuid (VendorGuid
, &gEfiGlobalVariableGuid
) && (StrCmp (VariableName
, EFI_KEY_EXCHANGE_KEY_NAME
) == 0)) ||
421 (CompareGuid (VendorGuid
, &gEfiImageSecurityDatabaseGuid
) &&
422 ((StrCmp (VariableName
, EFI_IMAGE_SECURITY_DATABASE
) == 0) || (StrCmp (VariableName
, EFI_IMAGE_SECURITY_DATABASE1
) == 0) ||
423 (StrCmp (VariableName
, EFI_IMAGE_SECURITY_DATABASE2
) == 0)))) {
430 SigList
= (EFI_SIGNATURE_LIST
*) Data
;
431 SigDataSize
= DataSize
;
435 // Walk through the input signature list and check the data format.
436 // If any signature is incorrectly formed, the whole check will fail.
438 while ((SigDataSize
> 0) && (SigDataSize
>= SigList
->SignatureListSize
)) {
439 for (Index
= 0; Index
< (sizeof (mSupportSigItem
) / sizeof (EFI_SIGNATURE_ITEM
)); Index
++ ) {
440 if (CompareGuid (&SigList
->SignatureType
, &mSupportSigItem
[Index
].SigType
)) {
442 // The value of SignatureSize should always be 16 (size of SignatureOwner
443 // component) add the data length according to signature type.
445 if (mSupportSigItem
[Index
].SigDataSize
!= ((UINT32
) ~0) &&
446 (SigList
->SignatureSize
- sizeof (EFI_GUID
)) != mSupportSigItem
[Index
].SigDataSize
) {
447 return EFI_INVALID_PARAMETER
;
449 if (mSupportSigItem
[Index
].SigHeaderSize
!= ((UINT32
) ~0) &&
450 SigList
->SignatureHeaderSize
!= mSupportSigItem
[Index
].SigHeaderSize
) {
451 return EFI_INVALID_PARAMETER
;
457 if (Index
== (sizeof (mSupportSigItem
) / sizeof (EFI_SIGNATURE_ITEM
))) {
459 // Undefined signature type.
461 return EFI_INVALID_PARAMETER
;
464 if (CompareGuid (&SigList
->SignatureType
, &gEfiCertX509Guid
)) {
466 // Try to retrieve the RSA public key from the X.509 certificate.
467 // If this operation fails, it's not a valid certificate.
469 RsaContext
= RsaNew ();
470 if (RsaContext
== NULL
) {
471 return EFI_INVALID_PARAMETER
;
473 CertData
= (EFI_SIGNATURE_DATA
*) ((UINT8
*) SigList
+ sizeof (EFI_SIGNATURE_LIST
) + SigList
->SignatureHeaderSize
);
474 CertLen
= SigList
->SignatureSize
- sizeof (EFI_GUID
);
475 if (!RsaGetPublicKeyFromX509 (CertData
->SignatureData
, CertLen
, &RsaContext
)) {
476 RsaFree (RsaContext
);
477 return EFI_INVALID_PARAMETER
;
479 RsaFree (RsaContext
);
482 if ((SigList
->SignatureListSize
- sizeof (EFI_SIGNATURE_LIST
) - SigList
->SignatureHeaderSize
) % SigList
->SignatureSize
!= 0) {
483 return EFI_INVALID_PARAMETER
;
485 SigCount
+= (SigList
->SignatureListSize
- sizeof (EFI_SIGNATURE_LIST
) - SigList
->SignatureHeaderSize
) / SigList
->SignatureSize
;
487 SigDataSize
-= SigList
->SignatureListSize
;
488 SigList
= (EFI_SIGNATURE_LIST
*) ((UINT8
*) SigList
+ SigList
->SignatureListSize
);
491 if (((UINTN
) SigList
- (UINTN
) Data
) != DataSize
) {
492 return EFI_INVALID_PARAMETER
;
495 if (IsPk
&& SigCount
> 1) {
496 return EFI_INVALID_PARAMETER
;
503 Update "VendorKeys" variable to record the out of band secure boot key modification.
505 @return EFI_SUCCESS Variable is updated successfully.
506 @return Others Failed to update variable.
510 VendorKeyIsModified (
516 if (mVendorKeyState
== VENDOR_KEYS_MODIFIED
) {
519 mVendorKeyState
= VENDOR_KEYS_MODIFIED
;
521 Status
= AuthServiceInternalUpdateVariable (
522 EFI_VENDOR_KEYS_NV_VARIABLE_NAME
,
523 &gEfiVendorKeysNvGuid
,
526 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
528 if (EFI_ERROR (Status
)) {
532 return AuthServiceInternalUpdateVariable (
533 EFI_VENDOR_KEYS_VARIABLE_NAME
,
534 &gEfiGlobalVariableGuid
,
537 EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_BOOTSERVICE_ACCESS
542 Process variable with platform key for verification.
544 Caution: This function may receive untrusted input.
545 This function may be invoked in SMM mode, and datasize and data are external input.
546 This function will do basic validation, before parse the data.
547 This function will parse the authentication carefully to avoid security issues, like
548 buffer overflow, integer overflow.
549 This function will check attribute carefully to avoid authentication bypass.
551 @param[in] VariableName Name of Variable to be found.
552 @param[in] VendorGuid Variable vendor GUID.
553 @param[in] Data Data pointer.
554 @param[in] DataSize Size of Data found. If size is less than the
555 data, this value contains the required size.
556 @param[in] Attributes Attribute value of the variable
557 @param[in] IsPk Indicate whether it is to process pk.
559 @return EFI_INVALID_PARAMETER Invalid parameter.
560 @return EFI_SECURITY_VIOLATION The variable does NOT pass the validation.
561 check carried out by the firmware.
562 @return EFI_SUCCESS Variable passed validation successfully.
567 IN CHAR16
*VariableName
,
568 IN EFI_GUID
*VendorGuid
,
571 IN UINT32 Attributes OPTIONAL
,
580 if ((Attributes
& EFI_VARIABLE_NON_VOLATILE
) == 0 ||
581 (Attributes
& EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
) == 0) {
583 // PK, KEK and db/dbx/dbt should set EFI_VARIABLE_NON_VOLATILE attribute and should be a time-based
584 // authenticated variable.
586 return EFI_INVALID_PARAMETER
;
590 // Init state of Del. State may change due to secure check
593 if ((InCustomMode() && UserPhysicalPresent()) || (mPlatformMode
== SETUP_MODE
&& !IsPk
)) {
594 Payload
= (UINT8
*) Data
+ AUTHINFO2_SIZE (Data
);
595 PayloadSize
= DataSize
- AUTHINFO2_SIZE (Data
);
596 if (PayloadSize
== 0) {
600 Status
= CheckSignatureListFormat(VariableName
, VendorGuid
, Payload
, PayloadSize
);
601 if (EFI_ERROR (Status
)) {
605 Status
= AuthServiceInternalUpdateVariableWithTimeStamp (
611 &((EFI_VARIABLE_AUTHENTICATION_2
*) Data
)->TimeStamp
613 if (EFI_ERROR(Status
)) {
617 if ((mPlatformMode
!= SETUP_MODE
) || IsPk
) {
618 Status
= VendorKeyIsModified ();
620 } else if (mPlatformMode
== USER_MODE
) {
622 // Verify against X509 Cert in PK database.
624 Status
= VerifyTimeBasedPayloadAndUpdate (
635 // Verify against the certificate in data payload.
637 Status
= VerifyTimeBasedPayloadAndUpdate (
648 if (!EFI_ERROR(Status
) && IsPk
) {
649 if (mPlatformMode
== SETUP_MODE
&& !Del
) {
651 // If enroll PK in setup mode, need change to user mode.
653 Status
= UpdatePlatformMode (USER_MODE
);
654 } else if (mPlatformMode
== USER_MODE
&& Del
){
656 // If delete PK in user mode, need change to setup mode.
658 Status
= UpdatePlatformMode (SETUP_MODE
);
666 Process variable with key exchange key for verification.
668 Caution: This function may receive untrusted input.
669 This function may be invoked in SMM mode, and datasize and data are external input.
670 This function will do basic validation, before parse the data.
671 This function will parse the authentication carefully to avoid security issues, like
672 buffer overflow, integer overflow.
673 This function will check attribute carefully to avoid authentication bypass.
675 @param[in] VariableName Name of Variable to be found.
676 @param[in] VendorGuid Variable vendor GUID.
677 @param[in] Data Data pointer.
678 @param[in] DataSize Size of Data found. If size is less than the
679 data, this value contains the required size.
680 @param[in] Attributes Attribute value of the variable.
682 @return EFI_INVALID_PARAMETER Invalid parameter.
683 @return EFI_SECURITY_VIOLATION The variable does NOT pass the validation
684 check carried out by the firmware.
685 @return EFI_SUCCESS Variable pass validation successfully.
690 IN CHAR16
*VariableName
,
691 IN EFI_GUID
*VendorGuid
,
694 IN UINT32 Attributes OPTIONAL
701 if ((Attributes
& EFI_VARIABLE_NON_VOLATILE
) == 0 ||
702 (Attributes
& EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
) == 0) {
704 // DB, DBX and DBT should set EFI_VARIABLE_NON_VOLATILE attribute and should be a time-based
705 // authenticated variable.
707 return EFI_INVALID_PARAMETER
;
710 Status
= EFI_SUCCESS
;
711 if (mPlatformMode
== USER_MODE
&& !(InCustomMode() && UserPhysicalPresent())) {
713 // Time-based, verify against X509 Cert KEK.
715 return VerifyTimeBasedPayloadAndUpdate (
726 // If in setup mode or custom secure boot mode, no authentication needed.
728 Payload
= (UINT8
*) Data
+ AUTHINFO2_SIZE (Data
);
729 PayloadSize
= DataSize
- AUTHINFO2_SIZE (Data
);
731 Status
= CheckSignatureListFormat(VariableName
, VendorGuid
, Payload
, PayloadSize
);
732 if (EFI_ERROR (Status
)) {
736 Status
= AuthServiceInternalUpdateVariableWithTimeStamp (
742 &((EFI_VARIABLE_AUTHENTICATION_2
*) Data
)->TimeStamp
744 if (EFI_ERROR (Status
)) {
748 if (mPlatformMode
!= SETUP_MODE
) {
749 Status
= VendorKeyIsModified ();
757 Check if it is to delete auth variable.
759 @param[in] OrgAttributes Original attribute value of the variable.
760 @param[in] Data Data pointer.
761 @param[in] DataSize Size of Data.
762 @param[in] Attributes Attribute value of the variable.
764 @retval TRUE It is to delete auth variable.
765 @retval FALSE It is not to delete auth variable.
769 IsDeleteAuthVariable (
770 IN UINT32 OrgAttributes
,
782 // To delete a variable created with the EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
783 // or the EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute,
784 // SetVariable must be used with attributes matching the existing variable
785 // and the DataSize set to the size of the AuthInfo descriptor.
787 if ((Attributes
== OrgAttributes
) &&
788 ((Attributes
& (EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
)) != 0)) {
789 if ((Attributes
& EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
) != 0) {
790 PayloadSize
= DataSize
- AUTHINFO2_SIZE (Data
);
791 if (PayloadSize
== 0) {
795 PayloadSize
= DataSize
- AUTHINFO_SIZE
;
796 if (PayloadSize
== 0) {
806 Process variable with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set
808 Caution: This function may receive untrusted input.
809 This function may be invoked in SMM mode, and datasize and data are external input.
810 This function will do basic validation, before parse the data.
811 This function will parse the authentication carefully to avoid security issues, like
812 buffer overflow, integer overflow.
813 This function will check attribute carefully to avoid authentication bypass.
815 @param[in] VariableName Name of the variable.
816 @param[in] VendorGuid Variable vendor GUID.
817 @param[in] Data Data pointer.
818 @param[in] DataSize Size of Data.
819 @param[in] Attributes Attribute value of the variable.
821 @return EFI_INVALID_PARAMETER Invalid parameter.
822 @return EFI_WRITE_PROTECTED Variable is write-protected and needs authentication with
823 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set.
824 @return EFI_OUT_OF_RESOURCES The Database to save the public key is full.
825 @return EFI_SECURITY_VIOLATION The variable is with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
826 set, but the AuthInfo does NOT pass the validation
827 check carried out by the firmware.
828 @return EFI_SUCCESS Variable is not write-protected or pass validation successfully.
833 IN CHAR16
*VariableName
,
834 IN EFI_GUID
*VendorGuid
,
841 AUTH_VARIABLE_INFO OrgVariableInfo
;
843 Status
= EFI_SUCCESS
;
845 ZeroMem (&OrgVariableInfo
, sizeof (OrgVariableInfo
));
846 Status
= mAuthVarLibContextIn
->FindVariable (
852 // If the VariablePolicy engine is disabled, allow deletion of any authenticated variables.
853 if ((!EFI_ERROR (Status
)) && IsDeleteAuthVariable (OrgVariableInfo
.Attributes
, Data
, DataSize
, Attributes
) && (UserPhysicalPresent() || !IsVariablePolicyEnabled())) {
855 // Allow the delete operation of common authenticated variable(AT or AW) at user physical presence.
857 Status
= AuthServiceInternalUpdateVariable (
864 if (!EFI_ERROR (Status
) && ((Attributes
& EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
) != 0)) {
865 Status
= DeleteCertsFromDb (VariableName
, VendorGuid
, Attributes
);
871 if (NeedPhysicallyPresent (VariableName
, VendorGuid
) && !UserPhysicalPresent()) {
873 // This variable is protected, only physical present user could modify its value.
875 return EFI_SECURITY_VIOLATION
;
879 if ((Attributes
& EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
) != 0) {
881 // Reject Counter Based Auth Variable processing request.
883 return EFI_UNSUPPORTED
;
884 } else if ((Attributes
& EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
) != 0) {
886 // Process Time-based Authenticated variable.
888 return VerifyTimeBasedPayloadAndUpdate (
899 if ((OrgVariableInfo
.Data
!= NULL
) &&
900 ((OrgVariableInfo
.Attributes
& (EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
)) != 0)) {
902 // If the variable is already write-protected, it always needs authentication before update.
904 return EFI_WRITE_PROTECTED
;
908 // Not authenticated variable, just update variable as usual.
910 Status
= AuthServiceInternalUpdateVariable (VariableName
, VendorGuid
, Data
, DataSize
, Attributes
);
916 Filter out the duplicated EFI_SIGNATURE_DATA from the new data by comparing to the original data.
918 @param[in] Data Pointer to original EFI_SIGNATURE_LIST.
919 @param[in] DataSize Size of Data buffer.
920 @param[in, out] NewData Pointer to new EFI_SIGNATURE_LIST.
921 @param[in, out] NewDataSize Size of NewData buffer.
925 FilterSignatureList (
928 IN OUT VOID
*NewData
,
929 IN OUT UINTN
*NewDataSize
932 EFI_SIGNATURE_LIST
*CertList
;
933 EFI_SIGNATURE_DATA
*Cert
;
935 EFI_SIGNATURE_LIST
*NewCertList
;
936 EFI_SIGNATURE_DATA
*NewCert
;
943 UINTN SignatureListSize
;
949 if (*NewDataSize
== 0) {
953 TempDataSize
= *NewDataSize
;
954 Status
= mAuthVarLibContextIn
->GetScratchBuffer (&TempDataSize
, (VOID
**) &TempData
);
955 if (EFI_ERROR (Status
)) {
956 return EFI_OUT_OF_RESOURCES
;
961 NewCertList
= (EFI_SIGNATURE_LIST
*) NewData
;
962 while ((*NewDataSize
> 0) && (*NewDataSize
>= NewCertList
->SignatureListSize
)) {
963 NewCert
= (EFI_SIGNATURE_DATA
*) ((UINT8
*) NewCertList
+ sizeof (EFI_SIGNATURE_LIST
) + NewCertList
->SignatureHeaderSize
);
964 NewCertCount
= (NewCertList
->SignatureListSize
- sizeof (EFI_SIGNATURE_LIST
) - NewCertList
->SignatureHeaderSize
) / NewCertList
->SignatureSize
;
967 for (Index
= 0; Index
< NewCertCount
; Index
++) {
971 CertList
= (EFI_SIGNATURE_LIST
*) Data
;
972 while ((Size
> 0) && (Size
>= CertList
->SignatureListSize
)) {
973 if (CompareGuid (&CertList
->SignatureType
, &NewCertList
->SignatureType
) &&
974 (CertList
->SignatureSize
== NewCertList
->SignatureSize
)) {
975 Cert
= (EFI_SIGNATURE_DATA
*) ((UINT8
*) CertList
+ sizeof (EFI_SIGNATURE_LIST
) + CertList
->SignatureHeaderSize
);
976 CertCount
= (CertList
->SignatureListSize
- sizeof (EFI_SIGNATURE_LIST
) - CertList
->SignatureHeaderSize
) / CertList
->SignatureSize
;
977 for (Index2
= 0; Index2
< CertCount
; Index2
++) {
979 // Iterate each Signature Data in this Signature List.
981 if (CompareMem (NewCert
, Cert
, CertList
->SignatureSize
) == 0) {
985 Cert
= (EFI_SIGNATURE_DATA
*) ((UINT8
*) Cert
+ CertList
->SignatureSize
);
992 Size
-= CertList
->SignatureListSize
;
993 CertList
= (EFI_SIGNATURE_LIST
*) ((UINT8
*) CertList
+ CertList
->SignatureListSize
);
998 // New EFI_SIGNATURE_DATA, keep it.
1000 if (CopiedCount
== 0) {
1002 // Copy EFI_SIGNATURE_LIST header for only once.
1004 CopyMem (Tail
, NewCertList
, sizeof (EFI_SIGNATURE_LIST
) + NewCertList
->SignatureHeaderSize
);
1005 Tail
= Tail
+ sizeof (EFI_SIGNATURE_LIST
) + NewCertList
->SignatureHeaderSize
;
1008 CopyMem (Tail
, NewCert
, NewCertList
->SignatureSize
);
1009 Tail
+= NewCertList
->SignatureSize
;
1013 NewCert
= (EFI_SIGNATURE_DATA
*) ((UINT8
*) NewCert
+ NewCertList
->SignatureSize
);
1017 // Update SignatureListSize in the kept EFI_SIGNATURE_LIST.
1019 if (CopiedCount
!= 0) {
1020 SignatureListSize
= sizeof (EFI_SIGNATURE_LIST
) + NewCertList
->SignatureHeaderSize
+ (CopiedCount
* NewCertList
->SignatureSize
);
1021 CertList
= (EFI_SIGNATURE_LIST
*) (Tail
- SignatureListSize
);
1022 CertList
->SignatureListSize
= (UINT32
) SignatureListSize
;
1025 *NewDataSize
-= NewCertList
->SignatureListSize
;
1026 NewCertList
= (EFI_SIGNATURE_LIST
*) ((UINT8
*) NewCertList
+ NewCertList
->SignatureListSize
);
1029 TempDataSize
= (Tail
- (UINT8
*) TempData
);
1031 CopyMem (NewData
, TempData
, TempDataSize
);
1032 *NewDataSize
= TempDataSize
;
1038 Compare two EFI_TIME data.
1041 @param FirstTime A pointer to the first EFI_TIME data.
1042 @param SecondTime A pointer to the second EFI_TIME data.
1044 @retval TRUE The FirstTime is not later than the SecondTime.
1045 @retval FALSE The FirstTime is later than the SecondTime.
1049 AuthServiceInternalCompareTimeStamp (
1050 IN EFI_TIME
*FirstTime
,
1051 IN EFI_TIME
*SecondTime
1054 if (FirstTime
->Year
!= SecondTime
->Year
) {
1055 return (BOOLEAN
) (FirstTime
->Year
< SecondTime
->Year
);
1056 } else if (FirstTime
->Month
!= SecondTime
->Month
) {
1057 return (BOOLEAN
) (FirstTime
->Month
< SecondTime
->Month
);
1058 } else if (FirstTime
->Day
!= SecondTime
->Day
) {
1059 return (BOOLEAN
) (FirstTime
->Day
< SecondTime
->Day
);
1060 } else if (FirstTime
->Hour
!= SecondTime
->Hour
) {
1061 return (BOOLEAN
) (FirstTime
->Hour
< SecondTime
->Hour
);
1062 } else if (FirstTime
->Minute
!= SecondTime
->Minute
) {
1063 return (BOOLEAN
) (FirstTime
->Minute
< SecondTime
->Minute
);
1066 return (BOOLEAN
) (FirstTime
->Second
<= SecondTime
->Second
);
1070 Calculate SHA256 digest of SignerCert CommonName + ToplevelCert tbsCertificate
1071 SignerCert and ToplevelCert are inside the signer certificate chain.
1073 @param[in] SignerCert A pointer to SignerCert data.
1074 @param[in] SignerCertSize Length of SignerCert data.
1075 @param[in] TopLevelCert A pointer to TopLevelCert data.
1076 @param[in] TopLevelCertSize Length of TopLevelCert data.
1077 @param[out] Sha256Digest Sha256 digest calculated.
1079 @return EFI_ABORTED Digest process failed.
1080 @return EFI_SUCCESS SHA256 Digest is successfully calculated.
1084 CalculatePrivAuthVarSignChainSHA256Digest(
1085 IN UINT8
*SignerCert
,
1086 IN UINTN SignerCertSize
,
1087 IN UINT8
*TopLevelCert
,
1088 IN UINTN TopLevelCertSize
,
1089 OUT UINT8
*Sha256Digest
1094 CHAR8 CertCommonName
[128];
1095 UINTN CertCommonNameSize
;
1096 BOOLEAN CryptoStatus
;
1099 CertCommonNameSize
= sizeof(CertCommonName
);
1102 // Get SignerCert CommonName
1104 Status
= X509GetCommonName(SignerCert
, SignerCertSize
, CertCommonName
, &CertCommonNameSize
);
1105 if (EFI_ERROR(Status
)) {
1106 DEBUG((DEBUG_INFO
, "%a Get SignerCert CommonName failed with status %x\n", __FUNCTION__
, Status
));
1111 // Get TopLevelCert tbsCertificate
1113 if (!X509GetTBSCert(TopLevelCert
, TopLevelCertSize
, &TbsCert
, &TbsCertSize
)) {
1114 DEBUG((DEBUG_INFO
, "%a Get Top-level Cert tbsCertificate failed!\n", __FUNCTION__
));
1119 // Digest SignerCert CN + TopLevelCert tbsCertificate
1121 ZeroMem (Sha256Digest
, SHA256_DIGEST_SIZE
);
1122 CryptoStatus
= Sha256Init (mHashCtx
);
1123 if (!CryptoStatus
) {
1128 // '\0' is forced in CertCommonName. No overflow issue
1130 CryptoStatus
= Sha256Update (
1133 AsciiStrLen (CertCommonName
)
1135 if (!CryptoStatus
) {
1139 CryptoStatus
= Sha256Update (mHashCtx
, TbsCert
, TbsCertSize
);
1140 if (!CryptoStatus
) {
1144 CryptoStatus
= Sha256Final (mHashCtx
, Sha256Digest
);
1145 if (!CryptoStatus
) {
1153 Find matching signer's certificates for common authenticated variable
1154 by corresponding VariableName and VendorGuid from "certdb" or "certdbv".
1156 The data format of "certdb" or "certdbv":
1158 // UINT32 CertDbListSize;
1159 // /// AUTH_CERT_DB_DATA Certs1[];
1160 // /// AUTH_CERT_DB_DATA Certs2[];
1162 // /// AUTH_CERT_DB_DATA Certsn[];
1165 @param[in] VariableName Name of authenticated Variable.
1166 @param[in] VendorGuid Vendor GUID of authenticated Variable.
1167 @param[in] Data Pointer to variable "certdb" or "certdbv".
1168 @param[in] DataSize Size of variable "certdb" or "certdbv".
1169 @param[out] CertOffset Offset of matching CertData, from starting of Data.
1170 @param[out] CertDataSize Length of CertData in bytes.
1171 @param[out] CertNodeOffset Offset of matching AUTH_CERT_DB_DATA , from
1173 @param[out] CertNodeSize Length of AUTH_CERT_DB_DATA in bytes.
1175 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
1176 @retval EFI_NOT_FOUND Fail to find matching certs.
1177 @retval EFI_SUCCESS Find matching certs and output parameters.
1182 IN CHAR16
*VariableName
,
1183 IN EFI_GUID
*VendorGuid
,
1186 OUT UINT32
*CertOffset
, OPTIONAL
1187 OUT UINT32
*CertDataSize
, OPTIONAL
1188 OUT UINT32
*CertNodeOffset
,OPTIONAL
1189 OUT UINT32
*CertNodeSize OPTIONAL
1193 AUTH_CERT_DB_DATA
*Ptr
;
1197 UINT32 CertDbListSize
;
1199 if ((VariableName
== NULL
) || (VendorGuid
== NULL
) || (Data
== NULL
)) {
1200 return EFI_INVALID_PARAMETER
;
1204 // Check whether DataSize matches recorded CertDbListSize.
1206 if (DataSize
< sizeof (UINT32
)) {
1207 return EFI_INVALID_PARAMETER
;
1210 CertDbListSize
= ReadUnaligned32 ((UINT32
*) Data
);
1212 if (CertDbListSize
!= (UINT32
) DataSize
) {
1213 return EFI_INVALID_PARAMETER
;
1216 Offset
= sizeof (UINT32
);
1219 // Get corresponding certificates by VendorGuid and VariableName.
1221 while (Offset
< (UINT32
) DataSize
) {
1222 Ptr
= (AUTH_CERT_DB_DATA
*) (Data
+ Offset
);
1224 // Check whether VendorGuid matches.
1226 if (CompareGuid (&Ptr
->VendorGuid
, VendorGuid
)) {
1227 NodeSize
= ReadUnaligned32 (&Ptr
->CertNodeSize
);
1228 NameSize
= ReadUnaligned32 (&Ptr
->NameSize
);
1229 CertSize
= ReadUnaligned32 (&Ptr
->CertDataSize
);
1231 if (NodeSize
!= sizeof (EFI_GUID
) + sizeof (UINT32
) * 3 + CertSize
+
1232 sizeof (CHAR16
) * NameSize
) {
1233 return EFI_INVALID_PARAMETER
;
1236 Offset
= Offset
+ sizeof (EFI_GUID
) + sizeof (UINT32
) * 3;
1238 // Check whether VariableName matches.
1240 if ((NameSize
== StrLen (VariableName
)) &&
1241 (CompareMem (Data
+ Offset
, VariableName
, NameSize
* sizeof (CHAR16
)) == 0)) {
1242 Offset
= Offset
+ NameSize
* sizeof (CHAR16
);
1244 if (CertOffset
!= NULL
) {
1245 *CertOffset
= Offset
;
1248 if (CertDataSize
!= NULL
) {
1249 *CertDataSize
= CertSize
;
1252 if (CertNodeOffset
!= NULL
) {
1253 *CertNodeOffset
= (UINT32
) ((UINT8
*) Ptr
- Data
);
1256 if (CertNodeSize
!= NULL
) {
1257 *CertNodeSize
= NodeSize
;
1262 Offset
= Offset
+ NameSize
* sizeof (CHAR16
) + CertSize
;
1265 NodeSize
= ReadUnaligned32 (&Ptr
->CertNodeSize
);
1266 Offset
= Offset
+ NodeSize
;
1270 return EFI_NOT_FOUND
;
1274 Retrieve signer's certificates for common authenticated variable
1275 by corresponding VariableName and VendorGuid from "certdb"
1276 or "certdbv" according to authenticated variable attributes.
1278 @param[in] VariableName Name of authenticated Variable.
1279 @param[in] VendorGuid Vendor GUID of authenticated Variable.
1280 @param[in] Attributes Attributes of authenticated variable.
1281 @param[out] CertData Pointer to signer's certificates.
1282 @param[out] CertDataSize Length of CertData in bytes.
1284 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
1285 @retval EFI_NOT_FOUND Fail to find "certdb"/"certdbv" or matching certs.
1286 @retval EFI_SUCCESS Get signer's certificates successfully.
1291 IN CHAR16
*VariableName
,
1292 IN EFI_GUID
*VendorGuid
,
1293 IN UINT32 Attributes
,
1294 OUT UINT8
**CertData
,
1295 OUT UINT32
*CertDataSize
1304 if ((VariableName
== NULL
) || (VendorGuid
== NULL
) || (CertData
== NULL
) || (CertDataSize
== NULL
)) {
1305 return EFI_INVALID_PARAMETER
;
1309 if ((Attributes
& EFI_VARIABLE_NON_VOLATILE
) != 0) {
1311 // Get variable "certdb".
1313 DbName
= EFI_CERT_DB_NAME
;
1316 // Get variable "certdbv".
1318 DbName
= EFI_CERT_DB_VOLATILE_NAME
;
1322 // Get variable "certdb" or "certdbv".
1324 Status
= AuthServiceInternalFindVariable (
1330 if (EFI_ERROR (Status
)) {
1334 if ((DataSize
== 0) || (Data
== NULL
)) {
1336 return EFI_NOT_FOUND
;
1339 Status
= FindCertsFromDb (
1350 if (EFI_ERROR (Status
)) {
1354 *CertData
= Data
+ CertOffset
;
1359 Delete matching signer's certificates when deleting common authenticated
1360 variable by corresponding VariableName and VendorGuid from "certdb" or
1361 "certdbv" according to authenticated variable attributes.
1363 @param[in] VariableName Name of authenticated Variable.
1364 @param[in] VendorGuid Vendor GUID of authenticated Variable.
1365 @param[in] Attributes Attributes of authenticated variable.
1367 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
1368 @retval EFI_NOT_FOUND Fail to find "certdb"/"certdbv" or matching certs.
1369 @retval EFI_OUT_OF_RESOURCES The operation is failed due to lack of resources.
1370 @retval EFI_SUCCESS The operation is completed successfully.
1375 IN CHAR16
*VariableName
,
1376 IN EFI_GUID
*VendorGuid
,
1377 IN UINT32 Attributes
1384 UINT32 CertNodeOffset
;
1385 UINT32 CertNodeSize
;
1387 UINT32 NewCertDbSize
;
1390 if ((VariableName
== NULL
) || (VendorGuid
== NULL
)) {
1391 return EFI_INVALID_PARAMETER
;
1394 if ((Attributes
& EFI_VARIABLE_NON_VOLATILE
) != 0) {
1396 // Get variable "certdb".
1398 DbName
= EFI_CERT_DB_NAME
;
1399 VarAttr
= EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
;
1402 // Get variable "certdbv".
1404 DbName
= EFI_CERT_DB_VOLATILE_NAME
;
1405 VarAttr
= EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
;
1408 Status
= AuthServiceInternalFindVariable (
1415 if (EFI_ERROR (Status
)) {
1419 if ((DataSize
== 0) || (Data
== NULL
)) {
1421 return EFI_NOT_FOUND
;
1424 if (DataSize
== sizeof (UINT32
)) {
1426 // There is no certs in "certdb" or "certdbv".
1432 // Get corresponding cert node from "certdb" or "certdbv".
1434 Status
= FindCertsFromDb (
1445 if (EFI_ERROR (Status
)) {
1449 if (DataSize
< (CertNodeOffset
+ CertNodeSize
)) {
1450 return EFI_NOT_FOUND
;
1454 // Construct new data content of variable "certdb" or "certdbv".
1456 NewCertDbSize
= (UINT32
) DataSize
- CertNodeSize
;
1457 NewCertDb
= (UINT8
*) mCertDbStore
;
1460 // Copy the DB entries before deleting node.
1462 CopyMem (NewCertDb
, Data
, CertNodeOffset
);
1464 // Update CertDbListSize.
1466 CopyMem (NewCertDb
, &NewCertDbSize
, sizeof (UINT32
));
1468 // Copy the DB entries after deleting node.
1470 if (DataSize
> (CertNodeOffset
+ CertNodeSize
)) {
1472 NewCertDb
+ CertNodeOffset
,
1473 Data
+ CertNodeOffset
+ CertNodeSize
,
1474 DataSize
- CertNodeOffset
- CertNodeSize
1479 // Set "certdb" or "certdbv".
1481 Status
= AuthServiceInternalUpdateVariable (
1493 Insert signer's certificates for common authenticated variable with VariableName
1494 and VendorGuid in AUTH_CERT_DB_DATA to "certdb" or "certdbv" according to
1495 time based authenticated variable attributes. CertData is the SHA256 digest of
1496 SignerCert CommonName + TopLevelCert tbsCertificate.
1498 @param[in] VariableName Name of authenticated Variable.
1499 @param[in] VendorGuid Vendor GUID of authenticated Variable.
1500 @param[in] Attributes Attributes of authenticated variable.
1501 @param[in] SignerCert Signer certificate data.
1502 @param[in] SignerCertSize Length of signer certificate.
1503 @param[in] TopLevelCert Top-level certificate data.
1504 @param[in] TopLevelCertSize Length of top-level certificate.
1506 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
1507 @retval EFI_ACCESS_DENIED An AUTH_CERT_DB_DATA entry with same VariableName
1508 and VendorGuid already exists.
1509 @retval EFI_OUT_OF_RESOURCES The operation is failed due to lack of resources.
1510 @retval EFI_SUCCESS Insert an AUTH_CERT_DB_DATA entry to "certdb" or "certdbv"
1515 IN CHAR16
*VariableName
,
1516 IN EFI_GUID
*VendorGuid
,
1517 IN UINT32 Attributes
,
1518 IN UINT8
*SignerCert
,
1519 IN UINTN SignerCertSize
,
1520 IN UINT8
*TopLevelCert
,
1521 IN UINTN TopLevelCertSize
1529 UINT32 NewCertDbSize
;
1530 UINT32 CertNodeSize
;
1532 UINT32 CertDataSize
;
1533 AUTH_CERT_DB_DATA
*Ptr
;
1535 UINT8 Sha256Digest
[SHA256_DIGEST_SIZE
];
1537 if ((VariableName
== NULL
) || (VendorGuid
== NULL
) || (SignerCert
== NULL
) ||(TopLevelCert
== NULL
)) {
1538 return EFI_INVALID_PARAMETER
;
1541 if ((Attributes
& EFI_VARIABLE_NON_VOLATILE
) != 0) {
1543 // Get variable "certdb".
1545 DbName
= EFI_CERT_DB_NAME
;
1546 VarAttr
= EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
;
1549 // Get variable "certdbv".
1551 DbName
= EFI_CERT_DB_VOLATILE_NAME
;
1552 VarAttr
= EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
;
1556 // Get variable "certdb" or "certdbv".
1558 Status
= AuthServiceInternalFindVariable (
1564 if (EFI_ERROR (Status
)) {
1568 if ((DataSize
== 0) || (Data
== NULL
)) {
1570 return EFI_NOT_FOUND
;
1574 // Find whether matching cert node already exists in "certdb" or "certdbv".
1575 // If yes return error.
1577 Status
= FindCertsFromDb (
1588 if (!EFI_ERROR (Status
)) {
1590 return EFI_ACCESS_DENIED
;
1594 // Construct new data content of variable "certdb" or "certdbv".
1596 NameSize
= (UINT32
) StrLen (VariableName
);
1597 CertDataSize
= sizeof(Sha256Digest
);
1598 CertNodeSize
= sizeof (AUTH_CERT_DB_DATA
) + (UINT32
) CertDataSize
+ NameSize
* sizeof (CHAR16
);
1599 NewCertDbSize
= (UINT32
) DataSize
+ CertNodeSize
;
1600 if (NewCertDbSize
> mMaxCertDbSize
) {
1601 return EFI_OUT_OF_RESOURCES
;
1604 Status
= CalculatePrivAuthVarSignChainSHA256Digest(
1611 if (EFI_ERROR (Status
)) {
1615 NewCertDb
= (UINT8
*) mCertDbStore
;
1618 // Copy the DB entries before inserting node.
1620 CopyMem (NewCertDb
, Data
, DataSize
);
1622 // Update CertDbListSize.
1624 CopyMem (NewCertDb
, &NewCertDbSize
, sizeof (UINT32
));
1626 // Construct new cert node.
1628 Ptr
= (AUTH_CERT_DB_DATA
*) (NewCertDb
+ DataSize
);
1629 CopyGuid (&Ptr
->VendorGuid
, VendorGuid
);
1630 CopyMem (&Ptr
->CertNodeSize
, &CertNodeSize
, sizeof (UINT32
));
1631 CopyMem (&Ptr
->NameSize
, &NameSize
, sizeof (UINT32
));
1632 CopyMem (&Ptr
->CertDataSize
, &CertDataSize
, sizeof (UINT32
));
1635 (UINT8
*) Ptr
+ sizeof (AUTH_CERT_DB_DATA
),
1637 NameSize
* sizeof (CHAR16
)
1641 (UINT8
*) Ptr
+ sizeof (AUTH_CERT_DB_DATA
) + NameSize
* sizeof (CHAR16
),
1647 // Set "certdb" or "certdbv".
1649 Status
= AuthServiceInternalUpdateVariable (
1661 Clean up signer's certificates for common authenticated variable
1662 by corresponding VariableName and VendorGuid from "certdb".
1663 System may break down during Timebased Variable update & certdb update,
1664 make them inconsistent, this function is called in AuthVariable Init
1665 to ensure consistency.
1667 @retval EFI_NOT_FOUND Fail to find variable "certdb".
1668 @retval EFI_OUT_OF_RESOURCES The operation is failed due to lack of resources.
1669 @retval EFI_SUCCESS The operation is completed successfully.
1678 AUTH_CERT_DB_DATA
*Ptr
;
1681 CHAR16
*VariableName
;
1683 BOOLEAN CertCleaned
;
1686 EFI_GUID AuthVarGuid
;
1687 AUTH_VARIABLE_INFO AuthVariableInfo
;
1689 Status
= EFI_SUCCESS
;
1692 // Get corresponding certificates by VendorGuid and VariableName.
1695 CertCleaned
= FALSE
;
1698 // Get latest variable "certdb"
1700 Status
= AuthServiceInternalFindVariable (
1706 if (EFI_ERROR (Status
)) {
1710 if ((DataSize
== 0) || (Data
== NULL
)) {
1712 return EFI_NOT_FOUND
;
1715 Offset
= sizeof (UINT32
);
1717 while (Offset
< (UINT32
) DataSize
) {
1718 Ptr
= (AUTH_CERT_DB_DATA
*) (Data
+ Offset
);
1719 NodeSize
= ReadUnaligned32 (&Ptr
->CertNodeSize
);
1720 NameSize
= ReadUnaligned32 (&Ptr
->NameSize
);
1723 // Get VarName tailed with '\0'
1725 VariableName
= AllocateZeroPool((NameSize
+ 1) * sizeof(CHAR16
));
1726 if (VariableName
== NULL
) {
1727 return EFI_OUT_OF_RESOURCES
;
1729 CopyMem (VariableName
, (UINT8
*) Ptr
+ sizeof (AUTH_CERT_DB_DATA
), NameSize
* sizeof(CHAR16
));
1731 // Keep VarGuid aligned
1733 CopyMem (&AuthVarGuid
, &Ptr
->VendorGuid
, sizeof(EFI_GUID
));
1736 // Find corresponding time auth variable
1738 ZeroMem (&AuthVariableInfo
, sizeof (AuthVariableInfo
));
1739 Status
= mAuthVarLibContextIn
->FindVariable (
1745 if (EFI_ERROR(Status
) || (AuthVariableInfo
.Attributes
& EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
) == 0) {
1747 // While cleaning certdb, always delete the variable in certdb regardless of it attributes.
1749 Status
= DeleteCertsFromDb(
1752 AuthVariableInfo
.Attributes
| EFI_VARIABLE_NON_VOLATILE
1755 DEBUG((DEBUG_INFO
, "Recovery!! Cert for Auth Variable %s Guid %g is removed for consistency\n", VariableName
, &AuthVarGuid
));
1756 FreePool(VariableName
);
1760 FreePool(VariableName
);
1761 Offset
= Offset
+ NodeSize
;
1763 } while (CertCleaned
);
1769 Process variable with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set
1771 Caution: This function may receive untrusted input.
1772 This function may be invoked in SMM mode, and datasize and data are external input.
1773 This function will do basic validation, before parse the data.
1774 This function will parse the authentication carefully to avoid security issues, like
1775 buffer overflow, integer overflow.
1777 @param[in] VariableName Name of Variable to be found.
1778 @param[in] VendorGuid Variable vendor GUID.
1779 @param[in] Data Data pointer.
1780 @param[in] DataSize Size of Data found. If size is less than the
1781 data, this value contains the required size.
1782 @param[in] Attributes Attribute value of the variable.
1783 @param[in] AuthVarType Verify against PK, KEK database, private database or certificate in data payload.
1784 @param[in] OrgTimeStamp Pointer to original time stamp,
1785 original variable is not found if NULL.
1786 @param[out] VarPayloadPtr Pointer to variable payload address.
1787 @param[out] VarPayloadSize Pointer to variable payload size.
1789 @retval EFI_INVALID_PARAMETER Invalid parameter.
1790 @retval EFI_SECURITY_VIOLATION The variable does NOT pass the validation
1791 check carried out by the firmware.
1792 @retval EFI_OUT_OF_RESOURCES Failed to process variable due to lack
1794 @retval EFI_SUCCESS Variable pass validation successfully.
1798 VerifyTimeBasedPayload (
1799 IN CHAR16
*VariableName
,
1800 IN EFI_GUID
*VendorGuid
,
1803 IN UINT32 Attributes
,
1804 IN AUTHVAR_TYPE AuthVarType
,
1805 IN EFI_TIME
*OrgTimeStamp
,
1806 OUT UINT8
**VarPayloadPtr
,
1807 OUT UINTN
*VarPayloadSize
1810 EFI_VARIABLE_AUTHENTICATION_2
*CertData
;
1816 BOOLEAN VerifyStatus
;
1818 EFI_SIGNATURE_LIST
*CertList
;
1819 EFI_SIGNATURE_DATA
*Cert
;
1827 UINT8
*TopLevelCert
;
1828 UINTN TopLevelCertSize
;
1830 UINTN TrustedCertSize
;
1832 UINTN CertStackSize
;
1833 UINT8
*CertsInCertDb
;
1834 UINT32 CertsSizeinDb
;
1835 UINT8 Sha256Digest
[SHA256_DIGEST_SIZE
];
1836 EFI_CERT_DATA
*CertDataPtr
;
1839 // 1. TopLevelCert is the top-level issuer certificate in signature Signer Cert Chain
1840 // 2. TrustedCert is the certificate which firmware trusts. It could be saved in protected
1841 // storage or PK payload on PK init
1843 VerifyStatus
= FALSE
;
1848 TopLevelCert
= NULL
;
1849 CertsInCertDb
= NULL
;
1853 // When the attribute EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS is
1854 // set, then the Data buffer shall begin with an instance of a complete (and serialized)
1855 // EFI_VARIABLE_AUTHENTICATION_2 descriptor. The descriptor shall be followed by the new
1856 // variable value and DataSize shall reflect the combined size of the descriptor and the new
1857 // variable value. The authentication descriptor is not part of the variable data and is not
1858 // returned by subsequent calls to GetVariable().
1860 CertData
= (EFI_VARIABLE_AUTHENTICATION_2
*) Data
;
1863 // Verify that Pad1, Nanosecond, TimeZone, Daylight and Pad2 components of the
1864 // TimeStamp value are set to zero.
1866 if ((CertData
->TimeStamp
.Pad1
!= 0) ||
1867 (CertData
->TimeStamp
.Nanosecond
!= 0) ||
1868 (CertData
->TimeStamp
.TimeZone
!= 0) ||
1869 (CertData
->TimeStamp
.Daylight
!= 0) ||
1870 (CertData
->TimeStamp
.Pad2
!= 0)) {
1871 return EFI_SECURITY_VIOLATION
;
1874 if ((OrgTimeStamp
!= NULL
) && ((Attributes
& EFI_VARIABLE_APPEND_WRITE
) == 0)) {
1875 if (AuthServiceInternalCompareTimeStamp (&CertData
->TimeStamp
, OrgTimeStamp
)) {
1877 // TimeStamp check fail, suspicious replay attack, return EFI_SECURITY_VIOLATION.
1879 return EFI_SECURITY_VIOLATION
;
1884 // wCertificateType should be WIN_CERT_TYPE_EFI_GUID.
1885 // Cert type should be EFI_CERT_TYPE_PKCS7_GUID.
1887 if ((CertData
->AuthInfo
.Hdr
.wCertificateType
!= WIN_CERT_TYPE_EFI_GUID
) ||
1888 !CompareGuid (&CertData
->AuthInfo
.CertType
, &gEfiCertPkcs7Guid
)) {
1890 // Invalid AuthInfo type, return EFI_SECURITY_VIOLATION.
1892 return EFI_SECURITY_VIOLATION
;
1896 // Find out Pkcs7 SignedData which follows the EFI_VARIABLE_AUTHENTICATION_2 descriptor.
1897 // AuthInfo.Hdr.dwLength is the length of the entire certificate, including the length of the header.
1899 SigData
= CertData
->AuthInfo
.CertData
;
1900 SigDataSize
= CertData
->AuthInfo
.Hdr
.dwLength
- (UINT32
) (OFFSET_OF (WIN_CERTIFICATE_UEFI_GUID
, CertData
));
1903 // SignedData.digestAlgorithms shall contain the digest algorithm used when preparing the
1904 // signature. Only a digest algorithm of SHA-256 is accepted.
1906 // According to PKCS#7 Definition:
1907 // SignedData ::= SEQUENCE {
1909 // digestAlgorithms DigestAlgorithmIdentifiers,
1910 // contentInfo ContentInfo,
1912 // The DigestAlgorithmIdentifiers can be used to determine the hash algorithm
1913 // in VARIABLE_AUTHENTICATION_2 descriptor.
1914 // This field has the fixed offset (+13) and be calculated based on two bytes of length encoding.
1916 if ((Attributes
& EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
) != 0) {
1917 if (SigDataSize
>= (13 + sizeof (mSha256OidValue
))) {
1918 if (((*(SigData
+ 1) & TWO_BYTE_ENCODE
) != TWO_BYTE_ENCODE
) ||
1919 (CompareMem (SigData
+ 13, &mSha256OidValue
, sizeof (mSha256OidValue
)) != 0)) {
1920 return EFI_SECURITY_VIOLATION
;
1926 // Find out the new data payload which follows Pkcs7 SignedData directly.
1928 PayloadPtr
= SigData
+ SigDataSize
;
1929 PayloadSize
= DataSize
- OFFSET_OF_AUTHINFO2_CERT_DATA
- (UINTN
) SigDataSize
;
1931 // If the VariablePolicy engine is disabled, allow deletion of any authenticated variables.
1932 if (PayloadSize
== 0 && (Attributes
& EFI_VARIABLE_APPEND_WRITE
) == 0 && !IsVariablePolicyEnabled()) {
1933 VerifyStatus
= TRUE
;
1938 // Construct a serialization buffer of the values of the VariableName, VendorGuid and Attributes
1939 // parameters of the SetVariable() call and the TimeStamp component of the
1940 // EFI_VARIABLE_AUTHENTICATION_2 descriptor followed by the variable's new value
1941 // i.e. (VariableName, VendorGuid, Attributes, TimeStamp, Data)
1943 NewDataSize
= PayloadSize
+ sizeof (EFI_TIME
) + sizeof (UINT32
) +
1944 sizeof (EFI_GUID
) + StrSize (VariableName
) - sizeof (CHAR16
);
1947 // Here is to reuse scratch data area(at the end of volatile variable store)
1948 // to reduce SMRAM consumption for SMM variable driver.
1949 // The scratch buffer is enough to hold the serialized data and safe to use,
1950 // because it is only used at here to do verification temporarily first
1951 // and then used in UpdateVariable() for a time based auth variable set.
1953 Status
= mAuthVarLibContextIn
->GetScratchBuffer (&NewDataSize
, (VOID
**) &NewData
);
1954 if (EFI_ERROR (Status
)) {
1955 return EFI_OUT_OF_RESOURCES
;
1959 Length
= StrLen (VariableName
) * sizeof (CHAR16
);
1960 CopyMem (Buffer
, VariableName
, Length
);
1963 Length
= sizeof (EFI_GUID
);
1964 CopyMem (Buffer
, VendorGuid
, Length
);
1967 Length
= sizeof (UINT32
);
1968 CopyMem (Buffer
, &Attr
, Length
);
1971 Length
= sizeof (EFI_TIME
);
1972 CopyMem (Buffer
, &CertData
->TimeStamp
, Length
);
1975 CopyMem (Buffer
, PayloadPtr
, PayloadSize
);
1977 if (AuthVarType
== AuthVarTypePk
) {
1979 // Verify that the signature has been made with the current Platform Key (no chaining for PK).
1980 // First, get signer's certificates from SignedData.
1982 VerifyStatus
= Pkcs7GetSigners (
1990 if (!VerifyStatus
) {
1995 // Second, get the current platform key from variable. Check whether it's identical with signer's certificates
1996 // in SignedData. If not, return error immediately.
1998 Status
= AuthServiceInternalFindVariable (
1999 EFI_PLATFORM_KEY_NAME
,
2000 &gEfiGlobalVariableGuid
,
2004 if (EFI_ERROR (Status
)) {
2005 VerifyStatus
= FALSE
;
2008 CertList
= (EFI_SIGNATURE_LIST
*) Data
;
2009 Cert
= (EFI_SIGNATURE_DATA
*) ((UINT8
*) CertList
+ sizeof (EFI_SIGNATURE_LIST
) + CertList
->SignatureHeaderSize
);
2010 if ((TopLevelCertSize
!= (CertList
->SignatureSize
- (sizeof (EFI_SIGNATURE_DATA
) - 1))) ||
2011 (CompareMem (Cert
->SignatureData
, TopLevelCert
, TopLevelCertSize
) != 0)) {
2012 VerifyStatus
= FALSE
;
2017 // Verify Pkcs7 SignedData via Pkcs7Verify library.
2019 VerifyStatus
= Pkcs7Verify (
2028 } else if (AuthVarType
== AuthVarTypeKek
) {
2031 // Get KEK database from variable.
2033 Status
= AuthServiceInternalFindVariable (
2034 EFI_KEY_EXCHANGE_KEY_NAME
,
2035 &gEfiGlobalVariableGuid
,
2039 if (EFI_ERROR (Status
)) {
2044 // Ready to verify Pkcs7 SignedData. Go through KEK Signature Database to find out X.509 CertList.
2046 KekDataSize
= (UINT32
) DataSize
;
2047 CertList
= (EFI_SIGNATURE_LIST
*) Data
;
2048 while ((KekDataSize
> 0) && (KekDataSize
>= CertList
->SignatureListSize
)) {
2049 if (CompareGuid (&CertList
->SignatureType
, &gEfiCertX509Guid
)) {
2050 Cert
= (EFI_SIGNATURE_DATA
*) ((UINT8
*) CertList
+ sizeof (EFI_SIGNATURE_LIST
) + CertList
->SignatureHeaderSize
);
2051 CertCount
= (CertList
->SignatureListSize
- sizeof (EFI_SIGNATURE_LIST
) - CertList
->SignatureHeaderSize
) / CertList
->SignatureSize
;
2052 for (Index
= 0; Index
< CertCount
; Index
++) {
2054 // Iterate each Signature Data Node within this CertList for a verify
2056 TrustedCert
= Cert
->SignatureData
;
2057 TrustedCertSize
= CertList
->SignatureSize
- (sizeof (EFI_SIGNATURE_DATA
) - 1);
2060 // Verify Pkcs7 SignedData via Pkcs7Verify library.
2062 VerifyStatus
= Pkcs7Verify (
2073 Cert
= (EFI_SIGNATURE_DATA
*) ((UINT8
*) Cert
+ CertList
->SignatureSize
);
2076 KekDataSize
-= CertList
->SignatureListSize
;
2077 CertList
= (EFI_SIGNATURE_LIST
*) ((UINT8
*) CertList
+ CertList
->SignatureListSize
);
2079 } else if (AuthVarType
== AuthVarTypePriv
) {
2082 // Process common authenticated variable except PK/KEK/DB/DBX/DBT.
2083 // Get signer's certificates from SignedData.
2085 VerifyStatus
= Pkcs7GetSigners (
2093 if (!VerifyStatus
) {
2098 // Get previously stored signer's certificates from certdb or certdbv for existing
2099 // variable. Check whether they are identical with signer's certificates
2100 // in SignedData. If not, return error immediately.
2102 if (OrgTimeStamp
!= NULL
) {
2103 VerifyStatus
= FALSE
;
2105 Status
= GetCertsFromDb (VariableName
, VendorGuid
, Attributes
, &CertsInCertDb
, &CertsSizeinDb
);
2106 if (EFI_ERROR (Status
)) {
2110 if (CertsSizeinDb
== SHA256_DIGEST_SIZE
) {
2112 // Check hash of signer cert CommonName + Top-level issuer tbsCertificate against data in CertDb
2114 CertDataPtr
= (EFI_CERT_DATA
*)(SignerCerts
+ 1);
2115 Status
= CalculatePrivAuthVarSignChainSHA256Digest(
2116 CertDataPtr
->CertDataBuffer
,
2117 ReadUnaligned32 ((UINT32
*)&(CertDataPtr
->CertDataLength
)),
2122 if (EFI_ERROR(Status
) || CompareMem (Sha256Digest
, CertsInCertDb
, CertsSizeinDb
) != 0){
2127 // Keep backward compatible with previous solution which saves whole signer certs stack in CertDb
2129 if ((CertStackSize
!= CertsSizeinDb
) ||
2130 (CompareMem (SignerCerts
, CertsInCertDb
, CertsSizeinDb
) != 0)) {
2136 VerifyStatus
= Pkcs7Verify (
2144 if (!VerifyStatus
) {
2148 if ((OrgTimeStamp
== NULL
) && (PayloadSize
!= 0)) {
2150 // When adding a new common authenticated variable, always save Hash of cn of signer cert + tbsCertificate of Top-level issuer
2152 CertDataPtr
= (EFI_CERT_DATA
*)(SignerCerts
+ 1);
2153 Status
= InsertCertsToDb (
2157 CertDataPtr
->CertDataBuffer
,
2158 ReadUnaligned32 ((UINT32
*)&(CertDataPtr
->CertDataLength
)),
2162 if (EFI_ERROR (Status
)) {
2163 VerifyStatus
= FALSE
;
2167 } else if (AuthVarType
== AuthVarTypePayload
) {
2168 CertList
= (EFI_SIGNATURE_LIST
*) PayloadPtr
;
2169 Cert
= (EFI_SIGNATURE_DATA
*) ((UINT8
*) CertList
+ sizeof (EFI_SIGNATURE_LIST
) + CertList
->SignatureHeaderSize
);
2170 TrustedCert
= Cert
->SignatureData
;
2171 TrustedCertSize
= CertList
->SignatureSize
- (sizeof (EFI_SIGNATURE_DATA
) - 1);
2173 // Verify Pkcs7 SignedData via Pkcs7Verify library.
2175 VerifyStatus
= Pkcs7Verify (
2184 return EFI_SECURITY_VIOLATION
;
2189 if (AuthVarType
== AuthVarTypePk
|| AuthVarType
== AuthVarTypePriv
) {
2190 if (TopLevelCert
!= NULL
) {
2191 Pkcs7FreeSigners (TopLevelCert
);
2193 if (SignerCerts
!= NULL
) {
2194 Pkcs7FreeSigners (SignerCerts
);
2198 if (!VerifyStatus
) {
2199 return EFI_SECURITY_VIOLATION
;
2202 Status
= CheckSignatureListFormat(VariableName
, VendorGuid
, PayloadPtr
, PayloadSize
);
2203 if (EFI_ERROR (Status
)) {
2207 *VarPayloadPtr
= PayloadPtr
;
2208 *VarPayloadSize
= PayloadSize
;
2214 Process variable with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set
2216 Caution: This function may receive untrusted input.
2217 This function may be invoked in SMM mode, and datasize and data are external input.
2218 This function will do basic validation, before parse the data.
2219 This function will parse the authentication carefully to avoid security issues, like
2220 buffer overflow, integer overflow.
2222 @param[in] VariableName Name of Variable to be found.
2223 @param[in] VendorGuid Variable vendor GUID.
2224 @param[in] Data Data pointer.
2225 @param[in] DataSize Size of Data found. If size is less than the
2226 data, this value contains the required size.
2227 @param[in] Attributes Attribute value of the variable.
2228 @param[in] AuthVarType Verify against PK, KEK database, private database or certificate in data payload.
2229 @param[out] VarDel Delete the variable or not.
2231 @retval EFI_INVALID_PARAMETER Invalid parameter.
2232 @retval EFI_SECURITY_VIOLATION The variable does NOT pass the validation
2233 check carried out by the firmware.
2234 @retval EFI_OUT_OF_RESOURCES Failed to process variable due to lack
2236 @retval EFI_SUCCESS Variable pass validation successfully.
2240 VerifyTimeBasedPayloadAndUpdate (
2241 IN CHAR16
*VariableName
,
2242 IN EFI_GUID
*VendorGuid
,
2245 IN UINT32 Attributes
,
2246 IN AUTHVAR_TYPE AuthVarType
,
2251 EFI_STATUS FindStatus
;
2254 EFI_VARIABLE_AUTHENTICATION_2
*CertData
;
2255 AUTH_VARIABLE_INFO OrgVariableInfo
;
2258 ZeroMem (&OrgVariableInfo
, sizeof (OrgVariableInfo
));
2259 FindStatus
= mAuthVarLibContextIn
->FindVariable (
2265 Status
= VerifyTimeBasedPayload (
2272 (!EFI_ERROR (FindStatus
)) ? OrgVariableInfo
.TimeStamp
: NULL
,
2276 if (EFI_ERROR (Status
)) {
2280 if (!EFI_ERROR(FindStatus
)
2281 && (PayloadSize
== 0)
2282 && ((Attributes
& EFI_VARIABLE_APPEND_WRITE
) == 0)) {
2288 CertData
= (EFI_VARIABLE_AUTHENTICATION_2
*) Data
;
2291 // Final step: Update/Append Variable if it pass Pkcs7Verify
2293 Status
= AuthServiceInternalUpdateVariableWithTimeStamp (
2299 &CertData
->TimeStamp
2303 // Delete signer's certificates when delete the common authenticated variable.
2305 if (IsDel
&& AuthVarType
== AuthVarTypePriv
&& !EFI_ERROR(Status
) ) {
2306 Status
= DeleteCertsFromDb (VariableName
, VendorGuid
, Attributes
);
2309 if (VarDel
!= NULL
) {
2310 if (IsDel
&& !EFI_ERROR(Status
)) {