TdxMeasurementHob.c 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259
  1. /** @file
  2. Build GuidHob for tdx measurement.
  3. Copyright (c) 2022 - 2023, Intel Corporation. All rights reserved.<BR>
  4. SPDX-License-Identifier: BSD-2-Clause-Patent
  5. **/
  6. #include <PiPei.h>
  7. #include <Library/BaseLib.h>
  8. #include <Library/BaseMemoryLib.h>
  9. #include <Library/DebugLib.h>
  10. #include <IndustryStandard/Tpm20.h>
  11. #include <IndustryStandard/UefiTcgPlatform.h>
  12. #include <Library/HobLib.h>
  13. #include <Library/PrintLib.h>
  14. #include <Library/TcgEventLogRecordLib.h>
  15. #include <WorkArea.h>
  16. #pragma pack(1)
  17. #define HANDOFF_TABLE_DESC "TdxTable"
  18. typedef struct {
  19. UINT8 TableDescriptionSize;
  20. UINT8 TableDescription[sizeof (HANDOFF_TABLE_DESC)];
  21. UINT64 NumberOfTables;
  22. EFI_CONFIGURATION_TABLE TableEntry[1];
  23. } TDX_HANDOFF_TABLE_POINTERS2;
  24. #pragma pack()
  25. #define FV_HANDOFF_TABLE_DESC "Fv(XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX)"
  26. typedef PLATFORM_FIRMWARE_BLOB2_STRUCT CFV_HANDOFF_TABLE_POINTERS2;
  27. /**
  28. * Build GuidHob for Tdx measurement.
  29. *
  30. * Tdx measurement includes the measurement of TdHob and CFV. They're measured
  31. * and extended to RTMR registers in SEC phase. Because at that moment the Hob
  32. * service are not available. So the values of the measurement are saved in
  33. * workarea and will be built into GuidHob after the Hob service is ready.
  34. *
  35. * @param RtmrIndex RTMR index
  36. * @param EventType Event type
  37. * @param EventData Event data
  38. * @param EventSize Size of event data
  39. * @param HashValue Hash value
  40. * @param HashSize Size of hash
  41. *
  42. * @retval EFI_SUCCESS Successfully build the GuidHobs
  43. * @retval Others Other error as indicated
  44. */
  45. STATIC
  46. EFI_STATUS
  47. BuildTdxMeasurementGuidHob (
  48. UINT32 RtmrIndex,
  49. UINT32 EventType,
  50. UINT8 *EventData,
  51. UINT32 EventSize,
  52. UINT8 *HashValue,
  53. UINT32 HashSize
  54. )
  55. {
  56. VOID *EventHobData;
  57. UINT8 *Ptr;
  58. TPML_DIGEST_VALUES *TdxDigest;
  59. if (HashSize != SHA384_DIGEST_SIZE) {
  60. return EFI_INVALID_PARAMETER;
  61. }
  62. #define TDX_DIGEST_VALUE_LEN (sizeof (UINT32) + sizeof (TPMI_ALG_HASH) + SHA384_DIGEST_SIZE)
  63. EventHobData = BuildGuidHob (
  64. &gCcEventEntryHobGuid,
  65. sizeof (TCG_PCRINDEX) + sizeof (TCG_EVENTTYPE) +
  66. TDX_DIGEST_VALUE_LEN +
  67. sizeof (UINT32) + EventSize
  68. );
  69. if (EventHobData == NULL) {
  70. return EFI_OUT_OF_RESOURCES;
  71. }
  72. Ptr = (UINT8 *)EventHobData;
  73. //
  74. // There are 2 types of measurement registers in TDX: MRTD and RTMR[0-3].
  75. // According to UEFI Spec 2.10 Section 38.4.1, RTMR[0-3] is mapped to MrIndex[1-4].
  76. // So RtmrIndex must be increased by 1 before the event log is created.
  77. //
  78. RtmrIndex++;
  79. CopyMem (Ptr, &RtmrIndex, sizeof (UINT32));
  80. Ptr += sizeof (UINT32);
  81. CopyMem (Ptr, &EventType, sizeof (TCG_EVENTTYPE));
  82. Ptr += sizeof (TCG_EVENTTYPE);
  83. TdxDigest = (TPML_DIGEST_VALUES *)Ptr;
  84. TdxDigest->count = 1;
  85. TdxDigest->digests[0].hashAlg = TPM_ALG_SHA384;
  86. CopyMem (
  87. TdxDigest->digests[0].digest.sha384,
  88. HashValue,
  89. SHA384_DIGEST_SIZE
  90. );
  91. Ptr += TDX_DIGEST_VALUE_LEN;
  92. CopyMem (Ptr, &EventSize, sizeof (UINT32));
  93. Ptr += sizeof (UINT32);
  94. CopyMem (Ptr, (VOID *)EventData, EventSize);
  95. Ptr += EventSize;
  96. return EFI_SUCCESS;
  97. }
  98. /**
  99. Get the FvName from the FV header.
  100. Causion: The FV is untrusted input.
  101. @param[in] FvBase Base address of FV image.
  102. @param[in] FvLength Length of FV image.
  103. @return FvName pointer
  104. @retval NULL FvName is NOT found
  105. **/
  106. VOID *
  107. GetFvName (
  108. IN EFI_PHYSICAL_ADDRESS FvBase,
  109. IN UINT64 FvLength
  110. )
  111. {
  112. EFI_FIRMWARE_VOLUME_HEADER *FvHeader;
  113. EFI_FIRMWARE_VOLUME_EXT_HEADER *FvExtHeader;
  114. if (FvBase >= MAX_ADDRESS) {
  115. return NULL;
  116. }
  117. if (FvLength >= MAX_ADDRESS - FvBase) {
  118. return NULL;
  119. }
  120. if (FvLength < sizeof (EFI_FIRMWARE_VOLUME_HEADER)) {
  121. return NULL;
  122. }
  123. FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *)(UINTN)FvBase;
  124. if (FvHeader->ExtHeaderOffset < sizeof (EFI_FIRMWARE_VOLUME_HEADER)) {
  125. return NULL;
  126. }
  127. if (FvHeader->ExtHeaderOffset + sizeof (EFI_FIRMWARE_VOLUME_EXT_HEADER) > FvLength) {
  128. return NULL;
  129. }
  130. FvExtHeader = (EFI_FIRMWARE_VOLUME_EXT_HEADER *)(UINTN)(FvBase + FvHeader->ExtHeaderOffset);
  131. return &FvExtHeader->FvName;
  132. }
  133. /**
  134. Build the GuidHob for tdx measurements which were done in SEC phase.
  135. The measurement values are stored in WorkArea.
  136. @retval EFI_SUCCESS The GuidHob is built successfully
  137. @retval Others Other errors as indicated
  138. **/
  139. EFI_STATUS
  140. InternalBuildGuidHobForTdxMeasurement (
  141. VOID
  142. )
  143. {
  144. EFI_STATUS Status;
  145. OVMF_WORK_AREA *WorkArea;
  146. VOID *TdHobList;
  147. TDX_HANDOFF_TABLE_POINTERS2 HandoffTables;
  148. VOID *FvName;
  149. CFV_HANDOFF_TABLE_POINTERS2 FvBlob2;
  150. EFI_PHYSICAL_ADDRESS FvBase;
  151. UINT64 FvLength;
  152. UINT8 *HashValue;
  153. if (!TdIsEnabled ()) {
  154. ASSERT (FALSE);
  155. return EFI_UNSUPPORTED;
  156. }
  157. WorkArea = (OVMF_WORK_AREA *)FixedPcdGet32 (PcdOvmfWorkAreaBase);
  158. if (WorkArea == NULL) {
  159. return EFI_ABORTED;
  160. }
  161. Status = EFI_SUCCESS;
  162. //
  163. // Build the GuidHob for TdHob measurement
  164. //
  165. TdHobList = (VOID *)(UINTN)FixedPcdGet32 (PcdOvmfSecGhcbBase);
  166. if (WorkArea->TdxWorkArea.SecTdxWorkArea.TdxMeasurementsData.MeasurementsBitmap & TDX_MEASUREMENT_TDHOB_BITMASK) {
  167. HashValue = WorkArea->TdxWorkArea.SecTdxWorkArea.TdxMeasurementsData.TdHobHashValue;
  168. HandoffTables.TableDescriptionSize = sizeof (HandoffTables.TableDescription);
  169. CopyMem (HandoffTables.TableDescription, HANDOFF_TABLE_DESC, sizeof (HandoffTables.TableDescription));
  170. HandoffTables.NumberOfTables = 1;
  171. CopyGuid (&(HandoffTables.TableEntry[0].VendorGuid), &gUefiOvmfPkgTokenSpaceGuid);
  172. HandoffTables.TableEntry[0].VendorTable = TdHobList;
  173. Status = BuildTdxMeasurementGuidHob (
  174. 0, // RtmrIndex
  175. EV_EFI_HANDOFF_TABLES2, // EventType
  176. (UINT8 *)(UINTN)&HandoffTables, // EventData
  177. sizeof (HandoffTables), // EventSize
  178. HashValue, // HashValue
  179. SHA384_DIGEST_SIZE // HashSize
  180. );
  181. }
  182. if (EFI_ERROR (Status)) {
  183. ASSERT (FALSE);
  184. return Status;
  185. }
  186. //
  187. // Build the GuidHob for Cfv measurement
  188. //
  189. if (WorkArea->TdxWorkArea.SecTdxWorkArea.TdxMeasurementsData.MeasurementsBitmap & TDX_MEASUREMENT_CFVIMG_BITMASK) {
  190. HashValue = WorkArea->TdxWorkArea.SecTdxWorkArea.TdxMeasurementsData.CfvImgHashValue;
  191. FvBase = (UINT64)PcdGet32 (PcdOvmfFlashNvStorageVariableBase);
  192. FvLength = (UINT64)PcdGet32 (PcdCfvRawDataSize);
  193. FvBlob2.BlobDescriptionSize = sizeof (FvBlob2.BlobDescription);
  194. CopyMem (FvBlob2.BlobDescription, FV_HANDOFF_TABLE_DESC, sizeof (FvBlob2.BlobDescription));
  195. FvName = GetFvName (FvBase, FvLength);
  196. if (FvName != NULL) {
  197. AsciiSPrint ((CHAR8 *)FvBlob2.BlobDescription, sizeof (FvBlob2.BlobDescription), "Fv(%g)", FvName);
  198. }
  199. FvBlob2.BlobBase = FvBase;
  200. FvBlob2.BlobLength = FvLength;
  201. Status = BuildTdxMeasurementGuidHob (
  202. 0, // RtmrIndex
  203. EV_EFI_PLATFORM_FIRMWARE_BLOB2, // EventType
  204. (VOID *)&FvBlob2, // EventData
  205. sizeof (FvBlob2), // EventSize
  206. HashValue, // HashValue
  207. SHA384_DIGEST_SIZE // HashSize
  208. );
  209. }
  210. if (EFI_ERROR (Status)) {
  211. ASSERT (FALSE);
  212. return Status;
  213. }
  214. return EFI_SUCCESS;
  215. }