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)))
185 // For variables with formatted as EFI_SIGNATURE_LIST, the driver shall not perform an append of
186 // EFI_SIGNATURE_DATA values that are already part of the existing variable value.
188 FilterSignatureList (
197 ZeroMem (&AuthVariableInfo
, sizeof (AuthVariableInfo
));
198 AuthVariableInfo
.VariableName
= VariableName
;
199 AuthVariableInfo
.VendorGuid
= VendorGuid
;
200 AuthVariableInfo
.Data
= Data
;
201 AuthVariableInfo
.DataSize
= DataSize
;
202 AuthVariableInfo
.Attributes
= Attributes
;
203 AuthVariableInfo
.TimeStamp
= TimeStamp
;
204 return mAuthVarLibContextIn
->UpdateVariable (
210 Determine whether this operation needs a physical present user.
212 @param[in] VariableName Name of the Variable.
213 @param[in] VendorGuid GUID of the Variable.
215 @retval TRUE This variable is protected, only a physical present user could set this variable.
216 @retval FALSE This variable is not protected.
220 NeedPhysicallyPresent (
221 IN CHAR16
*VariableName
,
222 IN EFI_GUID
*VendorGuid
225 // If the VariablePolicy engine is disabled, allow deletion of any authenticated variables.
226 if (IsVariablePolicyEnabled ()) {
227 if ( (CompareGuid (VendorGuid
, &gEfiSecureBootEnableDisableGuid
) && (StrCmp (VariableName
, EFI_SECURE_BOOT_ENABLE_NAME
) == 0))
228 || (CompareGuid (VendorGuid
, &gEfiCustomModeEnableGuid
) && (StrCmp (VariableName
, EFI_CUSTOM_MODE_NAME
) == 0)))
238 Determine whether the platform is operating in Custom Secure Boot mode.
240 @retval TRUE The platform is operating in Custom mode.
241 @retval FALSE The platform is operating in Standard mode.
253 Status
= AuthServiceInternalFindVariable (EFI_CUSTOM_MODE_NAME
, &gEfiCustomModeEnableGuid
, &Data
, &DataSize
);
254 if (!EFI_ERROR (Status
) && (*(UINT8
*)Data
== CUSTOM_SECURE_BOOT_MODE
)) {
262 Update platform mode.
264 @param[in] Mode SETUP_MODE or USER_MODE.
266 @return EFI_INVALID_PARAMETER Invalid parameter.
267 @return EFI_SUCCESS Update platform mode successfully.
278 UINT8 SecureBootMode
;
279 UINT8 SecureBootEnable
;
280 UINTN VariableDataSize
;
282 Status
= AuthServiceInternalFindVariable (
284 &gEfiGlobalVariableGuid
,
288 if (EFI_ERROR (Status
)) {
293 // Update the value of SetupMode variable by a simple mem copy, this could avoid possible
294 // variable storage reclaim at runtime.
296 mPlatformMode
= (UINT8
)Mode
;
297 CopyMem (Data
, &mPlatformMode
, sizeof (UINT8
));
299 if (mAuthVarLibContextIn
->AtRuntime ()) {
301 // SecureBoot Variable indicates whether the platform firmware is operating
302 // in Secure boot mode (1) or not (0), so we should not change SecureBoot
303 // Variable in runtime.
309 // Check "SecureBoot" variable's existence.
310 // If it doesn't exist, firmware has no capability to perform driver signing verification,
311 // then set "SecureBoot" to 0.
313 Status
= AuthServiceInternalFindVariable (
314 EFI_SECURE_BOOT_MODE_NAME
,
315 &gEfiGlobalVariableGuid
,
320 // If "SecureBoot" variable exists, then check "SetupMode" variable update.
321 // If "SetupMode" variable is USER_MODE, "SecureBoot" variable is set to 1.
322 // If "SetupMode" variable is SETUP_MODE, "SecureBoot" variable is set to 0.
324 if (EFI_ERROR (Status
)) {
325 SecureBootMode
= SECURE_BOOT_MODE_DISABLE
;
327 if (mPlatformMode
== USER_MODE
) {
328 SecureBootMode
= SECURE_BOOT_MODE_ENABLE
;
329 } else if (mPlatformMode
== SETUP_MODE
) {
330 SecureBootMode
= SECURE_BOOT_MODE_DISABLE
;
332 return EFI_NOT_FOUND
;
336 Status
= AuthServiceInternalUpdateVariable (
337 EFI_SECURE_BOOT_MODE_NAME
,
338 &gEfiGlobalVariableGuid
,
341 EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_BOOTSERVICE_ACCESS
343 if (EFI_ERROR (Status
)) {
348 // Check "SecureBootEnable" variable's existence. It can enable/disable secure boot feature.
350 Status
= AuthServiceInternalFindVariable (
351 EFI_SECURE_BOOT_ENABLE_NAME
,
352 &gEfiSecureBootEnableDisableGuid
,
357 if (SecureBootMode
== SECURE_BOOT_MODE_ENABLE
) {
359 // Create the "SecureBootEnable" variable as secure boot is enabled.
361 SecureBootEnable
= SECURE_BOOT_ENABLE
;
362 VariableDataSize
= sizeof (SecureBootEnable
);
365 // Delete the "SecureBootEnable" variable if this variable exist as "SecureBoot"
366 // variable is not in secure boot state.
368 if (EFI_ERROR (Status
)) {
372 SecureBootEnable
= SECURE_BOOT_DISABLE
;
373 VariableDataSize
= 0;
376 Status
= AuthServiceInternalUpdateVariable (
377 EFI_SECURE_BOOT_ENABLE_NAME
,
378 &gEfiSecureBootEnableDisableGuid
,
381 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
387 Check input data form to make sure it is a valid EFI_SIGNATURE_LIST for PK/KEK/db/dbx/dbt variable.
389 @param[in] VariableName Name of Variable to be check.
390 @param[in] VendorGuid Variable vendor GUID.
391 @param[in] Data Point to the variable data to be checked.
392 @param[in] DataSize Size of Data.
394 @return EFI_INVALID_PARAMETER Invalid signature list format.
395 @return EFI_SUCCESS Passed signature list format check successfully.
399 CheckSignatureListFormat (
400 IN CHAR16
*VariableName
,
401 IN EFI_GUID
*VendorGuid
,
406 EFI_SIGNATURE_LIST
*SigList
;
412 EFI_SIGNATURE_DATA
*CertData
;
419 ASSERT (VariableName
!= NULL
&& VendorGuid
!= NULL
&& Data
!= NULL
);
421 if (CompareGuid (VendorGuid
, &gEfiGlobalVariableGuid
) && (StrCmp (VariableName
, EFI_PLATFORM_KEY_NAME
) == 0)) {
423 } else if ((CompareGuid (VendorGuid
, &gEfiGlobalVariableGuid
) && (StrCmp (VariableName
, EFI_KEY_EXCHANGE_KEY_NAME
) == 0)) ||
424 (CompareGuid (VendorGuid
, &gEfiImageSecurityDatabaseGuid
) &&
425 ((StrCmp (VariableName
, EFI_IMAGE_SECURITY_DATABASE
) == 0) || (StrCmp (VariableName
, EFI_IMAGE_SECURITY_DATABASE1
) == 0) ||
426 (StrCmp (VariableName
, EFI_IMAGE_SECURITY_DATABASE2
) == 0))))
434 SigList
= (EFI_SIGNATURE_LIST
*)Data
;
435 SigDataSize
= DataSize
;
439 // Walk through the input signature list and check the data format.
440 // If any signature is incorrectly formed, the whole check will fail.
442 while ((SigDataSize
> 0) && (SigDataSize
>= SigList
->SignatureListSize
)) {
443 for (Index
= 0; Index
< (sizeof (mSupportSigItem
) / sizeof (EFI_SIGNATURE_ITEM
)); Index
++ ) {
444 if (CompareGuid (&SigList
->SignatureType
, &mSupportSigItem
[Index
].SigType
)) {
446 // The value of SignatureSize should always be 16 (size of SignatureOwner
447 // component) add the data length according to signature type.
449 if ((mSupportSigItem
[Index
].SigDataSize
!= ((UINT32
) ~0)) &&
450 ((SigList
->SignatureSize
- sizeof (EFI_GUID
)) != mSupportSigItem
[Index
].SigDataSize
))
452 return EFI_INVALID_PARAMETER
;
455 if ((mSupportSigItem
[Index
].SigHeaderSize
!= ((UINT32
) ~0)) &&
456 (SigList
->SignatureHeaderSize
!= mSupportSigItem
[Index
].SigHeaderSize
))
458 return EFI_INVALID_PARAMETER
;
465 if (Index
== (sizeof (mSupportSigItem
) / sizeof (EFI_SIGNATURE_ITEM
))) {
467 // Undefined signature type.
469 return EFI_INVALID_PARAMETER
;
472 if (CompareGuid (&SigList
->SignatureType
, &gEfiCertX509Guid
)) {
474 // Try to retrieve the RSA public key from the X.509 certificate.
475 // If this operation fails, it's not a valid certificate.
477 RsaContext
= RsaNew ();
478 if (RsaContext
== NULL
) {
479 return EFI_INVALID_PARAMETER
;
482 CertData
= (EFI_SIGNATURE_DATA
*)((UINT8
*)SigList
+ sizeof (EFI_SIGNATURE_LIST
) + SigList
->SignatureHeaderSize
);
483 CertLen
= SigList
->SignatureSize
- sizeof (EFI_GUID
);
484 if (!RsaGetPublicKeyFromX509 (CertData
->SignatureData
, CertLen
, &RsaContext
)) {
485 RsaFree (RsaContext
);
486 return EFI_INVALID_PARAMETER
;
489 RsaFree (RsaContext
);
492 if ((SigList
->SignatureListSize
- sizeof (EFI_SIGNATURE_LIST
) - SigList
->SignatureHeaderSize
) % SigList
->SignatureSize
!= 0) {
493 return EFI_INVALID_PARAMETER
;
496 SigCount
+= (SigList
->SignatureListSize
- sizeof (EFI_SIGNATURE_LIST
) - SigList
->SignatureHeaderSize
) / SigList
->SignatureSize
;
498 SigDataSize
-= SigList
->SignatureListSize
;
499 SigList
= (EFI_SIGNATURE_LIST
*)((UINT8
*)SigList
+ SigList
->SignatureListSize
);
502 if (((UINTN
)SigList
- (UINTN
)Data
) != DataSize
) {
503 return EFI_INVALID_PARAMETER
;
506 if (IsPk
&& (SigCount
> 1)) {
507 return EFI_INVALID_PARAMETER
;
514 Update "VendorKeys" variable to record the out of band secure boot key modification.
516 @return EFI_SUCCESS Variable is updated successfully.
517 @return Others Failed to update variable.
521 VendorKeyIsModified (
527 if (mVendorKeyState
== VENDOR_KEYS_MODIFIED
) {
531 mVendorKeyState
= VENDOR_KEYS_MODIFIED
;
533 Status
= AuthServiceInternalUpdateVariable (
534 EFI_VENDOR_KEYS_NV_VARIABLE_NAME
,
535 &gEfiVendorKeysNvGuid
,
538 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
540 if (EFI_ERROR (Status
)) {
544 return AuthServiceInternalUpdateVariable (
545 EFI_VENDOR_KEYS_VARIABLE_NAME
,
546 &gEfiGlobalVariableGuid
,
549 EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_BOOTSERVICE_ACCESS
554 Process variable with platform key for verification.
556 Caution: This function may receive untrusted input.
557 This function may be invoked in SMM mode, and datasize and data are external input.
558 This function will do basic validation, before parse the data.
559 This function will parse the authentication carefully to avoid security issues, like
560 buffer overflow, integer overflow.
561 This function will check attribute carefully to avoid authentication bypass.
563 @param[in] VariableName Name of Variable to be found.
564 @param[in] VendorGuid Variable vendor GUID.
565 @param[in] Data Data pointer.
566 @param[in] DataSize Size of Data found. If size is less than the
567 data, this value contains the required size.
568 @param[in] Attributes Attribute value of the variable
569 @param[in] IsPk Indicate whether it is to process pk.
571 @return EFI_INVALID_PARAMETER Invalid parameter.
572 @return EFI_SECURITY_VIOLATION The variable does NOT pass the validation.
573 check carried out by the firmware.
574 @return EFI_SUCCESS Variable passed validation successfully.
579 IN CHAR16
*VariableName
,
580 IN EFI_GUID
*VendorGuid
,
583 IN UINT32 Attributes OPTIONAL
,
592 if (((Attributes
& EFI_VARIABLE_NON_VOLATILE
) == 0) ||
593 ((Attributes
& EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
) == 0))
596 // PK, KEK and db/dbx/dbt should set EFI_VARIABLE_NON_VOLATILE attribute and should be a time-based
597 // authenticated variable.
599 return EFI_INVALID_PARAMETER
;
603 // Init state of Del. State may change due to secure check
606 if ((InCustomMode () && UserPhysicalPresent ()) || ((mPlatformMode
== SETUP_MODE
) && !IsPk
)) {
607 Payload
= (UINT8
*)Data
+ AUTHINFO2_SIZE (Data
);
608 PayloadSize
= DataSize
- AUTHINFO2_SIZE (Data
);
609 if (PayloadSize
== 0) {
613 Status
= CheckSignatureListFormat (VariableName
, VendorGuid
, Payload
, PayloadSize
);
614 if (EFI_ERROR (Status
)) {
618 Status
= AuthServiceInternalUpdateVariableWithTimeStamp (
624 &((EFI_VARIABLE_AUTHENTICATION_2
*)Data
)->TimeStamp
626 if (EFI_ERROR (Status
)) {
630 if ((mPlatformMode
!= SETUP_MODE
) || IsPk
) {
631 Status
= VendorKeyIsModified ();
633 } else if (mPlatformMode
== USER_MODE
) {
635 // Verify against X509 Cert in PK database.
637 Status
= VerifyTimeBasedPayloadAndUpdate (
648 // Verify against the certificate in data payload.
650 Status
= VerifyTimeBasedPayloadAndUpdate (
661 if (!EFI_ERROR (Status
) && IsPk
) {
662 if ((mPlatformMode
== SETUP_MODE
) && !Del
) {
664 // If enroll PK in setup mode, need change to user mode.
666 Status
= UpdatePlatformMode (USER_MODE
);
667 } else if ((mPlatformMode
== USER_MODE
) && Del
) {
669 // If delete PK in user mode, need change to setup mode.
671 Status
= UpdatePlatformMode (SETUP_MODE
);
679 Process variable with key exchange key for verification.
681 Caution: This function may receive untrusted input.
682 This function may be invoked in SMM mode, and datasize and data are external input.
683 This function will do basic validation, before parse the data.
684 This function will parse the authentication carefully to avoid security issues, like
685 buffer overflow, integer overflow.
686 This function will check attribute carefully to avoid authentication bypass.
688 @param[in] VariableName Name of Variable to be found.
689 @param[in] VendorGuid Variable vendor GUID.
690 @param[in] Data Data pointer.
691 @param[in] DataSize Size of Data found. If size is less than the
692 data, this value contains the required size.
693 @param[in] Attributes Attribute value of the variable.
695 @return EFI_INVALID_PARAMETER Invalid parameter.
696 @return EFI_SECURITY_VIOLATION The variable does NOT pass the validation
697 check carried out by the firmware.
698 @return EFI_SUCCESS Variable pass validation successfully.
703 IN CHAR16
*VariableName
,
704 IN EFI_GUID
*VendorGuid
,
707 IN UINT32 Attributes OPTIONAL
714 if (((Attributes
& EFI_VARIABLE_NON_VOLATILE
) == 0) ||
715 ((Attributes
& EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
) == 0))
718 // DB, DBX and DBT should set EFI_VARIABLE_NON_VOLATILE attribute and should be a time-based
719 // authenticated variable.
721 return EFI_INVALID_PARAMETER
;
724 Status
= EFI_SUCCESS
;
725 if ((mPlatformMode
== USER_MODE
) && !(InCustomMode () && UserPhysicalPresent ())) {
727 // Time-based, verify against X509 Cert KEK.
729 return VerifyTimeBasedPayloadAndUpdate (
740 // If in setup mode or custom secure boot mode, no authentication needed.
742 Payload
= (UINT8
*)Data
+ AUTHINFO2_SIZE (Data
);
743 PayloadSize
= DataSize
- AUTHINFO2_SIZE (Data
);
745 Status
= CheckSignatureListFormat (VariableName
, VendorGuid
, Payload
, PayloadSize
);
746 if (EFI_ERROR (Status
)) {
750 Status
= AuthServiceInternalUpdateVariableWithTimeStamp (
756 &((EFI_VARIABLE_AUTHENTICATION_2
*)Data
)->TimeStamp
758 if (EFI_ERROR (Status
)) {
762 if (mPlatformMode
!= SETUP_MODE
) {
763 Status
= VendorKeyIsModified ();
771 Check if it is to delete auth variable.
773 @param[in] OrgAttributes Original attribute value of the variable.
774 @param[in] Data Data pointer.
775 @param[in] DataSize Size of Data.
776 @param[in] Attributes Attribute value of the variable.
778 @retval TRUE It is to delete auth variable.
779 @retval FALSE It is not to delete auth variable.
783 IsDeleteAuthVariable (
784 IN UINT32 OrgAttributes
,
796 // To delete a variable created with the EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
797 // or the EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute,
798 // SetVariable must be used with attributes matching the existing variable
799 // and the DataSize set to the size of the AuthInfo descriptor.
801 if ((Attributes
== OrgAttributes
) &&
802 ((Attributes
& (EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
)) != 0))
804 if ((Attributes
& EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
) != 0) {
805 PayloadSize
= DataSize
- AUTHINFO2_SIZE (Data
);
806 if (PayloadSize
== 0) {
810 PayloadSize
= DataSize
- AUTHINFO_SIZE
;
811 if (PayloadSize
== 0) {
821 Process variable with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set
823 Caution: This function may receive untrusted input.
824 This function may be invoked in SMM mode, and datasize and data are external input.
825 This function will do basic validation, before parse the data.
826 This function will parse the authentication carefully to avoid security issues, like
827 buffer overflow, integer overflow.
828 This function will check attribute carefully to avoid authentication bypass.
830 @param[in] VariableName Name of the variable.
831 @param[in] VendorGuid Variable vendor GUID.
832 @param[in] Data Data pointer.
833 @param[in] DataSize Size of Data.
834 @param[in] Attributes Attribute value of the variable.
836 @return EFI_INVALID_PARAMETER Invalid parameter.
837 @return EFI_WRITE_PROTECTED Variable is write-protected and needs authentication with
838 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set.
839 @return EFI_OUT_OF_RESOURCES The Database to save the public key is full.
840 @return EFI_SECURITY_VIOLATION The variable is with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
841 set, but the AuthInfo does NOT pass the validation
842 check carried out by the firmware.
843 @return EFI_SUCCESS Variable is not write-protected or pass validation successfully.
848 IN CHAR16
*VariableName
,
849 IN EFI_GUID
*VendorGuid
,
856 AUTH_VARIABLE_INFO OrgVariableInfo
;
858 Status
= EFI_SUCCESS
;
860 ZeroMem (&OrgVariableInfo
, sizeof (OrgVariableInfo
));
861 Status
= mAuthVarLibContextIn
->FindVariable (
867 // If the VariablePolicy engine is disabled, allow deletion of any authenticated variables.
868 if ((!EFI_ERROR (Status
)) && IsDeleteAuthVariable (OrgVariableInfo
.Attributes
, Data
, DataSize
, Attributes
) && (UserPhysicalPresent () || !IsVariablePolicyEnabled ())) {
870 // Allow the delete operation of common authenticated variable(AT or AW) at user physical presence.
872 Status
= AuthServiceInternalUpdateVariable (
879 if (!EFI_ERROR (Status
) && ((Attributes
& EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
) != 0)) {
880 Status
= DeleteCertsFromDb (VariableName
, VendorGuid
, Attributes
);
886 if (NeedPhysicallyPresent (VariableName
, VendorGuid
) && !UserPhysicalPresent ()) {
888 // This variable is protected, only physical present user could modify its value.
890 return EFI_SECURITY_VIOLATION
;
894 if ((Attributes
& EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
) != 0) {
896 // Reject Counter Based Auth Variable processing request.
898 return EFI_UNSUPPORTED
;
899 } else if ((Attributes
& EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
) != 0) {
901 // Process Time-based Authenticated variable.
903 return VerifyTimeBasedPayloadAndUpdate (
914 if ((OrgVariableInfo
.Data
!= NULL
) &&
915 ((OrgVariableInfo
.Attributes
& (EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
)) != 0))
918 // If the variable is already write-protected, it always needs authentication before update.
920 return EFI_WRITE_PROTECTED
;
924 // Not authenticated variable, just update variable as usual.
926 Status
= AuthServiceInternalUpdateVariable (VariableName
, VendorGuid
, Data
, DataSize
, Attributes
);
931 Filter out the duplicated EFI_SIGNATURE_DATA from the new data by comparing to the original data.
933 @param[in] Data Pointer to original EFI_SIGNATURE_LIST.
934 @param[in] DataSize Size of Data buffer.
935 @param[in, out] NewData Pointer to new EFI_SIGNATURE_LIST.
936 @param[in, out] NewDataSize Size of NewData buffer.
940 FilterSignatureList (
943 IN OUT VOID
*NewData
,
944 IN OUT UINTN
*NewDataSize
947 EFI_SIGNATURE_LIST
*CertList
;
948 EFI_SIGNATURE_DATA
*Cert
;
950 EFI_SIGNATURE_LIST
*NewCertList
;
951 EFI_SIGNATURE_DATA
*NewCert
;
958 UINTN SignatureListSize
;
964 if (*NewDataSize
== 0) {
968 TempDataSize
= *NewDataSize
;
969 Status
= mAuthVarLibContextIn
->GetScratchBuffer (&TempDataSize
, (VOID
**)&TempData
);
970 if (EFI_ERROR (Status
)) {
971 return EFI_OUT_OF_RESOURCES
;
976 NewCertList
= (EFI_SIGNATURE_LIST
*)NewData
;
977 while ((*NewDataSize
> 0) && (*NewDataSize
>= NewCertList
->SignatureListSize
)) {
978 NewCert
= (EFI_SIGNATURE_DATA
*)((UINT8
*)NewCertList
+ sizeof (EFI_SIGNATURE_LIST
) + NewCertList
->SignatureHeaderSize
);
979 NewCertCount
= (NewCertList
->SignatureListSize
- sizeof (EFI_SIGNATURE_LIST
) - NewCertList
->SignatureHeaderSize
) / NewCertList
->SignatureSize
;
982 for (Index
= 0; Index
< NewCertCount
; Index
++) {
986 CertList
= (EFI_SIGNATURE_LIST
*)Data
;
987 while ((Size
> 0) && (Size
>= CertList
->SignatureListSize
)) {
988 if (CompareGuid (&CertList
->SignatureType
, &NewCertList
->SignatureType
) &&
989 (CertList
->SignatureSize
== NewCertList
->SignatureSize
))
991 Cert
= (EFI_SIGNATURE_DATA
*)((UINT8
*)CertList
+ sizeof (EFI_SIGNATURE_LIST
) + CertList
->SignatureHeaderSize
);
992 CertCount
= (CertList
->SignatureListSize
- sizeof (EFI_SIGNATURE_LIST
) - CertList
->SignatureHeaderSize
) / CertList
->SignatureSize
;
993 for (Index2
= 0; Index2
< CertCount
; Index2
++) {
995 // Iterate each Signature Data in this Signature List.
997 if (CompareMem (NewCert
, Cert
, CertList
->SignatureSize
) == 0) {
1002 Cert
= (EFI_SIGNATURE_DATA
*)((UINT8
*)Cert
+ CertList
->SignatureSize
);
1010 Size
-= CertList
->SignatureListSize
;
1011 CertList
= (EFI_SIGNATURE_LIST
*)((UINT8
*)CertList
+ CertList
->SignatureListSize
);
1016 // New EFI_SIGNATURE_DATA, keep it.
1018 if (CopiedCount
== 0) {
1020 // Copy EFI_SIGNATURE_LIST header for only once.
1022 CopyMem (Tail
, NewCertList
, sizeof (EFI_SIGNATURE_LIST
) + NewCertList
->SignatureHeaderSize
);
1023 Tail
= Tail
+ sizeof (EFI_SIGNATURE_LIST
) + NewCertList
->SignatureHeaderSize
;
1026 CopyMem (Tail
, NewCert
, NewCertList
->SignatureSize
);
1027 Tail
+= NewCertList
->SignatureSize
;
1031 NewCert
= (EFI_SIGNATURE_DATA
*)((UINT8
*)NewCert
+ NewCertList
->SignatureSize
);
1035 // Update SignatureListSize in the kept EFI_SIGNATURE_LIST.
1037 if (CopiedCount
!= 0) {
1038 SignatureListSize
= sizeof (EFI_SIGNATURE_LIST
) + NewCertList
->SignatureHeaderSize
+ (CopiedCount
* NewCertList
->SignatureSize
);
1039 CertList
= (EFI_SIGNATURE_LIST
*)(Tail
- SignatureListSize
);
1040 CertList
->SignatureListSize
= (UINT32
)SignatureListSize
;
1043 *NewDataSize
-= NewCertList
->SignatureListSize
;
1044 NewCertList
= (EFI_SIGNATURE_LIST
*)((UINT8
*)NewCertList
+ NewCertList
->SignatureListSize
);
1047 TempDataSize
= (Tail
- (UINT8
*)TempData
);
1049 CopyMem (NewData
, TempData
, TempDataSize
);
1050 *NewDataSize
= TempDataSize
;
1056 Compare two EFI_TIME data.
1059 @param FirstTime A pointer to the first EFI_TIME data.
1060 @param SecondTime A pointer to the second EFI_TIME data.
1062 @retval TRUE The FirstTime is not later than the SecondTime.
1063 @retval FALSE The FirstTime is later than the SecondTime.
1067 AuthServiceInternalCompareTimeStamp (
1068 IN EFI_TIME
*FirstTime
,
1069 IN EFI_TIME
*SecondTime
1072 if (FirstTime
->Year
!= SecondTime
->Year
) {
1073 return (BOOLEAN
)(FirstTime
->Year
< SecondTime
->Year
);
1074 } else if (FirstTime
->Month
!= SecondTime
->Month
) {
1075 return (BOOLEAN
)(FirstTime
->Month
< SecondTime
->Month
);
1076 } else if (FirstTime
->Day
!= SecondTime
->Day
) {
1077 return (BOOLEAN
)(FirstTime
->Day
< SecondTime
->Day
);
1078 } else if (FirstTime
->Hour
!= SecondTime
->Hour
) {
1079 return (BOOLEAN
)(FirstTime
->Hour
< SecondTime
->Hour
);
1080 } else if (FirstTime
->Minute
!= SecondTime
->Minute
) {
1081 return (BOOLEAN
)(FirstTime
->Minute
< SecondTime
->Minute
);
1084 return (BOOLEAN
)(FirstTime
->Second
<= SecondTime
->Second
);
1088 Calculate SHA256 digest of SignerCert CommonName + ToplevelCert tbsCertificate
1089 SignerCert and ToplevelCert are inside the signer certificate chain.
1091 @param[in] SignerCert A pointer to SignerCert data.
1092 @param[in] SignerCertSize Length of SignerCert data.
1093 @param[in] TopLevelCert A pointer to TopLevelCert data.
1094 @param[in] TopLevelCertSize Length of TopLevelCert data.
1095 @param[out] Sha256Digest Sha256 digest calculated.
1097 @return EFI_ABORTED Digest process failed.
1098 @return EFI_SUCCESS SHA256 Digest is successfully calculated.
1102 CalculatePrivAuthVarSignChainSHA256Digest (
1103 IN UINT8
*SignerCert
,
1104 IN UINTN SignerCertSize
,
1105 IN UINT8
*TopLevelCert
,
1106 IN UINTN TopLevelCertSize
,
1107 OUT UINT8
*Sha256Digest
1112 CHAR8 CertCommonName
[128];
1113 UINTN CertCommonNameSize
;
1114 BOOLEAN CryptoStatus
;
1117 CertCommonNameSize
= sizeof (CertCommonName
);
1120 // Get SignerCert CommonName
1122 Status
= X509GetCommonName (SignerCert
, SignerCertSize
, CertCommonName
, &CertCommonNameSize
);
1123 if (EFI_ERROR (Status
)) {
1124 DEBUG ((DEBUG_INFO
, "%a Get SignerCert CommonName failed with status %x\n", __FUNCTION__
, Status
));
1129 // Get TopLevelCert tbsCertificate
1131 if (!X509GetTBSCert (TopLevelCert
, TopLevelCertSize
, &TbsCert
, &TbsCertSize
)) {
1132 DEBUG ((DEBUG_INFO
, "%a Get Top-level Cert tbsCertificate failed!\n", __FUNCTION__
));
1137 // Digest SignerCert CN + TopLevelCert tbsCertificate
1139 ZeroMem (Sha256Digest
, SHA256_DIGEST_SIZE
);
1140 CryptoStatus
= Sha256Init (mHashCtx
);
1141 if (!CryptoStatus
) {
1146 // '\0' is forced in CertCommonName. No overflow issue
1148 CryptoStatus
= Sha256Update (
1151 AsciiStrLen (CertCommonName
)
1153 if (!CryptoStatus
) {
1157 CryptoStatus
= Sha256Update (mHashCtx
, TbsCert
, TbsCertSize
);
1158 if (!CryptoStatus
) {
1162 CryptoStatus
= Sha256Final (mHashCtx
, Sha256Digest
);
1163 if (!CryptoStatus
) {
1171 Find matching signer's certificates for common authenticated variable
1172 by corresponding VariableName and VendorGuid from "certdb" or "certdbv".
1174 The data format of "certdb" or "certdbv":
1176 // UINT32 CertDbListSize;
1177 // /// AUTH_CERT_DB_DATA Certs1[];
1178 // /// AUTH_CERT_DB_DATA Certs2[];
1180 // /// AUTH_CERT_DB_DATA Certsn[];
1183 @param[in] VariableName Name of authenticated Variable.
1184 @param[in] VendorGuid Vendor GUID of authenticated Variable.
1185 @param[in] Data Pointer to variable "certdb" or "certdbv".
1186 @param[in] DataSize Size of variable "certdb" or "certdbv".
1187 @param[out] CertOffset Offset of matching CertData, from starting of Data.
1188 @param[out] CertDataSize Length of CertData in bytes.
1189 @param[out] CertNodeOffset Offset of matching AUTH_CERT_DB_DATA , from
1191 @param[out] CertNodeSize Length of AUTH_CERT_DB_DATA in bytes.
1193 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
1194 @retval EFI_NOT_FOUND Fail to find matching certs.
1195 @retval EFI_SUCCESS Find matching certs and output parameters.
1200 IN CHAR16
*VariableName
,
1201 IN EFI_GUID
*VendorGuid
,
1204 OUT UINT32
*CertOffset OPTIONAL
,
1205 OUT UINT32
*CertDataSize OPTIONAL
,
1206 OUT UINT32
*CertNodeOffset OPTIONAL
,
1207 OUT UINT32
*CertNodeSize OPTIONAL
1211 AUTH_CERT_DB_DATA
*Ptr
;
1215 UINT32 CertDbListSize
;
1217 if ((VariableName
== NULL
) || (VendorGuid
== NULL
) || (Data
== NULL
)) {
1218 return EFI_INVALID_PARAMETER
;
1222 // Check whether DataSize matches recorded CertDbListSize.
1224 if (DataSize
< sizeof (UINT32
)) {
1225 return EFI_INVALID_PARAMETER
;
1228 CertDbListSize
= ReadUnaligned32 ((UINT32
*)Data
);
1230 if (CertDbListSize
!= (UINT32
)DataSize
) {
1231 return EFI_INVALID_PARAMETER
;
1234 Offset
= sizeof (UINT32
);
1237 // Get corresponding certificates by VendorGuid and VariableName.
1239 while (Offset
< (UINT32
)DataSize
) {
1240 Ptr
= (AUTH_CERT_DB_DATA
*)(Data
+ Offset
);
1242 // Check whether VendorGuid matches.
1244 if (CompareGuid (&Ptr
->VendorGuid
, VendorGuid
)) {
1245 NodeSize
= ReadUnaligned32 (&Ptr
->CertNodeSize
);
1246 NameSize
= ReadUnaligned32 (&Ptr
->NameSize
);
1247 CertSize
= ReadUnaligned32 (&Ptr
->CertDataSize
);
1249 if (NodeSize
!= sizeof (EFI_GUID
) + sizeof (UINT32
) * 3 + CertSize
+
1250 sizeof (CHAR16
) * NameSize
)
1252 return EFI_INVALID_PARAMETER
;
1255 Offset
= Offset
+ sizeof (EFI_GUID
) + sizeof (UINT32
) * 3;
1257 // Check whether VariableName matches.
1259 if ((NameSize
== StrLen (VariableName
)) &&
1260 (CompareMem (Data
+ Offset
, VariableName
, NameSize
* sizeof (CHAR16
)) == 0))
1262 Offset
= Offset
+ NameSize
* sizeof (CHAR16
);
1264 if (CertOffset
!= NULL
) {
1265 *CertOffset
= Offset
;
1268 if (CertDataSize
!= NULL
) {
1269 *CertDataSize
= CertSize
;
1272 if (CertNodeOffset
!= NULL
) {
1273 *CertNodeOffset
= (UINT32
)((UINT8
*)Ptr
- Data
);
1276 if (CertNodeSize
!= NULL
) {
1277 *CertNodeSize
= NodeSize
;
1282 Offset
= Offset
+ NameSize
* sizeof (CHAR16
) + CertSize
;
1285 NodeSize
= ReadUnaligned32 (&Ptr
->CertNodeSize
);
1286 Offset
= Offset
+ NodeSize
;
1290 return EFI_NOT_FOUND
;
1294 Retrieve signer's certificates for common authenticated variable
1295 by corresponding VariableName and VendorGuid from "certdb"
1296 or "certdbv" according to authenticated variable attributes.
1298 @param[in] VariableName Name of authenticated Variable.
1299 @param[in] VendorGuid Vendor GUID of authenticated Variable.
1300 @param[in] Attributes Attributes of authenticated variable.
1301 @param[out] CertData Pointer to signer's certificates.
1302 @param[out] CertDataSize Length of CertData in bytes.
1304 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
1305 @retval EFI_NOT_FOUND Fail to find "certdb"/"certdbv" or matching certs.
1306 @retval EFI_SUCCESS Get signer's certificates successfully.
1311 IN CHAR16
*VariableName
,
1312 IN EFI_GUID
*VendorGuid
,
1313 IN UINT32 Attributes
,
1314 OUT UINT8
**CertData
,
1315 OUT UINT32
*CertDataSize
1324 if ((VariableName
== NULL
) || (VendorGuid
== NULL
) || (CertData
== NULL
) || (CertDataSize
== NULL
)) {
1325 return EFI_INVALID_PARAMETER
;
1328 if ((Attributes
& EFI_VARIABLE_NON_VOLATILE
) != 0) {
1330 // Get variable "certdb".
1332 DbName
= EFI_CERT_DB_NAME
;
1335 // Get variable "certdbv".
1337 DbName
= EFI_CERT_DB_VOLATILE_NAME
;
1341 // Get variable "certdb" or "certdbv".
1343 Status
= AuthServiceInternalFindVariable (
1349 if (EFI_ERROR (Status
)) {
1353 if ((DataSize
== 0) || (Data
== NULL
)) {
1355 return EFI_NOT_FOUND
;
1358 Status
= FindCertsFromDb (
1369 if (EFI_ERROR (Status
)) {
1373 *CertData
= Data
+ CertOffset
;
1378 Delete matching signer's certificates when deleting common authenticated
1379 variable by corresponding VariableName and VendorGuid from "certdb" or
1380 "certdbv" according to authenticated variable attributes.
1382 @param[in] VariableName Name of authenticated Variable.
1383 @param[in] VendorGuid Vendor GUID of authenticated Variable.
1384 @param[in] Attributes Attributes of authenticated variable.
1386 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
1387 @retval EFI_NOT_FOUND Fail to find "certdb"/"certdbv" or matching certs.
1388 @retval EFI_OUT_OF_RESOURCES The operation is failed due to lack of resources.
1389 @retval EFI_SUCCESS The operation is completed successfully.
1394 IN CHAR16
*VariableName
,
1395 IN EFI_GUID
*VendorGuid
,
1396 IN UINT32 Attributes
1403 UINT32 CertNodeOffset
;
1404 UINT32 CertNodeSize
;
1406 UINT32 NewCertDbSize
;
1409 if ((VariableName
== NULL
) || (VendorGuid
== NULL
)) {
1410 return EFI_INVALID_PARAMETER
;
1413 if ((Attributes
& EFI_VARIABLE_NON_VOLATILE
) != 0) {
1415 // Get variable "certdb".
1417 DbName
= EFI_CERT_DB_NAME
;
1418 VarAttr
= EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
;
1421 // Get variable "certdbv".
1423 DbName
= EFI_CERT_DB_VOLATILE_NAME
;
1424 VarAttr
= EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
;
1427 Status
= AuthServiceInternalFindVariable (
1434 if (EFI_ERROR (Status
)) {
1438 if ((DataSize
== 0) || (Data
== NULL
)) {
1440 return EFI_NOT_FOUND
;
1443 if (DataSize
== sizeof (UINT32
)) {
1445 // There is no certs in "certdb" or "certdbv".
1451 // Get corresponding cert node from "certdb" or "certdbv".
1453 Status
= FindCertsFromDb (
1464 if (EFI_ERROR (Status
)) {
1468 if (DataSize
< (CertNodeOffset
+ CertNodeSize
)) {
1469 return EFI_NOT_FOUND
;
1473 // Construct new data content of variable "certdb" or "certdbv".
1475 NewCertDbSize
= (UINT32
)DataSize
- CertNodeSize
;
1476 NewCertDb
= (UINT8
*)mCertDbStore
;
1479 // Copy the DB entries before deleting node.
1481 CopyMem (NewCertDb
, Data
, CertNodeOffset
);
1483 // Update CertDbListSize.
1485 CopyMem (NewCertDb
, &NewCertDbSize
, sizeof (UINT32
));
1487 // Copy the DB entries after deleting node.
1489 if (DataSize
> (CertNodeOffset
+ CertNodeSize
)) {
1491 NewCertDb
+ CertNodeOffset
,
1492 Data
+ CertNodeOffset
+ CertNodeSize
,
1493 DataSize
- CertNodeOffset
- CertNodeSize
1498 // Set "certdb" or "certdbv".
1500 Status
= AuthServiceInternalUpdateVariable (
1512 Insert signer's certificates for common authenticated variable with VariableName
1513 and VendorGuid in AUTH_CERT_DB_DATA to "certdb" or "certdbv" according to
1514 time based authenticated variable attributes. CertData is the SHA256 digest of
1515 SignerCert CommonName + TopLevelCert tbsCertificate.
1517 @param[in] VariableName Name of authenticated Variable.
1518 @param[in] VendorGuid Vendor GUID of authenticated Variable.
1519 @param[in] Attributes Attributes of authenticated variable.
1520 @param[in] SignerCert Signer certificate data.
1521 @param[in] SignerCertSize Length of signer certificate.
1522 @param[in] TopLevelCert Top-level certificate data.
1523 @param[in] TopLevelCertSize Length of top-level certificate.
1525 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
1526 @retval EFI_ACCESS_DENIED An AUTH_CERT_DB_DATA entry with same VariableName
1527 and VendorGuid already exists.
1528 @retval EFI_OUT_OF_RESOURCES The operation is failed due to lack of resources.
1529 @retval EFI_SUCCESS Insert an AUTH_CERT_DB_DATA entry to "certdb" or "certdbv"
1534 IN CHAR16
*VariableName
,
1535 IN EFI_GUID
*VendorGuid
,
1536 IN UINT32 Attributes
,
1537 IN UINT8
*SignerCert
,
1538 IN UINTN SignerCertSize
,
1539 IN UINT8
*TopLevelCert
,
1540 IN UINTN TopLevelCertSize
1548 UINT32 NewCertDbSize
;
1549 UINT32 CertNodeSize
;
1551 UINT32 CertDataSize
;
1552 AUTH_CERT_DB_DATA
*Ptr
;
1554 UINT8 Sha256Digest
[SHA256_DIGEST_SIZE
];
1556 if ((VariableName
== NULL
) || (VendorGuid
== NULL
) || (SignerCert
== NULL
) || (TopLevelCert
== NULL
)) {
1557 return EFI_INVALID_PARAMETER
;
1560 if ((Attributes
& EFI_VARIABLE_NON_VOLATILE
) != 0) {
1562 // Get variable "certdb".
1564 DbName
= EFI_CERT_DB_NAME
;
1565 VarAttr
= EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
;
1568 // Get variable "certdbv".
1570 DbName
= EFI_CERT_DB_VOLATILE_NAME
;
1571 VarAttr
= EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
;
1575 // Get variable "certdb" or "certdbv".
1577 Status
= AuthServiceInternalFindVariable (
1583 if (EFI_ERROR (Status
)) {
1587 if ((DataSize
== 0) || (Data
== NULL
)) {
1589 return EFI_NOT_FOUND
;
1593 // Find whether matching cert node already exists in "certdb" or "certdbv".
1594 // If yes return error.
1596 Status
= FindCertsFromDb (
1607 if (!EFI_ERROR (Status
)) {
1609 return EFI_ACCESS_DENIED
;
1613 // Construct new data content of variable "certdb" or "certdbv".
1615 NameSize
= (UINT32
)StrLen (VariableName
);
1616 CertDataSize
= sizeof (Sha256Digest
);
1617 CertNodeSize
= sizeof (AUTH_CERT_DB_DATA
) + (UINT32
)CertDataSize
+ NameSize
* sizeof (CHAR16
);
1618 NewCertDbSize
= (UINT32
)DataSize
+ CertNodeSize
;
1619 if (NewCertDbSize
> mMaxCertDbSize
) {
1620 return EFI_OUT_OF_RESOURCES
;
1623 Status
= CalculatePrivAuthVarSignChainSHA256Digest (
1630 if (EFI_ERROR (Status
)) {
1634 NewCertDb
= (UINT8
*)mCertDbStore
;
1637 // Copy the DB entries before inserting node.
1639 CopyMem (NewCertDb
, Data
, DataSize
);
1641 // Update CertDbListSize.
1643 CopyMem (NewCertDb
, &NewCertDbSize
, sizeof (UINT32
));
1645 // Construct new cert node.
1647 Ptr
= (AUTH_CERT_DB_DATA
*)(NewCertDb
+ DataSize
);
1648 CopyGuid (&Ptr
->VendorGuid
, VendorGuid
);
1649 CopyMem (&Ptr
->CertNodeSize
, &CertNodeSize
, sizeof (UINT32
));
1650 CopyMem (&Ptr
->NameSize
, &NameSize
, sizeof (UINT32
));
1651 CopyMem (&Ptr
->CertDataSize
, &CertDataSize
, sizeof (UINT32
));
1654 (UINT8
*)Ptr
+ sizeof (AUTH_CERT_DB_DATA
),
1656 NameSize
* sizeof (CHAR16
)
1660 (UINT8
*)Ptr
+ sizeof (AUTH_CERT_DB_DATA
) + NameSize
* sizeof (CHAR16
),
1666 // Set "certdb" or "certdbv".
1668 Status
= AuthServiceInternalUpdateVariable (
1680 Clean up signer's certificates for common authenticated variable
1681 by corresponding VariableName and VendorGuid from "certdb".
1682 System may break down during Timebased Variable update & certdb update,
1683 make them inconsistent, this function is called in AuthVariable Init
1684 to ensure consistency.
1686 @retval EFI_NOT_FOUND Fail to find variable "certdb".
1687 @retval EFI_OUT_OF_RESOURCES The operation is failed due to lack of resources.
1688 @retval EFI_SUCCESS The operation is completed successfully.
1697 AUTH_CERT_DB_DATA
*Ptr
;
1700 CHAR16
*VariableName
;
1702 BOOLEAN CertCleaned
;
1705 EFI_GUID AuthVarGuid
;
1706 AUTH_VARIABLE_INFO AuthVariableInfo
;
1708 Status
= EFI_SUCCESS
;
1711 // Get corresponding certificates by VendorGuid and VariableName.
1714 CertCleaned
= FALSE
;
1717 // Get latest variable "certdb"
1719 Status
= AuthServiceInternalFindVariable (
1725 if (EFI_ERROR (Status
)) {
1729 if ((DataSize
== 0) || (Data
== NULL
)) {
1731 return EFI_NOT_FOUND
;
1734 Offset
= sizeof (UINT32
);
1736 while (Offset
< (UINT32
)DataSize
) {
1737 Ptr
= (AUTH_CERT_DB_DATA
*)(Data
+ Offset
);
1738 NodeSize
= ReadUnaligned32 (&Ptr
->CertNodeSize
);
1739 NameSize
= ReadUnaligned32 (&Ptr
->NameSize
);
1742 // Get VarName tailed with '\0'
1744 VariableName
= AllocateZeroPool ((NameSize
+ 1) * sizeof (CHAR16
));
1745 if (VariableName
== NULL
) {
1746 return EFI_OUT_OF_RESOURCES
;
1749 CopyMem (VariableName
, (UINT8
*)Ptr
+ sizeof (AUTH_CERT_DB_DATA
), NameSize
* sizeof (CHAR16
));
1751 // Keep VarGuid aligned
1753 CopyMem (&AuthVarGuid
, &Ptr
->VendorGuid
, sizeof (EFI_GUID
));
1756 // Find corresponding time auth variable
1758 ZeroMem (&AuthVariableInfo
, sizeof (AuthVariableInfo
));
1759 Status
= mAuthVarLibContextIn
->FindVariable (
1765 if (EFI_ERROR (Status
) || ((AuthVariableInfo
.Attributes
& EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
) == 0)) {
1767 // While cleaning certdb, always delete the variable in certdb regardless of it attributes.
1769 Status
= DeleteCertsFromDb (
1772 AuthVariableInfo
.Attributes
| EFI_VARIABLE_NON_VOLATILE
1775 DEBUG ((DEBUG_INFO
, "Recovery!! Cert for Auth Variable %s Guid %g is removed for consistency\n", VariableName
, &AuthVarGuid
));
1776 FreePool (VariableName
);
1780 FreePool (VariableName
);
1781 Offset
= Offset
+ NodeSize
;
1783 } while (CertCleaned
);
1789 Process variable with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set
1791 Caution: This function may receive untrusted input.
1792 This function may be invoked in SMM mode, and datasize and data are external input.
1793 This function will do basic validation, before parse the data.
1794 This function will parse the authentication carefully to avoid security issues, like
1795 buffer overflow, integer overflow.
1797 @param[in] VariableName Name of Variable to be found.
1798 @param[in] VendorGuid Variable vendor GUID.
1799 @param[in] Data Data pointer.
1800 @param[in] DataSize Size of Data found. If size is less than the
1801 data, this value contains the required size.
1802 @param[in] Attributes Attribute value of the variable.
1803 @param[in] AuthVarType Verify against PK, KEK database, private database or certificate in data payload.
1804 @param[in] OrgTimeStamp Pointer to original time stamp,
1805 original variable is not found if NULL.
1806 @param[out] VarPayloadPtr Pointer to variable payload address.
1807 @param[out] VarPayloadSize Pointer to variable payload size.
1809 @retval EFI_INVALID_PARAMETER Invalid parameter.
1810 @retval EFI_SECURITY_VIOLATION The variable does NOT pass the validation
1811 check carried out by the firmware.
1812 @retval EFI_OUT_OF_RESOURCES Failed to process variable due to lack
1814 @retval EFI_SUCCESS Variable pass validation successfully.
1818 VerifyTimeBasedPayload (
1819 IN CHAR16
*VariableName
,
1820 IN EFI_GUID
*VendorGuid
,
1823 IN UINT32 Attributes
,
1824 IN AUTHVAR_TYPE AuthVarType
,
1825 IN EFI_TIME
*OrgTimeStamp
,
1826 OUT UINT8
**VarPayloadPtr
,
1827 OUT UINTN
*VarPayloadSize
1830 EFI_VARIABLE_AUTHENTICATION_2
*CertData
;
1836 BOOLEAN VerifyStatus
;
1838 EFI_SIGNATURE_LIST
*CertList
;
1839 EFI_SIGNATURE_DATA
*Cert
;
1847 UINT8
*TopLevelCert
;
1848 UINTN TopLevelCertSize
;
1850 UINTN TrustedCertSize
;
1852 UINTN CertStackSize
;
1853 UINT8
*CertsInCertDb
;
1854 UINT32 CertsSizeinDb
;
1855 UINT8 Sha256Digest
[SHA256_DIGEST_SIZE
];
1856 EFI_CERT_DATA
*CertDataPtr
;
1859 // 1. TopLevelCert is the top-level issuer certificate in signature Signer Cert Chain
1860 // 2. TrustedCert is the certificate which firmware trusts. It could be saved in protected
1861 // storage or PK payload on PK init
1863 VerifyStatus
= FALSE
;
1868 TopLevelCert
= NULL
;
1869 CertsInCertDb
= NULL
;
1873 // When the attribute EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS is
1874 // set, then the Data buffer shall begin with an instance of a complete (and serialized)
1875 // EFI_VARIABLE_AUTHENTICATION_2 descriptor. The descriptor shall be followed by the new
1876 // variable value and DataSize shall reflect the combined size of the descriptor and the new
1877 // variable value. The authentication descriptor is not part of the variable data and is not
1878 // returned by subsequent calls to GetVariable().
1880 CertData
= (EFI_VARIABLE_AUTHENTICATION_2
*)Data
;
1883 // Verify that Pad1, Nanosecond, TimeZone, Daylight and Pad2 components of the
1884 // TimeStamp value are set to zero.
1886 if ((CertData
->TimeStamp
.Pad1
!= 0) ||
1887 (CertData
->TimeStamp
.Nanosecond
!= 0) ||
1888 (CertData
->TimeStamp
.TimeZone
!= 0) ||
1889 (CertData
->TimeStamp
.Daylight
!= 0) ||
1890 (CertData
->TimeStamp
.Pad2
!= 0))
1892 return EFI_SECURITY_VIOLATION
;
1895 if ((OrgTimeStamp
!= NULL
) && ((Attributes
& EFI_VARIABLE_APPEND_WRITE
) == 0)) {
1896 if (AuthServiceInternalCompareTimeStamp (&CertData
->TimeStamp
, OrgTimeStamp
)) {
1898 // TimeStamp check fail, suspicious replay attack, return EFI_SECURITY_VIOLATION.
1900 return EFI_SECURITY_VIOLATION
;
1905 // wCertificateType should be WIN_CERT_TYPE_EFI_GUID.
1906 // Cert type should be EFI_CERT_TYPE_PKCS7_GUID.
1908 if ((CertData
->AuthInfo
.Hdr
.wCertificateType
!= WIN_CERT_TYPE_EFI_GUID
) ||
1909 !CompareGuid (&CertData
->AuthInfo
.CertType
, &gEfiCertPkcs7Guid
))
1912 // Invalid AuthInfo type, return EFI_SECURITY_VIOLATION.
1914 return EFI_SECURITY_VIOLATION
;
1918 // Find out Pkcs7 SignedData which follows the EFI_VARIABLE_AUTHENTICATION_2 descriptor.
1919 // AuthInfo.Hdr.dwLength is the length of the entire certificate, including the length of the header.
1921 SigData
= CertData
->AuthInfo
.CertData
;
1922 SigDataSize
= CertData
->AuthInfo
.Hdr
.dwLength
- (UINT32
)(OFFSET_OF (WIN_CERTIFICATE_UEFI_GUID
, CertData
));
1925 // SignedData.digestAlgorithms shall contain the digest algorithm used when preparing the
1926 // signature. Only a digest algorithm of SHA-256 is accepted.
1928 // According to PKCS#7 Definition (https://www.rfc-editor.org/rfc/rfc2315):
1929 // SignedData ::= SEQUENCE {
1931 // digestAlgorithms DigestAlgorithmIdentifiers,
1932 // contentInfo ContentInfo,
1934 // The DigestAlgorithmIdentifiers can be used to determine the hash algorithm
1935 // in VARIABLE_AUTHENTICATION_2 descriptor.
1936 // This field has the fixed offset (+13) or (+32) based on whether the DER-encoded
1937 // ContentInfo structure is present or not, and can be calculated based on two
1938 // bytes of length encoding.
1940 // Both condition can be handled in WrapPkcs7Data() in CryptPkcs7VerifyCommon.c.
1942 // See below examples:
1944 // 1. Without ContentInfo
1945 // 30 82 0c da // SEQUENCE (5 element) (3294 BYTES) -- SignedData
1946 // 02 01 01 // INTEGER 1 -- Version
1947 // 31 0f // SET (1 element) (15 BYTES) -- DigestAlgorithmIdentifiers
1948 // 30 0d // SEQUENCE (2 element) (13 BYTES) -- AlgorithmIdentifier
1949 // 06 09 // OBJECT-IDENTIFIER (9 BYTES) -- algorithm
1950 // 60 86 48 01 65 03 04 02 01 // sha256 [2.16.840.1.101.3.4.2.1]
1951 // 05 00 // NULL (0 BYTES) -- parameters
1953 // Example from: https://uefi.org/revocationlistfile
1955 // 2. With ContentInfo
1956 // 30 82 05 90 // SEQUENCE (1424 BYTES) -- ContentInfo
1957 // 06 09 // OBJECT-IDENTIFIER (9 BYTES) -- ContentType
1958 // 2a 86 48 86 f7 0d 01 07 02 // signedData [1.2.840.113549.1.7.2]
1959 // a0 82 05 81 // CONTEXT-SPECIFIC CONSTRUCTED TAG 0 (1409 BYTES) -- content
1960 // 30 82 05 7d // SEQUENCE (1405 BYTES) -- SignedData
1961 // 02 01 01 // INTEGER 1 -- Version
1962 // 31 0f // SET (1 element) (15 BYTES) -- DigestAlgorithmIdentifiers
1963 // 30 0d // SEQUENCE (13 BYTES) -- AlgorithmIdentifier
1964 // 06 09 // OBJECT-IDENTIFIER (9 BYTES) -- algorithm
1965 // 60 86 48 01 65 03 04 02 01 // sha256 [2.16.840.1.101.3.4.2.1]
1966 // 05 00 // NULL (0 BYTES) -- parameters
1968 // Example generated with: https://wiki.archlinux.org/title/Unified_Extensible_Firmware_Interface/Secure_Boot#Manual_process
1970 if ((Attributes
& EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
) != 0) {
1971 if ( ( (SigDataSize
>= (13 + sizeof (mSha256OidValue
)))
1972 && ( ((*(SigData
+ 1) & TWO_BYTE_ENCODE
) != TWO_BYTE_ENCODE
)
1973 || (CompareMem (SigData
+ 13, &mSha256OidValue
, sizeof (mSha256OidValue
)) != 0)))
1974 && ( (SigDataSize
>= (32 + sizeof (mSha256OidValue
)))
1975 && ( ((*(SigData
+ 20) & TWO_BYTE_ENCODE
) != TWO_BYTE_ENCODE
)
1976 || (CompareMem (SigData
+ 32, &mSha256OidValue
, sizeof (mSha256OidValue
)) != 0))))
1978 return EFI_SECURITY_VIOLATION
;
1983 // Find out the new data payload which follows Pkcs7 SignedData directly.
1985 PayloadPtr
= SigData
+ SigDataSize
;
1986 PayloadSize
= DataSize
- OFFSET_OF_AUTHINFO2_CERT_DATA
- (UINTN
)SigDataSize
;
1988 // If the VariablePolicy engine is disabled, allow deletion of any authenticated variables.
1989 if ((PayloadSize
== 0) && ((Attributes
& EFI_VARIABLE_APPEND_WRITE
) == 0) && !IsVariablePolicyEnabled ()) {
1990 VerifyStatus
= TRUE
;
1995 // Construct a serialization buffer of the values of the VariableName, VendorGuid and Attributes
1996 // parameters of the SetVariable() call and the TimeStamp component of the
1997 // EFI_VARIABLE_AUTHENTICATION_2 descriptor followed by the variable's new value
1998 // i.e. (VariableName, VendorGuid, Attributes, TimeStamp, Data)
2000 NewDataSize
= PayloadSize
+ sizeof (EFI_TIME
) + sizeof (UINT32
) +
2001 sizeof (EFI_GUID
) + StrSize (VariableName
) - sizeof (CHAR16
);
2004 // Here is to reuse scratch data area(at the end of volatile variable store)
2005 // to reduce SMRAM consumption for SMM variable driver.
2006 // The scratch buffer is enough to hold the serialized data and safe to use,
2007 // because it is only used at here to do verification temporarily first
2008 // and then used in UpdateVariable() for a time based auth variable set.
2010 Status
= mAuthVarLibContextIn
->GetScratchBuffer (&NewDataSize
, (VOID
**)&NewData
);
2011 if (EFI_ERROR (Status
)) {
2012 return EFI_OUT_OF_RESOURCES
;
2016 Length
= StrLen (VariableName
) * sizeof (CHAR16
);
2017 CopyMem (Buffer
, VariableName
, Length
);
2020 Length
= sizeof (EFI_GUID
);
2021 CopyMem (Buffer
, VendorGuid
, Length
);
2024 Length
= sizeof (UINT32
);
2025 CopyMem (Buffer
, &Attr
, Length
);
2028 Length
= sizeof (EFI_TIME
);
2029 CopyMem (Buffer
, &CertData
->TimeStamp
, Length
);
2032 CopyMem (Buffer
, PayloadPtr
, PayloadSize
);
2034 if (AuthVarType
== AuthVarTypePk
) {
2036 // Verify that the signature has been made with the current Platform Key (no chaining for PK).
2037 // First, get signer's certificates from SignedData.
2039 VerifyStatus
= Pkcs7GetSigners (
2047 if (!VerifyStatus
) {
2052 // Second, get the current platform key from variable. Check whether it's identical with signer's certificates
2053 // in SignedData. If not, return error immediately.
2055 Status
= AuthServiceInternalFindVariable (
2056 EFI_PLATFORM_KEY_NAME
,
2057 &gEfiGlobalVariableGuid
,
2061 if (EFI_ERROR (Status
)) {
2062 VerifyStatus
= FALSE
;
2066 CertList
= (EFI_SIGNATURE_LIST
*)Data
;
2067 Cert
= (EFI_SIGNATURE_DATA
*)((UINT8
*)CertList
+ sizeof (EFI_SIGNATURE_LIST
) + CertList
->SignatureHeaderSize
);
2068 if ((TopLevelCertSize
!= (CertList
->SignatureSize
- (sizeof (EFI_SIGNATURE_DATA
) - 1))) ||
2069 (CompareMem (Cert
->SignatureData
, TopLevelCert
, TopLevelCertSize
) != 0))
2071 VerifyStatus
= FALSE
;
2076 // Verify Pkcs7 SignedData via Pkcs7Verify library.
2078 VerifyStatus
= Pkcs7Verify (
2086 } else if (AuthVarType
== AuthVarTypeKek
) {
2088 // Get KEK database from variable.
2090 Status
= AuthServiceInternalFindVariable (
2091 EFI_KEY_EXCHANGE_KEY_NAME
,
2092 &gEfiGlobalVariableGuid
,
2096 if (EFI_ERROR (Status
)) {
2101 // Ready to verify Pkcs7 SignedData. Go through KEK Signature Database to find out X.509 CertList.
2103 KekDataSize
= (UINT32
)DataSize
;
2104 CertList
= (EFI_SIGNATURE_LIST
*)Data
;
2105 while ((KekDataSize
> 0) && (KekDataSize
>= CertList
->SignatureListSize
)) {
2106 if (CompareGuid (&CertList
->SignatureType
, &gEfiCertX509Guid
)) {
2107 Cert
= (EFI_SIGNATURE_DATA
*)((UINT8
*)CertList
+ sizeof (EFI_SIGNATURE_LIST
) + CertList
->SignatureHeaderSize
);
2108 CertCount
= (CertList
->SignatureListSize
- sizeof (EFI_SIGNATURE_LIST
) - CertList
->SignatureHeaderSize
) / CertList
->SignatureSize
;
2109 for (Index
= 0; Index
< CertCount
; Index
++) {
2111 // Iterate each Signature Data Node within this CertList for a verify
2113 TrustedCert
= Cert
->SignatureData
;
2114 TrustedCertSize
= CertList
->SignatureSize
- (sizeof (EFI_SIGNATURE_DATA
) - 1);
2117 // Verify Pkcs7 SignedData via Pkcs7Verify library.
2119 VerifyStatus
= Pkcs7Verify (
2131 Cert
= (EFI_SIGNATURE_DATA
*)((UINT8
*)Cert
+ CertList
->SignatureSize
);
2135 KekDataSize
-= CertList
->SignatureListSize
;
2136 CertList
= (EFI_SIGNATURE_LIST
*)((UINT8
*)CertList
+ CertList
->SignatureListSize
);
2138 } else if (AuthVarType
== AuthVarTypePriv
) {
2140 // Process common authenticated variable except PK/KEK/DB/DBX/DBT.
2141 // Get signer's certificates from SignedData.
2143 VerifyStatus
= Pkcs7GetSigners (
2151 if (!VerifyStatus
) {
2156 // Get previously stored signer's certificates from certdb or certdbv for existing
2157 // variable. Check whether they are identical with signer's certificates
2158 // in SignedData. If not, return error immediately.
2160 if (OrgTimeStamp
!= NULL
) {
2161 VerifyStatus
= FALSE
;
2163 Status
= GetCertsFromDb (VariableName
, VendorGuid
, Attributes
, &CertsInCertDb
, &CertsSizeinDb
);
2164 if (EFI_ERROR (Status
)) {
2168 if (CertsSizeinDb
== SHA256_DIGEST_SIZE
) {
2170 // Check hash of signer cert CommonName + Top-level issuer tbsCertificate against data in CertDb
2172 CertDataPtr
= (EFI_CERT_DATA
*)(SignerCerts
+ 1);
2173 Status
= CalculatePrivAuthVarSignChainSHA256Digest (
2174 CertDataPtr
->CertDataBuffer
,
2175 ReadUnaligned32 ((UINT32
*)&(CertDataPtr
->CertDataLength
)),
2180 if (EFI_ERROR (Status
) || (CompareMem (Sha256Digest
, CertsInCertDb
, CertsSizeinDb
) != 0)) {
2185 // Keep backward compatible with previous solution which saves whole signer certs stack in CertDb
2187 if ((CertStackSize
!= CertsSizeinDb
) ||
2188 (CompareMem (SignerCerts
, CertsInCertDb
, CertsSizeinDb
) != 0))
2195 VerifyStatus
= Pkcs7Verify (
2203 if (!VerifyStatus
) {
2207 if ((OrgTimeStamp
== NULL
) && (PayloadSize
!= 0)) {
2209 // When adding a new common authenticated variable, always save Hash of cn of signer cert + tbsCertificate of Top-level issuer
2211 CertDataPtr
= (EFI_CERT_DATA
*)(SignerCerts
+ 1);
2212 Status
= InsertCertsToDb (
2216 CertDataPtr
->CertDataBuffer
,
2217 ReadUnaligned32 ((UINT32
*)&(CertDataPtr
->CertDataLength
)),
2221 if (EFI_ERROR (Status
)) {
2222 VerifyStatus
= FALSE
;
2226 } else if (AuthVarType
== AuthVarTypePayload
) {
2227 CertList
= (EFI_SIGNATURE_LIST
*)PayloadPtr
;
2228 Cert
= (EFI_SIGNATURE_DATA
*)((UINT8
*)CertList
+ sizeof (EFI_SIGNATURE_LIST
) + CertList
->SignatureHeaderSize
);
2229 TrustedCert
= Cert
->SignatureData
;
2230 TrustedCertSize
= CertList
->SignatureSize
- (sizeof (EFI_SIGNATURE_DATA
) - 1);
2232 // Verify Pkcs7 SignedData via Pkcs7Verify library.
2234 VerifyStatus
= Pkcs7Verify (
2243 return EFI_SECURITY_VIOLATION
;
2248 if ((AuthVarType
== AuthVarTypePk
) || (AuthVarType
== AuthVarTypePriv
)) {
2249 if (TopLevelCert
!= NULL
) {
2250 Pkcs7FreeSigners (TopLevelCert
);
2253 if (SignerCerts
!= NULL
) {
2254 Pkcs7FreeSigners (SignerCerts
);
2258 if (!VerifyStatus
) {
2259 return EFI_SECURITY_VIOLATION
;
2262 Status
= CheckSignatureListFormat (VariableName
, VendorGuid
, PayloadPtr
, PayloadSize
);
2263 if (EFI_ERROR (Status
)) {
2267 *VarPayloadPtr
= PayloadPtr
;
2268 *VarPayloadSize
= PayloadSize
;
2274 Process variable with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set
2276 Caution: This function may receive untrusted input.
2277 This function may be invoked in SMM mode, and datasize and data are external input.
2278 This function will do basic validation, before parse the data.
2279 This function will parse the authentication carefully to avoid security issues, like
2280 buffer overflow, integer overflow.
2282 @param[in] VariableName Name of Variable to be found.
2283 @param[in] VendorGuid Variable vendor GUID.
2284 @param[in] Data Data pointer.
2285 @param[in] DataSize Size of Data found. If size is less than the
2286 data, this value contains the required size.
2287 @param[in] Attributes Attribute value of the variable.
2288 @param[in] AuthVarType Verify against PK, KEK database, private database or certificate in data payload.
2289 @param[out] VarDel Delete the variable or not.
2291 @retval EFI_INVALID_PARAMETER Invalid parameter.
2292 @retval EFI_SECURITY_VIOLATION The variable does NOT pass the validation
2293 check carried out by the firmware.
2294 @retval EFI_OUT_OF_RESOURCES Failed to process variable due to lack
2296 @retval EFI_SUCCESS Variable pass validation successfully.
2300 VerifyTimeBasedPayloadAndUpdate (
2301 IN CHAR16
*VariableName
,
2302 IN EFI_GUID
*VendorGuid
,
2305 IN UINT32 Attributes
,
2306 IN AUTHVAR_TYPE AuthVarType
,
2311 EFI_STATUS FindStatus
;
2314 EFI_VARIABLE_AUTHENTICATION_2
*CertData
;
2315 AUTH_VARIABLE_INFO OrgVariableInfo
;
2318 ZeroMem (&OrgVariableInfo
, sizeof (OrgVariableInfo
));
2319 FindStatus
= mAuthVarLibContextIn
->FindVariable (
2325 Status
= VerifyTimeBasedPayload (
2332 (!EFI_ERROR (FindStatus
)) ? OrgVariableInfo
.TimeStamp
: NULL
,
2336 if (EFI_ERROR (Status
)) {
2340 if ( !EFI_ERROR (FindStatus
)
2341 && (PayloadSize
== 0)
2342 && ((Attributes
& EFI_VARIABLE_APPEND_WRITE
) == 0))
2349 CertData
= (EFI_VARIABLE_AUTHENTICATION_2
*)Data
;
2352 // Final step: Update/Append Variable if it pass Pkcs7Verify
2354 Status
= AuthServiceInternalUpdateVariableWithTimeStamp (
2360 &CertData
->TimeStamp
2364 // Delete signer's certificates when delete the common authenticated variable.
2366 if (IsDel
&& (AuthVarType
== AuthVarTypePriv
) && !EFI_ERROR (Status
)) {
2367 Status
= DeleteCertsFromDb (VariableName
, VendorGuid
, Attributes
);
2370 if (VarDel
!= NULL
) {
2371 if (IsDel
&& !EFI_ERROR (Status
)) {