They will do basic validation for authentication data structure, then call crypto library\r
to verify the signature.\r
\r
-Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2009 - 2017, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
//\r
CONST UINT8 mRsaE[] = { 0x01, 0x00, 0x01 };\r
\r
+CONST UINT8 mSha256OidValue[] = { 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02, 0x01 };\r
+\r
//\r
// Requirement for different signature type which have been defined in UEFI spec.\r
// These data are used to perform SignatureList format check while setting PK/KEK variable.\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
+ //\r
+ // Init state of Del. State may change due to secure check\r
+ //\r
Del = FALSE;\r
if ((InCustomMode() && UserPhysicalPresent()) || (mPlatformMode == SETUP_MODE && !IsPk)) {\r
Payload = (UINT8 *) Data + AUTHINFO2_SIZE (Data);\r
IN EFI_GUID *VendorGuid,\r
IN VOID *Data,\r
IN UINTN DataSize,\r
- IN UINT32 Attributes OPTIONAL\r
+ IN UINT32 Attributes\r
)\r
{\r
EFI_STATUS Status;\r
//\r
// Allow the delete operation of common authenticated variable at user physical presence.\r
//\r
- if ((Attributes & EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS) != 0) {\r
- Status = DeleteCertsFromDb (VariableName, VendorGuid);\r
- }\r
- if (!EFI_ERROR (Status)) {\r
- Status = AuthServiceInternalUpdateVariable (\r
- VariableName,\r
- VendorGuid,\r
- NULL,\r
- 0,\r
- 0\r
- );\r
+ Status = AuthServiceInternalUpdateVariable (\r
+ VariableName,\r
+ VendorGuid,\r
+ NULL,\r
+ 0,\r
+ 0\r
+ );\r
+ if (!EFI_ERROR (Status) && ((Attributes & EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS) != 0)) {\r
+ Status = DeleteCertsFromDb (VariableName, VendorGuid, Attributes);\r
}\r
+\r
return Status;\r
}\r
\r
\r
/**\r
Find matching signer's certificates for common authenticated variable\r
- by corresponding VariableName and VendorGuid from "certdb".\r
+ by corresponding VariableName and VendorGuid from "certdb" or "certdbv".\r
\r
- The data format of "certdb":\r
+ The data format of "certdb" or "certdbv":\r
//\r
// UINT32 CertDbListSize;\r
// /// AUTH_CERT_DB_DATA Certs1[];\r
\r
@param[in] VariableName Name of authenticated Variable.\r
@param[in] VendorGuid Vendor GUID of authenticated Variable.\r
- @param[in] Data Pointer to variable "certdb".\r
- @param[in] DataSize Size of variable "certdb".\r
+ @param[in] Data Pointer to variable "certdb" or "certdbv".\r
+ @param[in] DataSize Size of variable "certdb" or "certdbv".\r
@param[out] CertOffset Offset of matching CertData, from starting of Data.\r
@param[out] CertDataSize Length of CertData in bytes.\r
@param[out] CertNodeOffset Offset of matching AUTH_CERT_DB_DATA , from\r
\r
/**\r
Retrieve signer's certificates for common authenticated variable\r
- by corresponding VariableName and VendorGuid from "certdb".\r
+ by corresponding VariableName and VendorGuid from "certdb"\r
+ or "certdbv" according to authenticated variable attributes.\r
\r
@param[in] VariableName Name of authenticated Variable.\r
@param[in] VendorGuid Vendor GUID of authenticated Variable.\r
+ @param[in] Attributes Attributes of authenticated variable.\r
@param[out] CertData Pointer to signer's certificates.\r
@param[out] CertDataSize Length of CertData in bytes.\r
\r
@retval EFI_INVALID_PARAMETER Any input parameter is invalid.\r
- @retval EFI_NOT_FOUND Fail to find "certdb" or matching certs.\r
+ @retval EFI_NOT_FOUND Fail to find "certdb"/"certdbv" or matching certs.\r
@retval EFI_SUCCESS Get signer's certificates successfully.\r
\r
**/\r
GetCertsFromDb (\r
IN CHAR16 *VariableName,\r
IN EFI_GUID *VendorGuid,\r
+ IN UINT32 Attributes,\r
OUT UINT8 **CertData,\r
OUT UINT32 *CertDataSize\r
)\r
UINT8 *Data;\r
UINTN DataSize;\r
UINT32 CertOffset;\r
+ CHAR16 *DbName;\r
\r
if ((VariableName == NULL) || (VendorGuid == NULL) || (CertData == NULL) || (CertDataSize == NULL)) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
+ \r
+ if ((Attributes & EFI_VARIABLE_NON_VOLATILE) != 0) {\r
+ //\r
+ // Get variable "certdb".\r
+ //\r
+ DbName = EFI_CERT_DB_NAME;\r
+ } else {\r
+ //\r
+ // Get variable "certdbv".\r
+ //\r
+ DbName = EFI_CERT_DB_VOLATILE_NAME;\r
+ }\r
+\r
//\r
- // Get variable "certdb".\r
+ // Get variable "certdb" or "certdbv".\r
//\r
Status = AuthServiceInternalFindVariable (\r
- EFI_CERT_DB_NAME,\r
+ DbName,\r
&gEfiCertDbGuid,\r
(VOID **) &Data,\r
&DataSize\r
\r
/**\r
Delete matching signer's certificates when deleting common authenticated\r
- variable by corresponding VariableName and VendorGuid from "certdb".\r
+ variable by corresponding VariableName and VendorGuid from "certdb" or \r
+ "certdbv" according to authenticated variable attributes.\r
\r
@param[in] VariableName Name of authenticated Variable.\r
@param[in] VendorGuid Vendor GUID of authenticated Variable.\r
+ @param[in] Attributes Attributes of authenticated variable.\r
\r
@retval EFI_INVALID_PARAMETER Any input parameter is invalid.\r
- @retval EFI_NOT_FOUND Fail to find "certdb" or matching certs.\r
+ @retval EFI_NOT_FOUND Fail to find "certdb"/"certdbv" or matching certs.\r
@retval EFI_OUT_OF_RESOURCES The operation is failed due to lack of resources.\r
@retval EFI_SUCCESS The operation is completed successfully.\r
\r
EFI_STATUS\r
DeleteCertsFromDb (\r
IN CHAR16 *VariableName,\r
- IN EFI_GUID *VendorGuid\r
+ IN EFI_GUID *VendorGuid,\r
+ IN UINT32 Attributes\r
)\r
{\r
EFI_STATUS Status;\r
UINT32 CertNodeSize;\r
UINT8 *NewCertDb;\r
UINT32 NewCertDbSize;\r
+ CHAR16 *DbName;\r
\r
if ((VariableName == NULL) || (VendorGuid == NULL)) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
- //\r
- // Get variable "certdb".\r
- //\r
+ if ((Attributes & EFI_VARIABLE_NON_VOLATILE) != 0) {\r
+ //\r
+ // Get variable "certdb".\r
+ //\r
+ DbName = EFI_CERT_DB_NAME;\r
+ VarAttr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;\r
+ } else {\r
+ //\r
+ // Get variable "certdbv".\r
+ //\r
+ DbName = EFI_CERT_DB_VOLATILE_NAME;\r
+ VarAttr = EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;\r
+ }\r
+\r
Status = AuthServiceInternalFindVariable (\r
- EFI_CERT_DB_NAME,\r
+ DbName,\r
&gEfiCertDbGuid,\r
(VOID **) &Data,\r
&DataSize\r
);\r
+\r
if (EFI_ERROR (Status)) {\r
return Status;\r
}\r
\r
if (DataSize == sizeof (UINT32)) {\r
//\r
- // There is no certs in certdb.\r
+ // There is no certs in "certdb" or "certdbv".\r
//\r
return EFI_SUCCESS;\r
}\r
\r
//\r
- // Get corresponding cert node from certdb.\r
+ // Get corresponding cert node from "certdb" or "certdbv".\r
//\r
Status = FindCertsFromDb (\r
VariableName,\r
}\r
\r
//\r
- // Construct new data content of variable "certdb".\r
+ // Construct new data content of variable "certdb" or "certdbv".\r
//\r
NewCertDbSize = (UINT32) DataSize - CertNodeSize;\r
NewCertDb = (UINT8*) mCertDbStore;\r
}\r
\r
//\r
- // Set "certdb".\r
+ // Set "certdb" or "certdbv".\r
//\r
- VarAttr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;\r
Status = AuthServiceInternalUpdateVariable (\r
- EFI_CERT_DB_NAME,\r
+ DbName,\r
&gEfiCertDbGuid,\r
NewCertDb,\r
NewCertDbSize,\r
\r
/**\r
Insert signer's certificates for common authenticated variable with VariableName\r
- and VendorGuid in AUTH_CERT_DB_DATA to "certdb".\r
+ and VendorGuid in AUTH_CERT_DB_DATA to "certdb" or "certdbv" according to\r
+ time based authenticated variable attributes.\r
\r
@param[in] VariableName Name of authenticated Variable.\r
@param[in] VendorGuid Vendor GUID of authenticated Variable.\r
+ @param[in] Attributes Attributes of authenticated variable.\r
@param[in] CertData Pointer to signer's certificates.\r
@param[in] CertDataSize Length of CertData in bytes.\r
\r
@retval EFI_ACCESS_DENIED An AUTH_CERT_DB_DATA entry with same VariableName\r
and VendorGuid already exists.\r
@retval EFI_OUT_OF_RESOURCES The operation is failed due to lack of resources.\r
- @retval EFI_SUCCESS Insert an AUTH_CERT_DB_DATA entry to "certdb"\r
+ @retval EFI_SUCCESS Insert an AUTH_CERT_DB_DATA entry to "certdb" or "certdbv"\r
\r
**/\r
EFI_STATUS\r
InsertCertsToDb (\r
IN CHAR16 *VariableName,\r
IN EFI_GUID *VendorGuid,\r
+ IN UINT32 Attributes,\r
IN UINT8 *CertData,\r
IN UINTN CertDataSize\r
)\r
UINT32 CertNodeSize;\r
UINT32 NameSize;\r
AUTH_CERT_DB_DATA *Ptr;\r
+ CHAR16 *DbName;\r
\r
if ((VariableName == NULL) || (VendorGuid == NULL) || (CertData == NULL)) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
+ if ((Attributes & EFI_VARIABLE_NON_VOLATILE) != 0) {\r
+ //\r
+ // Get variable "certdb".\r
+ //\r
+ DbName = EFI_CERT_DB_NAME;\r
+ VarAttr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;\r
+ } else {\r
+ //\r
+ // Get variable "certdbv".\r
+ //\r
+ DbName = EFI_CERT_DB_VOLATILE_NAME;\r
+ VarAttr = EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;\r
+ }\r
+\r
//\r
- // Get variable "certdb".\r
+ // Get variable "certdb" or "certdbv".\r
//\r
Status = AuthServiceInternalFindVariable (\r
- EFI_CERT_DB_NAME,\r
+ DbName,\r
&gEfiCertDbGuid,\r
(VOID **) &Data,\r
&DataSize\r
}\r
\r
//\r
- // Find whether matching cert node already exists in "certdb".\r
+ // Find whether matching cert node already exists in "certdb" or "certdbv".\r
// If yes return error.\r
//\r
Status = FindCertsFromDb (\r
}\r
\r
//\r
- // Construct new data content of variable "certdb".\r
+ // Construct new data content of variable "certdb" or "certdbv".\r
//\r
NameSize = (UINT32) StrLen (VariableName);\r
CertNodeSize = sizeof (AUTH_CERT_DB_DATA) + (UINT32) CertDataSize + NameSize * sizeof (CHAR16);\r
);\r
\r
//\r
- // Set "certdb".\r
+ // Set "certdb" or "certdbv".\r
//\r
- VarAttr = EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS;\r
Status = AuthServiceInternalUpdateVariable (\r
- EFI_CERT_DB_NAME,\r
+ DbName,\r
&gEfiCertDbGuid,\r
NewCertDb,\r
NewCertDbSize,\r
return Status;\r
}\r
\r
+/**\r
+ Clean up signer's certificates for common authenticated variable\r
+ by corresponding VariableName and VendorGuid from "certdb".\r
+ System may break down during Timebased Variable update & certdb update,\r
+ make them inconsistent, this function is called in AuthVariable Init\r
+ to ensure consistency.\r
+\r
+ @retval EFI_NOT_FOUND Fail to find variable "certdb".\r
+ @retval EFI_OUT_OF_RESOURCES The operation is failed due to lack of resources.\r
+ @retval EFI_SUCCESS The operation is completed successfully.\r
+\r
+**/\r
+EFI_STATUS\r
+CleanCertsFromDb (\r
+ VOID\r
+ )\r
+{\r
+ UINT32 Offset;\r
+ AUTH_CERT_DB_DATA *Ptr;\r
+ UINT32 NameSize;\r
+ UINT32 NodeSize;\r
+ CHAR16 *VariableName;\r
+ EFI_STATUS Status;\r
+ BOOLEAN CertCleaned;\r
+ UINT8 *Data;\r
+ UINTN DataSize;\r
+ EFI_GUID AuthVarGuid;\r
+ AUTH_VARIABLE_INFO AuthVariableInfo;\r
+\r
+ Status = EFI_SUCCESS;\r
+\r
+ //\r
+ // Get corresponding certificates by VendorGuid and VariableName.\r
+ //\r
+ do {\r
+ CertCleaned = FALSE;\r
+\r
+ //\r
+ // Get latest variable "certdb"\r
+ //\r
+ Status = AuthServiceInternalFindVariable (\r
+ EFI_CERT_DB_NAME,\r
+ &gEfiCertDbGuid,\r
+ (VOID **) &Data,\r
+ &DataSize\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ if ((DataSize == 0) || (Data == NULL)) {\r
+ ASSERT (FALSE);\r
+ return EFI_NOT_FOUND;\r
+ }\r
+\r
+ Offset = sizeof (UINT32);\r
+\r
+ while (Offset < (UINT32) DataSize) {\r
+ Ptr = (AUTH_CERT_DB_DATA *) (Data + Offset);\r
+ NodeSize = ReadUnaligned32 (&Ptr->CertNodeSize);\r
+ NameSize = ReadUnaligned32 (&Ptr->NameSize);\r
+\r
+ //\r
+ // Get VarName tailed with '\0'\r
+ //\r
+ VariableName = AllocateZeroPool((NameSize + 1) * sizeof(CHAR16));\r
+ if (VariableName == NULL) {\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+ CopyMem (VariableName, (UINT8 *) Ptr + sizeof (AUTH_CERT_DB_DATA), NameSize * sizeof(CHAR16));\r
+ //\r
+ // Keep VarGuid aligned\r
+ //\r
+ CopyMem (&AuthVarGuid, &Ptr->VendorGuid, sizeof(EFI_GUID));\r
+\r
+ //\r
+ // Find corresponding time auth variable\r
+ //\r
+ ZeroMem (&AuthVariableInfo, sizeof (AuthVariableInfo));\r
+ Status = mAuthVarLibContextIn->FindVariable (\r
+ VariableName,\r
+ &AuthVarGuid,\r
+ &AuthVariableInfo\r
+ );\r
+\r
+ if (EFI_ERROR(Status) || (AuthVariableInfo.Attributes & EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS) == 0) {\r
+ Status = DeleteCertsFromDb(\r
+ VariableName,\r
+ &AuthVarGuid,\r
+ AuthVariableInfo.Attributes\r
+ );\r
+ CertCleaned = TRUE;\r
+ DEBUG((EFI_D_INFO, "Recovery!! Cert for Auth Variable %s Guid %g is removed for consistency\n", VariableName, &AuthVarGuid));\r
+ FreePool(VariableName);\r
+ break;\r
+ }\r
+\r
+ FreePool(VariableName);\r
+ Offset = Offset + NodeSize;\r
+ }\r
+ } while (CertCleaned);\r
+\r
+ return Status;\r
+}\r
+\r
/**\r
Process variable with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set\r
\r
SigData = CertData->AuthInfo.CertData;\r
SigDataSize = CertData->AuthInfo.Hdr.dwLength - (UINT32) (OFFSET_OF (WIN_CERTIFICATE_UEFI_GUID, CertData));\r
\r
+ //\r
+ // SignedData.digestAlgorithms shall contain the digest algorithm used when preparing the\r
+ // signature. Only a digest algorithm of SHA-256 is accepted.\r
+ //\r
+ // According to PKCS#7 Definition:\r
+ // SignedData ::= SEQUENCE {\r
+ // version Version,\r
+ // digestAlgorithms DigestAlgorithmIdentifiers,\r
+ // contentInfo ContentInfo,\r
+ // .... }\r
+ // The DigestAlgorithmIdentifiers can be used to determine the hash algorithm \r
+ // in VARIABLE_AUTHENTICATION_2 descriptor.\r
+ // This field has the fixed offset (+13) and be calculated based on two bytes of length encoding.\r
+ //\r
+ if ((Attributes & EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS) != 0) {\r
+ if (SigDataSize >= (13 + sizeof (mSha256OidValue))) {\r
+ if (((*(SigData + 1) & TWO_BYTE_ENCODE) != TWO_BYTE_ENCODE) || \r
+ (CompareMem (SigData + 13, &mSha256OidValue, sizeof (mSha256OidValue)) != 0)) {\r
+ return EFI_SECURITY_VIOLATION;\r
+ }\r
+ }\r
+ }\r
+\r
//\r
// Find out the new data payload which follows Pkcs7 SignedData directly.\r
//\r
}\r
\r
//\r
- // Get previously stored signer's certificates from certdb for existing\r
+ // Get previously stored signer's certificates from certdb or certdbv for existing\r
// variable. Check whether they are identical with signer's certificates\r
// in SignedData. If not, return error immediately.\r
//\r
if (OrgTimeStamp != NULL) {\r
VerifyStatus = FALSE;\r
\r
- Status = GetCertsFromDb (VariableName, VendorGuid, &CertsInCertDb, &CertsSizeinDb);\r
+ Status = GetCertsFromDb (VariableName, VendorGuid, Attributes, &CertsInCertDb, &CertsSizeinDb);\r
if (EFI_ERROR (Status)) {\r
goto Exit;\r
}\r
goto Exit;\r
}\r
\r
- //\r
- // Delete signer's certificates when delete the common authenticated variable.\r
- //\r
- if ((PayloadSize == 0) && (OrgTimeStamp != NULL) && ((Attributes & EFI_VARIABLE_APPEND_WRITE) == 0)) {\r
- Status = DeleteCertsFromDb (VariableName, VendorGuid);\r
- if (EFI_ERROR (Status)) {\r
- VerifyStatus = FALSE;\r
- goto Exit;\r
- }\r
- } else if ((OrgTimeStamp == NULL) && (PayloadSize != 0)) {\r
+ if ((OrgTimeStamp == NULL) && (PayloadSize != 0)) {\r
//\r
// Insert signer's certificates when adding a new common authenticated variable.\r
//\r
- Status = InsertCertsToDb (VariableName, VendorGuid, SignerCerts, CertStackSize);\r
+ Status = InsertCertsToDb (VariableName, VendorGuid, Attributes, SignerCerts, CertStackSize);\r
if (EFI_ERROR (Status)) {\r
VerifyStatus = FALSE;\r
goto Exit;\r
UINTN PayloadSize;\r
EFI_VARIABLE_AUTHENTICATION_2 *CertData;\r
AUTH_VARIABLE_INFO OrgVariableInfo;\r
+ BOOLEAN IsDel;\r
\r
ZeroMem (&OrgVariableInfo, sizeof (OrgVariableInfo));\r
FindStatus = mAuthVarLibContextIn->FindVariable (\r
return Status;\r
}\r
\r
- if ((PayloadSize == 0) && (VarDel != NULL)) {\r
- *VarDel = TRUE;\r
+ if (!EFI_ERROR(FindStatus)\r
+ && (PayloadSize == 0)\r
+ && ((Attributes & EFI_VARIABLE_APPEND_WRITE) == 0)) {\r
+ IsDel = TRUE;\r
+ } else {\r
+ IsDel = FALSE;\r
}\r
\r
CertData = (EFI_VARIABLE_AUTHENTICATION_2 *) Data;\r
//\r
// Final step: Update/Append Variable if it pass Pkcs7Verify\r
//\r
- return AuthServiceInternalUpdateVariableWithTimeStamp (\r
- VariableName,\r
- VendorGuid,\r
- PayloadPtr,\r
- PayloadSize,\r
- Attributes,\r
- &CertData->TimeStamp\r
- );\r
+ Status = AuthServiceInternalUpdateVariableWithTimeStamp (\r
+ VariableName,\r
+ VendorGuid,\r
+ PayloadPtr,\r
+ PayloadSize,\r
+ Attributes,\r
+ &CertData->TimeStamp\r
+ );\r
+\r
+ //\r
+ // Delete signer's certificates when delete the common authenticated variable.\r
+ //\r
+ if (IsDel && AuthVarType == AuthVarTypePriv && !EFI_ERROR(Status) ) {\r
+ Status = DeleteCertsFromDb (VariableName, VendorGuid, Attributes);\r
+ }\r
+\r
+ if (VarDel != NULL) {\r
+ if (IsDel && !EFI_ERROR(Status)) {\r
+ *VarDel = TRUE;\r
+ } else {\r
+ *VarDel = FALSE;\r
+ }\r
+ }\r
+\r
+ return Status;\r
}\r