TpmTestingPkg: Add InputChannelLib (#352)

## Description Adds a new library class (InputChannelLib) that allows the TPM replay event log to be passed through a platform-specific mechanism. - [x] Impacts functionality? - **Functionality** - Does the change ultimately impact how firmware functions? - Examples: Add a new library, publish a new PPI, update an algorithm, ... - [ ] Impacts security? - **Security** - Does the change have a direct security impact on an application, flow, or firmware? - Examples: Crypto algorithm change, buffer overflow fix, parameter validation improvement, ... - [ ] Breaking change? - **Breaking change** - Will anyone consuming this change experience a break in build or boot behavior? - Examples: Add a new library class, move a module to a different repo, call a function in a new library class in a pre-existing module, ... - [ ] Includes tests? - **Tests** - Does the change include any explicit test code? - Examples: Unit tests, integration tests, robot tests, ... - [ ] Includes documentation? - **Documentation** - Does the change contain explicit documentation additions outside direct code modifications (and comments)? - Examples: Update readme file, add feature readme file, link to documentation on an a separate Web page, ... ## How This Was Tested - Passed FW CFG TPM event log through QemuQ35Pkg - Verified library integrated without a custom log being passed uses lower priority input channels as expected - Verified BaseInputChannelLibNull is functionally usable for skipping custom log input. ## Integration Instructions Add `InputChannelLib|TpmTestingPkg/Library/BaseInputChannelLibNull/BaseInputChannelLibNull.inf` to a platform that uses the TPM Replay feature but does not provide a custom input channel instance. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
microsoft · Dec 14, 2023 · 345dd87 · 345dd87
1 parent d4a4622
commit 345dd87
Show file tree

Hide file tree

Showing 13 changed files with 115 additions and 8 deletions.
diff --git a/...stingPkg/TpmReplayPei/TpmReplayEventLog.h → ...stingPkg/Include/Guid/TpmReplayEventLog.h b/...stingPkg/TpmReplayPei/TpmReplayEventLog.h → ...stingPkg/Include/Guid/TpmReplayEventLog.h
diff --git a/TpmTestingPkg/Include/Library/InputChannelLib.h b/TpmTestingPkg/Include/Library/InputChannelLib.h
@@ -0,0 +1,36 @@
+/** @file
+  TPM Event Log Input Channel Library
+
+  Allows a TPM replay log to be passed through a custom interface.
+
+  Copyright (c) Microsoft Corporation.
+  SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+
+#ifndef INPUT_CHANNEL_LIB_H
+#define INPUT_CHANNEL_LIB_H
+
+#include <Guid/TpmReplayEventLog.h>
+
+/**
+  Retrieves a TPM Replay Event Log through a custom interface.
+
+  @param[out] ReplayEventLog            A pointer to a pointer to the buffer to hold the event log data.
+  @param[out] ReplayEventLogSize        The size of the data placed in the buffer.
+
+  @retval    EFI_SUCCESS            The TPM Replay event log was returned successfully.
+  @retval    EFI_INVALID_PARAMETER  A pointer argument given is NULL.
+  @retval    EFI_UNSUPPORTED        The function is not implemented yet. The arguments are not used.
+  @retval    EFI_COMPROMISED_DATA   The event log data found is not valid.
+  @retval    EFI_NOT_FOUND          The event log data was not found. The input channel is ignored in this case.
+
+**/
+EFI_STATUS
+EFIAPI
+GetReplayEventLogFromCustomInterface (
+  OUT VOID   **ReplayEventLog,
+  OUT UINTN  *ReplayEventLogSize
+  );
+
+#endif
diff --git a/TpmTestingPkg/Library/BaseInputChannelLibNull/BaseInputChannelLibNull.c b/TpmTestingPkg/Library/BaseInputChannelLibNull/BaseInputChannelLibNull.c
@@ -0,0 +1,33 @@
+/** @file
+  A null instance of the Input Channel Library.
+
+  Copyright (c) Microsoft Corporation.
+  SPDX-License-Identifier: BSD-2-Clause-Patent
+
+**/
+
+#include <Uefi.h>
+#include <Library/InputChannelLib.h>
+
+/**
+  Retrieves a TPM Replay Event Log through a custom interface.
+
+  @param[out] ReplayEventLog            A pointer to a pointer to the buffer to hold the event log data.
+  @param[out] ReplayEventLogSize        The size of the data placed in the buffer.
+
+  @retval    EFI_SUCCESS            The TPM Replay event log was returned successfully.
+  @retval    EFI_INVALID_PARAMETER  A pointer argument given is NULL.
+  @retval    EFI_UNSUPPORTED        The function is not implemented yet. The arguments are not used.
+  @retval    EFI_COMPROMISED_DATA   The event log data found is not valid.
+  @retval    EFI_NOT_FOUND          The event log data was not found. The input channel is ignored in this case.
+
+**/
+EFI_STATUS
+EFIAPI
+GetReplayEventLogFromCustomInterface (
+  OUT VOID   **ReplayEventLog,
+  OUT UINTN  *ReplayEventLogSize
+  )
+{
+  return EFI_UNSUPPORTED;
+}
diff --git a/TpmTestingPkg/Library/BaseInputChannelLibNull/BaseInputChannelLibNull.inf b/TpmTestingPkg/Library/BaseInputChannelLibNull/BaseInputChannelLibNull.inf
@@ -0,0 +1,24 @@
+## @file
+# A null instance of the Input Channel Library.
+#
+# Copyright (c) Microsoft Corporation.
+#
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+#
+##
+
+[Defines]
+  INF_VERSION           = 0x00010005
+  BASE_NAME             = BaseInputChannelLibNull
+  FILE_GUID             = F35B1671-08BC-4231-9CEB-A08E809E32FF
+  MODULE_TYPE           = BASE
+  VERSION_STRING        = 1.0
+  LIBRARY_CLASS         = InputChannelLib
+
+[Packages]
+  MdePkg/MdePkg.dec
+  SecurityPkg/SecurityPkg.dec
+  TpmTestingPkg/TpmTestingPkg.dec
+
+[Sources]
+  BaseInputChannelLibNull.c
diff --git a/TpmTestingPkg/TpmReplayPei/InputChannel/TpmReplayFfsFilePei.c b/TpmTestingPkg/TpmReplayPei/InputChannel/TpmReplayFfsFilePei.c
@@ -8,10 +8,10 @@
 **/
 
 #include <PiPei.h>
+#include <Guid/TpmReplayEventLog.h>
 #include <Library/DebugLib.h>
 #include <Library/PeiServicesLib.h>
 
-#include "../TpmReplayEventLog.h"
 #include "TpmReplayInputChannelInternal.h"
 
 /**

diff --git a/TpmTestingPkg/TpmReplayPei/InputChannel/TpmReplayInputChannel.c b/TpmTestingPkg/TpmReplayPei/InputChannel/TpmReplayInputChannel.c
@@ -8,9 +8,10 @@
 **/
 
 #include <Uefi.h>
+#include <Guid/TpmReplayEventLog.h>
 #include <Library/DebugLib.h>
+#include <Library/InputChannelLib.h>
 
-#include "../TpmReplayEventLog.h"
 #include "TpmReplayInputChannel.h"
 #include "TpmReplayInputChannelInternal.h"
 
@@ -48,10 +49,20 @@ GetReplayEventLog (
     goto Done;
   }
 
-  // Second priority: FFS in the FW image
+  // Second priority: Custom interface
+  Status = GetReplayEventLogFromCustomInterface (&ReplayEventLogData, &ReplayEventLogDataSize);
+  if (!EFI_ERROR (Status)) {
+    DEBUG ((DEBUG_INFO, "[%a] - Using TPM replay event log from a custom interface.\n", __func__));
+    goto Done;
+  } else if (EFI_ERROR (Status) && ((Status != EFI_UNSUPPORTED) && (Status != EFI_NOT_FOUND))) {
+    DEBUG ((DEBUG_ERROR, "[%a] - TPM replay event log from custom interface failed - %r.\n", __func__, Status));
+  }
+
+  // Third priority: FFS in the FW image
   Status = GetTpmReplayEventLogFfsFile (&ReplayEventLogData, &ReplayEventLogDataSize);
   ASSERT (Status == EFI_SUCCESS || Status == EFI_NOT_FOUND);
   if (!EFI_ERROR (Status)) {
+    DEBUG ((DEBUG_INFO, "[%a] - Using TPM replay event log from the firmware flash image.\n", __func__));
     goto Done;
   }
 

diff --git a/TpmTestingPkg/TpmReplayPei/InputChannel/TpmReplayInputChannel.h b/TpmTestingPkg/TpmReplayPei/InputChannel/TpmReplayInputChannel.h
@@ -10,7 +10,7 @@
 #ifndef TPM_REPLAY_INPUT_CHANNEL_H_
 #define TPM_REPLAY_INPUT_CHANNEL_H_
 
-#include "../TpmReplayEventLog.h"
+#include <Guid/TpmReplayEventLog.h>
 
 /**
   Retrieves a TPM Replay Event Log from the highest priority input channel.

diff --git a/TpmTestingPkg/TpmReplayPei/InputChannel/TpmReplayInputChannelInternal.h b/TpmTestingPkg/TpmReplayPei/InputChannel/TpmReplayInputChannelInternal.h
@@ -10,7 +10,7 @@
 #ifndef TPM_REPLAY_INPUT_CHANNEL_INTERNAL_H_
 #define TPM_REPLAY_INPUT_CHANNEL_INTERNAL_H_
 
-#include "../TpmReplayEventLog.h"
+#include <Guid/TpmReplayEventLog.h>
 
 /**
   Retrieves a TPM Replay Event Log from a FFS file.

diff --git a/TpmTestingPkg/TpmReplayPei/InputChannel/TpmReplayUefiVariable.c b/TpmTestingPkg/TpmReplayPei/InputChannel/TpmReplayUefiVariable.c
@@ -8,12 +8,12 @@
 **/
 
 #include <PiPei.h>
+#include <Guid/TpmReplayEventLog.h>
 #include <Library/DebugLib.h>
 #include <Library/MemoryAllocationLib.h>
 #include <Library/PeiServicesLib.h>
 #include <Ppi/ReadOnlyVariable2.h>
 
-#include "../TpmReplayEventLog.h"
 #include "TpmReplayInputChannelInternal.h"
 
 /**

diff --git a/TpmTestingPkg/TpmReplayPei/Pei/TpmReplayPei.inf b/TpmTestingPkg/TpmReplayPei/Pei/TpmReplayPei.inf
@@ -20,7 +20,6 @@
   ENTRY_POINT         = TpmReplayPeiEntryPoint
 
 [Sources]
-  ../TpmReplayEventLog.h
   ../TpmReplayReportingManager.c
   ../TpmReplayReportingManager.h
   ../TpmReplayTcg.c
@@ -51,6 +50,7 @@
   DebugLib
   FvMeasurementExclusionLib
   HobLib
+  InputChannelLib
   IoLib
   MemoryAllocationLib
   PcdLib

diff --git a/TpmTestingPkg/TpmReplayPei/Pei/TpmReplayPeiTpmInitialized.c b/TpmTestingPkg/TpmReplayPei/Pei/TpmReplayPeiTpmInitialized.c
@@ -15,6 +15,7 @@
 #include <PiPei.h>
 
 #include <Guid/TcgEventHob.h>
+#include <Guid/TpmReplayEventLog.h>
 #include <IndustryStandard/Tpm2Acpi.h>          // For locality code
 #include <IndustryStandard/TpmPtp.h>            // For locality code
 #include <Library/BaseLib.h>
@@ -32,7 +33,6 @@
 
 #include <TpmReplayConfig.h>
 #include "../InputChannel/TpmReplayInputChannel.h"
-#include "../TpmReplayEventLog.h"
 #include "../TpmReplayReportingManager.h"
 #include "../TpmReplayTcg.h"
 #include "../TpmReplayTcgRegs.h"

diff --git a/TpmTestingPkg/TpmTestingPkg.dec b/TpmTestingPkg/TpmTestingPkg.dec
@@ -20,6 +20,7 @@
 
 [LibraryClasses]
   FvMeasurementExclusionLib|Include/Library/FvMeasurementExclusionLib.h
+  InputChannelLib|Include/Library/InputChannelLib.h
 
 [Guids]
   ## Tokenspace GUID for TPM Testing Package PCDs

diff --git a/TpmTestingPkg/TpmTestingPkg.dsc b/TpmTestingPkg/TpmTestingPkg.dsc
@@ -23,6 +23,7 @@
   CpuLib|MdePkg/Library/BaseCpuLib/BaseCpuLib.inf
   DebugLib|MdePkg/Library/BaseDebugLibNull/BaseDebugLibNull.inf
   FvMeasurementExclusionLib|TpmTestingPkg/Library/BaseFvMeasurementExclusionLibNull/BaseFvMeasurementExclusionLibNull.inf
+  InputChannelLib|TpmTestingPkg/Library/BaseInputChannelLibNull/BaseInputChannelLibNull.inf
   IoLib|MdePkg/Library/BaseIoLibIntrinsic/BaseIoLibIntrinsic.inf
   PcdLib|MdePkg/Library/BasePcdLibNull/BasePcdLibNull.inf
   PciExpressLib|MdePkg/Library/BasePciExpressLib/BasePciExpressLib.inf
@@ -85,6 +86,7 @@
 
 [Components]
   TpmTestingPkg/Library/BaseFvMeasurementExclusionLibNull/BaseFvMeasurementExclusionLibNull.inf
+  TpmTestingPkg/Library/BaseInputChannelLibNull/BaseInputChannelLibNull.inf
   TpmTestingPkg/TpmReplayPei/Pei/TpmReplayPei.inf
 
   #