TcgEventLogRecordLib.c 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204
  1. /** @file
  2. This library is used by other modules to measure data to TPM.
  3. Copyright (c) 2020, Intel Corporation. All rights reserved. <BR>
  4. SPDX-License-Identifier: BSD-2-Clause-Patent
  5. **/
  6. #include <Uefi/UefiBaseType.h>
  7. #include <Pi/PiFirmwareVolume.h>
  8. #include <Library/BaseMemoryLib.h>
  9. #include <Library/DebugLib.h>
  10. #include <Library/ReportStatusCodeLib.h>
  11. #include <Library/PcdLib.h>
  12. #include <Library/PrintLib.h>
  13. #include <Library/TcgEventLogRecordLib.h>
  14. #include <Library/TpmMeasurementLib.h>
  15. #include <IndustryStandard/UefiTcgPlatform.h>
  16. /**
  17. Get the FvName from the FV header.
  18. Causion: The FV is untrusted input.
  19. @param[in] FvBase Base address of FV image.
  20. @param[in] FvLength Length of FV image.
  21. @return FvName pointer
  22. @retval NULL FvName is NOT found
  23. **/
  24. VOID *
  25. TpmMeasurementGetFvName (
  26. IN EFI_PHYSICAL_ADDRESS FvBase,
  27. IN UINT64 FvLength
  28. )
  29. {
  30. EFI_FIRMWARE_VOLUME_HEADER *FvHeader;
  31. EFI_FIRMWARE_VOLUME_EXT_HEADER *FvExtHeader;
  32. if (FvBase >= MAX_ADDRESS) {
  33. return NULL;
  34. }
  35. if (FvLength >= MAX_ADDRESS - FvBase) {
  36. return NULL;
  37. }
  38. if (FvLength < sizeof (EFI_FIRMWARE_VOLUME_HEADER)) {
  39. return NULL;
  40. }
  41. FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)FvBase;
  42. if (FvHeader->Signature != EFI_FVH_SIGNATURE) {
  43. return NULL;
  44. }
  45. if (FvHeader->ExtHeaderOffset < sizeof (EFI_FIRMWARE_VOLUME_HEADER)) {
  46. return NULL;
  47. }
  48. if (FvHeader->ExtHeaderOffset + sizeof (EFI_FIRMWARE_VOLUME_EXT_HEADER) > FvLength) {
  49. return NULL;
  50. }
  51. FvExtHeader = (EFI_FIRMWARE_VOLUME_EXT_HEADER *)(UINTN)(FvBase + FvHeader->ExtHeaderOffset);
  52. return &FvExtHeader->FvName;
  53. }
  54. /**
  55. Measure a FirmwareBlob.
  56. @param[in] PcrIndex PcrIndex of the measurement.
  57. @param[in] Description Description for this FirmwareBlob.
  58. @param[in] FirmwareBlobBase Base address of this FirmwareBlob.
  59. @param[in] FirmwareBlobLength Size in bytes of this FirmwareBlob.
  60. @retval EFI_SUCCESS Operation completed successfully.
  61. @retval EFI_UNSUPPORTED TPM device not available.
  62. @retval EFI_OUT_OF_RESOURCES Out of memory.
  63. @retval EFI_DEVICE_ERROR The operation was unsuccessful.
  64. **/
  65. EFI_STATUS
  66. EFIAPI
  67. MeasureFirmwareBlob (
  68. IN UINT32 PcrIndex,
  69. IN CHAR8 *Description OPTIONAL,
  70. IN EFI_PHYSICAL_ADDRESS FirmwareBlobBase,
  71. IN UINT64 FirmwareBlobLength
  72. )
  73. {
  74. EFI_PLATFORM_FIRMWARE_BLOB FvBlob;
  75. PLATFORM_FIRMWARE_BLOB2_STRUCT FvBlob2;
  76. VOID *FvName;
  77. UINT32 EventType;
  78. VOID *EventLog;
  79. UINT32 EventLogSize;
  80. EFI_STATUS Status;
  81. FvName = TpmMeasurementGetFvName (FirmwareBlobBase, FirmwareBlobLength);
  82. if (((Description != NULL) || (FvName != NULL)) &&
  83. (PcdGet32 (PcdTcgPfpMeasurementRevision) >= TCG_EfiSpecIDEventStruct_SPEC_ERRATA_TPM2_REV_105))
  84. {
  85. if (Description != NULL) {
  86. AsciiSPrint ((CHAR8 *)FvBlob2.BlobDescription, sizeof (FvBlob2.BlobDescription), "%a", Description);
  87. } else {
  88. AsciiSPrint ((CHAR8 *)FvBlob2.BlobDescription, sizeof (FvBlob2.BlobDescription), "Fv(%g)", FvName);
  89. }
  90. FvBlob2.BlobDescriptionSize = sizeof (FvBlob2.BlobDescription);
  91. FvBlob2.BlobBase = FirmwareBlobBase;
  92. FvBlob2.BlobLength = FirmwareBlobLength;
  93. EventType = EV_EFI_PLATFORM_FIRMWARE_BLOB2;
  94. EventLog = &FvBlob2;
  95. EventLogSize = sizeof (FvBlob2);
  96. } else {
  97. FvBlob.BlobBase = FirmwareBlobBase;
  98. FvBlob.BlobLength = FirmwareBlobLength;
  99. EventType = EV_EFI_PLATFORM_FIRMWARE_BLOB;
  100. EventLog = &FvBlob;
  101. EventLogSize = sizeof (FvBlob);
  102. }
  103. Status = TpmMeasureAndLogData (
  104. PcrIndex,
  105. EventType,
  106. EventLog,
  107. EventLogSize,
  108. (VOID *)(UINTN)FirmwareBlobBase,
  109. FirmwareBlobLength
  110. );
  111. return Status;
  112. }
  113. /**
  114. Measure a HandoffTable.
  115. @param[in] PcrIndex PcrIndex of the measurement.
  116. @param[in] Description Description for this HandoffTable.
  117. @param[in] TableGuid GUID of this HandoffTable.
  118. @param[in] TableAddress Base address of this HandoffTable.
  119. @param[in] TableLength Size in bytes of this HandoffTable.
  120. @retval EFI_SUCCESS Operation completed successfully.
  121. @retval EFI_UNSUPPORTED TPM device not available.
  122. @retval EFI_OUT_OF_RESOURCES Out of memory.
  123. @retval EFI_DEVICE_ERROR The operation was unsuccessful.
  124. **/
  125. EFI_STATUS
  126. EFIAPI
  127. MeasureHandoffTable (
  128. IN UINT32 PcrIndex,
  129. IN CHAR8 *Description OPTIONAL,
  130. IN EFI_GUID *TableGuid,
  131. IN VOID *TableAddress,
  132. IN UINTN TableLength
  133. )
  134. {
  135. EFI_HANDOFF_TABLE_POINTERS HandoffTables;
  136. HANDOFF_TABLE_POINTERS2_STRUCT HandoffTables2;
  137. UINT32 EventType;
  138. VOID *EventLog;
  139. UINT32 EventLogSize;
  140. EFI_STATUS Status;
  141. if ((Description != NULL) &&
  142. (PcdGet32 (PcdTcgPfpMeasurementRevision) >= TCG_EfiSpecIDEventStruct_SPEC_ERRATA_TPM2_REV_105))
  143. {
  144. AsciiSPrint ((CHAR8 *)HandoffTables2.TableDescription, sizeof (HandoffTables2.TableDescription), "%a", Description);
  145. HandoffTables2.TableDescriptionSize = sizeof (HandoffTables2.TableDescription);
  146. HandoffTables2.NumberOfTables = 1;
  147. CopyGuid (&(HandoffTables2.TableEntry[0].VendorGuid), TableGuid);
  148. HandoffTables2.TableEntry[0].VendorTable = TableAddress;
  149. EventType = EV_EFI_HANDOFF_TABLES2;
  150. EventLog = &HandoffTables2;
  151. EventLogSize = sizeof (HandoffTables2);
  152. } else {
  153. HandoffTables.NumberOfTables = 1;
  154. CopyGuid (&(HandoffTables.TableEntry[0].VendorGuid), TableGuid);
  155. HandoffTables.TableEntry[0].VendorTable = TableAddress;
  156. EventType = EV_EFI_HANDOFF_TABLES;
  157. EventLog = &HandoffTables;
  158. EventLogSize = sizeof (HandoffTables);
  159. }
  160. Status = TpmMeasureAndLogData (
  161. PcrIndex,
  162. EventType,
  163. EventLog,
  164. EventLogSize,
  165. TableAddress,
  166. TableLength
  167. );
  168. return Status;
  169. }