]> git.proxmox.com Git - mirror_edk2.git/blobdiff - SecurityPkg/Library/AuthVariableLib/AuthService.c
SecurityPkg: AuthVariableLib: Fix inconsistent CertDB case
[mirror_edk2.git] / SecurityPkg / Library / AuthVariableLib / AuthService.c
index 8805f54f9d6661606b51b666110f4b970c43614d..b013d420f62e29097e418143e19b85d866b3af76 100644 (file)
@@ -18,7 +18,7 @@
   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 - 2016, 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
@@ -927,6 +927,9 @@ ProcessVarWithPk (
     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
@@ -1172,7 +1175,7 @@ ProcessVariable (
   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
@@ -1213,7 +1216,7 @@ ProcessVariable (
               0\r
               );\r
     if (!EFI_ERROR (Status) && ((Attributes & EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS) != 0)) {\r
-      Status = DeleteCertsFromDb (VariableName, VendorGuid);\r
+      Status = DeleteCertsFromDb (VariableName, VendorGuid, Attributes);\r
     }\r
 \r
     return Status;\r
@@ -1526,9 +1529,9 @@ AuthServiceInternalCompareTimeStamp (
 \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
@@ -1539,8 +1542,8 @@ AuthServiceInternalCompareTimeStamp (
 \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
@@ -1647,15 +1650,17 @@ FindCertsFromDb (
 \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
@@ -1663,6 +1668,7 @@ EFI_STATUS
 GetCertsFromDb (\r
   IN     CHAR16           *VariableName,\r
   IN     EFI_GUID         *VendorGuid,\r
+  IN     UINT32           Attributes,\r
   OUT    UINT8            **CertData,\r
   OUT    UINT32           *CertDataSize\r
   )\r
@@ -1671,16 +1677,30 @@ GetCertsFromDb (
   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
@@ -1715,13 +1735,15 @@ GetCertsFromDb (
 \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
@@ -1729,7 +1751,8 @@ GetCertsFromDb (
 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
@@ -1740,20 +1763,33 @@ DeleteCertsFromDb (
   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
@@ -1765,13 +1801,13 @@ DeleteCertsFromDb (
 \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
@@ -1793,7 +1829,7 @@ DeleteCertsFromDb (
   }\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
@@ -1818,11 +1854,10 @@ DeleteCertsFromDb (
   }\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
@@ -1834,10 +1869,12 @@ DeleteCertsFromDb (
 \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
@@ -1845,13 +1882,14 @@ DeleteCertsFromDb (
   @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
@@ -1865,16 +1903,31 @@ InsertCertsToDb (
   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
@@ -1889,7 +1942,7 @@ InsertCertsToDb (
   }\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
@@ -1909,7 +1962,7 @@ InsertCertsToDb (
   }\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
@@ -1949,11 +2002,10 @@ InsertCertsToDb (
     );\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
@@ -1966,18 +2018,20 @@ InsertCertsToDb (
 /**\r
   Clean up signer's certificates for common authenticated variable\r
   by corresponding VariableName and VendorGuid from "certdb".\r
-  Sytem may break down during Timebased Variable update & certdb update,\r
-  make them inconsistent,  this function is called in AuthVariable Init to ensure \r
-  consistency\r
-  \r
-  @retval  EFI_NOT_FOUND         Fail to find matching certs.\r
-  @retval  EFI_SUCCESS           Find matching certs and output parameters.\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
+{\r
   UINT32                  Offset;\r
   AUTH_CERT_DB_DATA       *Ptr;\r
   UINT32                  NameSize;\r
@@ -1987,9 +2041,8 @@ CleanCertsFromDb (
   BOOLEAN                 CertCleaned;\r
   UINT8                   *Data;\r
   UINTN                   DataSize;\r
-  UINT8                   *AuthVarData;\r
-  UINTN                   AuthVarDataSize;\r
   EFI_GUID                AuthVarGuid;\r
+  AUTH_VARIABLE_INFO      AuthVariableInfo;\r
 \r
   Status = EFI_SUCCESS;\r
 \r
@@ -2021,9 +2074,6 @@ CleanCertsFromDb (
 \r
     while (Offset < (UINT32) DataSize) {\r
       Ptr = (AUTH_CERT_DB_DATA *) (Data + Offset);\r
-      //\r
-      // Check whether VendorGuid matches.\r
-      //\r
       NodeSize = ReadUnaligned32 (&Ptr->CertNodeSize);\r
       NameSize = ReadUnaligned32 (&Ptr->NameSize);\r
 \r
@@ -2043,15 +2093,19 @@ CleanCertsFromDb (
       //\r
       // Find corresponding time auth variable\r
       //\r
-      Status = AuthServiceInternalFindVariable (\r
-                 VariableName,\r
-                 &AuthVarGuid,\r
-                 (VOID **) &AuthVarData,\r
-                 &AuthVarDataSize\r
-                 );\r
-\r
-      if (EFI_ERROR(Status)) {\r
-        Status      = DeleteCertsFromDb(VariableName, &AuthVarGuid);\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
@@ -2357,14 +2411,14 @@ VerifyTimeBasedPayload (
     }\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
@@ -2391,7 +2445,7 @@ VerifyTimeBasedPayload (
       //\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
@@ -2532,7 +2586,7 @@ VerifyTimeBasedPayloadAndUpdate (
   // Delete signer's certificates when delete the common authenticated variable.\r
   //\r
   if (IsDel && AuthVarType == AuthVarTypePriv && !EFI_ERROR(Status) ) {\r
-    Status = DeleteCertsFromDb (VariableName, VendorGuid);\r
+    Status = DeleteCertsFromDb (VariableName, VendorGuid, Attributes);\r
   }\r
 \r
   if (VarDel != NULL) {\r