* [PATCH 0/2] Introduce TdProtocol into EDK2 @ 2021-09-14 1:57 Min Xu 2021-09-14 1:57 ` [PATCH 1/2] MdePkg: Introduce TdProtocol for TD-Guest firmware Min Xu 2021-09-14 1:57 ` [PATCH 2/2] SecurityPkg: Add DxeTdMeasureBootLib for TD measure boot Min Xu 0 siblings, 2 replies; 9+ messages in thread From: Min Xu @ 2021-09-14 1:57 UTC (permalink / raw) To: devel Cc: Min Xu, Michael D Kinney, Liming Gao, Zhiguang Liu, Jiewen Yao, Jian J Wang, Ken Lu BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=3625 If TD-Guest firmware supports measurement and an event is created, TD-Guest firmware is designed to report the event log with the same data structure in TCG-Platform-Firmware-Profile specification with EFI_TCG2_EVENT_LOG_FORMAT_TCG_2 format. The TD-Guest firmware supports measurement, the TD Guest Firmware is designed to produce EFI_TD_PROTOCOL with new GUID EFI_TD_PROTOCOL_GUID to report event log and provides hash capability. Patch #1: Introduce the TD Protocol definition into MdePkg Patch #2: Add DxeTdMeasureBootLib into SecurityPkg. This library instance provides security service of TD measure boot. Cc: Michael D Kinney <michael.d.kinney@intel.com> Cc: Liming Gao <gaoliming@byosoft.com.cn> Cc: Zhiguang Liu <zhiguang.liu@intel.com> Cc: Jiewen Yao <jiewen.yao@intel.com> Cc: Jian J Wang <jian.j.wang@intel.com> Cc: Ken Lu <ken.lu@intel.com> Signed-off-by: Min Xu <min.m.xu@intel.com> Min Xu (2): MdePkg: Introduce TdProtocol for TD-Guest firmware SecurityPkg: Add DxeTdMeasureBootLib for TD measure boot MdePkg/Include/Protocol/TdProtocol.h | 305 ++++++++ MdePkg/MdePkg.dec | 3 + .../DxeTdMeasureBootLib/DxeTdMeasureBootLib.c | 688 ++++++++++++++++++ .../DxeTdMeasureBootLib.inf | 61 ++ .../DxeTdMeasureBootLib.uni | 21 + SecurityPkg/SecurityPkg.dsc | 5 + 6 files changed, 1083 insertions(+) create mode 100644 MdePkg/Include/Protocol/TdProtocol.h create mode 100644 SecurityPkg/Library/DxeTdMeasureBootLib/DxeTdMeasureBootLib.c create mode 100644 SecurityPkg/Library/DxeTdMeasureBootLib/DxeTdMeasureBootLib.inf create mode 100644 SecurityPkg/Library/DxeTdMeasureBootLib/DxeTdMeasureBootLib.uni -- 2.29.2.windows.2 ^ permalink raw reply [flat|nested] 9+ messages in thread
* [PATCH 1/2] MdePkg: Introduce TdProtocol for TD-Guest firmware 2021-09-14 1:57 [PATCH 0/2] Introduce TdProtocol into EDK2 Min Xu @ 2021-09-14 1:57 ` Min Xu 2021-09-14 2:05 ` Yao, Jiewen 2021-09-15 5:49 ` 回复: [edk2-devel] " gaoliming 2021-09-14 1:57 ` [PATCH 2/2] SecurityPkg: Add DxeTdMeasureBootLib for TD measure boot Min Xu 1 sibling, 2 replies; 9+ messages in thread From: Min Xu @ 2021-09-14 1:57 UTC (permalink / raw) To: devel Cc: Min Xu, Michael D Kinney, Liming Gao, Zhiguang Liu, Jiewen Yao, Jian J Wang, Ken Lu BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=3625 If TD-Guest firmware supports measurement and an event is created, TD-Guest firmware is designed to report the event log with the same data structure in TCG-Platform-Firmware-Profile specification with EFI_TCG2_EVENT_LOG_FORMAT_TCG_2 format. The TD-Guest firmware supports measurement, the TD Guest Firmware is designed to produce EFI_TD_PROTOCOL with new GUID EFI_TD_PROTOCOL_GUID to report event log and provides hash capability. Cc: Michael D Kinney <michael.d.kinney@intel.com> Cc: Liming Gao <gaoliming@byosoft.com.cn> Cc: Zhiguang Liu <zhiguang.liu@intel.com> Cc: Jiewen Yao <jiewen.yao@intel.com> Cc: Jian J Wang <jian.j.wang@intel.com> Cc: Ken Lu <ken.lu@intel.com> Signed-off-by: Min Xu <min.m.xu@intel.com> --- MdePkg/Include/Protocol/TdProtocol.h | 305 +++++++++++++++++++++++++++ MdePkg/MdePkg.dec | 3 + 2 files changed, 308 insertions(+) create mode 100644 MdePkg/Include/Protocol/TdProtocol.h diff --git a/MdePkg/Include/Protocol/TdProtocol.h b/MdePkg/Include/Protocol/TdProtocol.h new file mode 100644 index 000000000000..5a015fca0079 --- /dev/null +++ b/MdePkg/Include/Protocol/TdProtocol.h @@ -0,0 +1,305 @@ +/** @file + If TD-Guest firmware supports measurement and an event is created, TD-Guest + firmware is designed to report the event log with the same data structure + in TCG-Platform-Firmware-Profile specification with + EFI_TCG2_EVENT_LOG_FORMAT_TCG_2 format. + + The TD-Guest firmware supports measurement, the TD Guest Firmware is designed + to produce EFI_TD_PROTOCOL with new GUID EFI_TD_PROTOCOL_GUID to report + event log and provides hash capability. + +Copyright (c) 2020 - 2021, Intel Corporation. All rights reserved.<BR> +SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + + +#ifndef TD_PROTOCOL_H_ +#define TD_PROTOCOL_H_ + +#include <Uefi/UefiBaseType.h> +#include <IndustryStandard/UefiTcgPlatform.h> +#include <IndustryStandard/Tpm20.h> + + +#define EFI_TD_PROTOCOL_GUID \ + { 0x96751a3d, 0x72f4, 0x41a6, { 0xa7, 0x94, 0xed, 0x5d, 0x0e, 0x67, 0xae, 0x6b }} +extern EFI_GUID gEfiTdProtocolGuid; + +typedef struct _EFI_TD_PROTOCOL EFI_TD_PROTOCOL; + +typedef struct { + UINT8 Major; + UINT8 Minor; +} EFI_TD_VERSION; + +typedef UINT32 EFI_TD_EVENT_LOG_BITMAP; +typedef UINT32 EFI_TD_EVENT_LOG_FORMAT; +typedef UINT32 EFI_TD_EVENT_ALGORITHM_BITMAP; +typedef UINT32 EFI_TD_MR_INDEX; + +#define EFI_TD_EVENT_LOG_FORMAT_TCG_2 0x00000002 +#define EFI_TD_BOOT_HASH_ALG_SHA384 0x00000004 + +// +// This bit is shall be set when an event shall be extended but not logged. +// +#define EFI_TD_FLAG_EXTEND_ONLY 0x0000000000000001 +// +// This bit shall be set when the intent is to measure a PE/COFF image. +// +#define EFI_TD_FLAG_PE_COFF_IMAGE 0x0000000000000010 + +#define MR_INDEX_MRTD 0 +#define MR_INDEX_RTMR0 1 +#define MR_INDEX_RTMR1 2 +#define MR_INDEX_RTMR2 3 +#define MR_INDEX_RTMR3 4 + +// +// This bit shall be set when the intent is to measure a PE/COFF image. +// +#define PE_COFF_IMAGE 0x0000000000000010 + +#pragma pack (1) + +#define EFI_TD_EVENT_HEADER_VERSION 1 + +typedef struct { + // + // Size of the event header itself (sizeof(EFI_TD_EVENT_HEADER)). + // + UINT32 HeaderSize; + // + // Header version. For this version of this specification, the value shall be 1. + // + UINT16 HeaderVersion; + // + // Index of the MR that shall be extended. + // + EFI_TD_MR_INDEX MrIndex; + // + // Type of the event that shall be extended (and optionally logged). + // + UINT32 EventType; +} EFI_TD_EVENT_HEADER; + +typedef struct { + // + // Total size of the event including the Size component, the header and the Event data. + // + UINT32 Size; + EFI_TD_EVENT_HEADER Header; + UINT8 Event[1]; +} EFI_TD_EVENT; + +#pragma pack() + + +typedef struct { + // + // Allocated size of the structure + // + UINT8 Size; + // + // Version of the EFI_TD_BOOT_SERVICE_CAPABILITY structure itself. + // For this version of the protocol, the Major version shall be set to 1 + // and the Minor version shall be set to 1. + // + EFI_TD_VERSION StructureVersion; + // + // Version of the EFI TD protocol. + // For this version of the protocol, the Major version shall be set to 1 + // and the Minor version shall be set to 1. + // + EFI_TD_VERSION ProtocolVersion; + // + // Supported hash algorithms + // + EFI_TD_EVENT_ALGORITHM_BITMAP HashAlgorithmBitmap; + // + // Bitmap of supported event log formats + // + EFI_TD_EVENT_LOG_BITMAP SupportedEventLogs; + + // + // False = TD not present + // + BOOLEAN TdPresentFlag; +} EFI_TD_BOOT_SERVICE_CAPABILITY; + +/** + The EFI_TD_PROTOCOL GetCapability function call provides protocol + capability information and state information. + + @param[in] This Indicates the calling context + @param[in, out] ProtocolCapability The caller allocates memory for a EFI_TD_BOOT_SERVICE_CAPABILITY + structure and sets the size field to the size of the structure allocated. + The callee fills in the fields with the EFI protocol capability information + and the current EFI TD state information up to the number of fields which + fit within the size of the structure passed in. + + @retval EFI_SUCCESS Operation completed successfully. + @retval EFI_DEVICE_ERROR The command was unsuccessful. + The ProtocolCapability variable will not be populated. + @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect. + The ProtocolCapability variable will not be populated. + @retval EFI_BUFFER_TOO_SMALL The ProtocolCapability variable is too small to hold the full response. + It will be partially populated (required Size field will be set). +**/ +typedef +EFI_STATUS +(EFIAPI *EFI_TD_GET_CAPABILITY) ( + IN EFI_TD_PROTOCOL *This, + IN OUT EFI_TD_BOOT_SERVICE_CAPABILITY *ProtocolCapability + ); + +/** + The EFI_TD_PROTOCOL Get Event Log function call allows a caller to + retrieve the address of a given event log and its last entry. + + @param[in] This Indicates the calling context + @param[in] EventLogFormat The type of the event log for which the information is requested. + @param[out] EventLogLocation A pointer to the memory address of the event log. + @param[out] EventLogLastEntry If the Event Log contains more than one entry, this is a pointer to the + address of the start of the last entry in the event log in memory. + @param[out] EventLogTruncated If the Event Log is missing at least one entry because an event would + have exceeded the area allocated for events, this value is set to TRUE. + Otherwise, the value will be FALSE and the Event Log will be complete. + + @retval EFI_SUCCESS Operation completed successfully. + @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect + (e.g. asking for an event log whose format is not supported). +**/ +typedef +EFI_STATUS +(EFIAPI *EFI_TD_GET_EVENT_LOG) ( + IN EFI_TD_PROTOCOL *This, + IN EFI_TD_EVENT_LOG_FORMAT EventLogFormat, + OUT EFI_PHYSICAL_ADDRESS *EventLogLocation, + OUT EFI_PHYSICAL_ADDRESS *EventLogLastEntry, + OUT BOOLEAN *EventLogTruncated + ); + +/** + The EFI_TD_PROTOCOL HashLogExtendEvent function call provides callers with + an opportunity to extend and optionally log events without requiring + knowledge of actual TD commands. + The extend operation will occur even if this function cannot create an event + log entry (e.g. due to the event log being full). + + @param[in] This Indicates the calling context + @param[in] Flags Bitmap providing additional information. + @param[in] DataToHash Physical address of the start of the data buffer to be hashed. + @param[in] DataToHashLen The length in bytes of the buffer referenced by DataToHash. + @param[in] EfiTdEvent Pointer to data buffer containing information about the event. + + @retval EFI_SUCCESS Operation completed successfully. + @retval EFI_DEVICE_ERROR The command was unsuccessful. + @retval EFI_VOLUME_FULL The extend operation occurred, but the event could not be written to one or more event logs. + @retval EFI_INVALID_PARAMETER One or more of the parameters are incorrect. + @retval EFI_UNSUPPORTED The PE/COFF image type is not supported. +**/ +typedef +EFI_STATUS +(EFIAPI * EFI_TD_HASH_LOG_EXTEND_EVENT) ( + IN EFI_TD_PROTOCOL *This, + IN UINT64 Flags, + IN EFI_PHYSICAL_ADDRESS DataToHash, + IN UINT64 DataToHashLen, + IN EFI_TD_EVENT *EfiTdEvent + ); + +/** + The EFI_TD_PROTOCOL MapPcrToMrIndex function call provides callers + the info on TPM PCR<-> measurement register mapping information. + + In current version, we use below mapping: + PCR0 -> MRTD (Index 0) + PCR1 -> RTMR0 (Index 1) + PCR2~6 -> RTMR1 (Index 2) + PCR7 -> RTMR0 (Index 1) + PCR8~15 -> RTMR2 (Index 3) + + @param[in] This Indicates the calling context + @param[in] PcrIndex TPM PCR index. + @param[out] MrIndex Measurement register index. + + @retval EFI_SUCCESS The MR index is returned. + @retval EFI_INVALID_PARAMETER The MrIndex is NULL. + @retval EFI_UNSUPPORTED The PcrIndex is invalid. +**/ +typedef +EFI_STATUS +(EFIAPI * EFI_TD_MAP_PCR_TO_MR_INDEX) ( + IN EFI_TD_PROTOCOL *This, + IN TCG_PCRINDEX PcrIndex, + OUT EFI_TD_MR_INDEX *MrIndex + ); + +struct _EFI_TD_PROTOCOL { + EFI_TD_GET_CAPABILITY GetCapability; + EFI_TD_GET_EVENT_LOG GetEventLog; + EFI_TD_HASH_LOG_EXTEND_EVENT HashLogExtendEvent; + EFI_TD_MAP_PCR_TO_MR_INDEX MapPcrToMrIndex; +}; + + +// +// TD event log +// + +#pragma pack(1) + +// +// Crypto Agile Log Entry Format. +// It is similar with TCG_PCR_EVENT2 except the field of MrIndex and PCRIndex. +// +typedef struct { + EFI_TD_MR_INDEX MrIndex; + UINT32 EventType; + TPML_DIGEST_VALUES Digests; + UINT32 EventSize; + UINT8 Event[1]; +} TD_EVENT; + +// +// EFI TD Event Header +// It is similar with TCG_PCR_EVENT2_HDR except the field of MrIndex and PCRIndex +// +typedef struct { + EFI_TD_MR_INDEX MrIndex; + UINT32 EventType; + TPML_DIGEST_VALUES Digests; + UINT32 EventSize; +} TD_EVENT_HDR; + +#pragma pack() + +// +// Log entries after Get Event Log service +// + + +typedef struct { + // + // The version of this structure. It shall be set ot 1. + // + UINT64 Version; + // + // Number of events recorded after invocation of GetEventLog API + // + UINT64 NumberOfEvents; + // + // List of events of type TCG_TD_EVENT. + // + //TD_EVENT Event[1]; +} EFI_TD_FINAL_EVENTS_TABLE; + + +#define EFI_TD_FINAL_EVENTS_TABLE_GUID \ + {0xdd4a4648, 0x2de7, 0x4665, {0x96, 0x4d, 0x21, 0xd9, 0xef, 0x5f, 0xb4, 0x46}} + +extern EFI_GUID gEfiTdFinalEventsTableGuid; + +#endif diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec index a28a2daaffa8..2f48f6c40c1e 100644 --- a/MdePkg/MdePkg.dec +++ b/MdePkg/MdePkg.dec @@ -1008,6 +1008,9 @@ ## Include/Protocol/PcdInfo.h gGetPcdInfoProtocolGuid = { 0x5be40f57, 0xfa68, 0x4610, { 0xbb, 0xbf, 0xe9, 0xc5, 0xfc, 0xda, 0xd3, 0x65 } } + ## Include/Protocol/TdProtocol.h + gEfiTdProtocolGuid = { 0x96751a3d, 0x72f4, 0x41a6, { 0xa7, 0x94, 0xed, 0x5d, 0x0e, 0x67, 0xae, 0x6b }} + # # Protocols defined in PI1.0. # -- 2.29.2.windows.2 ^ permalink raw reply related [flat|nested] 9+ messages in thread
* Re: [PATCH 1/2] MdePkg: Introduce TdProtocol for TD-Guest firmware 2021-09-14 1:57 ` [PATCH 1/2] MdePkg: Introduce TdProtocol for TD-Guest firmware Min Xu @ 2021-09-14 2:05 ` Yao, Jiewen 2021-09-15 5:49 ` 回复: [edk2-devel] " gaoliming 1 sibling, 0 replies; 9+ messages in thread From: Yao, Jiewen @ 2021-09-14 2:05 UTC (permalink / raw) To: Xu, Min M, devel@edk2.groups.io Cc: Kinney, Michael D, Liming Gao, Liu, Zhiguang, Wang, Jian J, Lu, Ken I think "+ // List of events of type TCG_TD_EVENT." Shall be "+ // List of events of type TD_EVENT." With that change, reviewed-by: Jiewen Yao <Jiewen.yao@intel.com> > -----Original Message----- > From: Xu, Min M <min.m.xu@intel.com> > Sent: Tuesday, September 14, 2021 9:57 AM > To: devel@edk2.groups.io > Cc: Xu, Min M <min.m.xu@intel.com>; Kinney, Michael D > <michael.d.kinney@intel.com>; Liming Gao <gaoliming@byosoft.com.cn>; Liu, > Zhiguang <zhiguang.liu@intel.com>; Yao, Jiewen <jiewen.yao@intel.com>; > Wang, Jian J <jian.j.wang@intel.com>; Lu, Ken <ken.lu@intel.com> > Subject: [PATCH 1/2] MdePkg: Introduce TdProtocol for TD-Guest firmware > > BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=3625 > > If TD-Guest firmware supports measurement and an event is created, > TD-Guest firmware is designed to report the event log with the same data > structure in TCG-Platform-Firmware-Profile specification with > EFI_TCG2_EVENT_LOG_FORMAT_TCG_2 format. > > The TD-Guest firmware supports measurement, the TD Guest Firmware is > designed to produce EFI_TD_PROTOCOL with new GUID > EFI_TD_PROTOCOL_GUID > to report event log and provides hash capability. > > Cc: Michael D Kinney <michael.d.kinney@intel.com> > Cc: Liming Gao <gaoliming@byosoft.com.cn> > Cc: Zhiguang Liu <zhiguang.liu@intel.com> > Cc: Jiewen Yao <jiewen.yao@intel.com> > Cc: Jian J Wang <jian.j.wang@intel.com> > Cc: Ken Lu <ken.lu@intel.com> > Signed-off-by: Min Xu <min.m.xu@intel.com> > --- > MdePkg/Include/Protocol/TdProtocol.h | 305 +++++++++++++++++++++++++++ > MdePkg/MdePkg.dec | 3 + > 2 files changed, 308 insertions(+) > create mode 100644 MdePkg/Include/Protocol/TdProtocol.h > > diff --git a/MdePkg/Include/Protocol/TdProtocol.h > b/MdePkg/Include/Protocol/TdProtocol.h > new file mode 100644 > index 000000000000..5a015fca0079 > --- /dev/null > +++ b/MdePkg/Include/Protocol/TdProtocol.h > @@ -0,0 +1,305 @@ > +/** @file > + If TD-Guest firmware supports measurement and an event is created, TD- > Guest > + firmware is designed to report the event log with the same data structure > + in TCG-Platform-Firmware-Profile specification with > + EFI_TCG2_EVENT_LOG_FORMAT_TCG_2 format. > + > + The TD-Guest firmware supports measurement, the TD Guest Firmware is > designed > + to produce EFI_TD_PROTOCOL with new GUID EFI_TD_PROTOCOL_GUID to > report > + event log and provides hash capability. > + > +Copyright (c) 2020 - 2021, Intel Corporation. All rights reserved.<BR> > +SPDX-License-Identifier: BSD-2-Clause-Patent > + > +**/ > + > + > +#ifndef TD_PROTOCOL_H_ > +#define TD_PROTOCOL_H_ > + > +#include <Uefi/UefiBaseType.h> > +#include <IndustryStandard/UefiTcgPlatform.h> > +#include <IndustryStandard/Tpm20.h> > + > + > +#define EFI_TD_PROTOCOL_GUID \ > + { 0x96751a3d, 0x72f4, 0x41a6, { 0xa7, 0x94, 0xed, 0x5d, 0x0e, 0x67, 0xae, > 0x6b }} > +extern EFI_GUID gEfiTdProtocolGuid; > + > +typedef struct _EFI_TD_PROTOCOL EFI_TD_PROTOCOL; > + > +typedef struct { > + UINT8 Major; > + UINT8 Minor; > +} EFI_TD_VERSION; > + > +typedef UINT32 EFI_TD_EVENT_LOG_BITMAP; > +typedef UINT32 EFI_TD_EVENT_LOG_FORMAT; > +typedef UINT32 EFI_TD_EVENT_ALGORITHM_BITMAP; > +typedef UINT32 EFI_TD_MR_INDEX; > + > +#define EFI_TD_EVENT_LOG_FORMAT_TCG_2 0x00000002 > +#define EFI_TD_BOOT_HASH_ALG_SHA384 0x00000004 > + > +// > +// This bit is shall be set when an event shall be extended but not logged. > +// > +#define EFI_TD_FLAG_EXTEND_ONLY 0x0000000000000001 > +// > +// This bit shall be set when the intent is to measure a PE/COFF image. > +// > +#define EFI_TD_FLAG_PE_COFF_IMAGE 0x0000000000000010 > + > +#define MR_INDEX_MRTD 0 > +#define MR_INDEX_RTMR0 1 > +#define MR_INDEX_RTMR1 2 > +#define MR_INDEX_RTMR2 3 > +#define MR_INDEX_RTMR3 4 > + > +// > +// This bit shall be set when the intent is to measure a PE/COFF image. > +// > +#define PE_COFF_IMAGE 0x0000000000000010 > + > +#pragma pack (1) > + > +#define EFI_TD_EVENT_HEADER_VERSION 1 > + > +typedef struct { > + // > + // Size of the event header itself (sizeof(EFI_TD_EVENT_HEADER)). > + // > + UINT32 HeaderSize; > + // > + // Header version. For this version of this specification, the value shall be 1. > + // > + UINT16 HeaderVersion; > + // > + // Index of the MR that shall be extended. > + // > + EFI_TD_MR_INDEX MrIndex; > + // > + // Type of the event that shall be extended (and optionally logged). > + // > + UINT32 EventType; > +} EFI_TD_EVENT_HEADER; > + > +typedef struct { > + // > + // Total size of the event including the Size component, the header and the > Event data. > + // > + UINT32 Size; > + EFI_TD_EVENT_HEADER Header; > + UINT8 Event[1]; > +} EFI_TD_EVENT; > + > +#pragma pack() > + > + > +typedef struct { > + // > + // Allocated size of the structure > + // > + UINT8 Size; > + // > + // Version of the EFI_TD_BOOT_SERVICE_CAPABILITY structure itself. > + // For this version of the protocol, the Major version shall be set to 1 > + // and the Minor version shall be set to 1. > + // > + EFI_TD_VERSION StructureVersion; > + // > + // Version of the EFI TD protocol. > + // For this version of the protocol, the Major version shall be set to 1 > + // and the Minor version shall be set to 1. > + // > + EFI_TD_VERSION ProtocolVersion; > + // > + // Supported hash algorithms > + // > + EFI_TD_EVENT_ALGORITHM_BITMAP HashAlgorithmBitmap; > + // > + // Bitmap of supported event log formats > + // > + EFI_TD_EVENT_LOG_BITMAP SupportedEventLogs; > + > + // > + // False = TD not present > + // > + BOOLEAN TdPresentFlag; > +} EFI_TD_BOOT_SERVICE_CAPABILITY; > + > +/** > + The EFI_TD_PROTOCOL GetCapability function call provides protocol > + capability information and state information. > + > + @param[in] This Indicates the calling context > + @param[in, out] ProtocolCapability The caller allocates memory for a > EFI_TD_BOOT_SERVICE_CAPABILITY > + structure and sets the size field to the size of the structure > allocated. > + The callee fills in the fields with the EFI protocol capability > information > + and the current EFI TD state information up to the number > of fields which > + fit within the size of the structure passed in. > + > + @retval EFI_SUCCESS Operation completed successfully. > + @retval EFI_DEVICE_ERROR The command was unsuccessful. > + The ProtocolCapability variable will not be populated. > + @retval EFI_INVALID_PARAMETER One or more of the parameters are > incorrect. > + The ProtocolCapability variable will not be populated. > + @retval EFI_BUFFER_TOO_SMALL The ProtocolCapability variable is too > small to hold the full response. > + It will be partially populated (required Size field will be set). > +**/ > +typedef > +EFI_STATUS > +(EFIAPI *EFI_TD_GET_CAPABILITY) ( > + IN EFI_TD_PROTOCOL *This, > + IN OUT EFI_TD_BOOT_SERVICE_CAPABILITY *ProtocolCapability > + ); > + > +/** > + The EFI_TD_PROTOCOL Get Event Log function call allows a caller to > + retrieve the address of a given event log and its last entry. > + > + @param[in] This Indicates the calling context > + @param[in] EventLogFormat The type of the event log for which the > information is requested. > + @param[out] EventLogLocation A pointer to the memory address of the > event log. > + @param[out] EventLogLastEntry If the Event Log contains more than one > entry, this is a pointer to the > + address of the start of the last entry in the event log in > memory. > + @param[out] EventLogTruncated If the Event Log is missing at least one > entry because an event would > + have exceeded the area allocated for events, this value is set > to TRUE. > + Otherwise, the value will be FALSE and the Event Log will be > complete. > + > + @retval EFI_SUCCESS Operation completed successfully. > + @retval EFI_INVALID_PARAMETER One or more of the parameters are > incorrect > + (e.g. asking for an event log whose format is not supported). > +**/ > +typedef > +EFI_STATUS > +(EFIAPI *EFI_TD_GET_EVENT_LOG) ( > + IN EFI_TD_PROTOCOL *This, > + IN EFI_TD_EVENT_LOG_FORMAT EventLogFormat, > + OUT EFI_PHYSICAL_ADDRESS *EventLogLocation, > + OUT EFI_PHYSICAL_ADDRESS *EventLogLastEntry, > + OUT BOOLEAN *EventLogTruncated > + ); > + > +/** > + The EFI_TD_PROTOCOL HashLogExtendEvent function call provides callers > with > + an opportunity to extend and optionally log events without requiring > + knowledge of actual TD commands. > + The extend operation will occur even if this function cannot create an event > + log entry (e.g. due to the event log being full). > + > + @param[in] This Indicates the calling context > + @param[in] Flags Bitmap providing additional information. > + @param[in] DataToHash Physical address of the start of the data buffer > to be hashed. > + @param[in] DataToHashLen The length in bytes of the buffer referenced > by DataToHash. > + @param[in] EfiTdEvent Pointer to data buffer containing information > about the event. > + > + @retval EFI_SUCCESS Operation completed successfully. > + @retval EFI_DEVICE_ERROR The command was unsuccessful. > + @retval EFI_VOLUME_FULL The extend operation occurred, but the event > could not be written to one or more event logs. > + @retval EFI_INVALID_PARAMETER One or more of the parameters are > incorrect. > + @retval EFI_UNSUPPORTED The PE/COFF image type is not supported. > +**/ > +typedef > +EFI_STATUS > +(EFIAPI * EFI_TD_HASH_LOG_EXTEND_EVENT) ( > + IN EFI_TD_PROTOCOL *This, > + IN UINT64 Flags, > + IN EFI_PHYSICAL_ADDRESS DataToHash, > + IN UINT64 DataToHashLen, > + IN EFI_TD_EVENT *EfiTdEvent > + ); > + > +/** > + The EFI_TD_PROTOCOL MapPcrToMrIndex function call provides callers > + the info on TPM PCR<-> measurement register mapping information. > + > + In current version, we use below mapping: > + PCR0 -> MRTD (Index 0) > + PCR1 -> RTMR0 (Index 1) > + PCR2~6 -> RTMR1 (Index 2) > + PCR7 -> RTMR0 (Index 1) > + PCR8~15 -> RTMR2 (Index 3) > + > + @param[in] This Indicates the calling context > + @param[in] PcrIndex TPM PCR index. > + @param[out] MrIndex Measurement register index. > + > + @retval EFI_SUCCESS The MR index is returned. > + @retval EFI_INVALID_PARAMETER The MrIndex is NULL. > + @retval EFI_UNSUPPORTED The PcrIndex is invalid. > +**/ > +typedef > +EFI_STATUS > +(EFIAPI * EFI_TD_MAP_PCR_TO_MR_INDEX) ( > + IN EFI_TD_PROTOCOL *This, > + IN TCG_PCRINDEX PcrIndex, > + OUT EFI_TD_MR_INDEX *MrIndex > + ); > + > +struct _EFI_TD_PROTOCOL { > + EFI_TD_GET_CAPABILITY GetCapability; > + EFI_TD_GET_EVENT_LOG GetEventLog; > + EFI_TD_HASH_LOG_EXTEND_EVENT HashLogExtendEvent; > + EFI_TD_MAP_PCR_TO_MR_INDEX MapPcrToMrIndex; > +}; > + > + > +// > +// TD event log > +// > + > +#pragma pack(1) > + > +// > +// Crypto Agile Log Entry Format. > +// It is similar with TCG_PCR_EVENT2 except the field of MrIndex and PCRIndex. > +// > +typedef struct { > + EFI_TD_MR_INDEX MrIndex; > + UINT32 EventType; > + TPML_DIGEST_VALUES Digests; > + UINT32 EventSize; > + UINT8 Event[1]; > +} TD_EVENT; > + > +// > +// EFI TD Event Header > +// It is similar with TCG_PCR_EVENT2_HDR except the field of MrIndex and > PCRIndex > +// > +typedef struct { > + EFI_TD_MR_INDEX MrIndex; > + UINT32 EventType; > + TPML_DIGEST_VALUES Digests; > + UINT32 EventSize; > +} TD_EVENT_HDR; > + > +#pragma pack() > + > +// > +// Log entries after Get Event Log service > +// > + > + > +typedef struct { > + // > + // The version of this structure. It shall be set ot 1. > + // > + UINT64 Version; > + // > + // Number of events recorded after invocation of GetEventLog API > + // > + UINT64 NumberOfEvents; > + // > + // List of events of type TCG_TD_EVENT. > + // > + //TD_EVENT Event[1]; > +} EFI_TD_FINAL_EVENTS_TABLE; > + > + > +#define EFI_TD_FINAL_EVENTS_TABLE_GUID \ > + {0xdd4a4648, 0x2de7, 0x4665, {0x96, 0x4d, 0x21, 0xd9, 0xef, 0x5f, 0xb4, > 0x46}} > + > +extern EFI_GUID gEfiTdFinalEventsTableGuid; > + > +#endif > diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec > index a28a2daaffa8..2f48f6c40c1e 100644 > --- a/MdePkg/MdePkg.dec > +++ b/MdePkg/MdePkg.dec > @@ -1008,6 +1008,9 @@ > ## Include/Protocol/PcdInfo.h > gGetPcdInfoProtocolGuid = { 0x5be40f57, 0xfa68, 0x4610, { 0xbb, 0xbf, > 0xe9, 0xc5, 0xfc, 0xda, 0xd3, 0x65 } } > > + ## Include/Protocol/TdProtocol.h > + gEfiTdProtocolGuid = { 0x96751a3d, 0x72f4, 0x41a6, { 0xa7, 0x94, 0xed, > 0x5d, 0x0e, 0x67, 0xae, 0x6b }} > + > # > # Protocols defined in PI1.0. > # > -- > 2.29.2.windows.2 ^ permalink raw reply [flat|nested] 9+ messages in thread
* 回复: [edk2-devel] [PATCH 1/2] MdePkg: Introduce TdProtocol for TD-Guest firmware 2021-09-14 1:57 ` [PATCH 1/2] MdePkg: Introduce TdProtocol for TD-Guest firmware Min Xu 2021-09-14 2:05 ` Yao, Jiewen @ 2021-09-15 5:49 ` gaoliming 2021-09-15 6:04 ` Min Xu 2021-09-24 23:01 ` Yao, Jiewen 1 sibling, 2 replies; 9+ messages in thread From: gaoliming @ 2021-09-15 5:49 UTC (permalink / raw) To: devel, min.m.xu Cc: 'Michael D Kinney', 'Zhiguang Liu', 'Jiewen Yao', 'Jian J Wang', 'Ken Lu' Min: Which public spec defines this new protocol? Thanks Liming > -----邮件原件----- > 发件人: devel@edk2.groups.io <devel@edk2.groups.io> 代表 Min Xu > 发送时间: 2021年9月14日 9:57 > 收件人: devel@edk2.groups.io > 抄送: Min Xu <min.m.xu@intel.com>; Michael D Kinney > <michael.d.kinney@intel.com>; Liming Gao <gaoliming@byosoft.com.cn>; > Zhiguang Liu <zhiguang.liu@intel.com>; Jiewen Yao <jiewen.yao@intel.com>; > Jian J Wang <jian.j.wang@intel.com>; Ken Lu <ken.lu@intel.com> > 主题: [edk2-devel] [PATCH 1/2] MdePkg: Introduce TdProtocol for TD-Guest > firmware > > BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=3625 > > If TD-Guest firmware supports measurement and an event is created, > TD-Guest firmware is designed to report the event log with the same data > structure in TCG-Platform-Firmware-Profile specification with > EFI_TCG2_EVENT_LOG_FORMAT_TCG_2 format. > > The TD-Guest firmware supports measurement, the TD Guest Firmware is > designed to produce EFI_TD_PROTOCOL with new GUID > EFI_TD_PROTOCOL_GUID > to report event log and provides hash capability. > > Cc: Michael D Kinney <michael.d.kinney@intel.com> > Cc: Liming Gao <gaoliming@byosoft.com.cn> > Cc: Zhiguang Liu <zhiguang.liu@intel.com> > Cc: Jiewen Yao <jiewen.yao@intel.com> > Cc: Jian J Wang <jian.j.wang@intel.com> > Cc: Ken Lu <ken.lu@intel.com> > Signed-off-by: Min Xu <min.m.xu@intel.com> > --- > MdePkg/Include/Protocol/TdProtocol.h | 305 > +++++++++++++++++++++++++++ > MdePkg/MdePkg.dec | 3 + > 2 files changed, 308 insertions(+) > create mode 100644 MdePkg/Include/Protocol/TdProtocol.h > > diff --git a/MdePkg/Include/Protocol/TdProtocol.h > b/MdePkg/Include/Protocol/TdProtocol.h > new file mode 100644 > index 000000000000..5a015fca0079 > --- /dev/null > +++ b/MdePkg/Include/Protocol/TdProtocol.h > @@ -0,0 +1,305 @@ > +/** @file > + If TD-Guest firmware supports measurement and an event is created, > TD-Guest > + firmware is designed to report the event log with the same data structure > + in TCG-Platform-Firmware-Profile specification with > + EFI_TCG2_EVENT_LOG_FORMAT_TCG_2 format. > + > + The TD-Guest firmware supports measurement, the TD Guest Firmware is > designed > + to produce EFI_TD_PROTOCOL with new GUID EFI_TD_PROTOCOL_GUID > to report > + event log and provides hash capability. > + > +Copyright (c) 2020 - 2021, Intel Corporation. All rights reserved.<BR> > +SPDX-License-Identifier: BSD-2-Clause-Patent > + > +**/ > + > + > +#ifndef TD_PROTOCOL_H_ > +#define TD_PROTOCOL_H_ > + > +#include <Uefi/UefiBaseType.h> > +#include <IndustryStandard/UefiTcgPlatform.h> > +#include <IndustryStandard/Tpm20.h> > + > + > +#define EFI_TD_PROTOCOL_GUID \ > + { 0x96751a3d, 0x72f4, 0x41a6, { 0xa7, 0x94, 0xed, 0x5d, 0x0e, 0x67, 0xae, > 0x6b }} > +extern EFI_GUID gEfiTdProtocolGuid; > + > +typedef struct _EFI_TD_PROTOCOL EFI_TD_PROTOCOL; > + > +typedef struct { > + UINT8 Major; > + UINT8 Minor; > +} EFI_TD_VERSION; > + > +typedef UINT32 EFI_TD_EVENT_LOG_BITMAP; > +typedef UINT32 EFI_TD_EVENT_LOG_FORMAT; > +typedef UINT32 > EFI_TD_EVENT_ALGORITHM_BITMAP; > +typedef UINT32 EFI_TD_MR_INDEX; > + > +#define EFI_TD_EVENT_LOG_FORMAT_TCG_2 0x00000002 > +#define EFI_TD_BOOT_HASH_ALG_SHA384 0x00000004 > + > +// > +// This bit is shall be set when an event shall be extended but not logged. > +// > +#define EFI_TD_FLAG_EXTEND_ONLY 0x0000000000000001 > +// > +// This bit shall be set when the intent is to measure a PE/COFF image. > +// > +#define EFI_TD_FLAG_PE_COFF_IMAGE 0x0000000000000010 > + > +#define MR_INDEX_MRTD 0 > +#define MR_INDEX_RTMR0 1 > +#define MR_INDEX_RTMR1 2 > +#define MR_INDEX_RTMR2 3 > +#define MR_INDEX_RTMR3 4 > + > +// > +// This bit shall be set when the intent is to measure a PE/COFF image. > +// > +#define PE_COFF_IMAGE 0x0000000000000010 > + > +#pragma pack (1) > + > +#define EFI_TD_EVENT_HEADER_VERSION 1 > + > +typedef struct { > + // > + // Size of the event header itself (sizeof(EFI_TD_EVENT_HEADER)). > + // > + UINT32 HeaderSize; > + // > + // Header version. For this version of this specification, the value shall be > 1. > + // > + UINT16 HeaderVersion; > + // > + // Index of the MR that shall be extended. > + // > + EFI_TD_MR_INDEX MrIndex; > + // > + // Type of the event that shall be extended (and optionally logged). > + // > + UINT32 EventType; > +} EFI_TD_EVENT_HEADER; > + > +typedef struct { > + // > + // Total size of the event including the Size component, the header and the > Event data. > + // > + UINT32 Size; > + EFI_TD_EVENT_HEADER Header; > + UINT8 Event[1]; > +} EFI_TD_EVENT; > + > +#pragma pack() > + > + > +typedef struct { > + // > + // Allocated size of the structure > + // > + UINT8 Size; > + // > + // Version of the EFI_TD_BOOT_SERVICE_CAPABILITY structure itself. > + // For this version of the protocol, the Major version shall be set to 1 > + // and the Minor version shall be set to 1. > + // > + EFI_TD_VERSION StructureVersion; > + // > + // Version of the EFI TD protocol. > + // For this version of the protocol, the Major version shall be set to 1 > + // and the Minor version shall be set to 1. > + // > + EFI_TD_VERSION ProtocolVersion; > + // > + // Supported hash algorithms > + // > + EFI_TD_EVENT_ALGORITHM_BITMAP HashAlgorithmBitmap; > + // > + // Bitmap of supported event log formats > + // > + EFI_TD_EVENT_LOG_BITMAP SupportedEventLogs; > + > + // > + // False = TD not present > + // > + BOOLEAN TdPresentFlag; > +} EFI_TD_BOOT_SERVICE_CAPABILITY; > + > +/** > + The EFI_TD_PROTOCOL GetCapability function call provides protocol > + capability information and state information. > + > + @param[in] This Indicates the calling context > + @param[in, out] ProtocolCapability The caller allocates memory for a > EFI_TD_BOOT_SERVICE_CAPABILITY > + structure and sets the size > field to the size of the structure allocated. > + The callee fills in the fields > with the EFI protocol capability information > + and the current EFI TD state > information up to the number of fields which > + fit within the size of the > structure passed in. > + > + @retval EFI_SUCCESS Operation completed successfully. > + @retval EFI_DEVICE_ERROR The command was unsuccessful. > + The ProtocolCapability variable will > not be populated. > + @retval EFI_INVALID_PARAMETER One or more of the parameters are > incorrect. > + The ProtocolCapability variable will > not be populated. > + @retval EFI_BUFFER_TOO_SMALL The ProtocolCapability variable is > too small to hold the full response. > + It will be partially populated > (required Size field will be set). > +**/ > +typedef > +EFI_STATUS > +(EFIAPI *EFI_TD_GET_CAPABILITY) ( > + IN EFI_TD_PROTOCOL *This, > + IN OUT EFI_TD_BOOT_SERVICE_CAPABILITY *ProtocolCapability > + ); > + > +/** > + The EFI_TD_PROTOCOL Get Event Log function call allows a caller to > + retrieve the address of a given event log and its last entry. > + > + @param[in] This Indicates the calling context > + @param[in] EventLogFormat The type of the event log for which > the information is requested. > + @param[out] EventLogLocation A pointer to the memory address of > the event log. > + @param[out] EventLogLastEntry If the Event Log contains more than > one entry, this is a pointer to the > + address of the start of the last > entry in the event log in memory. > + @param[out] EventLogTruncated If the Event Log is missing at least one > entry because an event would > + have exceeded the area allocated > for events, this value is set to TRUE. > + Otherwise, the value will be FALSE > and the Event Log will be complete. > + > + @retval EFI_SUCCESS Operation completed successfully. > + @retval EFI_INVALID_PARAMETER One or more of the parameters are > incorrect > + (e.g. asking for an event log whose > format is not supported). > +**/ > +typedef > +EFI_STATUS > +(EFIAPI *EFI_TD_GET_EVENT_LOG) ( > + IN EFI_TD_PROTOCOL *This, > + IN EFI_TD_EVENT_LOG_FORMAT EventLogFormat, > + OUT EFI_PHYSICAL_ADDRESS *EventLogLocation, > + OUT EFI_PHYSICAL_ADDRESS *EventLogLastEntry, > + OUT BOOLEAN *EventLogTruncated > + ); > + > +/** > + The EFI_TD_PROTOCOL HashLogExtendEvent function call provides callers > with > + an opportunity to extend and optionally log events without requiring > + knowledge of actual TD commands. > + The extend operation will occur even if this function cannot create an > event > + log entry (e.g. due to the event log being full). > + > + @param[in] This Indicates the calling context > + @param[in] Flags Bitmap providing additional > information. > + @param[in] DataToHash Physical address of the start of the > data buffer to be hashed. > + @param[in] DataToHashLen The length in bytes of the buffer > referenced by DataToHash. > + @param[in] EfiTdEvent Pointer to data buffer containing > information about the event. > + > + @retval EFI_SUCCESS Operation completed successfully. > + @retval EFI_DEVICE_ERROR The command was unsuccessful. > + @retval EFI_VOLUME_FULL The extend operation occurred, but > the event could not be written to one or more event logs. > + @retval EFI_INVALID_PARAMETER One or more of the parameters are > incorrect. > + @retval EFI_UNSUPPORTED The PE/COFF image type is not > supported. > +**/ > +typedef > +EFI_STATUS > +(EFIAPI * EFI_TD_HASH_LOG_EXTEND_EVENT) ( > + IN EFI_TD_PROTOCOL *This, > + IN UINT64 Flags, > + IN EFI_PHYSICAL_ADDRESS DataToHash, > + IN UINT64 DataToHashLen, > + IN EFI_TD_EVENT *EfiTdEvent > + ); > + > +/** > + The EFI_TD_PROTOCOL MapPcrToMrIndex function call provides callers > + the info on TPM PCR<-> measurement register mapping information. > + > + In current version, we use below mapping: > + PCR0 -> MRTD (Index 0) > + PCR1 -> RTMR0 (Index 1) > + PCR2~6 -> RTMR1 (Index 2) > + PCR7 -> RTMR0 (Index 1) > + PCR8~15 -> RTMR2 (Index 3) > + > + @param[in] This Indicates the calling context > + @param[in] PcrIndex TPM PCR index. > + @param[out] MrIndex Measurement register index. > + > + @retval EFI_SUCCESS The MR index is returned. > + @retval EFI_INVALID_PARAMETER The MrIndex is NULL. > + @retval EFI_UNSUPPORTED The PcrIndex is invalid. > +**/ > +typedef > +EFI_STATUS > +(EFIAPI * EFI_TD_MAP_PCR_TO_MR_INDEX) ( > + IN EFI_TD_PROTOCOL *This, > + IN TCG_PCRINDEX PcrIndex, > + OUT EFI_TD_MR_INDEX *MrIndex > + ); > + > +struct _EFI_TD_PROTOCOL { > + EFI_TD_GET_CAPABILITY GetCapability; > + EFI_TD_GET_EVENT_LOG GetEventLog; > + EFI_TD_HASH_LOG_EXTEND_EVENT > HashLogExtendEvent; > + EFI_TD_MAP_PCR_TO_MR_INDEX MapPcrToMrIndex; > +}; > + > + > +// > +// TD event log > +// > + > +#pragma pack(1) > + > +// > +// Crypto Agile Log Entry Format. > +// It is similar with TCG_PCR_EVENT2 except the field of MrIndex and > PCRIndex. > +// > +typedef struct { > + EFI_TD_MR_INDEX MrIndex; > + UINT32 EventType; > + TPML_DIGEST_VALUES Digests; > + UINT32 EventSize; > + UINT8 Event[1]; > +} TD_EVENT; > + > +// > +// EFI TD Event Header > +// It is similar with TCG_PCR_EVENT2_HDR except the field of MrIndex and > PCRIndex > +// > +typedef struct { > + EFI_TD_MR_INDEX MrIndex; > + UINT32 EventType; > + TPML_DIGEST_VALUES Digests; > + UINT32 EventSize; > +} TD_EVENT_HDR; > + > +#pragma pack() > + > +// > +// Log entries after Get Event Log service > +// > + > + > +typedef struct { > + // > + // The version of this structure. It shall be set ot 1. > + // > + UINT64 Version; > + // > + // Number of events recorded after invocation of GetEventLog API > + // > + UINT64 NumberOfEvents; > + // > + // List of events of type TCG_TD_EVENT. > + // > + //TD_EVENT Event[1]; > +} EFI_TD_FINAL_EVENTS_TABLE; > + > + > +#define EFI_TD_FINAL_EVENTS_TABLE_GUID \ > + {0xdd4a4648, 0x2de7, 0x4665, {0x96, 0x4d, 0x21, 0xd9, 0xef, 0x5f, 0xb4, > 0x46}} > + > +extern EFI_GUID gEfiTdFinalEventsTableGuid; > + > +#endif > diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec > index a28a2daaffa8..2f48f6c40c1e 100644 > --- a/MdePkg/MdePkg.dec > +++ b/MdePkg/MdePkg.dec > @@ -1008,6 +1008,9 @@ > ## Include/Protocol/PcdInfo.h > gGetPcdInfoProtocolGuid = { 0x5be40f57, 0xfa68, 0x4610, { 0xbb, > 0xbf, 0xe9, 0xc5, 0xfc, 0xda, 0xd3, 0x65 } } > > + ## Include/Protocol/TdProtocol.h > + gEfiTdProtocolGuid = { 0x96751a3d, 0x72f4, 0x41a6, { 0xa7, > 0x94, 0xed, 0x5d, 0x0e, 0x67, 0xae, 0x6b }} > + > # > # Protocols defined in PI1.0. > # > -- > 2.29.2.windows.2 > > > > > ^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [edk2-devel] [PATCH 1/2] MdePkg: Introduce TdProtocol for TD-Guest firmware 2021-09-15 5:49 ` 回复: [edk2-devel] " gaoliming @ 2021-09-15 6:04 ` Min Xu 2021-09-24 23:01 ` Yao, Jiewen 1 sibling, 0 replies; 9+ messages in thread From: Min Xu @ 2021-09-15 6:04 UTC (permalink / raw) To: devel@edk2.groups.io, gaoliming@byosoft.com.cn Cc: Kinney, Michael D, Liu, Zhiguang, Yao, Jiewen, Wang, Jian J, Lu, Ken Hi, Liming TD Protocol is defined in below spec (Section 4.3.2) https://software.intel.com/content/dam/develop/external/us/en/documents/intel-tdx-guest-hypervisor-communication-interface.pdf This patch-set is the detailed implementation of TD Protocol. The spec is being updated. Because there are other updates besides the TD Protocol, it need more time to complete the updating. Thanks for your understanding. > -----Original Message----- > From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of gaoliming > Sent: Wednesday, September 15, 2021 1:50 PM > To: devel@edk2.groups.io; Xu, Min M <min.m.xu@intel.com> > Cc: Kinney, Michael D <michael.d.kinney@intel.com>; Liu, Zhiguang > <zhiguang.liu@intel.com>; Yao, Jiewen <jiewen.yao@intel.com>; Wang, Jian J > <jian.j.wang@intel.com>; Lu, Ken <ken.lu@intel.com> > Subject: 回复: [edk2-devel] [PATCH 1/2] MdePkg: Introduce TdProtocol for TD- > Guest firmware > > Min: > Which public spec defines this new protocol? > > Thanks > Liming > > -----邮件原件----- > > 发件人: devel@edk2.groups.io <devel@edk2.groups.io> 代表 Min Xu > > 发送时间: 2021年9月14日 9:57 > > 收件人: devel@edk2.groups.io > > 抄送: Min Xu <min.m.xu@intel.com>; Michael D Kinney > > <michael.d.kinney@intel.com>; Liming Gao <gaoliming@byosoft.com.cn>; > > Zhiguang Liu <zhiguang.liu@intel.com>; Jiewen Yao > > <jiewen.yao@intel.com>; Jian J Wang <jian.j.wang@intel.com>; Ken Lu > > <ken.lu@intel.com> > > 主题: [edk2-devel] [PATCH 1/2] MdePkg: Introduce TdProtocol for TD-Guest > > firmware > > > > BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=3625 > > > > If TD-Guest firmware supports measurement and an event is created, > > TD-Guest firmware is designed to report the event log with the same > > data structure in TCG-Platform-Firmware-Profile specification with > > EFI_TCG2_EVENT_LOG_FORMAT_TCG_2 format. > > > > The TD-Guest firmware supports measurement, the TD Guest Firmware is > > designed to produce EFI_TD_PROTOCOL with new GUID > EFI_TD_PROTOCOL_GUID > > to report event log and provides hash capability. > > > > Cc: Michael D Kinney <michael.d.kinney@intel.com> > > Cc: Liming Gao <gaoliming@byosoft.com.cn> > > Cc: Zhiguang Liu <zhiguang.liu@intel.com> > > Cc: Jiewen Yao <jiewen.yao@intel.com> > > Cc: Jian J Wang <jian.j.wang@intel.com> > > Cc: Ken Lu <ken.lu@intel.com> > > Signed-off-by: Min Xu <min.m.xu@intel.com> > > --- > > MdePkg/Include/Protocol/TdProtocol.h | 305 > > +++++++++++++++++++++++++++ > > MdePkg/MdePkg.dec | 3 + > > 2 files changed, 308 insertions(+) > > create mode 100644 MdePkg/Include/Protocol/TdProtocol.h > > > > diff --git a/MdePkg/Include/Protocol/TdProtocol.h > > b/MdePkg/Include/Protocol/TdProtocol.h > > new file mode 100644 > > index 000000000000..5a015fca0079 > > --- /dev/null > > +++ b/MdePkg/Include/Protocol/TdProtocol.h > > @@ -0,0 +1,305 @@ > > +/** @file > > + If TD-Guest firmware supports measurement and an event is created, > > TD-Guest > > + firmware is designed to report the event log with the same data > structure > > + in TCG-Platform-Firmware-Profile specification with > > + EFI_TCG2_EVENT_LOG_FORMAT_TCG_2 format. > > + > > + The TD-Guest firmware supports measurement, the TD Guest Firmware > > + is > > designed > > + to produce EFI_TD_PROTOCOL with new GUID EFI_TD_PROTOCOL_GUID > > to report > > + event log and provides hash capability. > > + > > +Copyright (c) 2020 - 2021, Intel Corporation. All rights > > +reserved.<BR> > > +SPDX-License-Identifier: BSD-2-Clause-Patent > > + > > +**/ > > + > > + > > +#ifndef TD_PROTOCOL_H_ > > +#define TD_PROTOCOL_H_ > > + > > +#include <Uefi/UefiBaseType.h> > > +#include <IndustryStandard/UefiTcgPlatform.h> > > +#include <IndustryStandard/Tpm20.h> > > + > > + > > +#define EFI_TD_PROTOCOL_GUID \ > > + { 0x96751a3d, 0x72f4, 0x41a6, { 0xa7, 0x94, 0xed, 0x5d, 0x0e, 0x67, > 0xae, > > 0x6b }} > > +extern EFI_GUID gEfiTdProtocolGuid; > > + > > +typedef struct _EFI_TD_PROTOCOL EFI_TD_PROTOCOL; > > + > > +typedef struct { > > + UINT8 Major; > > + UINT8 Minor; > > +} EFI_TD_VERSION; > > + > > +typedef UINT32 EFI_TD_EVENT_LOG_BITMAP; > > +typedef UINT32 EFI_TD_EVENT_LOG_FORMAT; > > +typedef UINT32 > > EFI_TD_EVENT_ALGORITHM_BITMAP; > > +typedef UINT32 EFI_TD_MR_INDEX; > > + > > +#define EFI_TD_EVENT_LOG_FORMAT_TCG_2 0x00000002 > > +#define EFI_TD_BOOT_HASH_ALG_SHA384 0x00000004 > > + > > +// > > +// This bit is shall be set when an event shall be extended but not > logged. > > +// > > +#define EFI_TD_FLAG_EXTEND_ONLY 0x0000000000000001 > > +// > > +// This bit shall be set when the intent is to measure a PE/COFF image. > > +// > > +#define EFI_TD_FLAG_PE_COFF_IMAGE 0x0000000000000010 > > + > > +#define MR_INDEX_MRTD 0 > > +#define MR_INDEX_RTMR0 1 > > +#define MR_INDEX_RTMR1 2 > > +#define MR_INDEX_RTMR2 3 > > +#define MR_INDEX_RTMR3 4 > > + > > +// > > +// This bit shall be set when the intent is to measure a PE/COFF image. > > +// > > +#define PE_COFF_IMAGE 0x0000000000000010 > > + > > +#pragma pack (1) > > + > > +#define EFI_TD_EVENT_HEADER_VERSION 1 > > + > > +typedef struct { > > + // > > + // Size of the event header itself (sizeof(EFI_TD_EVENT_HEADER)). > > + // > > + UINT32 HeaderSize; > > + // > > + // Header version. For this version of this specification, the > > +value > shall be > > 1. > > + // > > + UINT16 HeaderVersion; > > + // > > + // Index of the MR that shall be extended. > > + // > > + EFI_TD_MR_INDEX MrIndex; > > + // > > + // Type of the event that shall be extended (and optionally logged). > > + // > > + UINT32 EventType; > > +} EFI_TD_EVENT_HEADER; > > + > > +typedef struct { > > + // > > + // Total size of the event including the Size component, the header > > +and > the > > Event data. > > + // > > + UINT32 Size; > > + EFI_TD_EVENT_HEADER Header; > > + UINT8 Event[1]; > > +} EFI_TD_EVENT; > > + > > +#pragma pack() > > + > > + > > +typedef struct { > > + // > > + // Allocated size of the structure > > + // > > + UINT8 Size; > > + // > > + // Version of the EFI_TD_BOOT_SERVICE_CAPABILITY structure itself. > > + // For this version of the protocol, the Major version shall be set > > +to > 1 > > + // and the Minor version shall be set to 1. > > + // > > + EFI_TD_VERSION StructureVersion; > > + // > > + // Version of the EFI TD protocol. > > + // For this version of the protocol, the Major version shall be set > > + to > 1 > > + // and the Minor version shall be set to 1. > > + // > > + EFI_TD_VERSION ProtocolVersion; > > + // > > + // Supported hash algorithms > > + // > > + EFI_TD_EVENT_ALGORITHM_BITMAP HashAlgorithmBitmap; > > + // > > + // Bitmap of supported event log formats // > > + EFI_TD_EVENT_LOG_BITMAP SupportedEventLogs; > > + > > + // > > + // False = TD not present > > + // > > + BOOLEAN TdPresentFlag; > > +} EFI_TD_BOOT_SERVICE_CAPABILITY; > > + > > +/** > > + The EFI_TD_PROTOCOL GetCapability function call provides protocol > > + capability information and state information. > > + > > + @param[in] This Indicates the calling context > > + @param[in, out] ProtocolCapability The caller allocates memory for > > + a > > EFI_TD_BOOT_SERVICE_CAPABILITY > > + structure and sets the size > > field to the size of the structure allocated. > > + The callee fills in the fields > > with the EFI protocol capability information > > + and the current EFI TD state > > information up to the number of fields which > > + fit within the size of the > > structure passed in. > > + > > + @retval EFI_SUCCESS Operation completed successfully. > > + @retval EFI_DEVICE_ERROR The command was unsuccessful. > > + The ProtocolCapability variable will > > not be populated. > > + @retval EFI_INVALID_PARAMETER One or more of the parameters are > > incorrect. > > + The ProtocolCapability variable will > > not be populated. > > + @retval EFI_BUFFER_TOO_SMALL The ProtocolCapability variable is > > too small to hold the full response. > > + It will be partially populated > > (required Size field will be set). > > +**/ > > +typedef > > +EFI_STATUS > > +(EFIAPI *EFI_TD_GET_CAPABILITY) ( > > + IN EFI_TD_PROTOCOL *This, > > + IN OUT EFI_TD_BOOT_SERVICE_CAPABILITY *ProtocolCapability > > + ); > > + > > +/** > > + The EFI_TD_PROTOCOL Get Event Log function call allows a caller to > > + retrieve the address of a given event log and its last entry. > > + > > + @param[in] This Indicates the calling context > > + @param[in] EventLogFormat The type of the event log for which > > the information is requested. > > + @param[out] EventLogLocation A pointer to the memory address of > > the event log. > > + @param[out] EventLogLastEntry If the Event Log contains more than > > one entry, this is a pointer to the > > + address of the start of the last > > entry in the event log in memory. > > + @param[out] EventLogTruncated If the Event Log is missing at least > > + one > > entry because an event would > > + have exceeded the area allocated > > for events, this value is set to TRUE. > > + Otherwise, the value will be FALSE > > and the Event Log will be complete. > > + > > + @retval EFI_SUCCESS Operation completed successfully. > > + @retval EFI_INVALID_PARAMETER One or more of the parameters are > > incorrect > > + (e.g. asking for an event log whose > > format is not supported). > > +**/ > > +typedef > > +EFI_STATUS > > +(EFIAPI *EFI_TD_GET_EVENT_LOG) ( > > + IN EFI_TD_PROTOCOL *This, > > + IN EFI_TD_EVENT_LOG_FORMAT EventLogFormat, > > + OUT EFI_PHYSICAL_ADDRESS *EventLogLocation, > > + OUT EFI_PHYSICAL_ADDRESS *EventLogLastEntry, > > + OUT BOOLEAN *EventLogTruncated > > + ); > > + > > +/** > > + The EFI_TD_PROTOCOL HashLogExtendEvent function call provides > > +callers > > with > > + an opportunity to extend and optionally log events without > > + requiring knowledge of actual TD commands. > > + The extend operation will occur even if this function cannot create > > + an > > event > > + log entry (e.g. due to the event log being full). > > + > > + @param[in] This Indicates the calling context > > + @param[in] Flags Bitmap providing additional > > information. > > + @param[in] DataToHash Physical address of the start of the > > data buffer to be hashed. > > + @param[in] DataToHashLen The length in bytes of the buffer > > referenced by DataToHash. > > + @param[in] EfiTdEvent Pointer to data buffer containing > > information about the event. > > + > > + @retval EFI_SUCCESS Operation completed successfully. > > + @retval EFI_DEVICE_ERROR The command was unsuccessful. > > + @retval EFI_VOLUME_FULL The extend operation occurred, but > > the event could not be written to one or more event logs. > > + @retval EFI_INVALID_PARAMETER One or more of the parameters are > > incorrect. > > + @retval EFI_UNSUPPORTED The PE/COFF image type is not > > supported. > > +**/ > > +typedef > > +EFI_STATUS > > +(EFIAPI * EFI_TD_HASH_LOG_EXTEND_EVENT) ( > > + IN EFI_TD_PROTOCOL *This, > > + IN UINT64 Flags, > > + IN EFI_PHYSICAL_ADDRESS DataToHash, > > + IN UINT64 DataToHashLen, > > + IN EFI_TD_EVENT *EfiTdEvent > > + ); > > + > > +/** > > + The EFI_TD_PROTOCOL MapPcrToMrIndex function call provides callers > > + the info on TPM PCR<-> measurement register mapping information. > > + > > + In current version, we use below mapping: > > + PCR0 -> MRTD (Index 0) > > + PCR1 -> RTMR0 (Index 1) > > + PCR2~6 -> RTMR1 (Index 2) > > + PCR7 -> RTMR0 (Index 1) > > + PCR8~15 -> RTMR2 (Index 3) > > + > > + @param[in] This Indicates the calling context > > + @param[in] PcrIndex TPM PCR index. > > + @param[out] MrIndex Measurement register index. > > + > > + @retval EFI_SUCCESS The MR index is returned. > > + @retval EFI_INVALID_PARAMETER The MrIndex is NULL. > > + @retval EFI_UNSUPPORTED The PcrIndex is invalid. > > +**/ > > +typedef > > +EFI_STATUS > > +(EFIAPI * EFI_TD_MAP_PCR_TO_MR_INDEX) ( > > + IN EFI_TD_PROTOCOL *This, > > + IN TCG_PCRINDEX PcrIndex, > > + OUT EFI_TD_MR_INDEX *MrIndex > > + ); > > + > > +struct _EFI_TD_PROTOCOL { > > + EFI_TD_GET_CAPABILITY GetCapability; > > + EFI_TD_GET_EVENT_LOG GetEventLog; > > + EFI_TD_HASH_LOG_EXTEND_EVENT > > HashLogExtendEvent; > > + EFI_TD_MAP_PCR_TO_MR_INDEX MapPcrToMrIndex; > > +}; > > + > > + > > +// > > +// TD event log > > +// > > + > > +#pragma pack(1) > > + > > +// > > +// Crypto Agile Log Entry Format. > > +// It is similar with TCG_PCR_EVENT2 except the field of MrIndex and > > PCRIndex. > > +// > > +typedef struct { > > + EFI_TD_MR_INDEX MrIndex; > > + UINT32 EventType; > > + TPML_DIGEST_VALUES Digests; > > + UINT32 EventSize; > > + UINT8 Event[1]; > > +} TD_EVENT; > > + > > +// > > +// EFI TD Event Header > > +// It is similar with TCG_PCR_EVENT2_HDR except the field of MrIndex > > +and > > PCRIndex > > +// > > +typedef struct { > > + EFI_TD_MR_INDEX MrIndex; > > + UINT32 EventType; > > + TPML_DIGEST_VALUES Digests; > > + UINT32 EventSize; > > +} TD_EVENT_HDR; > > + > > +#pragma pack() > > + > > +// > > +// Log entries after Get Event Log service // > > + > > + > > +typedef struct { > > + // > > + // The version of this structure. It shall be set ot 1. > > + // > > + UINT64 Version; > > + // > > + // Number of events recorded after invocation of GetEventLog API > > + // > > + UINT64 NumberOfEvents; > > + // > > + // List of events of type TCG_TD_EVENT. > > + // > > + //TD_EVENT Event[1]; > > +} EFI_TD_FINAL_EVENTS_TABLE; > > + > > + > > +#define EFI_TD_FINAL_EVENTS_TABLE_GUID \ > > + {0xdd4a4648, 0x2de7, 0x4665, {0x96, 0x4d, 0x21, 0xd9, 0xef, 0x5f, > > +0xb4, > > 0x46}} > > + > > +extern EFI_GUID gEfiTdFinalEventsTableGuid; > > + > > +#endif > > diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec index > > a28a2daaffa8..2f48f6c40c1e 100644 > > --- a/MdePkg/MdePkg.dec > > +++ b/MdePkg/MdePkg.dec > > @@ -1008,6 +1008,9 @@ > > ## Include/Protocol/PcdInfo.h > > gGetPcdInfoProtocolGuid = { 0x5be40f57, 0xfa68, 0x4610, { 0xbb, > > 0xbf, 0xe9, 0xc5, 0xfc, 0xda, 0xd3, 0x65 } } > > > > + ## Include/Protocol/TdProtocol.h > > + gEfiTdProtocolGuid = { 0x96751a3d, 0x72f4, 0x41a6, { 0xa7, > > 0x94, 0xed, 0x5d, 0x0e, 0x67, 0xae, 0x6b }} > > + > > # > > # Protocols defined in PI1.0. > > # > > -- > > 2.29.2.windows.2 > > > > > > > > > > > > > > > > > ^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [edk2-devel] [PATCH 1/2] MdePkg: Introduce TdProtocol for TD-Guest firmware 2021-09-15 5:49 ` 回复: [edk2-devel] " gaoliming 2021-09-15 6:04 ` Min Xu @ 2021-09-24 23:01 ` Yao, Jiewen 2021-09-26 0:53 ` 回复: " gaoliming 1 sibling, 1 reply; 9+ messages in thread From: Yao, Jiewen @ 2021-09-24 23:01 UTC (permalink / raw) To: devel@edk2.groups.io, gaoliming@byosoft.com.cn, Xu, Min M Cc: Kinney, Michael D, Liu, Zhiguang, Wang, Jian J, Lu, Ken Hi Liming We just published the GHCI spec version 1.0 revision 002 at https://software.intel.com/content/dam/develop/external/us/en/documents/intel-tdx-guest-hypervisor-communication-interface-1.0-344426-002.pdf 4.3.2 include the EFI_TD_PROTOCOL. Thank you Yao Jiewen > -----Original Message----- > From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of gaoliming > Sent: Wednesday, September 15, 2021 1:50 PM > To: devel@edk2.groups.io; Xu, Min M <min.m.xu@intel.com> > Cc: Kinney, Michael D <michael.d.kinney@intel.com>; Liu, Zhiguang > <zhiguang.liu@intel.com>; Yao, Jiewen <jiewen.yao@intel.com>; Wang, Jian J > <jian.j.wang@intel.com>; Lu, Ken <ken.lu@intel.com> > Subject: 回复: [edk2-devel] [PATCH 1/2] MdePkg: Introduce TdProtocol for TD- > Guest firmware > > Min: > Which public spec defines this new protocol? > > Thanks > Liming > > -----邮件原件----- > > 发件人: devel@edk2.groups.io <devel@edk2.groups.io> 代表 Min Xu > > 发送时间: 2021年9月14日 9:57 > > 收件人: devel@edk2.groups.io > > 抄送: Min Xu <min.m.xu@intel.com>; Michael D Kinney > > <michael.d.kinney@intel.com>; Liming Gao <gaoliming@byosoft.com.cn>; > > Zhiguang Liu <zhiguang.liu@intel.com>; Jiewen Yao <jiewen.yao@intel.com>; > > Jian J Wang <jian.j.wang@intel.com>; Ken Lu <ken.lu@intel.com> > > 主题: [edk2-devel] [PATCH 1/2] MdePkg: Introduce TdProtocol for TD-Guest > > firmware > > > > BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=3625 > > > > If TD-Guest firmware supports measurement and an event is created, > > TD-Guest firmware is designed to report the event log with the same data > > structure in TCG-Platform-Firmware-Profile specification with > > EFI_TCG2_EVENT_LOG_FORMAT_TCG_2 format. > > > > The TD-Guest firmware supports measurement, the TD Guest Firmware is > > designed to produce EFI_TD_PROTOCOL with new GUID > > EFI_TD_PROTOCOL_GUID > > to report event log and provides hash capability. > > > > Cc: Michael D Kinney <michael.d.kinney@intel.com> > > Cc: Liming Gao <gaoliming@byosoft.com.cn> > > Cc: Zhiguang Liu <zhiguang.liu@intel.com> > > Cc: Jiewen Yao <jiewen.yao@intel.com> > > Cc: Jian J Wang <jian.j.wang@intel.com> > > Cc: Ken Lu <ken.lu@intel.com> > > Signed-off-by: Min Xu <min.m.xu@intel.com> > > --- > > MdePkg/Include/Protocol/TdProtocol.h | 305 > > +++++++++++++++++++++++++++ > > MdePkg/MdePkg.dec | 3 + > > 2 files changed, 308 insertions(+) > > create mode 100644 MdePkg/Include/Protocol/TdProtocol.h > > > > diff --git a/MdePkg/Include/Protocol/TdProtocol.h > > b/MdePkg/Include/Protocol/TdProtocol.h > > new file mode 100644 > > index 000000000000..5a015fca0079 > > --- /dev/null > > +++ b/MdePkg/Include/Protocol/TdProtocol.h > > @@ -0,0 +1,305 @@ > > +/** @file > > + If TD-Guest firmware supports measurement and an event is created, > > TD-Guest > > + firmware is designed to report the event log with the same data > structure > > + in TCG-Platform-Firmware-Profile specification with > > + EFI_TCG2_EVENT_LOG_FORMAT_TCG_2 format. > > + > > + The TD-Guest firmware supports measurement, the TD Guest Firmware is > > designed > > + to produce EFI_TD_PROTOCOL with new GUID EFI_TD_PROTOCOL_GUID > > to report > > + event log and provides hash capability. > > + > > +Copyright (c) 2020 - 2021, Intel Corporation. All rights reserved.<BR> > > +SPDX-License-Identifier: BSD-2-Clause-Patent > > + > > +**/ > > + > > + > > +#ifndef TD_PROTOCOL_H_ > > +#define TD_PROTOCOL_H_ > > + > > +#include <Uefi/UefiBaseType.h> > > +#include <IndustryStandard/UefiTcgPlatform.h> > > +#include <IndustryStandard/Tpm20.h> > > + > > + > > +#define EFI_TD_PROTOCOL_GUID \ > > + { 0x96751a3d, 0x72f4, 0x41a6, { 0xa7, 0x94, 0xed, 0x5d, 0x0e, 0x67, > 0xae, > > 0x6b }} > > +extern EFI_GUID gEfiTdProtocolGuid; > > + > > +typedef struct _EFI_TD_PROTOCOL EFI_TD_PROTOCOL; > > + > > +typedef struct { > > + UINT8 Major; > > + UINT8 Minor; > > +} EFI_TD_VERSION; > > + > > +typedef UINT32 EFI_TD_EVENT_LOG_BITMAP; > > +typedef UINT32 EFI_TD_EVENT_LOG_FORMAT; > > +typedef UINT32 > > EFI_TD_EVENT_ALGORITHM_BITMAP; > > +typedef UINT32 EFI_TD_MR_INDEX; > > + > > +#define EFI_TD_EVENT_LOG_FORMAT_TCG_2 0x00000002 > > +#define EFI_TD_BOOT_HASH_ALG_SHA384 0x00000004 > > + > > +// > > +// This bit is shall be set when an event shall be extended but not > logged. > > +// > > +#define EFI_TD_FLAG_EXTEND_ONLY 0x0000000000000001 > > +// > > +// This bit shall be set when the intent is to measure a PE/COFF image. > > +// > > +#define EFI_TD_FLAG_PE_COFF_IMAGE 0x0000000000000010 > > + > > +#define MR_INDEX_MRTD 0 > > +#define MR_INDEX_RTMR0 1 > > +#define MR_INDEX_RTMR1 2 > > +#define MR_INDEX_RTMR2 3 > > +#define MR_INDEX_RTMR3 4 > > + > > +// > > +// This bit shall be set when the intent is to measure a PE/COFF image. > > +// > > +#define PE_COFF_IMAGE 0x0000000000000010 > > + > > +#pragma pack (1) > > + > > +#define EFI_TD_EVENT_HEADER_VERSION 1 > > + > > +typedef struct { > > + // > > + // Size of the event header itself (sizeof(EFI_TD_EVENT_HEADER)). > > + // > > + UINT32 HeaderSize; > > + // > > + // Header version. For this version of this specification, the value > shall be > > 1. > > + // > > + UINT16 HeaderVersion; > > + // > > + // Index of the MR that shall be extended. > > + // > > + EFI_TD_MR_INDEX MrIndex; > > + // > > + // Type of the event that shall be extended (and optionally logged). > > + // > > + UINT32 EventType; > > +} EFI_TD_EVENT_HEADER; > > + > > +typedef struct { > > + // > > + // Total size of the event including the Size component, the header and > the > > Event data. > > + // > > + UINT32 Size; > > + EFI_TD_EVENT_HEADER Header; > > + UINT8 Event[1]; > > +} EFI_TD_EVENT; > > + > > +#pragma pack() > > + > > + > > +typedef struct { > > + // > > + // Allocated size of the structure > > + // > > + UINT8 Size; > > + // > > + // Version of the EFI_TD_BOOT_SERVICE_CAPABILITY structure itself. > > + // For this version of the protocol, the Major version shall be set to > 1 > > + // and the Minor version shall be set to 1. > > + // > > + EFI_TD_VERSION StructureVersion; > > + // > > + // Version of the EFI TD protocol. > > + // For this version of the protocol, the Major version shall be set to > 1 > > + // and the Minor version shall be set to 1. > > + // > > + EFI_TD_VERSION ProtocolVersion; > > + // > > + // Supported hash algorithms > > + // > > + EFI_TD_EVENT_ALGORITHM_BITMAP HashAlgorithmBitmap; > > + // > > + // Bitmap of supported event log formats > > + // > > + EFI_TD_EVENT_LOG_BITMAP SupportedEventLogs; > > + > > + // > > + // False = TD not present > > + // > > + BOOLEAN TdPresentFlag; > > +} EFI_TD_BOOT_SERVICE_CAPABILITY; > > + > > +/** > > + The EFI_TD_PROTOCOL GetCapability function call provides protocol > > + capability information and state information. > > + > > + @param[in] This Indicates the calling context > > + @param[in, out] ProtocolCapability The caller allocates memory for a > > EFI_TD_BOOT_SERVICE_CAPABILITY > > + structure and sets the size > > field to the size of the structure allocated. > > + The callee fills in the fields > > with the EFI protocol capability information > > + and the current EFI TD state > > information up to the number of fields which > > + fit within the size of the > > structure passed in. > > + > > + @retval EFI_SUCCESS Operation completed successfully. > > + @retval EFI_DEVICE_ERROR The command was unsuccessful. > > + The ProtocolCapability variable will > > not be populated. > > + @retval EFI_INVALID_PARAMETER One or more of the parameters are > > incorrect. > > + The ProtocolCapability variable will > > not be populated. > > + @retval EFI_BUFFER_TOO_SMALL The ProtocolCapability variable is > > too small to hold the full response. > > + It will be partially populated > > (required Size field will be set). > > +**/ > > +typedef > > +EFI_STATUS > > +(EFIAPI *EFI_TD_GET_CAPABILITY) ( > > + IN EFI_TD_PROTOCOL *This, > > + IN OUT EFI_TD_BOOT_SERVICE_CAPABILITY *ProtocolCapability > > + ); > > + > > +/** > > + The EFI_TD_PROTOCOL Get Event Log function call allows a caller to > > + retrieve the address of a given event log and its last entry. > > + > > + @param[in] This Indicates the calling context > > + @param[in] EventLogFormat The type of the event log for which > > the information is requested. > > + @param[out] EventLogLocation A pointer to the memory address of > > the event log. > > + @param[out] EventLogLastEntry If the Event Log contains more than > > one entry, this is a pointer to the > > + address of the start of the last > > entry in the event log in memory. > > + @param[out] EventLogTruncated If the Event Log is missing at least one > > entry because an event would > > + have exceeded the area allocated > > for events, this value is set to TRUE. > > + Otherwise, the value will be FALSE > > and the Event Log will be complete. > > + > > + @retval EFI_SUCCESS Operation completed successfully. > > + @retval EFI_INVALID_PARAMETER One or more of the parameters are > > incorrect > > + (e.g. asking for an event log whose > > format is not supported). > > +**/ > > +typedef > > +EFI_STATUS > > +(EFIAPI *EFI_TD_GET_EVENT_LOG) ( > > + IN EFI_TD_PROTOCOL *This, > > + IN EFI_TD_EVENT_LOG_FORMAT EventLogFormat, > > + OUT EFI_PHYSICAL_ADDRESS *EventLogLocation, > > + OUT EFI_PHYSICAL_ADDRESS *EventLogLastEntry, > > + OUT BOOLEAN *EventLogTruncated > > + ); > > + > > +/** > > + The EFI_TD_PROTOCOL HashLogExtendEvent function call provides callers > > with > > + an opportunity to extend and optionally log events without requiring > > + knowledge of actual TD commands. > > + The extend operation will occur even if this function cannot create an > > event > > + log entry (e.g. due to the event log being full). > > + > > + @param[in] This Indicates the calling context > > + @param[in] Flags Bitmap providing additional > > information. > > + @param[in] DataToHash Physical address of the start of the > > data buffer to be hashed. > > + @param[in] DataToHashLen The length in bytes of the buffer > > referenced by DataToHash. > > + @param[in] EfiTdEvent Pointer to data buffer containing > > information about the event. > > + > > + @retval EFI_SUCCESS Operation completed successfully. > > + @retval EFI_DEVICE_ERROR The command was unsuccessful. > > + @retval EFI_VOLUME_FULL The extend operation occurred, but > > the event could not be written to one or more event logs. > > + @retval EFI_INVALID_PARAMETER One or more of the parameters are > > incorrect. > > + @retval EFI_UNSUPPORTED The PE/COFF image type is not > > supported. > > +**/ > > +typedef > > +EFI_STATUS > > +(EFIAPI * EFI_TD_HASH_LOG_EXTEND_EVENT) ( > > + IN EFI_TD_PROTOCOL *This, > > + IN UINT64 Flags, > > + IN EFI_PHYSICAL_ADDRESS DataToHash, > > + IN UINT64 DataToHashLen, > > + IN EFI_TD_EVENT *EfiTdEvent > > + ); > > + > > +/** > > + The EFI_TD_PROTOCOL MapPcrToMrIndex function call provides callers > > + the info on TPM PCR<-> measurement register mapping information. > > + > > + In current version, we use below mapping: > > + PCR0 -> MRTD (Index 0) > > + PCR1 -> RTMR0 (Index 1) > > + PCR2~6 -> RTMR1 (Index 2) > > + PCR7 -> RTMR0 (Index 1) > > + PCR8~15 -> RTMR2 (Index 3) > > + > > + @param[in] This Indicates the calling context > > + @param[in] PcrIndex TPM PCR index. > > + @param[out] MrIndex Measurement register index. > > + > > + @retval EFI_SUCCESS The MR index is returned. > > + @retval EFI_INVALID_PARAMETER The MrIndex is NULL. > > + @retval EFI_UNSUPPORTED The PcrIndex is invalid. > > +**/ > > +typedef > > +EFI_STATUS > > +(EFIAPI * EFI_TD_MAP_PCR_TO_MR_INDEX) ( > > + IN EFI_TD_PROTOCOL *This, > > + IN TCG_PCRINDEX PcrIndex, > > + OUT EFI_TD_MR_INDEX *MrIndex > > + ); > > + > > +struct _EFI_TD_PROTOCOL { > > + EFI_TD_GET_CAPABILITY GetCapability; > > + EFI_TD_GET_EVENT_LOG GetEventLog; > > + EFI_TD_HASH_LOG_EXTEND_EVENT > > HashLogExtendEvent; > > + EFI_TD_MAP_PCR_TO_MR_INDEX MapPcrToMrIndex; > > +}; > > + > > + > > +// > > +// TD event log > > +// > > + > > +#pragma pack(1) > > + > > +// > > +// Crypto Agile Log Entry Format. > > +// It is similar with TCG_PCR_EVENT2 except the field of MrIndex and > > PCRIndex. > > +// > > +typedef struct { > > + EFI_TD_MR_INDEX MrIndex; > > + UINT32 EventType; > > + TPML_DIGEST_VALUES Digests; > > + UINT32 EventSize; > > + UINT8 Event[1]; > > +} TD_EVENT; > > + > > +// > > +// EFI TD Event Header > > +// It is similar with TCG_PCR_EVENT2_HDR except the field of MrIndex and > > PCRIndex > > +// > > +typedef struct { > > + EFI_TD_MR_INDEX MrIndex; > > + UINT32 EventType; > > + TPML_DIGEST_VALUES Digests; > > + UINT32 EventSize; > > +} TD_EVENT_HDR; > > + > > +#pragma pack() > > + > > +// > > +// Log entries after Get Event Log service > > +// > > + > > + > > +typedef struct { > > + // > > + // The version of this structure. It shall be set ot 1. > > + // > > + UINT64 Version; > > + // > > + // Number of events recorded after invocation of GetEventLog API > > + // > > + UINT64 NumberOfEvents; > > + // > > + // List of events of type TCG_TD_EVENT. > > + // > > + //TD_EVENT Event[1]; > > +} EFI_TD_FINAL_EVENTS_TABLE; > > + > > + > > +#define EFI_TD_FINAL_EVENTS_TABLE_GUID \ > > + {0xdd4a4648, 0x2de7, 0x4665, {0x96, 0x4d, 0x21, 0xd9, 0xef, 0x5f, 0xb4, > > 0x46}} > > + > > +extern EFI_GUID gEfiTdFinalEventsTableGuid; > > + > > +#endif > > diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec > > index a28a2daaffa8..2f48f6c40c1e 100644 > > --- a/MdePkg/MdePkg.dec > > +++ b/MdePkg/MdePkg.dec > > @@ -1008,6 +1008,9 @@ > > ## Include/Protocol/PcdInfo.h > > gGetPcdInfoProtocolGuid = { 0x5be40f57, 0xfa68, 0x4610, { 0xbb, > > 0xbf, 0xe9, 0xc5, 0xfc, 0xda, 0xd3, 0x65 } } > > > > + ## Include/Protocol/TdProtocol.h > > + gEfiTdProtocolGuid = { 0x96751a3d, 0x72f4, 0x41a6, { 0xa7, > > 0x94, 0xed, 0x5d, 0x0e, 0x67, 0xae, 0x6b }} > > + > > # > > # Protocols defined in PI1.0. > > # > > -- > > 2.29.2.windows.2 > > > > > > > > > > > > > > > > > ^ permalink raw reply [flat|nested] 9+ messages in thread
* 回复: [edk2-devel] [PATCH 1/2] MdePkg: Introduce TdProtocol for TD-Guest firmware 2021-09-24 23:01 ` Yao, Jiewen @ 2021-09-26 0:53 ` gaoliming 2021-09-26 1:00 ` Yao, Jiewen 0 siblings, 1 reply; 9+ messages in thread From: gaoliming @ 2021-09-26 0:53 UTC (permalink / raw) To: 'Yao, Jiewen', devel, 'Xu, Min M' Cc: 'Kinney, Michael D', 'Liu, Zhiguang', 'Wang, Jian J', 'Lu, Ken' Jiewen: Thanks for this information. I suggest to add this URL into the file header comment, like Edk2\MdePkg\Include\IndustryStandard\DmaRemappingReportingTable.h. Thanks Liming > -----邮件原件----- > 发件人: Yao, Jiewen <jiewen.yao@intel.com> > 发送时间: 2021年9月25日 7:01 > 收件人: devel@edk2.groups.io; gaoliming@byosoft.com.cn; Xu, Min M > <min.m.xu@intel.com> > 抄送: Kinney, Michael D <michael.d.kinney@intel.com>; Liu, Zhiguang > <zhiguang.liu@intel.com>; Wang, Jian J <jian.j.wang@intel.com>; Lu, Ken > <ken.lu@intel.com> > 主题: RE: [edk2-devel] [PATCH 1/2] MdePkg: Introduce TdProtocol for > TD-Guest firmware > > Hi Liming > We just published the GHCI spec version 1.0 revision 002 at > https://software.intel.com/content/dam/develop/external/us/en/documents > /intel-tdx-guest-hypervisor-communication-interface-1.0-344426-002.pdf > > 4.3.2 include the EFI_TD_PROTOCOL. > > Thank you > Yao Jiewen > > > -----Original Message----- > > From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of > gaoliming > > Sent: Wednesday, September 15, 2021 1:50 PM > > To: devel@edk2.groups.io; Xu, Min M <min.m.xu@intel.com> > > Cc: Kinney, Michael D <michael.d.kinney@intel.com>; Liu, Zhiguang > > <zhiguang.liu@intel.com>; Yao, Jiewen <jiewen.yao@intel.com>; Wang, > Jian J > > <jian.j.wang@intel.com>; Lu, Ken <ken.lu@intel.com> > > Subject: 回复: [edk2-devel] [PATCH 1/2] MdePkg: Introduce TdProtocol for > TD- > > Guest firmware > > > > Min: > > Which public spec defines this new protocol? > > > > Thanks > > Liming > > > -----邮件原件----- > > > 发件人: devel@edk2.groups.io <devel@edk2.groups.io> 代表 Min Xu > > > 发送时间: 2021年9月14日 9:57 > > > 收件人: devel@edk2.groups.io > > > 抄送: Min Xu <min.m.xu@intel.com>; Michael D Kinney > > > <michael.d.kinney@intel.com>; Liming Gao <gaoliming@byosoft.com.cn>; > > > Zhiguang Liu <zhiguang.liu@intel.com>; Jiewen Yao > <jiewen.yao@intel.com>; > > > Jian J Wang <jian.j.wang@intel.com>; Ken Lu <ken.lu@intel.com> > > > 主题: [edk2-devel] [PATCH 1/2] MdePkg: Introduce TdProtocol for > TD-Guest > > > firmware > > > > > > BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=3625 > > > > > > If TD-Guest firmware supports measurement and an event is created, > > > TD-Guest firmware is designed to report the event log with the same data > > > structure in TCG-Platform-Firmware-Profile specification with > > > EFI_TCG2_EVENT_LOG_FORMAT_TCG_2 format. > > > > > > The TD-Guest firmware supports measurement, the TD Guest Firmware is > > > designed to produce EFI_TD_PROTOCOL with new GUID > > > EFI_TD_PROTOCOL_GUID > > > to report event log and provides hash capability. > > > > > > Cc: Michael D Kinney <michael.d.kinney@intel.com> > > > Cc: Liming Gao <gaoliming@byosoft.com.cn> > > > Cc: Zhiguang Liu <zhiguang.liu@intel.com> > > > Cc: Jiewen Yao <jiewen.yao@intel.com> > > > Cc: Jian J Wang <jian.j.wang@intel.com> > > > Cc: Ken Lu <ken.lu@intel.com> > > > Signed-off-by: Min Xu <min.m.xu@intel.com> > > > --- > > > MdePkg/Include/Protocol/TdProtocol.h | 305 > > > +++++++++++++++++++++++++++ > > > MdePkg/MdePkg.dec | 3 + > > > 2 files changed, 308 insertions(+) > > > create mode 100644 MdePkg/Include/Protocol/TdProtocol.h > > > > > > diff --git a/MdePkg/Include/Protocol/TdProtocol.h > > > b/MdePkg/Include/Protocol/TdProtocol.h > > > new file mode 100644 > > > index 000000000000..5a015fca0079 > > > --- /dev/null > > > +++ b/MdePkg/Include/Protocol/TdProtocol.h > > > @@ -0,0 +1,305 @@ > > > +/** @file > > > + If TD-Guest firmware supports measurement and an event is created, > > > TD-Guest > > > + firmware is designed to report the event log with the same data > > structure > > > + in TCG-Platform-Firmware-Profile specification with > > > + EFI_TCG2_EVENT_LOG_FORMAT_TCG_2 format. > > > + > > > + The TD-Guest firmware supports measurement, the TD Guest > Firmware is > > > designed > > > + to produce EFI_TD_PROTOCOL with new GUID > EFI_TD_PROTOCOL_GUID > > > to report > > > + event log and provides hash capability. > > > + > > > +Copyright (c) 2020 - 2021, Intel Corporation. All rights reserved.<BR> > > > +SPDX-License-Identifier: BSD-2-Clause-Patent > > > + > > > +**/ > > > + > > > + > > > +#ifndef TD_PROTOCOL_H_ > > > +#define TD_PROTOCOL_H_ > > > + > > > +#include <Uefi/UefiBaseType.h> > > > +#include <IndustryStandard/UefiTcgPlatform.h> > > > +#include <IndustryStandard/Tpm20.h> > > > + > > > + > > > +#define EFI_TD_PROTOCOL_GUID \ > > > + { 0x96751a3d, 0x72f4, 0x41a6, { 0xa7, 0x94, 0xed, 0x5d, 0x0e, 0x67, > > 0xae, > > > 0x6b }} > > > +extern EFI_GUID gEfiTdProtocolGuid; > > > + > > > +typedef struct _EFI_TD_PROTOCOL EFI_TD_PROTOCOL; > > > + > > > +typedef struct { > > > + UINT8 Major; > > > + UINT8 Minor; > > > +} EFI_TD_VERSION; > > > + > > > +typedef UINT32 > EFI_TD_EVENT_LOG_BITMAP; > > > +typedef UINT32 > EFI_TD_EVENT_LOG_FORMAT; > > > +typedef UINT32 > > > EFI_TD_EVENT_ALGORITHM_BITMAP; > > > +typedef UINT32 EFI_TD_MR_INDEX; > > > + > > > +#define EFI_TD_EVENT_LOG_FORMAT_TCG_2 0x00000002 > > > +#define EFI_TD_BOOT_HASH_ALG_SHA384 0x00000004 > > > + > > > +// > > > +// This bit is shall be set when an event shall be extended but not > > logged. > > > +// > > > +#define EFI_TD_FLAG_EXTEND_ONLY 0x0000000000000001 > > > +// > > > +// This bit shall be set when the intent is to measure a PE/COFF image. > > > +// > > > +#define EFI_TD_FLAG_PE_COFF_IMAGE 0x0000000000000010 > > > + > > > +#define MR_INDEX_MRTD 0 > > > +#define MR_INDEX_RTMR0 1 > > > +#define MR_INDEX_RTMR1 2 > > > +#define MR_INDEX_RTMR2 3 > > > +#define MR_INDEX_RTMR3 4 > > > + > > > +// > > > +// This bit shall be set when the intent is to measure a PE/COFF image. > > > +// > > > +#define PE_COFF_IMAGE 0x0000000000000010 > > > + > > > +#pragma pack (1) > > > + > > > +#define EFI_TD_EVENT_HEADER_VERSION 1 > > > + > > > +typedef struct { > > > + // > > > + // Size of the event header itself (sizeof(EFI_TD_EVENT_HEADER)). > > > + // > > > + UINT32 HeaderSize; > > > + // > > > + // Header version. For this version of this specification, the value > > shall be > > > 1. > > > + // > > > + UINT16 HeaderVersion; > > > + // > > > + // Index of the MR that shall be extended. > > > + // > > > + EFI_TD_MR_INDEX MrIndex; > > > + // > > > + // Type of the event that shall be extended (and optionally logged). > > > + // > > > + UINT32 EventType; > > > +} EFI_TD_EVENT_HEADER; > > > + > > > +typedef struct { > > > + // > > > + // Total size of the event including the Size component, the header and > > the > > > Event data. > > > + // > > > + UINT32 Size; > > > + EFI_TD_EVENT_HEADER Header; > > > + UINT8 Event[1]; > > > +} EFI_TD_EVENT; > > > + > > > +#pragma pack() > > > + > > > + > > > +typedef struct { > > > + // > > > + // Allocated size of the structure > > > + // > > > + UINT8 Size; > > > + // > > > + // Version of the EFI_TD_BOOT_SERVICE_CAPABILITY structure itself. > > > + // For this version of the protocol, the Major version shall be set to > > 1 > > > + // and the Minor version shall be set to 1. > > > + // > > > + EFI_TD_VERSION StructureVersion; > > > + // > > > + // Version of the EFI TD protocol. > > > + // For this version of the protocol, the Major version shall be set to > > 1 > > > + // and the Minor version shall be set to 1. > > > + // > > > + EFI_TD_VERSION ProtocolVersion; > > > + // > > > + // Supported hash algorithms > > > + // > > > + EFI_TD_EVENT_ALGORITHM_BITMAP HashAlgorithmBitmap; > > > + // > > > + // Bitmap of supported event log formats > > > + // > > > + EFI_TD_EVENT_LOG_BITMAP SupportedEventLogs; > > > + > > > + // > > > + // False = TD not present > > > + // > > > + BOOLEAN TdPresentFlag; > > > +} EFI_TD_BOOT_SERVICE_CAPABILITY; > > > + > > > +/** > > > + The EFI_TD_PROTOCOL GetCapability function call provides protocol > > > + capability information and state information. > > > + > > > + @param[in] This Indicates the calling context > > > + @param[in, out] ProtocolCapability The caller allocates memory for a > > > EFI_TD_BOOT_SERVICE_CAPABILITY > > > + structure and sets the size > > > field to the size of the structure allocated. > > > + The callee fills in the fields > > > with the EFI protocol capability information > > > + and the current EFI TD > state > > > information up to the number of fields which > > > + fit within the size of the > > > structure passed in. > > > + > > > + @retval EFI_SUCCESS Operation completed > successfully. > > > + @retval EFI_DEVICE_ERROR The command was unsuccessful. > > > + The ProtocolCapability variable > will > > > not be populated. > > > + @retval EFI_INVALID_PARAMETER One or more of the parameters > are > > > incorrect. > > > + The ProtocolCapability variable > will > > > not be populated. > > > + @retval EFI_BUFFER_TOO_SMALL The ProtocolCapability variable > is > > > too small to hold the full response. > > > + It will be partially populated > > > (required Size field will be set). > > > +**/ > > > +typedef > > > +EFI_STATUS > > > +(EFIAPI *EFI_TD_GET_CAPABILITY) ( > > > + IN EFI_TD_PROTOCOL *This, > > > + IN OUT EFI_TD_BOOT_SERVICE_CAPABILITY *ProtocolCapability > > > + ); > > > + > > > +/** > > > + The EFI_TD_PROTOCOL Get Event Log function call allows a caller to > > > + retrieve the address of a given event log and its last entry. > > > + > > > + @param[in] This Indicates the calling context > > > + @param[in] EventLogFormat The type of the event log for > which > > > the information is requested. > > > + @param[out] EventLogLocation A pointer to the memory address > of > > > the event log. > > > + @param[out] EventLogLastEntry If the Event Log contains more than > > > one entry, this is a pointer to the > > > + address of the start of the last > > > entry in the event log in memory. > > > + @param[out] EventLogTruncated If the Event Log is missing at least > one > > > entry because an event would > > > + have exceeded the area > allocated > > > for events, this value is set to TRUE. > > > + Otherwise, the value will be > FALSE > > > and the Event Log will be complete. > > > + > > > + @retval EFI_SUCCESS Operation completed > successfully. > > > + @retval EFI_INVALID_PARAMETER One or more of the parameters > are > > > incorrect > > > + (e.g. asking for an event log > whose > > > format is not supported). > > > +**/ > > > +typedef > > > +EFI_STATUS > > > +(EFIAPI *EFI_TD_GET_EVENT_LOG) ( > > > + IN EFI_TD_PROTOCOL *This, > > > + IN EFI_TD_EVENT_LOG_FORMAT EventLogFormat, > > > + OUT EFI_PHYSICAL_ADDRESS *EventLogLocation, > > > + OUT EFI_PHYSICAL_ADDRESS *EventLogLastEntry, > > > + OUT BOOLEAN *EventLogTruncated > > > + ); > > > + > > > +/** > > > + The EFI_TD_PROTOCOL HashLogExtendEvent function call provides > callers > > > with > > > + an opportunity to extend and optionally log events without requiring > > > + knowledge of actual TD commands. > > > + The extend operation will occur even if this function cannot create an > > > event > > > + log entry (e.g. due to the event log being full). > > > + > > > + @param[in] This Indicates the calling context > > > + @param[in] Flags Bitmap providing additional > > > information. > > > + @param[in] DataToHash Physical address of the start of > the > > > data buffer to be hashed. > > > + @param[in] DataToHashLen The length in bytes of the buffer > > > referenced by DataToHash. > > > + @param[in] EfiTdEvent Pointer to data buffer containing > > > information about the event. > > > + > > > + @retval EFI_SUCCESS Operation completed > successfully. > > > + @retval EFI_DEVICE_ERROR The command was unsuccessful. > > > + @retval EFI_VOLUME_FULL The extend operation occurred, > but > > > the event could not be written to one or more event logs. > > > + @retval EFI_INVALID_PARAMETER One or more of the parameters > are > > > incorrect. > > > + @retval EFI_UNSUPPORTED The PE/COFF image type is not > > > supported. > > > +**/ > > > +typedef > > > +EFI_STATUS > > > +(EFIAPI * EFI_TD_HASH_LOG_EXTEND_EVENT) ( > > > + IN EFI_TD_PROTOCOL *This, > > > + IN UINT64 Flags, > > > + IN EFI_PHYSICAL_ADDRESS DataToHash, > > > + IN UINT64 DataToHashLen, > > > + IN EFI_TD_EVENT *EfiTdEvent > > > + ); > > > + > > > +/** > > > + The EFI_TD_PROTOCOL MapPcrToMrIndex function call provides > callers > > > + the info on TPM PCR<-> measurement register mapping information. > > > + > > > + In current version, we use below mapping: > > > + PCR0 -> MRTD (Index 0) > > > + PCR1 -> RTMR0 (Index 1) > > > + PCR2~6 -> RTMR1 (Index 2) > > > + PCR7 -> RTMR0 (Index 1) > > > + PCR8~15 -> RTMR2 (Index 3) > > > + > > > + @param[in] This Indicates the calling context > > > + @param[in] PcrIndex TPM PCR index. > > > + @param[out] MrIndex Measurement register index. > > > + > > > + @retval EFI_SUCCESS The MR index is returned. > > > + @retval EFI_INVALID_PARAMETER The MrIndex is NULL. > > > + @retval EFI_UNSUPPORTED The PcrIndex is invalid. > > > +**/ > > > +typedef > > > +EFI_STATUS > > > +(EFIAPI * EFI_TD_MAP_PCR_TO_MR_INDEX) ( > > > + IN EFI_TD_PROTOCOL *This, > > > + IN TCG_PCRINDEX PcrIndex, > > > + OUT EFI_TD_MR_INDEX *MrIndex > > > + ); > > > + > > > +struct _EFI_TD_PROTOCOL { > > > + EFI_TD_GET_CAPABILITY GetCapability; > > > + EFI_TD_GET_EVENT_LOG GetEventLog; > > > + EFI_TD_HASH_LOG_EXTEND_EVENT > > > HashLogExtendEvent; > > > + EFI_TD_MAP_PCR_TO_MR_INDEX > MapPcrToMrIndex; > > > +}; > > > + > > > + > > > +// > > > +// TD event log > > > +// > > > + > > > +#pragma pack(1) > > > + > > > +// > > > +// Crypto Agile Log Entry Format. > > > +// It is similar with TCG_PCR_EVENT2 except the field of MrIndex and > > > PCRIndex. > > > +// > > > +typedef struct { > > > + EFI_TD_MR_INDEX MrIndex; > > > + UINT32 EventType; > > > + TPML_DIGEST_VALUES Digests; > > > + UINT32 EventSize; > > > + UINT8 Event[1]; > > > +} TD_EVENT; > > > + > > > +// > > > +// EFI TD Event Header > > > +// It is similar with TCG_PCR_EVENT2_HDR except the field of MrIndex > and > > > PCRIndex > > > +// > > > +typedef struct { > > > + EFI_TD_MR_INDEX MrIndex; > > > + UINT32 EventType; > > > + TPML_DIGEST_VALUES Digests; > > > + UINT32 EventSize; > > > +} TD_EVENT_HDR; > > > + > > > +#pragma pack() > > > + > > > +// > > > +// Log entries after Get Event Log service > > > +// > > > + > > > + > > > +typedef struct { > > > + // > > > + // The version of this structure. It shall be set ot 1. > > > + // > > > + UINT64 Version; > > > + // > > > + // Number of events recorded after invocation of GetEventLog API > > > + // > > > + UINT64 NumberOfEvents; > > > + // > > > + // List of events of type TCG_TD_EVENT. > > > + // > > > + //TD_EVENT Event[1]; > > > +} EFI_TD_FINAL_EVENTS_TABLE; > > > + > > > + > > > +#define EFI_TD_FINAL_EVENTS_TABLE_GUID \ > > > + {0xdd4a4648, 0x2de7, 0x4665, {0x96, 0x4d, 0x21, 0xd9, 0xef, 0x5f, > 0xb4, > > > 0x46}} > > > + > > > +extern EFI_GUID gEfiTdFinalEventsTableGuid; > > > + > > > +#endif > > > diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec > > > index a28a2daaffa8..2f48f6c40c1e 100644 > > > --- a/MdePkg/MdePkg.dec > > > +++ b/MdePkg/MdePkg.dec > > > @@ -1008,6 +1008,9 @@ > > > ## Include/Protocol/PcdInfo.h > > > gGetPcdInfoProtocolGuid = { 0x5be40f57, 0xfa68, 0x4610, > { 0xbb, > > > 0xbf, 0xe9, 0xc5, 0xfc, 0xda, 0xd3, 0x65 } } > > > > > > + ## Include/Protocol/TdProtocol.h > > > + gEfiTdProtocolGuid = { 0x96751a3d, 0x72f4, 0x41a6, > { 0xa7, > > > 0x94, 0xed, 0x5d, 0x0e, 0x67, 0xae, 0x6b }} > > > + > > > # > > > # Protocols defined in PI1.0. > > > # > > > -- > > > 2.29.2.windows.2 > > > > > > > > > > > > > > > > > > > > > > > > > > > > > ^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [edk2-devel] [PATCH 1/2] MdePkg: Introduce TdProtocol for TD-Guest firmware 2021-09-26 0:53 ` 回复: " gaoliming @ 2021-09-26 1:00 ` Yao, Jiewen 0 siblings, 0 replies; 9+ messages in thread From: Yao, Jiewen @ 2021-09-26 1:00 UTC (permalink / raw) To: devel@edk2.groups.io, gaoliming@byosoft.com.cn, Xu, Min M Cc: Kinney, Michael D, Liu, Zhiguang, Wang, Jian J, Lu, Ken Yes. Agree. Good suggestion. > -----Original Message----- > From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of gaoliming > Sent: Sunday, September 26, 2021 8:54 AM > To: Yao, Jiewen <jiewen.yao@intel.com>; devel@edk2.groups.io; Xu, Min M > <min.m.xu@intel.com> > Cc: Kinney, Michael D <michael.d.kinney@intel.com>; Liu, Zhiguang > <zhiguang.liu@intel.com>; Wang, Jian J <jian.j.wang@intel.com>; Lu, Ken > <ken.lu@intel.com> > Subject: 回复: [edk2-devel] [PATCH 1/2] MdePkg: Introduce TdProtocol for TD- > Guest firmware > > Jiewen: > Thanks for this information. I suggest to add this URL into the file header > comment, like > Edk2\MdePkg\Include\IndustryStandard\DmaRemappingReportingTable.h. > > Thanks > Liming > > -----邮件原件----- > > 发件人: Yao, Jiewen <jiewen.yao@intel.com> > > 发送时间: 2021年9月25日 7:01 > > 收件人: devel@edk2.groups.io; gaoliming@byosoft.com.cn; Xu, Min M > > <min.m.xu@intel.com> > > 抄送: Kinney, Michael D <michael.d.kinney@intel.com>; Liu, Zhiguang > > <zhiguang.liu@intel.com>; Wang, Jian J <jian.j.wang@intel.com>; Lu, Ken > > <ken.lu@intel.com> > > 主题: RE: [edk2-devel] [PATCH 1/2] MdePkg: Introduce TdProtocol for > > TD-Guest firmware > > > > Hi Liming > > We just published the GHCI spec version 1.0 revision 002 at > > https://software.intel.com/content/dam/develop/external/us/en/documents > > /intel-tdx-guest-hypervisor-communication-interface-1.0-344426-002.pdf > > > > 4.3.2 include the EFI_TD_PROTOCOL. > > > > Thank you > > Yao Jiewen > > > > > -----Original Message----- > > > From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of > > gaoliming > > > Sent: Wednesday, September 15, 2021 1:50 PM > > > To: devel@edk2.groups.io; Xu, Min M <min.m.xu@intel.com> > > > Cc: Kinney, Michael D <michael.d.kinney@intel.com>; Liu, Zhiguang > > > <zhiguang.liu@intel.com>; Yao, Jiewen <jiewen.yao@intel.com>; Wang, > > Jian J > > > <jian.j.wang@intel.com>; Lu, Ken <ken.lu@intel.com> > > > Subject: 回复: [edk2-devel] [PATCH 1/2] MdePkg: Introduce TdProtocol for > > TD- > > > Guest firmware > > > > > > Min: > > > Which public spec defines this new protocol? > > > > > > Thanks > > > Liming > > > > -----邮件原件----- > > > > 发件人: devel@edk2.groups.io <devel@edk2.groups.io> 代表 Min Xu > > > > 发送时间: 2021年9月14日 9:57 > > > > 收件人: devel@edk2.groups.io > > > > 抄送: Min Xu <min.m.xu@intel.com>; Michael D Kinney > > > > <michael.d.kinney@intel.com>; Liming Gao <gaoliming@byosoft.com.cn>; > > > > Zhiguang Liu <zhiguang.liu@intel.com>; Jiewen Yao > > <jiewen.yao@intel.com>; > > > > Jian J Wang <jian.j.wang@intel.com>; Ken Lu <ken.lu@intel.com> > > > > 主题: [edk2-devel] [PATCH 1/2] MdePkg: Introduce TdProtocol for > > TD-Guest > > > > firmware > > > > > > > > BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=3625 > > > > > > > > If TD-Guest firmware supports measurement and an event is created, > > > > TD-Guest firmware is designed to report the event log with the same data > > > > structure in TCG-Platform-Firmware-Profile specification with > > > > EFI_TCG2_EVENT_LOG_FORMAT_TCG_2 format. > > > > > > > > The TD-Guest firmware supports measurement, the TD Guest Firmware is > > > > designed to produce EFI_TD_PROTOCOL with new GUID > > > > EFI_TD_PROTOCOL_GUID > > > > to report event log and provides hash capability. > > > > > > > > Cc: Michael D Kinney <michael.d.kinney@intel.com> > > > > Cc: Liming Gao <gaoliming@byosoft.com.cn> > > > > Cc: Zhiguang Liu <zhiguang.liu@intel.com> > > > > Cc: Jiewen Yao <jiewen.yao@intel.com> > > > > Cc: Jian J Wang <jian.j.wang@intel.com> > > > > Cc: Ken Lu <ken.lu@intel.com> > > > > Signed-off-by: Min Xu <min.m.xu@intel.com> > > > > --- > > > > MdePkg/Include/Protocol/TdProtocol.h | 305 > > > > +++++++++++++++++++++++++++ > > > > MdePkg/MdePkg.dec | 3 + > > > > 2 files changed, 308 insertions(+) > > > > create mode 100644 MdePkg/Include/Protocol/TdProtocol.h > > > > > > > > diff --git a/MdePkg/Include/Protocol/TdProtocol.h > > > > b/MdePkg/Include/Protocol/TdProtocol.h > > > > new file mode 100644 > > > > index 000000000000..5a015fca0079 > > > > --- /dev/null > > > > +++ b/MdePkg/Include/Protocol/TdProtocol.h > > > > @@ -0,0 +1,305 @@ > > > > +/** @file > > > > + If TD-Guest firmware supports measurement and an event is created, > > > > TD-Guest > > > > + firmware is designed to report the event log with the same data > > > structure > > > > + in TCG-Platform-Firmware-Profile specification with > > > > + EFI_TCG2_EVENT_LOG_FORMAT_TCG_2 format. > > > > + > > > > + The TD-Guest firmware supports measurement, the TD Guest > > Firmware is > > > > designed > > > > + to produce EFI_TD_PROTOCOL with new GUID > > EFI_TD_PROTOCOL_GUID > > > > to report > > > > + event log and provides hash capability. > > > > + > > > > +Copyright (c) 2020 - 2021, Intel Corporation. All rights reserved.<BR> > > > > +SPDX-License-Identifier: BSD-2-Clause-Patent > > > > + > > > > +**/ > > > > + > > > > + > > > > +#ifndef TD_PROTOCOL_H_ > > > > +#define TD_PROTOCOL_H_ > > > > + > > > > +#include <Uefi/UefiBaseType.h> > > > > +#include <IndustryStandard/UefiTcgPlatform.h> > > > > +#include <IndustryStandard/Tpm20.h> > > > > + > > > > + > > > > +#define EFI_TD_PROTOCOL_GUID \ > > > > + { 0x96751a3d, 0x72f4, 0x41a6, { 0xa7, 0x94, 0xed, 0x5d, 0x0e, 0x67, > > > 0xae, > > > > 0x6b }} > > > > +extern EFI_GUID gEfiTdProtocolGuid; > > > > + > > > > +typedef struct _EFI_TD_PROTOCOL EFI_TD_PROTOCOL; > > > > + > > > > +typedef struct { > > > > + UINT8 Major; > > > > + UINT8 Minor; > > > > +} EFI_TD_VERSION; > > > > + > > > > +typedef UINT32 > > EFI_TD_EVENT_LOG_BITMAP; > > > > +typedef UINT32 > > EFI_TD_EVENT_LOG_FORMAT; > > > > +typedef UINT32 > > > > EFI_TD_EVENT_ALGORITHM_BITMAP; > > > > +typedef UINT32 EFI_TD_MR_INDEX; > > > > + > > > > +#define EFI_TD_EVENT_LOG_FORMAT_TCG_2 0x00000002 > > > > +#define EFI_TD_BOOT_HASH_ALG_SHA384 0x00000004 > > > > + > > > > +// > > > > +// This bit is shall be set when an event shall be extended but not > > > logged. > > > > +// > > > > +#define EFI_TD_FLAG_EXTEND_ONLY 0x0000000000000001 > > > > +// > > > > +// This bit shall be set when the intent is to measure a PE/COFF image. > > > > +// > > > > +#define EFI_TD_FLAG_PE_COFF_IMAGE 0x0000000000000010 > > > > + > > > > +#define MR_INDEX_MRTD 0 > > > > +#define MR_INDEX_RTMR0 1 > > > > +#define MR_INDEX_RTMR1 2 > > > > +#define MR_INDEX_RTMR2 3 > > > > +#define MR_INDEX_RTMR3 4 > > > > + > > > > +// > > > > +// This bit shall be set when the intent is to measure a PE/COFF image. > > > > +// > > > > +#define PE_COFF_IMAGE 0x0000000000000010 > > > > + > > > > +#pragma pack (1) > > > > + > > > > +#define EFI_TD_EVENT_HEADER_VERSION 1 > > > > + > > > > +typedef struct { > > > > + // > > > > + // Size of the event header itself (sizeof(EFI_TD_EVENT_HEADER)). > > > > + // > > > > + UINT32 HeaderSize; > > > > + // > > > > + // Header version. For this version of this specification, the value > > > shall be > > > > 1. > > > > + // > > > > + UINT16 HeaderVersion; > > > > + // > > > > + // Index of the MR that shall be extended. > > > > + // > > > > + EFI_TD_MR_INDEX MrIndex; > > > > + // > > > > + // Type of the event that shall be extended (and optionally logged). > > > > + // > > > > + UINT32 EventType; > > > > +} EFI_TD_EVENT_HEADER; > > > > + > > > > +typedef struct { > > > > + // > > > > + // Total size of the event including the Size component, the header and > > > the > > > > Event data. > > > > + // > > > > + UINT32 Size; > > > > + EFI_TD_EVENT_HEADER Header; > > > > + UINT8 Event[1]; > > > > +} EFI_TD_EVENT; > > > > + > > > > +#pragma pack() > > > > + > > > > + > > > > +typedef struct { > > > > + // > > > > + // Allocated size of the structure > > > > + // > > > > + UINT8 Size; > > > > + // > > > > + // Version of the EFI_TD_BOOT_SERVICE_CAPABILITY structure itself. > > > > + // For this version of the protocol, the Major version shall be set to > > > 1 > > > > + // and the Minor version shall be set to 1. > > > > + // > > > > + EFI_TD_VERSION StructureVersion; > > > > + // > > > > + // Version of the EFI TD protocol. > > > > + // For this version of the protocol, the Major version shall be set to > > > 1 > > > > + // and the Minor version shall be set to 1. > > > > + // > > > > + EFI_TD_VERSION ProtocolVersion; > > > > + // > > > > + // Supported hash algorithms > > > > + // > > > > + EFI_TD_EVENT_ALGORITHM_BITMAP HashAlgorithmBitmap; > > > > + // > > > > + // Bitmap of supported event log formats > > > > + // > > > > + EFI_TD_EVENT_LOG_BITMAP SupportedEventLogs; > > > > + > > > > + // > > > > + // False = TD not present > > > > + // > > > > + BOOLEAN TdPresentFlag; > > > > +} EFI_TD_BOOT_SERVICE_CAPABILITY; > > > > + > > > > +/** > > > > + The EFI_TD_PROTOCOL GetCapability function call provides protocol > > > > + capability information and state information. > > > > + > > > > + @param[in] This Indicates the calling context > > > > + @param[in, out] ProtocolCapability The caller allocates memory for a > > > > EFI_TD_BOOT_SERVICE_CAPABILITY > > > > + structure and sets the size > > > > field to the size of the structure allocated. > > > > + The callee fills in the fields > > > > with the EFI protocol capability information > > > > + and the current EFI TD > > state > > > > information up to the number of fields which > > > > + fit within the size of the > > > > structure passed in. > > > > + > > > > + @retval EFI_SUCCESS Operation completed > > successfully. > > > > + @retval EFI_DEVICE_ERROR The command was unsuccessful. > > > > + The ProtocolCapability variable > > will > > > > not be populated. > > > > + @retval EFI_INVALID_PARAMETER One or more of the parameters > > are > > > > incorrect. > > > > + The ProtocolCapability variable > > will > > > > not be populated. > > > > + @retval EFI_BUFFER_TOO_SMALL The ProtocolCapability variable > > is > > > > too small to hold the full response. > > > > + It will be partially populated > > > > (required Size field will be set). > > > > +**/ > > > > +typedef > > > > +EFI_STATUS > > > > +(EFIAPI *EFI_TD_GET_CAPABILITY) ( > > > > + IN EFI_TD_PROTOCOL *This, > > > > + IN OUT EFI_TD_BOOT_SERVICE_CAPABILITY *ProtocolCapability > > > > + ); > > > > + > > > > +/** > > > > + The EFI_TD_PROTOCOL Get Event Log function call allows a caller to > > > > + retrieve the address of a given event log and its last entry. > > > > + > > > > + @param[in] This Indicates the calling context > > > > + @param[in] EventLogFormat The type of the event log for > > which > > > > the information is requested. > > > > + @param[out] EventLogLocation A pointer to the memory address > > of > > > > the event log. > > > > + @param[out] EventLogLastEntry If the Event Log contains more than > > > > one entry, this is a pointer to the > > > > + address of the start of the last > > > > entry in the event log in memory. > > > > + @param[out] EventLogTruncated If the Event Log is missing at least > > one > > > > entry because an event would > > > > + have exceeded the area > > allocated > > > > for events, this value is set to TRUE. > > > > + Otherwise, the value will be > > FALSE > > > > and the Event Log will be complete. > > > > + > > > > + @retval EFI_SUCCESS Operation completed > > successfully. > > > > + @retval EFI_INVALID_PARAMETER One or more of the parameters > > are > > > > incorrect > > > > + (e.g. asking for an event log > > whose > > > > format is not supported). > > > > +**/ > > > > +typedef > > > > +EFI_STATUS > > > > +(EFIAPI *EFI_TD_GET_EVENT_LOG) ( > > > > + IN EFI_TD_PROTOCOL *This, > > > > + IN EFI_TD_EVENT_LOG_FORMAT EventLogFormat, > > > > + OUT EFI_PHYSICAL_ADDRESS *EventLogLocation, > > > > + OUT EFI_PHYSICAL_ADDRESS *EventLogLastEntry, > > > > + OUT BOOLEAN *EventLogTruncated > > > > + ); > > > > + > > > > +/** > > > > + The EFI_TD_PROTOCOL HashLogExtendEvent function call provides > > callers > > > > with > > > > + an opportunity to extend and optionally log events without requiring > > > > + knowledge of actual TD commands. > > > > + The extend operation will occur even if this function cannot create an > > > > event > > > > + log entry (e.g. due to the event log being full). > > > > + > > > > + @param[in] This Indicates the calling context > > > > + @param[in] Flags Bitmap providing additional > > > > information. > > > > + @param[in] DataToHash Physical address of the start of > > the > > > > data buffer to be hashed. > > > > + @param[in] DataToHashLen The length in bytes of the buffer > > > > referenced by DataToHash. > > > > + @param[in] EfiTdEvent Pointer to data buffer containing > > > > information about the event. > > > > + > > > > + @retval EFI_SUCCESS Operation completed > > successfully. > > > > + @retval EFI_DEVICE_ERROR The command was unsuccessful. > > > > + @retval EFI_VOLUME_FULL The extend operation occurred, > > but > > > > the event could not be written to one or more event logs. > > > > + @retval EFI_INVALID_PARAMETER One or more of the parameters > > are > > > > incorrect. > > > > + @retval EFI_UNSUPPORTED The PE/COFF image type is not > > > > supported. > > > > +**/ > > > > +typedef > > > > +EFI_STATUS > > > > +(EFIAPI * EFI_TD_HASH_LOG_EXTEND_EVENT) ( > > > > + IN EFI_TD_PROTOCOL *This, > > > > + IN UINT64 Flags, > > > > + IN EFI_PHYSICAL_ADDRESS DataToHash, > > > > + IN UINT64 DataToHashLen, > > > > + IN EFI_TD_EVENT *EfiTdEvent > > > > + ); > > > > + > > > > +/** > > > > + The EFI_TD_PROTOCOL MapPcrToMrIndex function call provides > > callers > > > > + the info on TPM PCR<-> measurement register mapping information. > > > > + > > > > + In current version, we use below mapping: > > > > + PCR0 -> MRTD (Index 0) > > > > + PCR1 -> RTMR0 (Index 1) > > > > + PCR2~6 -> RTMR1 (Index 2) > > > > + PCR7 -> RTMR0 (Index 1) > > > > + PCR8~15 -> RTMR2 (Index 3) > > > > + > > > > + @param[in] This Indicates the calling context > > > > + @param[in] PcrIndex TPM PCR index. > > > > + @param[out] MrIndex Measurement register index. > > > > + > > > > + @retval EFI_SUCCESS The MR index is returned. > > > > + @retval EFI_INVALID_PARAMETER The MrIndex is NULL. > > > > + @retval EFI_UNSUPPORTED The PcrIndex is invalid. > > > > +**/ > > > > +typedef > > > > +EFI_STATUS > > > > +(EFIAPI * EFI_TD_MAP_PCR_TO_MR_INDEX) ( > > > > + IN EFI_TD_PROTOCOL *This, > > > > + IN TCG_PCRINDEX PcrIndex, > > > > + OUT EFI_TD_MR_INDEX *MrIndex > > > > + ); > > > > + > > > > +struct _EFI_TD_PROTOCOL { > > > > + EFI_TD_GET_CAPABILITY GetCapability; > > > > + EFI_TD_GET_EVENT_LOG GetEventLog; > > > > + EFI_TD_HASH_LOG_EXTEND_EVENT > > > > HashLogExtendEvent; > > > > + EFI_TD_MAP_PCR_TO_MR_INDEX > > MapPcrToMrIndex; > > > > +}; > > > > + > > > > + > > > > +// > > > > +// TD event log > > > > +// > > > > + > > > > +#pragma pack(1) > > > > + > > > > +// > > > > +// Crypto Agile Log Entry Format. > > > > +// It is similar with TCG_PCR_EVENT2 except the field of MrIndex and > > > > PCRIndex. > > > > +// > > > > +typedef struct { > > > > + EFI_TD_MR_INDEX MrIndex; > > > > + UINT32 EventType; > > > > + TPML_DIGEST_VALUES Digests; > > > > + UINT32 EventSize; > > > > + UINT8 Event[1]; > > > > +} TD_EVENT; > > > > + > > > > +// > > > > +// EFI TD Event Header > > > > +// It is similar with TCG_PCR_EVENT2_HDR except the field of MrIndex > > and > > > > PCRIndex > > > > +// > > > > +typedef struct { > > > > + EFI_TD_MR_INDEX MrIndex; > > > > + UINT32 EventType; > > > > + TPML_DIGEST_VALUES Digests; > > > > + UINT32 EventSize; > > > > +} TD_EVENT_HDR; > > > > + > > > > +#pragma pack() > > > > + > > > > +// > > > > +// Log entries after Get Event Log service > > > > +// > > > > + > > > > + > > > > +typedef struct { > > > > + // > > > > + // The version of this structure. It shall be set ot 1. > > > > + // > > > > + UINT64 Version; > > > > + // > > > > + // Number of events recorded after invocation of GetEventLog API > > > > + // > > > > + UINT64 NumberOfEvents; > > > > + // > > > > + // List of events of type TCG_TD_EVENT. > > > > + // > > > > + //TD_EVENT Event[1]; > > > > +} EFI_TD_FINAL_EVENTS_TABLE; > > > > + > > > > + > > > > +#define EFI_TD_FINAL_EVENTS_TABLE_GUID \ > > > > + {0xdd4a4648, 0x2de7, 0x4665, {0x96, 0x4d, 0x21, 0xd9, 0xef, 0x5f, > > 0xb4, > > > > 0x46}} > > > > + > > > > +extern EFI_GUID gEfiTdFinalEventsTableGuid; > > > > + > > > > +#endif > > > > diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec > > > > index a28a2daaffa8..2f48f6c40c1e 100644 > > > > --- a/MdePkg/MdePkg.dec > > > > +++ b/MdePkg/MdePkg.dec > > > > @@ -1008,6 +1008,9 @@ > > > > ## Include/Protocol/PcdInfo.h > > > > gGetPcdInfoProtocolGuid = { 0x5be40f57, 0xfa68, 0x4610, > > { 0xbb, > > > > 0xbf, 0xe9, 0xc5, 0xfc, 0xda, 0xd3, 0x65 } } > > > > > > > > + ## Include/Protocol/TdProtocol.h > > > > + gEfiTdProtocolGuid = { 0x96751a3d, 0x72f4, 0x41a6, > > { 0xa7, > > > > 0x94, 0xed, 0x5d, 0x0e, 0x67, 0xae, 0x6b }} > > > > + > > > > # > > > > # Protocols defined in PI1.0. > > > > # > > > > -- > > > > 2.29.2.windows.2 > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > ^ permalink raw reply [flat|nested] 9+ messages in thread
* [PATCH 2/2] SecurityPkg: Add DxeTdMeasureBootLib for TD measure boot 2021-09-14 1:57 [PATCH 0/2] Introduce TdProtocol into EDK2 Min Xu 2021-09-14 1:57 ` [PATCH 1/2] MdePkg: Introduce TdProtocol for TD-Guest firmware Min Xu @ 2021-09-14 1:57 ` Min Xu 1 sibling, 0 replies; 9+ messages in thread From: Min Xu @ 2021-09-14 1:57 UTC (permalink / raw) To: devel; +Cc: Min Xu, Jiewen Yao, Jian J Wang BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=3625 The library instance provides security service of TD measure boot. DxeTdMeasureBootLibImageRead() function will make sure the PE/COFF image content read is within the image buffer. TdMeasurePeImage() function will accept untrusted PE/COFF image and validate its data structure within this image buffer before use. TdMeasureGptTable() function will receive untrusted GPT partition table, and parse partition data carefully. Cc: Jiewen Yao <jiewen.yao@intel.com> Cc: Jian J Wang <jian.j.wang@intel.com> Signed-off-by: Min Xu <min.m.xu@intel.com> --- .../DxeTdMeasureBootLib/DxeTdMeasureBootLib.c | 688 ++++++++++++++++++ .../DxeTdMeasureBootLib.inf | 61 ++ .../DxeTdMeasureBootLib.uni | 21 + SecurityPkg/SecurityPkg.dsc | 5 + 4 files changed, 775 insertions(+) create mode 100644 SecurityPkg/Library/DxeTdMeasureBootLib/DxeTdMeasureBootLib.c create mode 100644 SecurityPkg/Library/DxeTdMeasureBootLib/DxeTdMeasureBootLib.inf create mode 100644 SecurityPkg/Library/DxeTdMeasureBootLib/DxeTdMeasureBootLib.uni diff --git a/SecurityPkg/Library/DxeTdMeasureBootLib/DxeTdMeasureBootLib.c b/SecurityPkg/Library/DxeTdMeasureBootLib/DxeTdMeasureBootLib.c new file mode 100644 index 000000000000..797925fb6888 --- /dev/null +++ b/SecurityPkg/Library/DxeTdMeasureBootLib/DxeTdMeasureBootLib.c @@ -0,0 +1,688 @@ +/** @file + The library instance provides security service of TD measure boot. + + Caution: This file requires additional review when modified. + This library will have external input - PE/COFF image and GPT partition. + This external input must be validated carefully to avoid security issue like + buffer overflow, integer overflow. + + DxeTdMeasureBootLibImageRead() function will make sure the PE/COFF image content + read is within the image buffer. + + TdMeasurePeImage() function will accept untrusted PE/COFF image and validate its + data structure within this image buffer before use. + + TdMeasureGptTable() function will receive untrusted GPT partition table, and parse + partition data carefully. + + Copyright (c) 2021, Intel Corporation. All rights reserved.<BR> + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include <PiDxe.h> + +#include <Protocol/TdProtocol.h> +#include <Protocol/BlockIo.h> +#include <Protocol/DiskIo.h> +#include <Protocol/DevicePathToText.h> +#include <Protocol/FirmwareVolumeBlock.h> + +#include <Guid/MeasuredFvHob.h> + +#include <Library/BaseLib.h> +#include <Library/DebugLib.h> +#include <Library/BaseMemoryLib.h> +#include <Library/MemoryAllocationLib.h> +#include <Library/DevicePathLib.h> +#include <Library/UefiBootServicesTableLib.h> +#include <Library/BaseCryptLib.h> +#include <Library/PeCoffLib.h> +#include <Library/SecurityManagementLib.h> +#include <Library/HobLib.h> + +// +// Flag to check GPT partition. It only need be measured once. +// +BOOLEAN mTdMeasureGptTableFlag = FALSE; +UINTN mTdMeasureGptCount = 0; +VOID *mTdFileBuffer; +UINTN mTdImageSize; +// +// Measured FV handle cache +// +EFI_HANDLE mTdCacheMeasuredHandle = NULL; +MEASURED_HOB_DATA *mTdMeasuredHobData = NULL; + +/** + Reads contents of a PE/COFF image in memory buffer. + + Caution: This function may receive untrusted input. + PE/COFF image is external input, so this function will make sure the PE/COFF image content + read is within the image buffer. + + @param FileHandle Pointer to the file handle to read the PE/COFF image. + @param FileOffset Offset into the PE/COFF image to begin the read operation. + @param ReadSize On input, the size in bytes of the requested read operation. + On output, the number of bytes actually read. + @param Buffer Output buffer that contains the data read from the PE/COFF image. + + @retval EFI_SUCCESS The specified portion of the PE/COFF image was read and the size +**/ +EFI_STATUS +EFIAPI +DxeTdMeasureBootLibImageRead ( + IN VOID *FileHandle, + IN UINTN FileOffset, + IN OUT UINTN *ReadSize, + OUT VOID *Buffer + ) +{ + UINTN EndPosition; + + if (FileHandle == NULL || ReadSize == NULL || Buffer == NULL) { + return EFI_INVALID_PARAMETER; + } + + if (MAX_ADDRESS - FileOffset < *ReadSize) { + return EFI_INVALID_PARAMETER; + } + + EndPosition = FileOffset + *ReadSize; + if (EndPosition > mTdImageSize) { + *ReadSize = (UINT32)(mTdImageSize - FileOffset); + } + + if (FileOffset >= mTdImageSize) { + *ReadSize = 0; + } + + CopyMem (Buffer, (UINT8 *)((UINTN) FileHandle + FileOffset), *ReadSize); + + return EFI_SUCCESS; +} + +/** + Measure GPT table data into TD Event log. + + Caution: This function may receive untrusted input. + The GPT partition table is external input, so this function should parse partition data carefully. + + @param TdProtocol Pointer to the located TD protocol instance. + @param GptHandle Handle that GPT partition was installed. + + @retval EFI_SUCCESS Successfully measure GPT table. + @retval EFI_UNSUPPORTED Not support GPT table on the given handle. + @retval EFI_DEVICE_ERROR Can't get GPT table because device error. + @retval EFI_OUT_OF_RESOURCES No enough resource to measure GPT table. + @retval other error value +**/ +EFI_STATUS +EFIAPI +TdMeasureGptTable ( + IN EFI_TD_PROTOCOL *TdProtocol, + IN EFI_HANDLE GptHandle + ) +{ + EFI_STATUS Status; + EFI_BLOCK_IO_PROTOCOL *BlockIo; + EFI_DISK_IO_PROTOCOL *DiskIo; + EFI_PARTITION_TABLE_HEADER *PrimaryHeader; + EFI_PARTITION_ENTRY *PartitionEntry; + UINT8 *EntryPtr; + UINTN NumberOfPartition; + UINT32 Index; + EFI_TD_EVENT *TdEvent; + EFI_GPT_DATA *GptData; + UINT32 EventSize; + + if (mTdMeasureGptCount > 0) { + return EFI_SUCCESS; + } + + Status = gBS->HandleProtocol (GptHandle, &gEfiBlockIoProtocolGuid, (VOID**)&BlockIo); + if (EFI_ERROR (Status)) { + return EFI_UNSUPPORTED; + } + Status = gBS->HandleProtocol (GptHandle, &gEfiDiskIoProtocolGuid, (VOID**)&DiskIo); + if (EFI_ERROR (Status)) { + return EFI_UNSUPPORTED; + } + // + // Read the EFI Partition Table Header + // + PrimaryHeader = (EFI_PARTITION_TABLE_HEADER *) AllocatePool (BlockIo->Media->BlockSize); + if (PrimaryHeader == NULL) { + return EFI_OUT_OF_RESOURCES; + } + Status = DiskIo->ReadDisk ( + DiskIo, + BlockIo->Media->MediaId, + 1 * BlockIo->Media->BlockSize, + BlockIo->Media->BlockSize, + (UINT8 *)PrimaryHeader + ); + if (EFI_ERROR (Status)) { + DEBUG ((DEBUG_ERROR, "Failed to Read Partition Table Header!\n")); + FreePool (PrimaryHeader); + return EFI_DEVICE_ERROR; + } + // + // Read the partition entry. + // + EntryPtr = (UINT8 *)AllocatePool (PrimaryHeader->NumberOfPartitionEntries * PrimaryHeader->SizeOfPartitionEntry); + if (EntryPtr == NULL) { + FreePool (PrimaryHeader); + return EFI_OUT_OF_RESOURCES; + } + Status = DiskIo->ReadDisk ( + DiskIo, + BlockIo->Media->MediaId, + MultU64x32(PrimaryHeader->PartitionEntryLBA, BlockIo->Media->BlockSize), + PrimaryHeader->NumberOfPartitionEntries * PrimaryHeader->SizeOfPartitionEntry, + EntryPtr + ); + if (EFI_ERROR (Status)) { + FreePool (PrimaryHeader); + FreePool (EntryPtr); + return EFI_DEVICE_ERROR; + } + + // + // Count the valid partition + // + PartitionEntry = (EFI_PARTITION_ENTRY *)EntryPtr; + NumberOfPartition = 0; + for (Index = 0; Index < PrimaryHeader->NumberOfPartitionEntries; Index++) { + if (!IsZeroGuid (&PartitionEntry->PartitionTypeGUID)) { + NumberOfPartition++; + } + PartitionEntry = (EFI_PARTITION_ENTRY *)((UINT8 *)PartitionEntry + PrimaryHeader->SizeOfPartitionEntry); + } + + // + // Prepare Data for Measurement + // + EventSize = (UINT32)(sizeof (EFI_GPT_DATA) - sizeof (GptData->Partitions) + + NumberOfPartition * PrimaryHeader->SizeOfPartitionEntry); + TdEvent = (EFI_TD_EVENT *) AllocateZeroPool (EventSize + sizeof (EFI_TD_EVENT) - sizeof(TdEvent->Event)); + if (TdEvent == NULL) { + FreePool (PrimaryHeader); + FreePool (EntryPtr); + return EFI_OUT_OF_RESOURCES; + } + + TdEvent->Size = EventSize + sizeof (EFI_TD_EVENT) - sizeof(TdEvent->Event); + TdEvent->Header.HeaderSize = sizeof(EFI_TD_EVENT_HEADER); + TdEvent->Header.HeaderVersion = EFI_TD_EVENT_HEADER_VERSION; + TdEvent->Header.MrIndex = 1; + TdEvent->Header.EventType = EV_EFI_GPT_EVENT; + GptData = (EFI_GPT_DATA *) TdEvent->Event; + + // + // Copy the EFI_PARTITION_TABLE_HEADER and NumberOfPartition + // + CopyMem ((UINT8 *)GptData, (UINT8*)PrimaryHeader, sizeof (EFI_PARTITION_TABLE_HEADER)); + GptData->NumberOfPartitions = NumberOfPartition; + // + // Copy the valid partition entry + // + PartitionEntry = (EFI_PARTITION_ENTRY*)EntryPtr; + NumberOfPartition = 0; + for (Index = 0; Index < PrimaryHeader->NumberOfPartitionEntries; Index++) { + if (!IsZeroGuid (&PartitionEntry->PartitionTypeGUID)) { + CopyMem ( + (UINT8 *)&GptData->Partitions + NumberOfPartition * PrimaryHeader->SizeOfPartitionEntry, + (UINT8 *)PartitionEntry, + PrimaryHeader->SizeOfPartitionEntry + ); + NumberOfPartition++; + } + PartitionEntry =(EFI_PARTITION_ENTRY *)((UINT8 *)PartitionEntry + PrimaryHeader->SizeOfPartitionEntry); + } + + // + // Measure the GPT data + // + Status = TdProtocol->HashLogExtendEvent ( + TdProtocol, + 0, + (EFI_PHYSICAL_ADDRESS) (UINTN) (VOID *) GptData, + (UINT64) EventSize, + TdEvent + ); + if (!EFI_ERROR (Status)) { + mTdMeasureGptCount++; + } + + FreePool (PrimaryHeader); + FreePool (EntryPtr); + FreePool (TdEvent); + + return Status; +} + +/** + Measure PE image into TD log based on the authenticode image hashing in + PE/COFF Specification 8.0 Appendix A. + + Caution: This function may receive untrusted input. + PE/COFF image is external input, so this function will validate its data structure + within this image buffer before use. + + @param[in] TdProtocol Pointer to the located TD protocol instance. + @param[in] ImageAddress Start address of image buffer. + @param[in] ImageSize Image size + @param[in] LinkTimeBase Address that the image is loaded into memory. + @param[in] ImageType Image subsystem type. + @param[in] FilePath File path is corresponding to the input image. + + @retval EFI_SUCCESS Successfully measure image. + @retval EFI_OUT_OF_RESOURCES No enough resource to measure image. + @retval EFI_UNSUPPORTED ImageType is unsupported or PE image is mal-format. + @retval other error value + +**/ +EFI_STATUS +EFIAPI +TdMeasurePeImage ( + IN EFI_TD_PROTOCOL *TdProtocol, + IN EFI_PHYSICAL_ADDRESS ImageAddress, + IN UINTN ImageSize, + IN UINTN LinkTimeBase, + IN UINT16 ImageType, + IN EFI_DEVICE_PATH_PROTOCOL *FilePath + ) +{ + EFI_STATUS Status; + EFI_TD_EVENT *TdEvent; + EFI_IMAGE_LOAD_EVENT *ImageLoad; + UINT32 FilePathSize; + UINT32 EventSize; + + Status = EFI_UNSUPPORTED; + ImageLoad = NULL; + FilePathSize = (UINT32) GetDevicePathSize (FilePath); + + // + // Determine destination PCR by BootPolicy + // + EventSize = sizeof (*ImageLoad) - sizeof (ImageLoad->DevicePath) + FilePathSize; + TdEvent = AllocateZeroPool (EventSize + sizeof (EFI_TD_EVENT) - sizeof(TdEvent->Event)); + if (TdEvent == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + TdEvent->Size = EventSize + sizeof (EFI_TD_EVENT) - sizeof(TdEvent->Event); + TdEvent->Header.HeaderSize = sizeof(EFI_TD_EVENT_HEADER); + TdEvent->Header.HeaderVersion = EFI_TD_EVENT_HEADER_VERSION; + ImageLoad = (EFI_IMAGE_LOAD_EVENT *) TdEvent->Event; + + switch (ImageType) { + case EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION: + TdEvent->Header.EventType = EV_EFI_BOOT_SERVICES_APPLICATION; + TdEvent->Header.MrIndex = 1; + break; + case EFI_IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER: + TdEvent->Header.EventType = EV_EFI_BOOT_SERVICES_DRIVER; + TdEvent->Header.MrIndex = 1; + break; + case EFI_IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER: + TdEvent->Header.EventType = EV_EFI_RUNTIME_SERVICES_DRIVER; + TdEvent->Header.MrIndex = 1; + break; + default: + DEBUG (( + DEBUG_ERROR, + "TdMeasurePeImage: Unknown subsystem type %d", + ImageType + )); + goto Finish; + } + + ImageLoad->ImageLocationInMemory = ImageAddress; + ImageLoad->ImageLengthInMemory = ImageSize; + ImageLoad->ImageLinkTimeAddress = LinkTimeBase; + ImageLoad->LengthOfDevicePath = FilePathSize; + if ((FilePath != NULL) && (FilePathSize != 0)) { + CopyMem (ImageLoad->DevicePath, FilePath, FilePathSize); + } + + // + // Log the PE data + // + Status = TdProtocol->HashLogExtendEvent ( + TdProtocol, + PE_COFF_IMAGE, + ImageAddress, + ImageSize, + TdEvent + ); + if (Status == EFI_VOLUME_FULL) { + // + // Volume full here means the image is hashed and its result is extended to PCR. + // But the event log can't be saved since log area is full. + // Just return EFI_SUCCESS in order not to block the image load. + // + Status = EFI_SUCCESS; + } + +Finish: + FreePool (TdEvent); + + return Status; +} + +/** + The security handler is used to abstract platform-specific policy + from the DXE core response to an attempt to use a file that returns a + given status for the authentication check from the section extraction protocol. + + The possible responses in a given SAP implementation may include locking + flash upon failure to authenticate, attestation logging for all signed drivers, + and other exception operations. The File parameter allows for possible logging + within the SAP of the driver. + + If the file specified by File with an authentication status specified by + AuthenticationStatus is safe for the DXE Core to use, then EFI_SUCCESS is returned. + + If the file specified by File with an authentication status specified by + AuthenticationStatus is not safe for the DXE Core to use under any circumstances, + then EFI_ACCESS_DENIED is returned. + + If the file specified by File with an authentication status specified by + AuthenticationStatus is not safe for the DXE Core to use right now, but it + might be possible to use it at a future time, then EFI_SECURITY_VIOLATION is + returned. + + If check image specified by FileBuffer and File is NULL meanwhile, return EFI_ACCESS_DENIED. + + @param[in] AuthenticationStatus This is the authentication status returned + from the securitymeasurement services for the + input file. + @param[in] File This is a pointer to the device path of the file that is + being dispatched. This will optionally be used for logging. + @param[in] FileBuffer File buffer matches the input file device path. + @param[in] FileSize Size of File buffer matches the input file device path. + @param[in] BootPolicy A boot policy that was used to call LoadImage() UEFI service. + + @retval EFI_SUCCESS The file specified by DevicePath and non-NULL + FileBuffer did authenticate, and the platform policy dictates + that the DXE Foundation may use the file. + @retval other error value +**/ +EFI_STATUS +EFIAPI +DxeTdMeasureBootHandler ( + IN UINT32 AuthenticationStatus, + IN CONST EFI_DEVICE_PATH_PROTOCOL *File, OPTIONAL + IN VOID *FileBuffer, + IN UINTN FileSize, + IN BOOLEAN BootPolicy + ) +{ + EFI_TD_PROTOCOL *TdProtocol; + EFI_STATUS Status; + EFI_DEVICE_PATH_PROTOCOL *DevicePathNode; + EFI_DEVICE_PATH_PROTOCOL *OrigDevicePathNode; + EFI_HANDLE Handle; + EFI_HANDLE TempHandle; + BOOLEAN ApplicationRequired; + PE_COFF_LOADER_IMAGE_CONTEXT ImageContext; + EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *FvbProtocol; + EFI_PHYSICAL_ADDRESS FvAddress; + UINT32 Index; + + Status = gBS->LocateProtocol (&gEfiTdProtocolGuid, NULL, (VOID **) &TdProtocol); + if (EFI_ERROR (Status)) { + // + // TD protocol is not installed. So, TD is not present. + // Don't do any measurement, and directly return EFI_SUCCESS. + // + DEBUG ((DEBUG_VERBOSE, "DxeTdMeasureBootHandler - TD - %r\n", Status)); + return EFI_SUCCESS; + } + + // + // Copy File Device Path + // + OrigDevicePathNode = DuplicateDevicePath (File); + + // + // 1. Check whether this device path support BlockIo protocol. + // Is so, this device path may be a GPT device path. + // + DevicePathNode = OrigDevicePathNode; + Status = gBS->LocateDevicePath (&gEfiBlockIoProtocolGuid, &DevicePathNode, &Handle); + if (!EFI_ERROR (Status) && !mTdMeasureGptTableFlag) { + // + // Find the gpt partition on the given devicepath + // + DevicePathNode = OrigDevicePathNode; + ASSERT (DevicePathNode != NULL); + while (!IsDevicePathEnd (DevicePathNode)) { + // + // Find the Gpt partition + // + if (DevicePathType (DevicePathNode) == MEDIA_DEVICE_PATH && + DevicePathSubType (DevicePathNode) == MEDIA_HARDDRIVE_DP) { + // + // Check whether it is a gpt partition or not + // + if (((HARDDRIVE_DEVICE_PATH *) DevicePathNode)->MBRType == MBR_TYPE_EFI_PARTITION_TABLE_HEADER && + ((HARDDRIVE_DEVICE_PATH *) DevicePathNode)->SignatureType == SIGNATURE_TYPE_GUID) { + + // + // Change the partition device path to its parent device path (disk) and get the handle. + // + DevicePathNode->Type = END_DEVICE_PATH_TYPE; + DevicePathNode->SubType = END_ENTIRE_DEVICE_PATH_SUBTYPE; + DevicePathNode = OrigDevicePathNode; + Status = gBS->LocateDevicePath ( + &gEfiDiskIoProtocolGuid, + &DevicePathNode, + &Handle + ); + if (!EFI_ERROR (Status)) { + // + // Measure GPT disk. + // + Status = TdMeasureGptTable (TdProtocol, Handle); + DEBUG ((DEBUG_INFO, "DxeTdMeasureBootHandler - TdMeasureGptTable - %r\n", Status)); + if (!EFI_ERROR (Status)) { + // + // GPT disk check done. + // + mTdMeasureGptTableFlag = TRUE; + } + } + FreePool (OrigDevicePathNode); + OrigDevicePathNode = DuplicateDevicePath (File); + ASSERT (OrigDevicePathNode != NULL); + break; + } + } + DevicePathNode = NextDevicePathNode (DevicePathNode); + } + } + + // + // 2. Measure PE image. + // + ApplicationRequired = FALSE; + + // + // Check whether this device path support FVB protocol. + // + DevicePathNode = OrigDevicePathNode; + Status = gBS->LocateDevicePath (&gEfiFirmwareVolumeBlockProtocolGuid, &DevicePathNode, &Handle); + if (!EFI_ERROR (Status)) { + // + // Don't check FV image, and directly return EFI_SUCCESS. + // It can be extended to the specific FV authentication according to the different requirement. + // + if (IsDevicePathEnd (DevicePathNode)) { + return EFI_SUCCESS; + } + // + // The PE image from unmeasured Firmware volume need be measured + // The PE image from measured Firmware volume will be measured according to policy below. + // If it is driver, do not measure + // If it is application, still measure. + // + ApplicationRequired = TRUE; + + if (mTdCacheMeasuredHandle != Handle && mTdMeasuredHobData != NULL) { + // + // Search for Root FV of this PE image + // + TempHandle = Handle; + do { + Status = gBS->HandleProtocol( + TempHandle, + &gEfiFirmwareVolumeBlockProtocolGuid, + (VOID**)&FvbProtocol + ); + TempHandle = FvbProtocol->ParentHandle; + } while (!EFI_ERROR(Status) && FvbProtocol->ParentHandle != NULL); + + // + // Search in measured FV Hob + // + Status = FvbProtocol->GetPhysicalAddress(FvbProtocol, &FvAddress); + if (EFI_ERROR(Status)){ + return Status; + } + + ApplicationRequired = FALSE; + + for (Index = 0; Index < mTdMeasuredHobData->Num; Index++) { + if(mTdMeasuredHobData->MeasuredFvBuf[Index].BlobBase == FvAddress) { + // + // Cache measured FV for next measurement + // + mTdCacheMeasuredHandle = Handle; + ApplicationRequired = TRUE; + break; + } + } + } + } + + // + // File is not found. + // + if (FileBuffer == NULL) { + Status = EFI_SECURITY_VIOLATION; + goto Finish; + } + + mTdImageSize = FileSize; + mTdFileBuffer = FileBuffer; + + // + // Measure PE Image + // + DevicePathNode = OrigDevicePathNode; + ZeroMem (&ImageContext, sizeof (ImageContext)); + ImageContext.Handle = (VOID *) FileBuffer; + ImageContext.ImageRead = (PE_COFF_LOADER_READ_FILE) DxeTdMeasureBootLibImageRead; + + // + // Get information about the image being loaded + // + Status = PeCoffLoaderGetImageInfo (&ImageContext); + if (EFI_ERROR (Status)) { + // + // Check for invalid parameters. + // + if (File == NULL) { + Status = EFI_ACCESS_DENIED; + } + + // + // The information can't be got from the invalid PeImage + // + goto Finish; + } + + // + // Measure only application if Application flag is set + // Measure drivers and applications if Application flag is not set + // + if ((!ApplicationRequired) || + (ApplicationRequired && ImageContext.ImageType == EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION)) { + // + // Print the image path to be measured. + // + DEBUG_CODE_BEGIN (); + CHAR16 *ToText; + ToText = ConvertDevicePathToText ( + DevicePathNode, + FALSE, + TRUE + ); + if (ToText != NULL) { + DEBUG ((DEBUG_INFO, "The measured image path is %s.\n", ToText)); + FreePool (ToText); + } + DEBUG_CODE_END (); + + // + // Measure PE image into TD log. + // + Status = TdMeasurePeImage ( + TdProtocol, + (EFI_PHYSICAL_ADDRESS) (UINTN) FileBuffer, + FileSize, + (UINTN) ImageContext.ImageAddress, + ImageContext.ImageType, + DevicePathNode + ); + DEBUG ((DEBUG_INFO, "DxeTdMeasureBootHandler - TdMeasurePeImage - %r\n", Status)); + } + + // + // Done, free the allocated resource. + // +Finish: + if (OrigDevicePathNode != NULL) { + FreePool (OrigDevicePathNode); + } + + DEBUG ((DEBUG_INFO, "DxeTdMeasureBootHandler - %r\n", Status)); + + return Status; +} + +/** + Register the security handler to provide TD measure boot service. + + @param ImageHandle ImageHandle of the loaded driver. + @param SystemTable Pointer to the EFI System Table. + + @retval EFI_SUCCESS Register successfully. + @retval EFI_OUT_OF_RESOURCES No enough memory to register this handler. +**/ +EFI_STATUS +EFIAPI +DxeTdMeasureBootLibConstructor ( + IN EFI_HANDLE ImageHandle, + IN EFI_SYSTEM_TABLE *SystemTable + ) +{ + EFI_HOB_GUID_TYPE *GuidHob; + + GuidHob = NULL; + + GuidHob = GetFirstGuidHob (&gMeasuredFvHobGuid); + + if (GuidHob != NULL) { + mTdMeasuredHobData = GET_GUID_HOB_DATA (GuidHob); + } + + return RegisterSecurity2Handler ( + DxeTdMeasureBootHandler, + EFI_AUTH_OPERATION_MEASURE_IMAGE | EFI_AUTH_OPERATION_IMAGE_REQUIRED + ); +} diff --git a/SecurityPkg/Library/DxeTdMeasureBootLib/DxeTdMeasureBootLib.inf b/SecurityPkg/Library/DxeTdMeasureBootLib/DxeTdMeasureBootLib.inf new file mode 100644 index 000000000000..defe2857749d --- /dev/null +++ b/SecurityPkg/Library/DxeTdMeasureBootLib/DxeTdMeasureBootLib.inf @@ -0,0 +1,61 @@ +## @file +# Provides security service for TD measured boot +# +# This library instance hooks LoadImage() API to measure every image that +# is not measured in PEI phase. And, it will also measure GPT partition. +# +# Caution: This module requires additional review when modified. +# This library will have external input - PE/COFF image and GPT partition. +# This external input must be validated carefully to avoid security issues such +# as buffer overflow or integer overflow. +# +# Copyright (c) 2021, Intel Corporation. All rights reserved.<BR> +# SPDX-License-Identifier: BSD-2-Clause-Patent +# +## + +[Defines] + INF_VERSION = 0x00010005 + BASE_NAME = DxeTdMeasureBootLib + MODULE_UNI_FILE = DxeTdMeasureBootLib.uni + FILE_GUID = 5ECEEF3F-05ED-4BC8-B027-A6AD182BE2F3 + MODULE_TYPE = DXE_DRIVER + VERSION_STRING = 1.0 + LIBRARY_CLASS = NULL|DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SAL_DRIVER UEFI_APPLICATION UEFI_DRIVER + CONSTRUCTOR = DxeTdMeasureBootLibConstructor + +# +# The following information is for reference only and not required by the build tools. +# +# VALID_ARCHITECTURES = X64 +# + +[Sources] + DxeTdMeasureBootLib.c + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + SecurityPkg/SecurityPkg.dec + CryptoPkg/CryptoPkg.dec + +[LibraryClasses] + BaseMemoryLib + DebugLib + MemoryAllocationLib + DevicePathLib + UefiBootServicesTableLib + BaseCryptLib + PeCoffLib + BaseLib + SecurityManagementLib + HobLib + +[Guids] + gMeasuredFvHobGuid ## SOMETIMES_CONSUMES ## HOB + +[Protocols] + gEfiTdProtocolGuid ## SOMETIMES_CONSUMES + gEfiFirmwareVolumeBlockProtocolGuid ## SOMETIMES_CONSUMES + gEfiBlockIoProtocolGuid ## SOMETIMES_CONSUMES + gEfiDiskIoProtocolGuid ## SOMETIMES_CONSUMES diff --git a/SecurityPkg/Library/DxeTdMeasureBootLib/DxeTdMeasureBootLib.uni b/SecurityPkg/Library/DxeTdMeasureBootLib/DxeTdMeasureBootLib.uni new file mode 100644 index 000000000000..65769e91127c --- /dev/null +++ b/SecurityPkg/Library/DxeTdMeasureBootLib/DxeTdMeasureBootLib.uni @@ -0,0 +1,21 @@ +// /** @file +// Provides security service for TD measured boot +// +// This library instance hooks LoadImage() API to measure every image that +// is not measured in PEI phase. And, it will also measure GPT partition. +// +// Caution: This module requires additional review when modified. +// This library will have external input - PE/COFF image and GPT partition. +// This external input must be validated carefully to avoid security issues such +// as buffer overflow or integer overflow. +// +// Copyright (c) 2021, Intel Corporation. All rights reserved.<BR> +// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + + +#string STR_MODULE_ABSTRACT #language en-US "Provides security service for TD measured boot" + +#string STR_MODULE_DESCRIPTION #language en-US "This library instance hooks LoadImage() API to measure every image that is not measured in PEI phase. And, it will also measure GPT partition. Caution: This module requires additional review when modified. This library will have external input - PE/COFF image and GPT partition. This external input must be validated carefully to avoid security issues such as buffer overflow or integer overflow." diff --git a/SecurityPkg/SecurityPkg.dsc b/SecurityPkg/SecurityPkg.dsc index f1f678c492b3..8d8b6a38b1e4 100644 --- a/SecurityPkg/SecurityPkg.dsc +++ b/SecurityPkg/SecurityPkg.dsc @@ -218,6 +218,11 @@ SecurityPkg/Library/DxeTcg2PhysicalPresenceLib/DxeTcg2PhysicalPresenceLib.inf SecurityPkg/Library/PeiTcg2PhysicalPresenceLib/PeiTcg2PhysicalPresenceLib.inf + # + # TD + # + SecurityPkg/Library/DxeTdMeasureBootLib/DxeTdMeasureBootLib.inf + SecurityPkg/Library/HashLibBaseCryptoRouter/HashLibBaseCryptoRouterDxe.inf SecurityPkg/Library/HashLibBaseCryptoRouter/HashLibBaseCryptoRouterPei.inf -- 2.29.2.windows.2 ^ permalink raw reply related [flat|nested] 9+ messages in thread
end of thread, other threads:[~2021-09-26 1:01 UTC | newest] Thread overview: 9+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2021-09-14 1:57 [PATCH 0/2] Introduce TdProtocol into EDK2 Min Xu 2021-09-14 1:57 ` [PATCH 1/2] MdePkg: Introduce TdProtocol for TD-Guest firmware Min Xu 2021-09-14 2:05 ` Yao, Jiewen 2021-09-15 5:49 ` 回复: [edk2-devel] " gaoliming 2021-09-15 6:04 ` Min Xu 2021-09-24 23:01 ` Yao, Jiewen 2021-09-26 0:53 ` 回复: " gaoliming 2021-09-26 1:00 ` Yao, Jiewen 2021-09-14 1:57 ` [PATCH 2/2] SecurityPkg: Add DxeTdMeasureBootLib for TD measure boot Min Xu
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox