Handle TPM device error and avoid deadloop in BDS.

If TPM error happens, set TPM flag to NOT present, so that trusted boot patch is disabled.
Also report status code for failure, so that platform may register handler to apply policy like force system reset, or disable TPM permanently.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: "Yao, Jiewen" <jiewen.yao@intel.com>
Reviewed-by: "Dong, Guo" <guo.dong@intel.com>




git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@16598 6f19259b-4bc3-4df7-8a09-765794883524

2 files changed, 42 insertions, 73 deletions

diff --git a/SecurityPkg/Tcg/TrEEDxe/TrEEDxe.c b/SecurityPkg/Tcg/TrEEDxe/TrEEDxe.c
index 54e505d136..58c4aff819 100644
--- a/SecurityPkg/Tcg/TrEEDxe/TrEEDxe.c
+++ b/SecurityPkg/Tcg/TrEEDxe/TrEEDxe.c
@@ -1,7 +1,7 @@
 /** @file

   This module implements TrEE Protocol.

   

-Copyright (c) 2013 - 2014, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2013 - 2015, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials 

 are licensed and made available under the terms and conditions of the BSD License 

 which accompanies this distribution.  The full text of the license may be found at 

@@ -48,6 +48,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Library/Tpm2DeviceLib.h>

 #include <Library/HashLib.h>

 #include <Library/PerformanceLib.h>

+#include <Library/ReportStatusCodeLib.h>

 

 #define PERF_ID_TREE_DXE  0x3120

 

@@ -64,16 +65,13 @@ typedef struct {
 typedef struct {

   EFI_GUID               *EventGuid;

   TREE_EVENT_LOG_FORMAT  LogFormat;

-  UINT32                 BootHashAlg;

-  UINT16                 DigestAlgID;

-  TPMI_ALG_HASH          TpmHashAlgo;

 } TREE_EVENT_INFO_STRUCT;

 

 TREE_EVENT_INFO_STRUCT mTreeEventInfo[] = {

-  {&gTcgEventEntryHobGuid,             TREE_EVENT_LOG_FORMAT_TCG_1_2,      TREE_BOOT_HASH_ALG_SHA1,     0,                       TPM_ALG_SHA1},

+  {&gTcgEventEntryHobGuid,             TREE_EVENT_LOG_FORMAT_TCG_1_2},

 };

 

-#define TCG_EVENT_LOG_AREA_COUNT_MAX   5

+#define TCG_EVENT_LOG_AREA_COUNT_MAX   2

 

 typedef struct {

   TREE_EVENT_LOG_FORMAT             EventLogFormat;

@@ -629,72 +627,6 @@ TcgDxeLogEvent (
 }

 

 /**

-  This function return hash algorithm from event log format.

-

-  @param[in]     EventLogFormat    Event log format.

-

-  @return hash algorithm.

-**/

-TPMI_ALG_HASH

-TrEEGetHashAlgoFromLogFormat (

-  IN      TREE_EVENT_LOG_FORMAT     EventLogFormat

-  )

-{

-  UINTN  Index;

-

-  for (Index = 0; Index < sizeof(mTreeEventInfo)/sizeof(mTreeEventInfo[0]); Index++) {

-    if (mTreeEventInfo[Index].LogFormat == EventLogFormat) {

-      return mTreeEventInfo[Index].TpmHashAlgo;

-    }

-  }

-  return TPM_ALG_SHA1;

-}

-

-/**

-  This function return hash algorithm ID from event log format.

-

-  @param[in]     EventLogFormat    Event log format.

-

-  @return hash algorithm ID.

-**/

-UINT16

-TrEEGetAlgIDFromLogFormat (

-  IN      TREE_EVENT_LOG_FORMAT     EventLogFormat

-  )

-{

-  UINTN  Index;

-

-  for (Index = 0; Index < sizeof(mTreeEventInfo)/sizeof(mTreeEventInfo[0]); Index++) {

-    if (mTreeEventInfo[Index].LogFormat == EventLogFormat) {

-      return mTreeEventInfo[Index].DigestAlgID;

-    }

-  }

-  return 0;

-}

-

-/**

-  This function return boot hash algorithm from event log format.

-

-  @param[in]     EventLogFormat    Event log format.

-

-  @return boot hash algorithm.

-**/

-UINT32

-TrEEGetBootHashAlgFromLogFormat (

-  IN      TREE_EVENT_LOG_FORMAT     EventLogFormat

-  )

-{

-  UINTN  Index;

-

-  for (Index = 0; Index < sizeof(mTreeEventInfo)/sizeof(mTreeEventInfo[0]); Index++) {

-    if (mTreeEventInfo[Index].LogFormat == EventLogFormat) {

-      return mTreeEventInfo[Index].BootHashAlg;

-    }

-  }

-  return TREE_BOOT_HASH_ALG_SHA1;

-}

-

-/**

   This function get digest from digest list.

 

   @param HashAlg    digest algorithm

@@ -811,6 +743,10 @@ TcgDxeHashLogExtendEvent (
 {

   EFI_STATUS                        Status;

   TPML_DIGEST_VALUES                DigestList;

+  

+  if (!mTcgDxeData.BsCap.TrEEPresentFlag) {

+    return EFI_DEVICE_ERROR;

+  }

 

   Status = HashAndExtend (

              NewEventHdr->PCRIndex,

@@ -824,6 +760,15 @@ TcgDxeHashLogExtendEvent (
     }

   }

 

+  if (Status == EFI_DEVICE_ERROR) {

+    DEBUG ((EFI_D_ERROR, "TcgDxeHashLogExtendEvent - %r. Disable TPM.\n", Status));

+    mTcgDxeData.BsCap.TrEEPresentFlag = FALSE;

+    REPORT_STATUS_CODE (

+      EFI_ERROR_CODE | EFI_ERROR_MINOR,

+      (PcdGet32 (PcdStatusCodeSubClassTpmDevice) | EFI_P_EC_INTERFACE_ERROR)

+      );

+  }

+

   return Status;

 }

 

@@ -893,6 +838,14 @@ TreeHashLogExtendEvent (
         Status = TcgDxeLogHashEvent (&DigestList, &NewEventHdr, Event->Event);

       }

     }

+    if (Status == EFI_DEVICE_ERROR) {

+      DEBUG ((EFI_D_ERROR, "MeasurePeImageAndExtend - %r. Disable TPM.\n", Status));

+      mTcgDxeData.BsCap.TrEEPresentFlag = FALSE;

+      REPORT_STATUS_CODE (

+        EFI_ERROR_CODE | EFI_ERROR_MINOR,

+        (PcdGet32 (PcdStatusCodeSubClassTpmDevice) | EFI_P_EC_INTERFACE_ERROR)

+        );

+    }

   } else {

     Status = TcgDxeHashLogExtendEvent (

                Flags,

@@ -1614,6 +1567,9 @@ OnReadyToBoot (
     Status = TcgMeasureAction (

                EFI_CALLING_EFI_APPLICATION

                );

+    if (EFI_ERROR (Status)) {

+      DEBUG ((EFI_D_ERROR, "%s not Measured. Error!\n", EFI_CALLING_EFI_APPLICATION));

+    }

 

     //

     // 2. Draw a line between pre-boot env and entering post-boot env.

@@ -1621,6 +1577,9 @@ OnReadyToBoot (
     //

     for (PcrIndex = 0; PcrIndex < 7; PcrIndex++) {

       Status = MeasureSeparatorEvent (PcrIndex);

+      if (EFI_ERROR (Status)) {

+        DEBUG ((EFI_D_ERROR, "Seperator Event not Measured. Error!\n"));

+      }

     }

 

     //

@@ -1641,6 +1600,9 @@ OnReadyToBoot (
     Status = TcgMeasureAction (

                EFI_RETURNING_FROM_EFI_APPLICATOIN

                );

+    if (EFI_ERROR (Status)) {

+      DEBUG ((EFI_D_ERROR, "%s not Measured. Error!\n", EFI_RETURNING_FROM_EFI_APPLICATOIN));

+    }

   }

 

   DEBUG ((EFI_D_INFO, "TPM2 TrEEDxe Measure Data when ReadyToBoot\n"));

@@ -1858,6 +1820,10 @@ DriverEntry (
     DEBUG ((EFI_D_ERROR, "TPM not detected!\n"));

     return Status;

   }

+  

+  if (GetFirstGuidHob (&gTpmErrorHobGuid) != NULL) {

+    mTcgDxeData.BsCap.TrEEPresentFlag = FALSE;

+  }

 

   //

   // Fill information

diff --git a/SecurityPkg/Tcg/TrEEDxe/TrEEDxe.inf b/SecurityPkg/Tcg/TrEEDxe/TrEEDxe.inf
index ef8505cf39..e564c8f2a5 100644
--- a/SecurityPkg/Tcg/TrEEDxe/TrEEDxe.inf
+++ b/SecurityPkg/Tcg/TrEEDxe/TrEEDxe.inf
@@ -7,7 +7,7 @@
 #  This external input must be validated carefully to avoid security issue like

 #  buffer overflow, integer overflow.

 #

-# Copyright (c) 2013 - 2014, Intel Corporation. All rights reserved.<BR>

+# Copyright (c) 2013 - 2015, Intel Corporation. All rights reserved.<BR>

 # This program and the accompanying materials

 # are licensed and made available under the terms and conditions of the BSD License

 # which accompanies this distribution. The full text of the license may be found at

@@ -57,6 +57,7 @@
   Tpm2DeviceLib

   HashLib

   PerformanceLib

+  ReportStatusCodeLib

 

 [Guids]

   ## SOMETIMES_CONSUMES     ## SystemTable           # Smbios Table

@@ -74,6 +75,7 @@
   gEfiImageSecurityDatabaseGuid

     

   gTcgEventEntryHobGuid                              ## SOMETIMES_CONSUMES  ## HOB

+  gTpmErrorHobGuid                                   ## SOMETIMES_CONSUMES  ## HOB

   gEfiEventExitBootServicesGuid                      ## CONSUMES            ## Event

   gEventExitBootServicesFailedGuid                   ## SOMETIMES_CONSUMES  ## Event

   gEfiTpmDeviceInstanceNoneGuid                      ## SOMETIMES_CONSUMES  ## GUID       # TPM device identifier

@@ -95,6 +97,7 @@
   gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultOemRevision                  ## SOMETIMES_CONSUMES

   gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultCreatorId                    ## SOMETIMES_CONSUMES

   gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiDefaultCreatorRevision              ## SOMETIMES_CONSUMES

+  gEfiSecurityPkgTokenSpaceGuid.PcdStatusCodeSubClassTpmDevice              ## SOMETIMES_CONSUMES

 

 [Depex]

   TRUE