]> git.proxmox.com Git - mirror_edk2.git/blobdiff - SecurityPkg/Library/DxeImageVerificationLib/DxeImageVerificationLib.c
PerformancePkg: Convert all .uni files to utf-8
[mirror_edk2.git] / SecurityPkg / Library / DxeImageVerificationLib / DxeImageVerificationLib.c
index c01ffda61608591840557d88c1150a4a0ae6cd1f..4b4d3bf77de53eefdbe0e9221e95434fd1d003aa 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  Implement image verification services for secure boot service in UEFI2.3.1.\r
+  Implement image verification services for secure boot service\r
 \r
   Caution: This file requires additional review when modified.\r
   This library will have external input - PE/COFF image.\r
@@ -270,7 +270,7 @@ GetImageType (
 }\r
 \r
 /**\r
-  Caculate hash of Pe/Coff image based on the authenticode image hashing in\r
+  Calculate hash of Pe/Coff image based on the authenticode image hashing in\r
   PE/COFF Specification 8.0 Appendix A\r
 \r
   Caution: This function may receive untrusted input.\r
@@ -609,7 +609,7 @@ Done:
 }\r
 \r
 /**\r
-  Recognize the Hash algorithm in PE/COFF Authenticode and caculate hash of\r
+  Recognize the Hash algorithm in PE/COFF Authenticode and calculate hash of\r
   Pe/Coff image based on the authenticode image hashing in PE/COFF Specification\r
   8.0 Appendix A\r
 \r
@@ -711,6 +711,58 @@ GetImageExeInfoTableSize (
   return TotalSize;\r
 }\r
 \r
+/**\r
+  Create signature list based on input signature data and certificate type GUID. Caller is reposible \r
+  to free new created SignatureList.\r
+\r
+  @param[in]   SignatureData           Signature data in SignatureList.\r
+  @param[in]   SignatureDataSize       Signature data size.\r
+  @param[in]   CertType                Certificate Type.\r
+  @param[out]  SignatureList           Created SignatureList.\r
+  @param[out]  SignatureListSize       Created SignatureListSize.\r
+\r
+  @return EFI_OUT_OF_RESOURCES         The operation is failed due to lack of resources.\r
+  @retval EFI_SUCCESS          Successfully create signature list.\r
+\r
+**/\r
+EFI_STATUS\r
+CreateSignatureList(\r
+  IN UINT8                *SignatureData,\r
+  IN UINTN                SignatureDataSize,\r
+  IN EFI_GUID             *CertType,\r
+  OUT EFI_SIGNATURE_LIST  **SignatureList,\r
+  OUT UINTN               *SignatureListSize\r
+  )\r
+{\r
+  EFI_SIGNATURE_LIST   *SignList;\r
+  UINTN                SignListSize;\r
+  EFI_SIGNATURE_DATA   *Signature;\r
+\r
+  SignList       = NULL;\r
+  *SignatureList = NULL;\r
+\r
+  SignListSize = sizeof (EFI_SIGNATURE_LIST) + sizeof (EFI_SIGNATURE_DATA) - 1 + SignatureDataSize;\r
+  SignList     = (EFI_SIGNATURE_LIST *) AllocateZeroPool (SignListSize);\r
+  if (SignList == NULL) {\r
+    return EFI_OUT_OF_RESOURCES;\r
+  }\r
+\r
+  SignList->SignatureHeaderSize = 0;\r
+  SignList->SignatureListSize   = (UINT32) SignListSize;\r
+  SignList->SignatureSize       = (UINT32) SignatureDataSize + sizeof (EFI_SIGNATURE_DATA) - 1;\r
+  CopyMem (&SignList->SignatureType, CertType, sizeof (EFI_GUID));\r
+\r
+  DEBUG((EFI_D_INFO, "SignatureDataSize %x\n", SignatureDataSize));\r
+  Signature = (EFI_SIGNATURE_DATA *) ((UINT8 *) SignList + sizeof (EFI_SIGNATURE_LIST));\r
+  CopyMem (Signature->SignatureData, SignatureData, SignatureDataSize);\r
+\r
+  *SignatureList     = SignList;\r
+  *SignatureListSize = SignListSize;\r
+\r
+  return EFI_SUCCESS;\r
+\r
+}\r
+\r
 /**\r
   Create an Image Execution Information Table entry and add it to system configuration table.\r
 \r
@@ -737,11 +789,13 @@ AddImageExeInfo (
   UINTN                           NewImageExeInfoEntrySize;\r
   UINTN                           NameStringLen;\r
   UINTN                           DevicePathSize;\r
+  CHAR16                          *NameStr;\r
 \r
   ImageExeInfoTable     = NULL;\r
   NewImageExeInfoTable  = NULL;\r
   ImageExeInfoEntry     = NULL;\r
   NameStringLen         = 0;\r
+  NameStr               = NULL;\r
 \r
   if (DevicePath == NULL) {\r
     return ;\r
@@ -769,7 +823,12 @@ AddImageExeInfo (
   }\r
 \r
   DevicePathSize            = GetDevicePathSize (DevicePath);\r
-  NewImageExeInfoEntrySize  = sizeof (EFI_IMAGE_EXECUTION_INFO) - sizeof (EFI_SIGNATURE_LIST) + NameStringLen + DevicePathSize + SignatureSize;\r
+\r
+  //\r
+  // Signature size can be odd. Pad after signature to ensure next EXECUTION_INFO entry align\r
+  //\r
+  NewImageExeInfoEntrySize = sizeof (EFI_IMAGE_EXECUTION_INFO) + NameStringLen + DevicePathSize + SignatureSize;\r
+\r
   NewImageExeInfoTable      = (EFI_IMAGE_EXECUTION_INFO_TABLE *) AllocateRuntimePool (ImageExeInfoTableSize + NewImageExeInfoEntrySize);\r
   if (NewImageExeInfoTable == NULL) {\r
     return ;\r
@@ -788,19 +847,21 @@ AddImageExeInfo (
   WriteUnaligned32 ((UINT32 *) ImageExeInfoEntry, Action);\r
   WriteUnaligned32 ((UINT32 *) ((UINT8 *) ImageExeInfoEntry + sizeof (EFI_IMAGE_EXECUTION_ACTION)), (UINT32) NewImageExeInfoEntrySize);\r
 \r
+  NameStr = (CHAR16 *)(ImageExeInfoEntry + 1);\r
   if (Name != NULL) {\r
-    CopyMem ((UINT8 *) ImageExeInfoEntry + sizeof (EFI_IMAGE_EXECUTION_ACTION) + sizeof (UINT32), Name, NameStringLen);\r
+    CopyMem ((UINT8 *) NameStr, Name, NameStringLen);\r
   } else {\r
-    ZeroMem ((UINT8 *) ImageExeInfoEntry + sizeof (EFI_IMAGE_EXECUTION_ACTION) + sizeof (UINT32), sizeof (CHAR16));\r
+    ZeroMem ((UINT8 *) NameStr, sizeof (CHAR16));\r
   }\r
+\r
   CopyMem (\r
-    (UINT8 *) ImageExeInfoEntry + sizeof (EFI_IMAGE_EXECUTION_ACTION) + sizeof (UINT32) + NameStringLen,\r
+    (UINT8 *) NameStr + NameStringLen,\r
     DevicePath,\r
     DevicePathSize\r
     );\r
   if (Signature != NULL) {\r
     CopyMem (\r
-      (UINT8 *) ImageExeInfoEntry + sizeof (EFI_IMAGE_EXECUTION_ACTION) + sizeof (UINT32) + NameStringLen + DevicePathSize,\r
+      (UINT8 *) NameStr + NameStringLen + DevicePathSize,\r
       Signature,\r
       SignatureSize\r
       );\r
@@ -1087,6 +1148,53 @@ IsTimeZero (
   return FALSE;\r
 }\r
 \r
+/**\r
+  Record multiple certificate list & verification state of a verified image to \r
+  IMAGE_EXECUTION_TABLE.\r
+\r
+  @param[in]  CertBuf              Certificate list buffer.\r
+  @param[in]  CertBufLength        Certificate list buffer.\r
+  @param[in]  Action               Certificate list action to be record.\r
+  @param[in]  ImageName            Image name.\r
+  @param[in]  ImageDevicePath      Image device path.\r
+\r
+**/\r
+VOID \r
+RecordCertListToImageExeuctionTable(\r
+  IN UINT8                          *CertBuf,\r
+  IN UINTN                           CertBufLength,\r
+  IN EFI_IMAGE_EXECUTION_ACTION      Action,\r
+  IN CHAR16                         *ImageName OPTIONAL,\r
+  IN CONST EFI_DEVICE_PATH_PROTOCOL *ImageDevicePath OPTIONAL\r
+  )\r
+{\r
+  UINT8               CertNumber;\r
+  UINT8               *CertPtr;\r
+  UINTN               Index;\r
+  UINT8               *Cert;\r
+  UINTN               CertSize;\r
+  EFI_STATUS          Status;\r
+  EFI_SIGNATURE_LIST  *SignatureList;\r
+  UINTN               SignatureListSize;\r
+\r
+  CertNumber = (UINT8) (*CertBuf);\r
+  CertPtr    = CertBuf + 1;\r
+  for (Index = 0; Index < CertNumber; Index++) {\r
+    CertSize = (UINTN) ReadUnaligned32 ((UINT32 *)CertPtr);\r
+    Cert     = (UINT8 *)CertPtr + sizeof (UINT32);\r
+\r
+    //\r
+    // Record all cert in cert chain to be passed\r
+    //\r
+    Status = CreateSignatureList(Cert, CertSize, &gEfiCertX509Guid, &SignatureList, &SignatureListSize);\r
+    if (!EFI_ERROR(Status)) {\r
+      AddImageExeInfo (Action, ImageName, ImageDevicePath, SignatureList, SignatureListSize);\r
+      FreePool (SignatureList);\r
+    }\r
+  }\r
+}\r
+\r
+\r
 /**\r
   Check whether the timestamp signature is valid and the signing time is also earlier than \r
   the revocation time.\r
@@ -1197,8 +1305,11 @@ Done:
   Check whether the image signature is forbidden by the forbidden database (dbx).\r
   The image is forbidden to load if any certificates for signing are revoked before signing time.\r
 \r
-  @param[in]  AuthData      Pointer to the Authenticode signature retrieved from the signed image.\r
-  @param[in]  AuthDataSize  Size of the Authenticode signature in bytes.\r
+  @param[in]  AuthData             Pointer to the Authenticode signature retrieved from the signed image.\r
+  @param[in]  AuthDataSize         Size of the Authenticode signature in bytes.\r
+  @param[in]  IsAuditMode          Whether system Secure Boot Mode is in AuditMode.\r
+  @param[in]  ImageName            Name of the image to verify.\r
+  @param[in]  ImageDevicePath      DevicePath of the image to verify.\r
 \r
   @retval TRUE              Image is forbidden by dbx.\r
   @retval FALSE             Image is not forbidden by dbx.\r
@@ -1206,8 +1317,11 @@ Done:
 **/\r
 BOOLEAN\r
 IsForbiddenByDbx (\r
-  IN UINT8                  *AuthData,\r
-  IN UINTN                  AuthDataSize\r
+  IN UINT8                          *AuthData,\r
+  IN UINTN                          AuthDataSize,\r
+  IN BOOLEAN                        IsAuditMode,\r
+  IN CHAR16                         *ImageName OPTIONAL,\r
+  IN CONST EFI_DEVICE_PATH_PROTOCOL *ImageDevicePath OPTIONAL\r
   )\r
 {\r
   EFI_STATUS                Status;\r
@@ -1230,7 +1344,10 @@ IsForbiddenByDbx (
   UINT8                     *Cert;\r
   UINTN                     CertSize;\r
   EFI_TIME                  RevocationTime;\r
-\r
+  UINT8                     *SignerCert;\r
+  UINTN                     SignerCertLength;\r
+  UINT8                     *UnchainCert;\r
+  UINTN                     UnchainCertLength;\r
   //\r
   // Variable Initialization\r
   //\r
@@ -1245,6 +1362,10 @@ IsForbiddenByDbx (
   BufferLength      = 0;\r
   TrustedCert       = NULL;\r
   TrustedCertLength = 0;\r
+  SignerCert        = NULL;\r
+  SignerCertLength  = 0;\r
+  UnchainCert       = NULL;\r
+  UnchainCertLength = 0;\r
 \r
   //\r
   // The image will not be forbidden if dbx can't be got.\r
@@ -1294,7 +1415,7 @@ IsForbiddenByDbx (
                         mImageDigestSize\r
                         );\r
         if (IsForbidden) {\r
-          SecureBootHook (EFI_IMAGE_SECURITY_DATABASE1, &gEfiImageSecurityDatabaseGuid, CertList->SignatureSize, Cert);\r
+          SecureBootHook (EFI_IMAGE_SECURITY_DATABASE1, &gEfiImageSecurityDatabaseGuid, CertList->SignatureSize, CertData);\r
           goto Done;\r
         }\r
 \r
@@ -1352,21 +1473,54 @@ IsForbiddenByDbx (
   }\r
 \r
 Done:\r
+  if (IsForbidden && IsAuditMode) {\r
+    Pkcs7GetCertificatesList(AuthData, AuthDataSize, &SignerCert, &SignerCertLength, &UnchainCert, &UnchainCertLength);\r
+\r
+    //\r
+    // Record all certs in image to be failed\r
+    //\r
+    if ((SignerCertLength != 0) && (SignerCert != NULL)) {\r
+      RecordCertListToImageExeuctionTable(\r
+        SignerCert,\r
+        SignerCertLength,\r
+        EFI_IMAGE_EXECUTION_AUTH_SIG_FAILED | EFI_IMAGE_EXECUTION_INITIALIZED,\r
+        ImageName,\r
+        ImageDevicePath\r
+        );\r
+    }\r
+\r
+    if ((UnchainCertLength != 0) && (UnchainCert != NULL)) {\r
+      RecordCertListToImageExeuctionTable(\r
+        UnchainCert,\r
+        UnchainCertLength,\r
+        EFI_IMAGE_EXECUTION_AUTH_SIG_FAILED | EFI_IMAGE_EXECUTION_INITIALIZED,\r
+        ImageName,\r
+        ImageDevicePath\r
+        );\r
+    }\r
+  }\r
+\r
   if (Data != NULL) {\r
     FreePool (Data);\r
   }\r
 \r
   Pkcs7FreeSigners (CertBuffer);\r
   Pkcs7FreeSigners (TrustedCert);\r
+  Pkcs7FreeSigners (SignerCert);\r
+  Pkcs7FreeSigners (UnchainCert);\r
 \r
   return IsForbidden;\r
 }\r
 \r
+\r
 /**\r
   Check whether the image signature can be verified by the trusted certificates in DB database.\r
 \r
-  @param[in]  AuthData      Pointer to the Authenticode signature retrieved from signed image.\r
-  @param[in]  AuthDataSize  Size of the Authenticode signature in bytes.\r
+  @param[in]  AuthData              Pointer to the Authenticode signature retrieved from signed image.\r
+  @param[in]  AuthDataSize          Size of the Authenticode signature in bytes.\r
+  @param[in]  IsAuditMode           Whether system Secure Boot Mode is in AuditMode.\r
+  @param[in]  ImageName             Name of the image to verify.\r
+  @param[in]  ImageDevicePath       DevicePath of the image to verify.\r
 \r
   @retval TRUE         Image passed verification using certificate in db.\r
   @retval FALSE        Image didn't pass verification using certificate in db.\r
@@ -1374,14 +1528,17 @@ Done:
 **/\r
 BOOLEAN\r
 IsAllowedByDb (\r
-  IN UINT8              *AuthData,\r
-  IN UINTN              AuthDataSize\r
+  IN UINT8                          *AuthData,\r
+  IN UINTN                          AuthDataSize,\r
+  IN BOOLEAN                        IsAuditMode,\r
+  IN CHAR16                         *ImageName OPTIONAL,\r
+  IN CONST EFI_DEVICE_PATH_PROTOCOL *ImageDevicePath OPTIONAL\r
   )\r
 {\r
   EFI_STATUS                Status;\r
   BOOLEAN                   VerifyStatus;\r
   EFI_SIGNATURE_LIST        *CertList;\r
-  EFI_SIGNATURE_DATA        *Cert;\r
+  EFI_SIGNATURE_DATA        *CertData;\r
   UINTN                     DataSize;\r
   UINT8                     *Data;\r
   UINT8                     *RootCert;\r
@@ -1391,13 +1548,22 @@ IsAllowedByDb (
   UINTN                     DbxDataSize;\r
   UINT8                     *DbxData;\r
   EFI_TIME                  RevocationTime;\r
+  UINT8                     *SignerCert;\r
+  UINTN                     SignerCertLength;\r
+  UINT8                     *UnchainCert;\r
+  UINTN                     UnchainCertLength;\r
 \r
-  Data         = NULL;\r
-  CertList     = NULL;\r
-  Cert         = NULL;\r
-  RootCert     = NULL;\r
-  RootCertSize = 0;\r
-  VerifyStatus = FALSE;\r
+  Data              = NULL;\r
+  CertList          = NULL;\r
+  CertData          = NULL;\r
+  RootCert          = NULL;\r
+  DbxData           = NULL;\r
+  RootCertSize      = 0;\r
+  VerifyStatus      = FALSE;\r
+  SignerCert        = NULL;\r
+  SignerCertLength  = 0;\r
+  UnchainCert       = NULL;\r
+  UnchainCertLength = 0;\r
 \r
   DataSize = 0;\r
   Status   = gRT->GetVariable (EFI_IMAGE_SECURITY_DATABASE, &gEfiImageSecurityDatabaseGuid, NULL, &DataSize, NULL);\r
@@ -1418,14 +1584,14 @@ IsAllowedByDb (
     CertList = (EFI_SIGNATURE_LIST *) Data;\r
     while ((DataSize > 0) && (DataSize >= CertList->SignatureListSize)) {\r
       if (CompareGuid (&CertList->SignatureType, &gEfiCertX509Guid)) {\r
-        Cert       = (EFI_SIGNATURE_DATA *) ((UINT8 *) CertList + sizeof (EFI_SIGNATURE_LIST) + CertList->SignatureHeaderSize);\r
-        CertCount  = (CertList->SignatureListSize - sizeof (EFI_SIGNATURE_LIST) - CertList->SignatureHeaderSize) / CertList->SignatureSize;\r
+        CertData  = (EFI_SIGNATURE_DATA *) ((UINT8 *) CertList + sizeof (EFI_SIGNATURE_LIST) + CertList->SignatureHeaderSize);\r
+        CertCount = (CertList->SignatureListSize - sizeof (EFI_SIGNATURE_LIST) - CertList->SignatureHeaderSize) / CertList->SignatureSize;\r
 \r
         for (Index = 0; Index < CertCount; Index++) {\r
           //\r
           // Iterate each Signature Data Node within this CertList for verify.\r
           //\r
-          RootCert     = Cert->SignatureData;\r
+          RootCert     = CertData->SignatureData;\r
           RootCertSize = CertList->SignatureSize - sizeof (EFI_GUID);\r
 \r
           //\r
@@ -1447,7 +1613,7 @@ IsAllowedByDb (
             if (Status == EFI_BUFFER_TOO_SMALL) {\r
               goto Done;\r
             }\r
-            DbxData = (UINT8 *) AllocateZeroPool (DataSize);\r
+            DbxData = (UINT8 *) AllocateZeroPool (DbxDataSize);\r
             if (DbxData == NULL) {\r
               goto Done;\r
             }\r
@@ -1467,7 +1633,7 @@ IsAllowedByDb (
             goto Done;\r
           }\r
 \r
-          Cert = (EFI_SIGNATURE_DATA *) ((UINT8 *) Cert + CertList->SignatureSize);\r
+          CertData = (EFI_SIGNATURE_DATA *) ((UINT8 *) CertData + CertList->SignatureSize);\r
         }\r
       }\r
 \r
@@ -1477,10 +1643,67 @@ IsAllowedByDb (
   }\r
 \r
 Done:\r
+\r
   if (VerifyStatus) {\r
-    SecureBootHook (EFI_IMAGE_SECURITY_DATABASE, &gEfiImageSecurityDatabaseGuid, CertList->SignatureSize, Cert);\r
+    SecureBootHook (EFI_IMAGE_SECURITY_DATABASE, &gEfiImageSecurityDatabaseGuid, CertList->SignatureSize, CertData);\r
+  }\r
+\r
+  if (IsAuditMode) {\r
+\r
+    Pkcs7GetCertificatesList(AuthData, AuthDataSize, &SignerCert, &SignerCertLength, &UnchainCert, &UnchainCertLength);\r
+    if (VerifyStatus) {\r
+      if ((SignerCertLength != 0) && (SignerCert != NULL)) {\r
+        //\r
+        // Record all cert in signer's cert chain to be passed\r
+        //\r
+        RecordCertListToImageExeuctionTable(\r
+          SignerCert,\r
+          SignerCertLength,\r
+          EFI_IMAGE_EXECUTION_AUTH_SIG_PASSED | EFI_IMAGE_EXECUTION_INITIALIZED,\r
+          ImageName,\r
+          ImageDevicePath\r
+          );\r
+      }\r
+\r
+      if ((UnchainCertLength != 0) && (UnchainCert != NULL)) {\r
+        //\r
+        // Record all certs in unchained certificates lists to be failed\r
+        //\r
+        RecordCertListToImageExeuctionTable(\r
+          UnchainCert,\r
+          UnchainCertLength,\r
+          EFI_IMAGE_EXECUTION_AUTH_SIG_FAILED | EFI_IMAGE_EXECUTION_INITIALIZED,\r
+          ImageName,\r
+          ImageDevicePath\r
+          );\r
+      }\r
+    } else {\r
+      //\r
+      // Record all certs in image to be failed\r
+      //\r
+      if ((SignerCertLength != 0) && (SignerCert != NULL)) {\r
+        RecordCertListToImageExeuctionTable(\r
+          SignerCert,\r
+          SignerCertLength,\r
+          EFI_IMAGE_EXECUTION_AUTH_SIG_FAILED | EFI_IMAGE_EXECUTION_INITIALIZED,\r
+          ImageName,\r
+          ImageDevicePath\r
+          );\r
+      }\r
+\r
+      if ((UnchainCertLength != 0) && (UnchainCert != NULL)) {\r
+        RecordCertListToImageExeuctionTable(\r
+          UnchainCert,\r
+          UnchainCertLength,\r
+          EFI_IMAGE_EXECUTION_AUTH_SIG_FAILED | EFI_IMAGE_EXECUTION_INITIALIZED,\r
+          ImageName,\r
+          ImageDevicePath\r
+          );\r
+      }\r
+    }\r
   }\r
 \r
+\r
   if (Data != NULL) {\r
     FreePool (Data);\r
   }\r
@@ -1488,9 +1711,369 @@ Done:
     FreePool (DbxData);\r
   }\r
 \r
+  Pkcs7FreeSigners (SignerCert);\r
+  Pkcs7FreeSigners (UnchainCert);\r
+\r
   return VerifyStatus;\r
 }\r
 \r
+/**\r
+  Provide verification service for signed images in AuditMode, which include both signature validation\r
+  and platform policy control. For signature types, both UEFI WIN_CERTIFICATE_UEFI_GUID and\r
+  MSFT Authenticode type signatures are supported. \r
+\r
+  In this implementation, only verify external executables when in AuditMode.\r
+  Executables from FV is bypass, so pass in AuthenticationStatus is ignored. Other authentication status\r
+  are record into IMAGE_EXECUTION_TABLE.\r
+\r
+  The image verification policy is:\r
+    If the image is signed,\r
+      At least one valid signature or at least one hash value of the image must match a record\r
+      in the security database "db", and no valid signature nor any hash value of the image may\r
+      be reflected in the security database "dbx".\r
+    Otherwise, the image is not signed,\r
+      The SHA256 hash value of the image must match a record in the security database "db", and\r
+      not be reflected in the security data base "dbx".\r
+\r
+  Caution: This function may receive untrusted input.\r
+  PE/COFF image is external input, so this function will validate its data structure\r
+  within this image buffer before use.\r
+\r
+  @param[in]    AuthenticationStatus\r
+                           This is the authentication status returned from the security\r
+                           measurement services for the input file.\r
+  @param[in]    File       This is a pointer to the device path of the file that is\r
+                           being dispatched. This will optionally be used for logging.\r
+  @param[in]    FileBuffer File buffer matches the input file device path.\r
+  @param[in]    FileSize   Size of File buffer matches the input file device path.\r
+  @param[in]    BootPolicy A boot policy that was used to call LoadImage() UEFI service.\r
+\r
+  @retval EFI_SUCCESS            The authenticate info is sucessfully stored for the file \r
+                                 specified by DevicePath and non-NULL FileBuffer \r
+  @retval EFI_ACCESS_DENIED      The file specified by File and FileBuffer did not\r
+                                 authenticate, and the platform policy dictates that the DXE\r
+                                 Foundation many not use File.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+ImageVerificationInAuditMode (\r
+  IN  UINT32                           AuthenticationStatus,\r
+  IN  CONST EFI_DEVICE_PATH_PROTOCOL   *File,\r
+  IN  VOID                             *FileBuffer,\r
+  IN  UINTN                            FileSize,\r
+  IN  BOOLEAN                          BootPolicy\r
+  )\r
+{\r
+  EFI_STATUS                           Status;\r
+  UINT16                               Magic;\r
+  EFI_IMAGE_DOS_HEADER                 *DosHdr;\r
+  EFI_SIGNATURE_LIST                   *SignatureList;\r
+  EFI_IMAGE_EXECUTION_ACTION           Action;\r
+  WIN_CERTIFICATE                      *WinCertificate;\r
+  UINT32                               Policy;\r
+  PE_COFF_LOADER_IMAGE_CONTEXT         ImageContext;\r
+  UINT32                               NumberOfRvaAndSizes;\r
+  WIN_CERTIFICATE_EFI_PKCS             *PkcsCertData;\r
+  WIN_CERTIFICATE_UEFI_GUID            *WinCertUefiGuid;\r
+  UINT8                                *AuthData;\r
+  UINTN                                AuthDataSize;\r
+  EFI_IMAGE_DATA_DIRECTORY             *SecDataDir;\r
+  UINT32                               OffSet;\r
+  CHAR16                               *FilePathStr;\r
+  UINTN                                SignatureListSize;\r
+\r
+  SignatureList     = NULL;\r
+  WinCertificate    = NULL;\r
+  SecDataDir        = NULL;\r
+  PkcsCertData      = NULL;\r
+  FilePathStr       = NULL;\r
+  Action            = EFI_IMAGE_EXECUTION_AUTH_SIG_FAILED | EFI_IMAGE_EXECUTION_INITIALIZED;\r
+  Status            = EFI_ACCESS_DENIED;\r
+\r
+\r
+  //\r
+  // Check the image type and get policy setting.\r
+  //\r
+  switch (GetImageType (File)) {\r
+\r
+  case IMAGE_FROM_FV:\r
+    Policy = ALWAYS_EXECUTE;\r
+    break;\r
+\r
+  case IMAGE_FROM_OPTION_ROM:\r
+    Policy = PcdGet32 (PcdOptionRomImageVerificationPolicy);\r
+    break;\r
+\r
+  case IMAGE_FROM_REMOVABLE_MEDIA:\r
+    Policy = PcdGet32 (PcdRemovableMediaImageVerificationPolicy);\r
+    break;\r
+\r
+  case IMAGE_FROM_FIXED_MEDIA:\r
+    Policy = PcdGet32 (PcdFixedMediaImageVerificationPolicy);\r
+    break;\r
+\r
+  default:\r
+    Policy = DENY_EXECUTE_ON_SECURITY_VIOLATION;\r
+    break;\r
+  }\r
+\r
+  //\r
+  // If policy is always/never execute, return directly.\r
+  //\r
+  if (Policy == ALWAYS_EXECUTE) {\r
+    return EFI_SUCCESS;\r
+  }\r
+\r
+  //\r
+  // Get Image Device Path Str\r
+  //\r
+  FilePathStr = ConvertDevicePathToText (File, FALSE, TRUE);\r
+\r
+  //\r
+  // Authentication failed because of (unspecified) firmware security policy\r
+  //\r
+  if (Policy == NEVER_EXECUTE) {\r
+    //\r
+    // No signature, record FilePath/FilePathStr only\r
+    //\r
+    AddImageExeInfo (EFI_IMAGE_EXECUTION_POLICY_FAILED | EFI_IMAGE_EXECUTION_INITIALIZED, FilePathStr, File, NULL, 0);\r
+    goto END;\r
+  }\r
+\r
+  //\r
+  // The policy QUERY_USER_ON_SECURITY_VIOLATION and ALLOW_EXECUTE_ON_SECURITY_VIOLATION\r
+  // violates the UEFI spec and has been removed.\r
+  //\r
+  ASSERT (Policy != QUERY_USER_ON_SECURITY_VIOLATION && Policy != ALLOW_EXECUTE_ON_SECURITY_VIOLATION);\r
+  if (Policy == QUERY_USER_ON_SECURITY_VIOLATION || Policy == ALLOW_EXECUTE_ON_SECURITY_VIOLATION) {\r
+    CpuDeadLoop ();\r
+  }\r
+\r
+  //\r
+  // Read the Dos header.\r
+  //\r
+  if (FileBuffer == NULL) {\r
+    Status = EFI_INVALID_PARAMETER;\r
+    goto END;\r
+  }\r
+\r
+  mImageBase  = (UINT8 *) FileBuffer;\r
+  mImageSize  = FileSize;\r
+\r
+  ZeroMem (&ImageContext, sizeof (ImageContext));\r
+  ImageContext.Handle    = (VOID *) FileBuffer;\r
+  ImageContext.ImageRead = (PE_COFF_LOADER_READ_FILE) DxeImageVerificationLibImageRead;\r
+\r
+  //\r
+  // Get information about the image being loaded\r
+  //\r
+  Status = PeCoffLoaderGetImageInfo (&ImageContext);\r
+  if (EFI_ERROR (Status)) {\r
+    //\r
+    // The information can't be got from the invalid PeImage\r
+    //\r
+    goto END;\r
+  }\r
+\r
+\r
+  DosHdr = (EFI_IMAGE_DOS_HEADER *) mImageBase;\r
+  if (DosHdr->e_magic == EFI_IMAGE_DOS_SIGNATURE) {\r
+    //\r
+    // DOS image header is present,\r
+    // so read the PE header after the DOS image header.\r
+    //\r
+    mPeCoffHeaderOffset = DosHdr->e_lfanew;\r
+  } else {\r
+    mPeCoffHeaderOffset = 0;\r
+  }\r
+\r
+  //\r
+  // Check PE/COFF image.\r
+  //\r
+  mNtHeader.Pe32 = (EFI_IMAGE_NT_HEADERS32 *) (mImageBase + mPeCoffHeaderOffset);\r
+  if (mNtHeader.Pe32->Signature != EFI_IMAGE_NT_SIGNATURE) {\r
+    //\r
+    // It is not a valid Pe/Coff file.\r
+    //\r
+    Status = EFI_ACCESS_DENIED;\r
+    goto END;\r
+  }\r
+\r
+  if (mNtHeader.Pe32->FileHeader.Machine == IMAGE_FILE_MACHINE_IA64 && mNtHeader.Pe32->OptionalHeader.Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r
+    //\r
+    // NOTE: Some versions of Linux ELILO for Itanium have an incorrect magic value\r
+    //       in the PE/COFF Header. If the MachineType is Itanium(IA64) and the\r
+    //       Magic value in the OptionalHeader is EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC\r
+    //       then override the magic value to EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC\r
+    //\r
+    Magic = EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC;\r
+  } else {\r
+    //\r
+    // Get the magic value from the PE/COFF Optional Header\r
+    //\r
+    Magic = mNtHeader.Pe32->OptionalHeader.Magic;\r
+  }\r
+\r
+  if (Magic == EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC) {\r
+    //\r
+    // Use PE32 offset.\r
+    //\r
+    NumberOfRvaAndSizes = mNtHeader.Pe32->OptionalHeader.NumberOfRvaAndSizes;\r
+    if (NumberOfRvaAndSizes > EFI_IMAGE_DIRECTORY_ENTRY_SECURITY) {\r
+      SecDataDir = (EFI_IMAGE_DATA_DIRECTORY *) &mNtHeader.Pe32->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY];\r
+    }\r
+  } else {\r
+    //\r
+    // Use PE32+ offset.\r
+    //\r
+    NumberOfRvaAndSizes = mNtHeader.Pe32Plus->OptionalHeader.NumberOfRvaAndSizes;\r
+    if (NumberOfRvaAndSizes > EFI_IMAGE_DIRECTORY_ENTRY_SECURITY) {\r
+      SecDataDir = (EFI_IMAGE_DATA_DIRECTORY *) &mNtHeader.Pe32Plus->OptionalHeader.DataDirectory[EFI_IMAGE_DIRECTORY_ENTRY_SECURITY];\r
+    }\r
+  }\r
+\r
+  //\r
+  // Start Image Validation.\r
+  //\r
+  if (SecDataDir == NULL || SecDataDir->Size == 0) {\r
+    //\r
+    // This image is not signed. The SHA256 hash value of the image must match a record in the security database "db",\r
+    // and not be reflected in the security data base "dbx".\r
+    //\r
+    if (!HashPeImage (HASHALG_SHA256)) {\r
+      Status = EFI_ACCESS_DENIED;\r
+      goto END;\r
+    }\r
+\r
+    //\r
+    // Image Hash is in forbidden database (DBX).\r
+    //\r
+    if (!IsSignatureFoundInDatabase (EFI_IMAGE_SECURITY_DATABASE1, mImageDigest, &mCertType, mImageDigestSize)) {\r
+      //\r
+      // Image Hash is in allowed database (DB).\r
+      //\r
+      if (IsSignatureFoundInDatabase (EFI_IMAGE_SECURITY_DATABASE, mImageDigest, &mCertType, mImageDigestSize)) {\r
+        Action = EFI_IMAGE_EXECUTION_AUTH_SIG_PASSED | EFI_IMAGE_EXECUTION_INITIALIZED;\r
+      }\r
+    }\r
+\r
+    //\r
+    // Add HASH digest for image without signature\r
+    //\r
+    Status = CreateSignatureList(mImageDigest, mImageDigestSize, &mCertType, &SignatureList, &SignatureListSize);\r
+    if (!EFI_ERROR(Status)) {\r
+      AddImageExeInfo (Action, FilePathStr, File, SignatureList, SignatureListSize);\r
+      FreePool (SignatureList);\r
+    }\r
+    goto END;\r
+  }\r
+\r
+  //\r
+  // Verify the signature of the image, multiple signatures are allowed as per PE/COFF Section 4.7\r
+  // "Attribute Certificate Table".\r
+  // The first certificate starts at offset (SecDataDir->VirtualAddress) from the start of the file.\r
+  //\r
+  for (OffSet = SecDataDir->VirtualAddress;\r
+       OffSet < (SecDataDir->VirtualAddress + SecDataDir->Size);\r
+       OffSet += (WinCertificate->dwLength + ALIGN_SIZE (WinCertificate->dwLength))) {\r
+    WinCertificate = (WIN_CERTIFICATE *) (mImageBase + OffSet);\r
+    if ((SecDataDir->VirtualAddress + SecDataDir->Size - OffSet) <= sizeof (WIN_CERTIFICATE) ||\r
+        (SecDataDir->VirtualAddress + SecDataDir->Size - OffSet) < WinCertificate->dwLength) {\r
+      break;\r
+    }\r
+\r
+    //\r
+    // Verify the image's Authenticode signature, only DER-encoded PKCS#7 signed data is supported.\r
+    //\r
+    if (WinCertificate->wCertificateType == WIN_CERT_TYPE_PKCS_SIGNED_DATA) {\r
+      //\r
+      // The certificate is formatted as WIN_CERTIFICATE_EFI_PKCS which is described in the\r
+      // Authenticode specification.\r
+      //\r
+      PkcsCertData = (WIN_CERTIFICATE_EFI_PKCS *) WinCertificate;\r
+      if (PkcsCertData->Hdr.dwLength <= sizeof (PkcsCertData->Hdr)) {\r
+        break;\r
+      }\r
+      AuthData   = PkcsCertData->CertData;\r
+      AuthDataSize = PkcsCertData->Hdr.dwLength - sizeof(PkcsCertData->Hdr);\r
+    } else if (WinCertificate->wCertificateType == WIN_CERT_TYPE_EFI_GUID) {\r
+      //\r
+      // The certificate is formatted as WIN_CERTIFICATE_UEFI_GUID which is described in UEFI Spec.\r
+      //\r
+      WinCertUefiGuid = (WIN_CERTIFICATE_UEFI_GUID *) WinCertificate;\r
+      if (WinCertUefiGuid->Hdr.dwLength <= OFFSET_OF(WIN_CERTIFICATE_UEFI_GUID, CertData)) {\r
+        break;\r
+      }\r
+      if (!CompareGuid (&WinCertUefiGuid->CertType, &gEfiCertPkcs7Guid)) {\r
+        continue;\r
+      }\r
+      AuthData = WinCertUefiGuid->CertData;\r
+      AuthDataSize = WinCertUefiGuid->Hdr.dwLength - OFFSET_OF(WIN_CERTIFICATE_UEFI_GUID, CertData);\r
+    } else {\r
+      if (WinCertificate->dwLength < sizeof (WIN_CERTIFICATE)) {\r
+        break;\r
+      }\r
+      continue;\r
+    }\r
+\r
+    Status = HashPeImageByType (AuthData, AuthDataSize);\r
+    if (EFI_ERROR (Status)) {\r
+      continue;\r
+    }\r
+\r
+    Action = EFI_IMAGE_EXECUTION_AUTH_SIG_FAILED | EFI_IMAGE_EXECUTION_INITIALIZED;\r
+\r
+    //\r
+    // Check the digital signature against the revoked certificate in forbidden database (dbx).\r
+    // Check the digital signature against the valid certificate in allowed database (db).\r
+    //\r
+    if (!IsForbiddenByDbx (AuthData, AuthDataSize, TRUE, FilePathStr, File)) {\r
+      IsAllowedByDb (AuthData, AuthDataSize, TRUE, FilePathStr, File);\r
+    }\r
+\r
+    //\r
+    // Check the image's hash value.\r
+    //\r
+    if (!IsSignatureFoundInDatabase (EFI_IMAGE_SECURITY_DATABASE1, mImageDigest, &mCertType, mImageDigestSize)) {\r
+      if (IsSignatureFoundInDatabase (EFI_IMAGE_SECURITY_DATABASE, mImageDigest, &mCertType, mImageDigestSize)) {\r
+        Action = EFI_IMAGE_EXECUTION_AUTH_SIG_PASSED | EFI_IMAGE_EXECUTION_INITIALIZED; \r
+      }\r
+    }\r
+\r
+    //\r
+    // Add HASH digest for image with signature\r
+    //\r
+    Status = CreateSignatureList(mImageDigest, mImageDigestSize, &mCertType, &SignatureList, &SignatureListSize);\r
+\r
+    if (!EFI_ERROR(Status)) {\r
+      AddImageExeInfo (Action, FilePathStr, File, SignatureList, SignatureListSize);\r
+      FreePool (SignatureList);\r
+    } else {\r
+      goto END;\r
+    }\r
+  }\r
+\r
+\r
+  if (OffSet != (SecDataDir->VirtualAddress + SecDataDir->Size)) {\r
+    //\r
+    // The Size in Certificate Table or the attribute certicate table is corrupted.\r
+    //\r
+    Status = EFI_ACCESS_DENIED;\r
+  } else {\r
+    Status = EFI_SUCCESS;\r
+  }\r
+\r
+END:\r
+\r
+  if (FilePathStr != NULL) {\r
+    FreePool(FilePathStr);\r
+    FilePathStr = NULL;\r
+  }\r
+\r
+  return Status;\r
+}\r
+\r
 /**\r
   Provide verification service for signed images, which include both signature validation\r
   and platform policy control. For signature types, both UEFI WIN_CERTIFICATE_UEFI_GUID and\r
@@ -1558,7 +2141,9 @@ DxeImageVerificationHandler (
   EFI_IMAGE_EXECUTION_ACTION           Action;\r
   WIN_CERTIFICATE                      *WinCertificate;\r
   UINT32                               Policy;\r
-  UINT8                                *SecureBoot;\r
+  UINT8                                *VarData;\r
+  UINT8                                SecureBoot;\r
+  UINT8                                AuditMode;\r
   PE_COFF_LOADER_IMAGE_CONTEXT         ImageContext;\r
   UINT32                               NumberOfRvaAndSizes;\r
   WIN_CERTIFICATE_EFI_PKCS             *PkcsCertData;\r
@@ -1578,6 +2163,20 @@ DxeImageVerificationHandler (
   Status            = EFI_ACCESS_DENIED;\r
   VerifyStatus      = EFI_ACCESS_DENIED;\r
 \r
+  GetEfiGlobalVariable2 (EFI_AUDIT_MODE_NAME, (VOID**)&VarData, NULL);\r
+  //\r
+  // Skip verification if AuditMode variable doesn't exist. AuditMode should always exist\r
+  //\r
+  if (VarData == NULL) {\r
+    return EFI_SUCCESS;\r
+  }\r
+  AuditMode = *VarData;\r
+  FreePool(VarData);\r
+\r
+  if (AuditMode == AUDIT_MODE_ENABLE) {\r
+    return ImageVerificationInAuditMode(AuthenticationStatus, File, FileBuffer, FileSize, BootPolicy);\r
+  }\r
+\r
   //\r
   // Check the image type and get policy setting.\r
   //\r
@@ -1621,22 +2220,22 @@ DxeImageVerificationHandler (
     CpuDeadLoop ();\r
   }\r
 \r
-  GetEfiGlobalVariable2 (EFI_SECURE_BOOT_MODE_NAME, (VOID**)&SecureBoot, NULL);\r
+  GetEfiGlobalVariable2 (EFI_SECURE_BOOT_MODE_NAME, (VOID**)&VarData, NULL);\r
   //\r
   // Skip verification if SecureBoot variable doesn't exist.\r
   //\r
-  if (SecureBoot == NULL) {\r
+  if (VarData == NULL) {\r
     return EFI_SUCCESS;\r
   }\r
+  SecureBoot = *VarData;\r
+  FreePool(VarData);\r
 \r
   //\r
-  // Skip verification if SecureBoot is disabled.\r
+  // Skip verification if SecureBoot is disabled but not AuditMode\r
   //\r
-  if (*SecureBoot == SECURE_BOOT_MODE_DISABLE) {\r
-    FreePool (SecureBoot);\r
+  if (SecureBoot == SECURE_BOOT_MODE_DISABLE) {\r
     return EFI_SUCCESS;\r
   }\r
-  FreePool (SecureBoot);\r
 \r
   //\r
   // Read the Dos header.\r
@@ -1807,7 +2406,7 @@ DxeImageVerificationHandler (
     //\r
     // Check the digital signature against the revoked certificate in forbidden database (dbx).\r
     //\r
-    if (IsForbiddenByDbx (AuthData, AuthDataSize)) {\r
+    if (IsForbiddenByDbx (AuthData, AuthDataSize, FALSE, NULL, NULL)) {\r
       Action = EFI_IMAGE_EXECUTION_AUTH_SIG_FAILED;\r
       VerifyStatus = EFI_ACCESS_DENIED;\r
       break;\r
@@ -1817,7 +2416,7 @@ DxeImageVerificationHandler (
     // Check the digital signature against the valid certificate in allowed database (db).\r
     //\r
     if (EFI_ERROR (VerifyStatus)) {\r
-      if (IsAllowedByDb (AuthData, AuthDataSize)) {\r
+      if (IsAllowedByDb (AuthData, AuthDataSize, FALSE, NULL, NULL)) {\r
         VerifyStatus = EFI_SUCCESS;\r
       }\r
     }\r
@@ -1859,7 +2458,7 @@ DxeImageVerificationHandler (
       }\r
       SignatureList->SignatureHeaderSize  = 0;\r
       SignatureList->SignatureListSize    = (UINT32) SignatureListSize;\r
-      SignatureList->SignatureSize        = (UINT32) mImageDigestSize;\r
+      SignatureList->SignatureSize        = (UINT32) (sizeof (EFI_SIGNATURE_DATA) - 1 + mImageDigestSize);\r
       CopyMem (&SignatureList->SignatureType, &mCertType, sizeof (EFI_GUID));\r
       Signature = (EFI_SIGNATURE_DATA *) ((UINT8 *) SignatureList + sizeof (EFI_SIGNATURE_LIST));\r
       CopyMem (Signature->SignatureData, mImageDigest, mImageDigestSize);\r