From nobody Sun Feb 8 20:58:10 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) client-ip=66.175.222.108; envelope-from=bounce+27952+80627+1787277+3901457@groups.io; helo=mail02.groups.io; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+80627+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=intel.com ARC-Seal: i=1; a=rsa-sha256; t=1631584664; cv=none; d=zohomail.com; s=zohoarc; b=J/a2oquaVm3u4vGo3fpwGfj77C+8A2padPhO1L3UALxtTLxEo05sXrkbYikzIT0FVrWn9fuwMHAYSIJwyOcOZVLjqsjoH+CmxGSA4jKsMMbP8p9QxPsGghvX9BCF8C09CNohkGs9/dYsAFfcl9MOulLvY4xzzeV53TVpOgZt/K4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1631584664; h=Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Id:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:References:Sender:Subject:To; bh=cM6dMfhj/GH1Rw9OtxwIW0D0ta6zVYvy1/7zKKJlDL8=; b=ErnQaXaKNneyVbCMgYVa/f3NFWLks2CYiaXiT3Oa2oMjAElAc5SVolO47RIXqf4SbOomw/Gtqj8yZyoBPOkeyPYZ8X2ZvQKY9Hy/FR7id+VG3svPNa1ilU+gNlEhw9vfFfabifGplTvKxyjwvokZSo7edYw2BrI+clxU8YwQj+8= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce+27952+80627+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by mx.zohomail.com with SMTPS id 16315846642271013.221511106925; Mon, 13 Sep 2021 18:57:44 -0700 (PDT) Return-Path: X-Received: by 127.0.0.2 with SMTP id uGBhYY1788612xt9SyjfOyvy; Mon, 13 Sep 2021 18:57:43 -0700 X-Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by mx.groups.io with SMTP id smtpd.web09.4269.1631584662538995448 for ; Mon, 13 Sep 2021 18:57:43 -0700 X-IronPort-AV: E=McAfee;i="6200,9189,10106"; a="285538711" X-IronPort-AV: E=Sophos;i="5.85,291,1624345200"; d="scan'208";a="285538711" X-Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 13 Sep 2021 18:57:42 -0700 X-IronPort-AV: E=Sophos;i="5.85,291,1624345200"; d="scan'208";a="552035349" X-Received: from mxu9-mobl1.ccr.corp.intel.com ([10.249.169.243]) by fmsmga002-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 13 Sep 2021 18:57:39 -0700 From: "Min Xu" To: devel@edk2.groups.io Cc: Min Xu , Michael D Kinney , Liming Gao , Zhiguang Liu , Jiewen Yao , Jian J Wang , Ken Lu Subject: [edk2-devel] [PATCH 1/2] MdePkg: Introduce TdProtocol for TD-Guest firmware Date: Tue, 14 Sep 2021 09:57:19 +0800 Message-Id: <29ffecfbc2a4076d9cb9fc40238548ab637c5f19.1631583583.git.min.m.xu@intel.com> In-Reply-To: References: MIME-Version: 1.0 Precedence: Bulk List-Unsubscribe: List-Subscribe: List-Help: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,min.m.xu@intel.com X-Gm-Message-State: BAWKQypZlpM3Lw9X5KM2kkTBx1787277AA= Content-Transfer-Encoding: quoted-printable DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1631584663; bh=S4aEyXob0lqHBHbTG1n5+i/sFBOnRnQYI7hc/w071W4=; h=Cc:Date:From:Reply-To:Subject:To; b=sQwynVUskBNrzZ2zwQH0/bfFDqvao0m+NdeqvnmkhJXqSDUjEEf3WAP5CQUtuW0D+mP kUQ/HTDNXMdCKK90tJs1gO/rWloRyW1LvS9A1mimnjtYmDAA7z9TFID0RqgqJZ0bV56mr jyLn+JqDkrZeM2N7RHCsiJ9aSo00zsP8giw= X-ZohoMail-DKIM: pass (identity @groups.io) X-ZM-MESSAGEID: 1631584665155100003 Content-Type: text/plain; charset="utf-8" BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=3D3625 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 Cc: Liming Gao Cc: Zhiguang Liu Cc: Jiewen Yao Cc: Jian J Wang Cc: Ken Lu Signed-off-by: Min Xu --- 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-Gu= est + 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 des= igned + 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.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + + +#ifndef TD_PROTOCOL_H_ +#define TD_PROTOCOL_H_ + +#include +#include +#include + + +#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 sha= ll 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 =3D 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 t= he EFI protocol capability information + and the current EFI TD state informat= ion 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 incorre= ct. + The ProtocolCapability variable will not = be populated. + @retval EFI_BUFFER_TOO_SMALL The ProtocolCapability variable is too sm= all 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 i= nformation is requested. + @param[out] EventLogLocation A pointer to the memory address of the ev= ent log. + @param[out] EventLogLastEntry If the Event Log contains more than one e= ntry, 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 even= ts, this value is set to TRUE. + Otherwise, the value will be FALSE and th= e Event Log will be complete. + + @retval EFI_SUCCESS Operation completed successfully. + @retval EFI_INVALID_PARAMETER One or more of the parameters are incorre= ct + (e.g. asking for an event log whose forma= t 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 wi= th + 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 e= vent + 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 referen= ced by DataToHash. + @param[in] EfiTdEvent Pointer to data buffer containing informa= tion 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 ev= ent could not be written to one or more event logs. + @retval EFI_INVALID_PARAMETER One or more of the parameters are incorre= ct. + @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 PCRIn= dex. +// +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 P= CRIndex +// +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 =3D { 0x5be40f57, 0xfa68, 0x4610, { 0xbb,= 0xbf, 0xe9, 0xc5, 0xfc, 0xda, 0xd3, 0x65 } } =20 + ## Include/Protocol/TdProtocol.h + gEfiTdProtocolGuid =3D { 0x96751a3d, 0x72f4, 0x41a6, { 0xa7,= 0x94, 0xed, 0x5d, 0x0e, 0x67, 0xae, 0x6b }} + # # Protocols defined in PI1.0. # --=20 2.29.2.windows.2 -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#80627): https://edk2.groups.io/g/devel/message/80627 Mute This Topic: https://groups.io/mt/85592907/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-