]> git.proxmox.com Git - mirror_edk2.git/blobdiff - SecurityPkg/Tcg/TrEEDxe/TrEEDxe.c
Handle TPM device error and avoid deadloop in BDS.
[mirror_edk2.git] / SecurityPkg / Tcg / TrEEDxe / TrEEDxe.c
index 8db0fa0df01ddbe737b0c7c48d4bc8088fd456e5..58c4aff819b493594d712bed6ad91c73a6002338 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   This module implements TrEE Protocol.\r
   \r
-Copyright (c) 2013 - 2014, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2013 - 2015, 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
@@ -48,6 +48,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Library/Tpm2DeviceLib.h>\r
 #include <Library/HashLib.h>\r
 #include <Library/PerformanceLib.h>\r
+#include <Library/ReportStatusCodeLib.h>\r
 \r
 #define PERF_ID_TREE_DXE  0x3120\r
 \r
@@ -64,16 +65,13 @@ typedef struct {
 typedef struct {\r
   EFI_GUID               *EventGuid;\r
   TREE_EVENT_LOG_FORMAT  LogFormat;\r
-  UINT32                 BootHashAlg;\r
-  UINT16                 DigestAlgID;\r
-  TPMI_ALG_HASH          TpmHashAlgo;\r
 } TREE_EVENT_INFO_STRUCT;\r
 \r
 TREE_EVENT_INFO_STRUCT mTreeEventInfo[] = {\r
-  {&gTcgEventEntryHobGuid,             TREE_EVENT_LOG_FORMAT_TCG_1_2,      TREE_BOOT_HASH_ALG_SHA1,     0,                       TPM_ALG_SHA1},\r
+  {&gTcgEventEntryHobGuid,             TREE_EVENT_LOG_FORMAT_TCG_1_2},\r
 };\r
 \r
-#define TCG_EVENT_LOG_AREA_COUNT_MAX   5\r
+#define TCG_EVENT_LOG_AREA_COUNT_MAX   2\r
 \r
 typedef struct {\r
   TREE_EVENT_LOG_FORMAT             EventLogFormat;\r
@@ -364,7 +362,7 @@ TreeGetCapability (
   IN OUT TREE_BOOT_SERVICE_CAPABILITY *ProtocolCapability\r
   )\r
 {\r
-  DEBUG ((EFI_D_ERROR, "TreeGetCapability ...\n"));\r
+  DEBUG ((EFI_D_INFO, "TreeGetCapability ...\n"));\r
 \r
   if ((This == NULL) || (ProtocolCapability == NULL)) {\r
     return EFI_INVALID_PARAMETER;\r
@@ -376,7 +374,7 @@ TreeGetCapability (
   }\r
 \r
   CopyMem (ProtocolCapability, &mTcgDxeData.BsCap, mTcgDxeData.BsCap.Size);\r
-  DEBUG ((EFI_D_ERROR, "TreeGetCapability - %r\n", EFI_SUCCESS));\r
+  DEBUG ((EFI_D_INFO, "TreeGetCapability - %r\n", EFI_SUCCESS));\r
   return EFI_SUCCESS;\r
 }\r
 \r
@@ -451,7 +449,7 @@ TreeGetEventLog (
 {\r
   UINTN  Index;\r
 \r
-  DEBUG ((EFI_D_ERROR, "TreeGetEventLog ...\n"));\r
+  DEBUG ((EFI_D_INFO, "TreeGetEventLog ...\n"));\r
 \r
   if (This == NULL) {\r
     return EFI_INVALID_PARAMETER;\r
@@ -482,7 +480,7 @@ TreeGetEventLog (
 \r
   if (EventLogLocation != NULL) {\r
     *EventLogLocation = mTcgDxeData.EventLogAreaStruct[Index].Lasa;\r
-    DEBUG ((EFI_D_ERROR, "TreeGetEventLog (EventLogLocation - %x)\n", *EventLogLocation));\r
+    DEBUG ((EFI_D_INFO, "TreeGetEventLog (EventLogLocation - %x)\n", *EventLogLocation));\r
   }\r
 \r
   if (EventLogLastEntry != NULL) {\r
@@ -491,15 +489,15 @@ TreeGetEventLog (
     } else {\r
       *EventLogLastEntry = (EFI_PHYSICAL_ADDRESS)(UINTN)mTcgDxeData.EventLogAreaStruct[Index].LastEvent;\r
     }\r
-    DEBUG ((EFI_D_ERROR, "TreeGetEventLog (EventLogLastEntry - %x)\n", *EventLogLastEntry));\r
+    DEBUG ((EFI_D_INFO, "TreeGetEventLog (EventLogLastEntry - %x)\n", *EventLogLastEntry));\r
   }\r
 \r
   if (EventLogTruncated != NULL) {\r
     *EventLogTruncated = mTcgDxeData.EventLogAreaStruct[Index].EventLogTruncated;\r
-    DEBUG ((EFI_D_ERROR, "TreeGetEventLog (EventLogTruncated - %x)\n", *EventLogTruncated));\r
+    DEBUG ((EFI_D_INFO, "TreeGetEventLog (EventLogTruncated - %x)\n", *EventLogTruncated));\r
   }\r
 \r
-  DEBUG ((EFI_D_ERROR, "TreeGetEventLog - %r\n", EFI_SUCCESS));\r
+  DEBUG ((EFI_D_INFO, "TreeGetEventLog - %r\n", EFI_SUCCESS));\r
 \r
   // Dump Event Log for debug purpose\r
   if ((EventLogLocation != NULL) && (EventLogLastEntry != NULL)) {\r
@@ -628,72 +626,6 @@ TcgDxeLogEvent (
   return Status;\r
 }\r
 \r
-/**\r
-  This function return hash algorithm from event log format.\r
-\r
-  @param[in]     EventLogFormat    Event log format.\r
-\r
-  @return hash algorithm.\r
-**/\r
-TPMI_ALG_HASH\r
-TrEEGetHashAlgoFromLogFormat (\r
-  IN      TREE_EVENT_LOG_FORMAT     EventLogFormat\r
-  )\r
-{\r
-  UINTN  Index;\r
-\r
-  for (Index = 0; Index < sizeof(mTreeEventInfo)/sizeof(mTreeEventInfo[0]); Index++) {\r
-    if (mTreeEventInfo[Index].LogFormat == EventLogFormat) {\r
-      return mTreeEventInfo[Index].TpmHashAlgo;\r
-    }\r
-  }\r
-  return TPM_ALG_SHA1;\r
-}\r
-\r
-/**\r
-  This function return hash algorithm ID from event log format.\r
-\r
-  @param[in]     EventLogFormat    Event log format.\r
-\r
-  @return hash algorithm ID.\r
-**/\r
-UINT16\r
-TrEEGetAlgIDFromLogFormat (\r
-  IN      TREE_EVENT_LOG_FORMAT     EventLogFormat\r
-  )\r
-{\r
-  UINTN  Index;\r
-\r
-  for (Index = 0; Index < sizeof(mTreeEventInfo)/sizeof(mTreeEventInfo[0]); Index++) {\r
-    if (mTreeEventInfo[Index].LogFormat == EventLogFormat) {\r
-      return mTreeEventInfo[Index].DigestAlgID;\r
-    }\r
-  }\r
-  return 0;\r
-}\r
-\r
-/**\r
-  This function return boot hash algorithm from event log format.\r
-\r
-  @param[in]     EventLogFormat    Event log format.\r
-\r
-  @return boot hash algorithm.\r
-**/\r
-UINT32\r
-TrEEGetBootHashAlgFromLogFormat (\r
-  IN      TREE_EVENT_LOG_FORMAT     EventLogFormat\r
-  )\r
-{\r
-  UINTN  Index;\r
-\r
-  for (Index = 0; Index < sizeof(mTreeEventInfo)/sizeof(mTreeEventInfo[0]); Index++) {\r
-    if (mTreeEventInfo[Index].LogFormat == EventLogFormat) {\r
-      return mTreeEventInfo[Index].BootHashAlg;\r
-    }\r
-  }\r
-  return TREE_BOOT_HASH_ALG_SHA1;\r
-}\r
-\r
 /**\r
   This function get digest from digest list.\r
 \r
@@ -811,6 +743,10 @@ TcgDxeHashLogExtendEvent (
 {\r
   EFI_STATUS                        Status;\r
   TPML_DIGEST_VALUES                DigestList;\r
+  \r
+  if (!mTcgDxeData.BsCap.TrEEPresentFlag) {\r
+    return EFI_DEVICE_ERROR;\r
+  }\r
 \r
   Status = HashAndExtend (\r
              NewEventHdr->PCRIndex,\r
@@ -824,6 +760,15 @@ TcgDxeHashLogExtendEvent (
     }\r
   }\r
 \r
+  if (Status == EFI_DEVICE_ERROR) {\r
+    DEBUG ((EFI_D_ERROR, "TcgDxeHashLogExtendEvent - %r. Disable TPM.\n", Status));\r
+    mTcgDxeData.BsCap.TrEEPresentFlag = FALSE;\r
+    REPORT_STATUS_CODE (\r
+      EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
+      (PcdGet32 (PcdStatusCodeSubClassTpmDevice) | EFI_P_EC_INTERFACE_ERROR)\r
+      );\r
+  }\r
+\r
   return Status;\r
 }\r
 \r
@@ -860,7 +805,7 @@ TreeHashLogExtendEvent (
   TCG_PCR_EVENT_HDR  NewEventHdr;\r
   TPML_DIGEST_VALUES DigestList;\r
 \r
-  DEBUG ((EFI_D_ERROR, "TreeHashLogExtendEvent ...\n"));\r
+  DEBUG ((EFI_D_INFO, "TreeHashLogExtendEvent ...\n"));\r
 \r
   if ((This == NULL) || (DataToHash == 0) || (Event == NULL)) {\r
     return EFI_INVALID_PARAMETER;\r
@@ -893,6 +838,14 @@ TreeHashLogExtendEvent (
         Status = TcgDxeLogHashEvent (&DigestList, &NewEventHdr, Event->Event);\r
       }\r
     }\r
+    if (Status == EFI_DEVICE_ERROR) {\r
+      DEBUG ((EFI_D_ERROR, "MeasurePeImageAndExtend - %r. Disable TPM.\n", Status));\r
+      mTcgDxeData.BsCap.TrEEPresentFlag = FALSE;\r
+      REPORT_STATUS_CODE (\r
+        EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
+        (PcdGet32 (PcdStatusCodeSubClassTpmDevice) | EFI_P_EC_INTERFACE_ERROR)\r
+        );\r
+    }\r
   } else {\r
     Status = TcgDxeHashLogExtendEvent (\r
                Flags,\r
@@ -902,7 +855,7 @@ TreeHashLogExtendEvent (
                Event->Event\r
                );\r
   }\r
-  DEBUG ((EFI_D_ERROR, "TreeHashLogExtendEvent - %r\n", Status));\r
+  DEBUG ((EFI_D_INFO, "TreeHashLogExtendEvent - %r\n", Status));\r
   return Status;\r
 }\r
 \r
@@ -932,7 +885,7 @@ TreeSubmitCommand (
 {\r
   EFI_STATUS    Status;\r
 \r
-  DEBUG ((EFI_D_ERROR, "TreeSubmitCommand ...\n"));\r
+  DEBUG ((EFI_D_INFO, "TreeSubmitCommand ...\n"));\r
 \r
   if ((This == NULL) ||\r
       (InputParameterBlockSize == 0) || (InputParameterBlock == NULL) ||\r
@@ -957,7 +910,7 @@ TreeSubmitCommand (
              &OutputParameterBlockSize,\r
              OutputParameterBlock\r
              );\r
-  DEBUG ((EFI_D_ERROR, "TreeSubmitCommand - %r\n", Status));\r
+  DEBUG ((EFI_D_INFO, "TreeSubmitCommand - %r\n", Status));\r
   return Status;\r
 }\r
 \r
@@ -1178,7 +1131,7 @@ MeasureSeparatorEvent (
   TCG_PCR_EVENT_HDR                 TcgEvent;\r
   UINT32                            EventData;\r
 \r
-  DEBUG ((EFI_D_ERROR, "MeasureSeparatorEvent Pcr - %x\n", PCRIndex));\r
+  DEBUG ((EFI_D_INFO, "MeasureSeparatorEvent Pcr - %x\n", PCRIndex));\r
 \r
   EventData = 0;\r
   TcgEvent.PCRIndex  = PCRIndex;\r
@@ -1223,8 +1176,8 @@ MeasureVariable (
   UINTN                             VarNameLength;\r
   EFI_VARIABLE_DATA_TREE            *VarLog;\r
 \r
-  DEBUG ((EFI_D_ERROR, "TrEEDxe: MeasureVariable (Pcr - %x, EventType - %x, ", (UINTN)PCRIndex, (UINTN)EventType));\r
-  DEBUG ((EFI_D_ERROR, "VariableName - %s, VendorGuid - %g)\n", VarName, VendorGuid));\r
+  DEBUG ((EFI_D_INFO, "TrEEDxe: MeasureVariable (Pcr - %x, EventType - %x, ", (UINTN)PCRIndex, (UINTN)EventType));\r
+  DEBUG ((EFI_D_INFO, "VariableName - %s, VendorGuid - %g)\n", VarName, VendorGuid));\r
 \r
   VarNameLength      = StrLen (VarName);\r
   TcgEvent.PCRIndex  = PCRIndex;\r
@@ -1245,7 +1198,7 @@ MeasureVariable (
      VarName,\r
      VarNameLength * sizeof (*VarName)\r
      );\r
-  if (VarSize != 0) {\r
+  if (VarSize != 0 && VarData != NULL) {\r
     CopyMem (\r
        (CHAR16 *)VarLog->UnicodeName + VarNameLength,\r
        VarData,\r
@@ -1423,7 +1376,7 @@ MeasureAllBootVariables (
              &BootCount,\r
              (VOID **) &BootOrder\r
              );\r
-  if (Status == EFI_NOT_FOUND) {\r
+  if (Status == EFI_NOT_FOUND || BootOrder == NULL) {\r
     return EFI_SUCCESS;\r
   }\r
 \r
@@ -1553,11 +1506,11 @@ MeasureSecureBootPolicy (
 \r
   if (PcdGetBool (PcdFirmwareDebuggerInitialized)) {\r
     Status = MeasureLaunchOfFirmwareDebugger ();\r
-    DEBUG ((EFI_D_ERROR, "MeasureLaunchOfFirmwareDebugger - %r\n", Status));\r
+    DEBUG ((EFI_D_INFO, "MeasureLaunchOfFirmwareDebugger - %r\n", Status));\r
   }\r
 \r
   Status = MeasureAllSecureVariables ();\r
-  DEBUG ((EFI_D_ERROR, "MeasureAllSecureVariables - %r\n", Status));\r
+  DEBUG ((EFI_D_INFO, "MeasureAllSecureVariables - %r\n", Status));\r
 \r
   //\r
   // We need measure Separator(7) here, because this event must be between SecureBootPolicy (Configure)\r
@@ -1566,7 +1519,7 @@ MeasureSecureBootPolicy (
   // the Authority measurement happen before ReadToBoot event.\r
   //\r
   Status = MeasureSeparatorEvent (7);\r
-  DEBUG ((EFI_D_ERROR, "MeasureSeparatorEvent - %r\n", Status));\r
+  DEBUG ((EFI_D_INFO, "MeasureSeparatorEvent - %r\n", Status));\r
   return ;\r
 }\r
 \r
@@ -1614,6 +1567,9 @@ OnReadyToBoot (
     Status = TcgMeasureAction (\r
                EFI_CALLING_EFI_APPLICATION\r
                );\r
+    if (EFI_ERROR (Status)) {\r
+      DEBUG ((EFI_D_ERROR, "%s not Measured. Error!\n", EFI_CALLING_EFI_APPLICATION));\r
+    }\r
 \r
     //\r
     // 2. Draw a line between pre-boot env and entering post-boot env.\r
@@ -1621,6 +1577,9 @@ OnReadyToBoot (
     //\r
     for (PcrIndex = 0; PcrIndex < 7; PcrIndex++) {\r
       Status = MeasureSeparatorEvent (PcrIndex);\r
+      if (EFI_ERROR (Status)) {\r
+        DEBUG ((EFI_D_ERROR, "Seperator Event not Measured. Error!\n"));\r
+      }\r
     }\r
 \r
     //\r
@@ -1641,6 +1600,9 @@ OnReadyToBoot (
     Status = TcgMeasureAction (\r
                EFI_RETURNING_FROM_EFI_APPLICATOIN\r
                );\r
+    if (EFI_ERROR (Status)) {\r
+      DEBUG ((EFI_D_ERROR, "%s not Measured. Error!\n", EFI_RETURNING_FROM_EFI_APPLICATOIN));\r
+    }\r
   }\r
 \r
   DEBUG ((EFI_D_INFO, "TPM2 TrEEDxe Measure Data when ReadyToBoot\n"));\r
@@ -1858,18 +1820,22 @@ DriverEntry (
     DEBUG ((EFI_D_ERROR, "TPM not detected!\n"));\r
     return Status;\r
   }\r
+  \r
+  if (GetFirstGuidHob (&gTpmErrorHobGuid) != NULL) {\r
+    mTcgDxeData.BsCap.TrEEPresentFlag = FALSE;\r
+  }\r
 \r
   //\r
   // Fill information\r
   //\r
-  DEBUG ((EFI_D_ERROR, "TrEE.ProtocolVersion  - %02x.%02x\n", mTcgDxeData.BsCap.ProtocolVersion.Major, mTcgDxeData.BsCap.ProtocolVersion.Minor));\r
-  DEBUG ((EFI_D_ERROR, "TrEE.StructureVersion - %02x.%02x\n", mTcgDxeData.BsCap.StructureVersion.Major, mTcgDxeData.BsCap.StructureVersion.Minor));\r
+  DEBUG ((EFI_D_INFO, "TrEE.ProtocolVersion  - %02x.%02x\n", mTcgDxeData.BsCap.ProtocolVersion.Major, mTcgDxeData.BsCap.ProtocolVersion.Minor));\r
+  DEBUG ((EFI_D_INFO, "TrEE.StructureVersion - %02x.%02x\n", mTcgDxeData.BsCap.StructureVersion.Major, mTcgDxeData.BsCap.StructureVersion.Minor));\r
 \r
   Status = Tpm2GetCapabilityManufactureID (&mTcgDxeData.BsCap.ManufacturerID);\r
   if (EFI_ERROR (Status)) {\r
     DEBUG ((EFI_D_ERROR, "Tpm2GetCapabilityManufactureID fail!\n"));\r
   } else {\r
-    DEBUG ((EFI_D_ERROR, "Tpm2GetCapabilityManufactureID - %08x\n", mTcgDxeData.BsCap.ManufacturerID));\r
+    DEBUG ((EFI_D_INFO, "Tpm2GetCapabilityManufactureID - %08x\n", mTcgDxeData.BsCap.ManufacturerID));\r
   }\r
 \r
   DEBUG_CODE (\r
@@ -1880,7 +1846,7 @@ DriverEntry (
     if (EFI_ERROR (Status)) {\r
       DEBUG ((EFI_D_ERROR, "Tpm2GetCapabilityFirmwareVersion fail!\n"));\r
     } else {\r
-      DEBUG ((EFI_D_ERROR, "Tpm2GetCapabilityFirmwareVersion - %08x %08x\n", FirmwareVersion1, FirmwareVersion2));\r
+      DEBUG ((EFI_D_INFO, "Tpm2GetCapabilityFirmwareVersion - %08x %08x\n", FirmwareVersion1, FirmwareVersion2));\r
     }\r
   );\r
 \r
@@ -1890,7 +1856,7 @@ DriverEntry (
   } else {\r
     mTcgDxeData.BsCap.MaxCommandSize  = (UINT16)MaxCommandSize;\r
     mTcgDxeData.BsCap.MaxResponseSize = (UINT16)MaxResponseSize;\r
-    DEBUG ((EFI_D_ERROR, "Tpm2GetCapabilityMaxCommandResponseSize - %08x, %08x\n", MaxCommandSize, MaxResponseSize));\r
+    DEBUG ((EFI_D_INFO, "Tpm2GetCapabilityMaxCommandResponseSize - %08x, %08x\n", MaxCommandSize, MaxResponseSize));\r
   }\r
 \r
   Status = Tpm2GetCapabilityPcrs (&Pcrs);\r
@@ -1898,10 +1864,10 @@ DriverEntry (
     DEBUG ((EFI_D_ERROR, "Tpm2GetCapabilityPcrs fail!\n"));\r
     TpmHashAlgorithmBitmap = TREE_BOOT_HASH_ALG_SHA1;\r
   } else {\r
-    DEBUG ((EFI_D_ERROR, "Tpm2GetCapabilityPcrs Count - %08x\n", Pcrs.count));\r
+    DEBUG ((EFI_D_INFO, "Tpm2GetCapabilityPcrs Count - %08x\n", Pcrs.count));\r
     TpmHashAlgorithmBitmap = 0;\r
     for (Index = 0; Index < Pcrs.count; Index++) {\r
-      DEBUG ((EFI_D_ERROR, "hash - %x\n", Pcrs.pcrSelections[Index].hash));\r
+      DEBUG ((EFI_D_INFO, "hash - %x\n", Pcrs.pcrSelections[Index].hash));\r
       switch (Pcrs.pcrSelections[Index].hash) {\r
       case TPM_ALG_SHA1:\r
         TpmHashAlgorithmBitmap |= TREE_BOOT_HASH_ALG_SHA1;\r
@@ -1921,11 +1887,11 @@ DriverEntry (
       }\r
     }\r
   }\r
-  DEBUG ((EFI_D_ERROR, "TPM.HashAlgorithmBitmap - 0x%08x\n", TpmHashAlgorithmBitmap));\r
+  DEBUG ((EFI_D_INFO, "TPM.HashAlgorithmBitmap - 0x%08x\n", TpmHashAlgorithmBitmap));\r
 \r
-  DEBUG ((EFI_D_ERROR, "TrEE.SupportedEventLogs - 0x%08x\n", mTcgDxeData.BsCap.SupportedEventLogs));\r
+  DEBUG ((EFI_D_INFO, "TrEE.SupportedEventLogs - 0x%08x\n", mTcgDxeData.BsCap.SupportedEventLogs));\r
   mTcgDxeData.BsCap.HashAlgorithmBitmap = TpmHashAlgorithmBitmap;\r
-  DEBUG ((EFI_D_ERROR, "TrEE.HashAlgorithmBitmap - 0x%08x\n", mTcgDxeData.BsCap.HashAlgorithmBitmap));\r
+  DEBUG ((EFI_D_INFO, "TrEE.HashAlgorithmBitmap - 0x%08x\n", mTcgDxeData.BsCap.HashAlgorithmBitmap));\r
 \r
   if (mTcgDxeData.BsCap.TrEEPresentFlag) {\r
     //\r
@@ -1982,7 +1948,7 @@ DriverEntry (
   // Install TrEEProtocol\r
   //\r
   Status = InstallTrEE ();\r
-  DEBUG ((EFI_D_ERROR, "InstallTrEE - %r\n", Status));\r
+  DEBUG ((EFI_D_INFO, "InstallTrEE - %r\n", Status));\r
 \r
   return Status;\r
 }\r