From nobody Sat May 4 22:10:20 2024 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+82795+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+82795+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=intel.com ARC-Seal: i=1; a=rsa-sha256; t=1635397212; cv=none; d=zohomail.com; s=zohoarc; b=WnB+vl0SIwGKwHZVi6WZpaT3nxSn6hP9zsYWAI6pAJTU+aKO4Q/yvINdFNngw+/1pgoH1oDW5mmwhVvLJgaDHO8vTZ6H8ZuwO9Zb2b8GassdAbEx4q+Yh+zKM2AVZ5dfV8EAumVWKcPpYs6Pwa6esYf7PwoTEhBz4VFvgttTlhE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1635397212; 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=cgxhYyNVF3fnPbB6Pp/LccxFFYGST7QhzAOmOOWHpMg=; b=iAzLElvrxg1H2livq7HgcVl1UUMpgd/rLSY45CztgFHlLYw/z36qmyUduaQXvQy44BCie/8JS1qzS+Ak7vA8NpALqVK2C3d7yRqAA23hMKdwOPrViURka3hfHWjUcWIGAenxWhT2Y1uZO3e5RyyA5TWqnAp0GKx6Rtc/HrQPqSM= 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+82795+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 1635397212199897.430753920165; Wed, 27 Oct 2021 22:00:12 -0700 (PDT) Return-Path: X-Received: by 127.0.0.2 with SMTP id Kbn9YY1788612xJZ7VDrI9FJ; Wed, 27 Oct 2021 22:00:11 -0700 X-Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by mx.groups.io with SMTP id smtpd.web08.7256.1635397209852794289 for ; Wed, 27 Oct 2021 22:00:10 -0700 X-IronPort-AV: E=McAfee;i="6200,9189,10150"; a="291160658" X-IronPort-AV: E=Sophos;i="5.87,188,1631602800"; d="scan'208";a="291160658" X-Received: from orsmga008.jf.intel.com ([10.7.209.65]) by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 27 Oct 2021 22:00:09 -0700 X-IronPort-AV: E=Sophos;i="5.87,188,1631602800"; d="scan'208";a="498214327" X-Received: from mxu9-mobl1.ccr.corp.intel.com ([10.238.4.37]) by orsmga008-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 27 Oct 2021 22:00:06 -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 , Sami Mujawar Subject: [edk2-devel] [PATCH V3 1/3] MdePkg: Introduce TeeMeasurementProtocol for TEE Guest firmware Date: Thu, 28 Oct 2021 12:59:27 +0800 Message-Id: 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: HQGwW8tQEqFQSQwGFN488ZFux1787277AA= Content-Transfer-Encoding: quoted-printable DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1635397211; bh=/yn4BbsWV3va5qLR8you2ZAHV7dUglcdhaZ7EKkxeAU=; h=Cc:Date:From:Reply-To:Subject:To; b=cnOTdysJJqRi92jZsl94M69n+3EHrLDXO2Tb//J8SZ9o4wW92qWy4tXtmM+jnLqKgQw NNN8UgvXUxb0snjDbDRMjVCxQDpAxyApeQPEyl5iKcjinp3GQ0Jumi1UbTeEp+kk839rA ClPa1fTfmzCmtW/TD6DIZVMHzBk820ORBDc= X-ZohoMail-DKIM: pass (identity @groups.io) X-ZM-MESSAGEID: 1635397213159100005 Content-Type: text/plain; charset="utf-8" BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=3D3625 If TEE Guest firmware supports measurement and an event is created, TEE 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 TEE Guest firmware supports measurement. It is designed to produce EFI_TEE_MEASUREMENT_PROTOCOL with new GUID EFI_TEE_MEASUREMENT_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 Cc: Sami Mujawar Signed-off-by: Min Xu --- MdePkg/Include/Protocol/TdProtocol.h | 36 +++ MdePkg/Include/Protocol/TeeMeasurement.h | 296 +++++++++++++++++++++++ MdePkg/MdePkg.dec | 3 + 3 files changed, 335 insertions(+) create mode 100644 MdePkg/Include/Protocol/TdProtocol.h create mode 100644 MdePkg/Include/Protocol/TeeMeasurement.h diff --git a/MdePkg/Include/Protocol/TdProtocol.h b/MdePkg/Include/Protocol= /TdProtocol.h new file mode 100644 index 000000000000..8d938b00f3c0 --- /dev/null +++ b/MdePkg/Include/Protocol/TdProtocol.h @@ -0,0 +1,36 @@ +/** @file + TDX specific definitions for EFI_TEE_MEASUREMENT_PROTOCOL + +Copyright (c) 2020 - 2021, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef TD_PROTOCOL_H_ +#define TD_PROTOCOL_H_ + +#define TDX_MR_INDEX_MRTD 0 +#define TDX_MR_INDEX_RTMR0 1 +#define TDX_MR_INDEX_RTMR1 2 +#define TDX_MR_INDEX_RTMR2 3 +#define TDX_MR_INDEX_RTMR3 4 + +/** + 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) + +typedef +EFI_STATUS +(EFIAPI * EFI_TEE_MAP_PCR_TO_MR_INDEX) ( + IN EFI_TEE_MEASUREMENT_PROTOCOL *This, + IN TCG_PCRINDEX PcrIndex, + OUT EFI_TEE_MR_INDEX *MrIndex + ); + +**/ + +#endif diff --git a/MdePkg/Include/Protocol/TeeMeasurement.h b/MdePkg/Include/Prot= ocol/TeeMeasurement.h new file mode 100644 index 000000000000..3f3c71e3dba0 --- /dev/null +++ b/MdePkg/Include/Protocol/TeeMeasurement.h @@ -0,0 +1,296 @@ +/** @file + If TEE Guest firmware supports measurement and an event is created, + TEE 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 TEE Guest firmware supports measurement, the TEE Guest Firmware is + designed to produce EFI_TEE_MEASUREMENT_PROTOCOL with new GUID + EFI_TEE_MEASUREMENT_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 TEE_MEASUREMENT_PROTOCOL_H_ +#define TEE_MEASUREMENT_PROTOCOL_H_ + +#include +#include + +#define EFI_TEE_MEASUREMENT_PROTOCOL_GUID \ + { 0x96751a3d, 0x72f4, 0x41a6, { 0xa7, 0x94, 0xed, 0x5d, 0x0e, 0x67, 0xae= , 0x6b }} +extern EFI_GUID gEfiTeeMeasurementProtocolGuid; + +typedef struct _EFI_TEE_MEASUREMENT_PROTOCOL EFI_TEE_MEASUREMENT_PROTOCOL; + +typedef struct { + UINT8 Major; + UINT8 Minor; +} EFI_TEE_VERSION; + +// +// EFI_TEE Type/SubType definition +// +#define EFI_TEE_TYPE_NONE 0 +#define EFI_TEE_TYPE_SEV 1 +#define EFI_TEE_TYPE_TDX 2 + +typedef struct { + UINT8 Type; + UINT8 SubType; +} EFI_TEE_TYPE; + +typedef UINT32 EFI_TEE_EVENT_LOG_BITMAP; +typedef UINT32 EFI_TEE_EVENT_LOG_FORMAT; +typedef UINT32 EFI_TEE_EVENT_ALGORITHM_BITMAP; +typedef UINT32 EFI_TEE_MR_INDEX; + +#define EFI_TEE_EVENT_LOG_FORMAT_TCG_2 0x00000002 +#define EFI_TEE_BOOT_HASH_ALG_SHA384 0x00000004 + +// +// This bit is shall be set when an event shall be extended but not logged. +// +#define EFI_TEE_FLAG_EXTEND_ONLY 0x0000000000000001 +// +// This bit shall be set when the intent is to measure a PE/COFF image. +// +#define EFI_TEE_FLAG_PE_COFF_IMAGE 0x0000000000000010 + +#pragma pack (1) + +#define EFI_TEE_EVENT_HEADER_VERSION 1 + +typedef struct { + // + // Size of the event header itself (sizeof(EFI_TEE_EVENT_HEADER)). + // + UINT32 HeaderSize; + // + // Header version. For this version of this specification, the value sha= ll be 1. + // + UINT16 HeaderVersion; + // + // Index of the MR (measurement register) that shall be extended. + // + EFI_TEE_MR_INDEX MrIndex; + // + // Type of the event that shall be extended (and optionally logged). + // + UINT32 EventType; +} EFI_TEE_EVENT_HEADER; + +typedef struct { + // + // Total size of the event including the Size component, the header and = the Event data. + // + UINT32 Size; + EFI_TEE_EVENT_HEADER Header; + UINT8 Event[1]; +} EFI_TEE_EVENT; + +#pragma pack() + + +typedef struct { + // + // Allocated size of the structure + // + UINT8 Size; + // + // Version of the EFI_TEE_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 0. + // + EFI_TEE_VERSION StructureVersion; + // + // Version of the EFI TEE Measurement protocol. + // For this version of the protocol, the Major version shall be set to 1 + // and the Minor version shall be set to 0. + // + EFI_TEE_VERSION ProtocolVersion; + // + // Supported hash algorithms + // + EFI_TEE_EVENT_ALGORITHM_BITMAP HashAlgorithmBitmap; + // + // Bitmap of supported event log formats + // + EFI_TEE_EVENT_LOG_BITMAP SupportedEventLogs; + + // + // Indicates the TEE type + // + EFI_TEE_TYPE TeeType; +} EFI_TEE_BOOT_SERVICE_CAPABILITY; + +/** + The EFI_TEE_MEASUREMENT_PROTOCOL GetCapability function call provides pr= otocol + capability information and state information. + + @param[in] This Indicates the calling context + @param[in, out] ProtocolCapability The caller allocates memory for a EFI= _TEE_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 TEE BOOT Service capability + information and the current TEE infor= mation. + + @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_TEE_GET_CAPABILITY) ( + IN EFI_TEE_MEASUREMENT_PROTOCOL *This, + IN OUT EFI_TEE_BOOT_SERVICE_CAPABILITY *ProtocolCapability + ); + +/** + The EFI_TEE_MEASUREMENT_PROTOCOL Get Event Log function call allows a ca= ller 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_TEE_GET_EVENT_LOG) ( + IN EFI_TEE_MEASUREMENT_PROTOCOL *This, + IN EFI_TEE_EVENT_LOG_FORMAT EventLogFormat, + OUT EFI_PHYSICAL_ADDRESS *EventLogLocation, + OUT EFI_PHYSICAL_ADDRESS *EventLogLastEntry, + OUT BOOLEAN *EventLogTruncated + ); + +/** + The EFI_TEE_MEASUREMENT_PROTOCOL HashLogExtendEvent function call provid= es + callers with an opportunity to extend and optionally log events without = requiring + knowledge of actual TEE 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] EfiTeeEvent 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_TEE_HASH_LOG_EXTEND_EVENT) ( + IN EFI_TEE_MEASUREMENT_PROTOCOL *This, + IN UINT64 Flags, + IN EFI_PHYSICAL_ADDRESS DataToHash, + IN UINT64 DataToHashLen, + IN EFI_TEE_EVENT *EfiTeeEvent + ); + +/** + The EFI_TEE_MEASUREMENT_PROTOCOL MapPcrToMrIndex function call provides = callers + the info on TPM PCR <-> TEE MR mapping information. + + @param[in] This Indicates the calling context + @param[in] PcrIndex TPM PCR index. + @param[out] MrIndex TEE MR index. + + @retval EFI_SUCCESS The MrIndex is returned. + @retval EFI_INVALID_PARAMETER The MrIndex is NULL. + @retval EFI_UNSUPPORTED The PcrIndex is invalid. +**/ +typedef +EFI_STATUS +(EFIAPI * EFI_TEE_MAP_PCR_TO_MR_INDEX) ( + IN EFI_TEE_MEASUREMENT_PROTOCOL *This, + IN TCG_PCRINDEX PcrIndex, + OUT EFI_TEE_MR_INDEX *MrIndex + ); + +struct _EFI_TEE_MEASUREMENT_PROTOCOL { + EFI_TEE_GET_CAPABILITY GetCapability; + EFI_TEE_GET_EVENT_LOG GetEventLog; + EFI_TEE_HASH_LOG_EXTEND_EVENT HashLogExtendEvent; + EFI_TEE_MAP_PCR_TO_MR_INDEX MapPcrToMrIndex; +}; + +// +// TEE 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_TEE_MR_INDEX MrIndex; + UINT32 EventType; + TPML_DIGEST_VALUES Digests; + UINT32 EventSize; + UINT8 Event[1]; +} TEE_EVENT; + +// +// EFI TEE Event Header +// It is similar with TCG_PCR_EVENT2_HDR except the field of MrIndex and P= CRIndex +// +typedef struct { + EFI_TEE_MR_INDEX MrIndex; + UINT32 EventType; + TPML_DIGEST_VALUES Digests; + UINT32 EventSize; +} TEE_EVENT_HDR; + +#pragma pack() + +// +// Log entries after Get Event Log service +// + +#define EFI_TEE_FINAL_EVENTS_TABLE_VERSION 1 + +typedef struct { + // + // The version of this structure. It shall be set to 1. + // + UINT64 Version; + // + // Number of events recorded after invocation of GetEventLog API + // + UINT64 NumberOfEvents; + // + // List of events of type TEE_EVENT. + // + //TEE_EVENT Event[1]; +} EFI_TEE_FINAL_EVENTS_TABLE; + + +#define EFI_TEE_FINAL_EVENTS_TABLE_GUID \ + {0xdd4a4648, 0x2de7, 0x4665, {0x96, 0x4d, 0x21, 0xd9, 0xef, 0x5f, 0xb4, = 0x46}} + +extern EFI_GUID gEfiTeeFinalEventsTableGuid; + +#endif diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec index 8b18415b107a..cfb3fa3adc83 100644 --- a/MdePkg/MdePkg.dec +++ b/MdePkg/MdePkg.dec @@ -1011,6 +1011,9 @@ ## Include/Protocol/PcdInfo.h gGetPcdInfoProtocolGuid =3D { 0x5be40f57, 0xfa68, 0x4610, { 0xbb,= 0xbf, 0xe9, 0xc5, 0xfc, 0xda, 0xd3, 0x65 } } =20 + ## Include/Protocol/TeeMeasurement.h + gEfiTeeMeasurementProtocolGuid =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 (#82795): https://edk2.groups.io/g/devel/message/82795 Mute This Topic: https://groups.io/mt/86646137/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- From nobody Sat May 4 22:10:20 2024 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+82797+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+82797+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=intel.com ARC-Seal: i=1; a=rsa-sha256; t=1635397222; cv=none; d=zohomail.com; s=zohoarc; b=i4I+wEmApwlJi2eKPu1HVn23DFncRYixNGpmuvKXXpvltTSOEf7Zbd4i8qs/bOLqv3tYq9F+7TXl/h3BmlTLT+7O18oP/T+/zEaQur+tE5QjzPyHYoYukE7yGExFpX3SMttdJ9d1oPXdJCHGyl/HBZg+ap1YZkWAmZ+L2mth6jk= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1635397222; 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=vsjeU7hVFjyNpqiCMSGfWWQcuk4Y43BEv+DvQ6t6MWc=; b=DlsJMUgQl7gYeS5BokdNLh2o2/ndijgwpvNtIhKQeI2Och/0O/Cj7hL+qWVErtnFS8F3e/uT4ePUyL7EB6MebVHBNlTyNRgbmIhi/8G1QI5ix0CtvdGB6nzPtVd9ULh70965eqJHekMfAsf9b1u+TR8/TwqKNR8Vn21knNXe3Gw= 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+82797+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 1635397222427863.8848466939767; Wed, 27 Oct 2021 22:00:22 -0700 (PDT) Return-Path: X-Received: by 127.0.0.2 with SMTP id FGmYYY1788612xSVc7rWrItN; Wed, 27 Oct 2021 22:00:22 -0700 X-Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by mx.groups.io with SMTP id smtpd.web12.7167.1635397214644232798 for ; Wed, 27 Oct 2021 22:00:16 -0700 X-IronPort-AV: E=McAfee;i="6200,9189,10150"; a="291160680" X-IronPort-AV: E=Sophos;i="5.87,188,1631602800"; d="scan'208";a="291160680" X-Received: from orsmga008.jf.intel.com ([10.7.209.65]) by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 27 Oct 2021 22:00:12 -0700 X-IronPort-AV: E=Sophos;i="5.87,188,1631602800"; d="scan'208";a="498214342" X-Received: from mxu9-mobl1.ccr.corp.intel.com ([10.238.4.37]) by orsmga008-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 27 Oct 2021 22:00:09 -0700 From: "Min Xu" To: devel@edk2.groups.io Cc: Min Xu , Michael D Kinney , Liming Gao , Zhiguang Liu , Jiewen Yao , Jian J Wang , Sami Mujawar Subject: [edk2-devel] [PATCH V3 2/3] SecurityPkg: Support TeeMeasurementProtocol in DxeTpm2MeasureBootLib Date: Thu, 28 Oct 2021 12:59:28 +0800 Message-Id: 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: onqU2C3k3vSncAAJsiWjIoyxx1787277AA= Content-Transfer-Encoding: quoted-printable DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1635397222; bh=I8fz+Z/bb0OUIoCQt65Ge9BAV2MJDHyY+JjJC7xWz+4=; h=Cc:Date:From:Reply-To:Subject:To; b=kQ5YGJtWm1w4FJ5mOu/VVchbzpLqebde4eNc8HK9/AcnhzucgRv5tjcBwDhwN7ZpHFg vY1SQUuEUzMNSeKMfTGp/xSG+KntqUtAfOFCoLaZoj5HDTI6kX+ZlXnsS9aYbu9DZum0k 8cdXpbWLgrHrgfsj+ODARU0MabpuOi9D/+c= X-ZohoMail-DKIM: pass (identity @groups.io) X-ZM-MESSAGEID: 1635397224069100002 Content-Type: text/plain; charset="utf-8" BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=3D3625 DxeTpm2MeasureBootLib supports TPM2 based measure boot. After TeeMeasurementProtocol is introduced, TEE based measure boot needs to be supported in DxeTpm2MeasureBootLib as well. There are 2 major changes in this commit. 1. MEASURE_BOOT_PROTOCOLS is defined to store the instances of TCG2 protocol and TEE protocol. In the DxeTpm2MeasureBootHandler above 2 measure boot protocol instances will be located. Then the located protocol instances will be called to do the measure boot. 2. TeeEvent is similar to Tcg2Event except the MrIndex and PcrIndex. CreateTeeEventFromTcg2Event is used to create the TeeEvent based on the Tcg2Event. Above 2 changes make the minimize changes to the existing code. Cc: Michael D Kinney Cc: Liming Gao Cc: Zhiguang Liu Cc: Jiewen Yao Cc: Jian J Wang Cc: Sami Mujawar Signed-off-by: Min Xu --- .../DxeTpm2MeasureBootLib.c | 364 ++++++++++++++---- .../DxeTpm2MeasureBootLib.inf | 1 + 2 files changed, 297 insertions(+), 68 deletions(-) diff --git a/SecurityPkg/Library/DxeTpm2MeasureBootLib/DxeTpm2MeasureBootLi= b.c b/SecurityPkg/Library/DxeTpm2MeasureBootLib/DxeTpm2MeasureBootLib.c index 92eac715800f..cd4b779896fb 100644 --- a/SecurityPkg/Library/DxeTpm2MeasureBootLib/DxeTpm2MeasureBootLib.c +++ b/SecurityPkg/Library/DxeTpm2MeasureBootLib/DxeTpm2MeasureBootLib.c @@ -41,6 +41,13 @@ SPDX-License-Identifier: BSD-2-Clause-Patent #include #include #include +#include +#include + +typedef struct { + EFI_TCG2_PROTOCOL *Tcg2Protocol; + EFI_TEE_MEASUREMENT_PROTOCOL *TeeProtocol; +} MEASURE_BOOT_PROTOCOLS; =20 // // Flag to check GPT partition. It only need be measured once. @@ -55,6 +62,62 @@ UINTN mTcg2ImageSize; EFI_HANDLE mTcg2CacheMeasuredHandle =3D NULL; MEASURED_HOB_DATA *mTcg2MeasuredHobData =3D NULL; =20 +/** + Create TeeEvent from Tcg2Event. + + TeeEvent is similar to Tcg2Event except the MrIndex. + + @param TeeProtocol Pointer to the located Tee Measurement protocol inst= ance. + @param Tcg2Event Pointer to the Tcg2Event. + @param EventSize Size of the Event. + @param EfiTeeEvent The created TeeEvent + + @retval EFI_SUCCESS Successfully create the TeeEvent + @retval EFI_INVALID_PARAMETER The input parameter is invalid + @retval EFI_UNSUPPORTED The input PCRIndex cannot be mapped to Tee= MR + @retval EFI_OUT_OF_RESOURCES Out of resource +**/ +EFI_STATUS +CreateTeeEventFromTcg2Event ( + IN EFI_TEE_MEASUREMENT_PROTOCOL *TeeProtocol, + IN EFI_TCG2_EVENT *Tcg2Event, + IN UINT32 EventSize, + IN OUT EFI_TEE_EVENT **EfiTeeEvent + ) +{ + UINT32 MrIndex; + EFI_STATUS Status; + EFI_TEE_EVENT *TeeEvent; + + if (Tcg2Event =3D=3D NULL || TeeProtocol =3D=3D NULL || EfiTeeEvent =3D= =3D NULL) { + return EFI_INVALID_PARAMETER; + } + + *EfiTeeEvent =3D NULL; + + Status =3D TeeProtocol->MapPcrToMrIndex (TeeProtocol, Tcg2Event->Header.= PCRIndex, &MrIndex); + if (EFI_ERROR (Status)) { + DEBUG ((DEBUG_ERROR, "Cannot map PcrIndex(%d) to MrIndex\n", Tcg2Event= ->Header.PCRIndex)); + return Status; + } + + TeeEvent =3D (EFI_TEE_EVENT *)AllocateZeroPool (Tcg2Event->Size); + if (TeeEvent =3D=3D NULL) { + return EFI_OUT_OF_RESOURCES; + } + + TeeEvent->Size =3D Tcg2Event->Size; + TeeEvent->Header.HeaderSize =3D Tcg2Event->Header.HeaderSize; + TeeEvent->Header.HeaderVersion =3D Tcg2Event->Header.HeaderVersion; + TeeEvent->Header.MrIndex =3D MrIndex; + TeeEvent->Header.EventType =3D Tcg2Event->Header.EventType; + CopyMem (TeeEvent->Event, Tcg2Event->Event, EventSize); + + *EfiTeeEvent =3D TeeEvent; + + return EFI_SUCCESS; +} + /** Reads contents of a PE/COFF image in memory buffer. =20 @@ -109,7 +172,7 @@ DxeTpm2MeasureBootLibImageRead ( Caution: This function may receive untrusted input. The GPT partition table is external input, so this function should parse= partition data carefully. =20 - @param Tcg2Protocol Pointer to the located TCG2 protocol inst= ance. + @param MeasureBootProtocols Pointer to the located MeasureBoot protoc= ol instances (i.e. TCG2/Td protocol). @param GptHandle Handle that GPT partition was installed. =20 @retval EFI_SUCCESS Successfully measure GPT table. @@ -121,8 +184,8 @@ DxeTpm2MeasureBootLibImageRead ( EFI_STATUS EFIAPI Tcg2MeasureGptTable ( - IN EFI_TCG2_PROTOCOL *Tcg2Protocol, - IN EFI_HANDLE GptHandle + IN MEASURE_BOOT_PROTOCOLS *MeasureBootProtocols, + IN EFI_HANDLE GptHandle ) { EFI_STATUS Status; @@ -134,13 +197,29 @@ Tcg2MeasureGptTable ( UINTN NumberOfPartition; UINT32 Index; EFI_TCG2_EVENT *Tcg2Event; + EFI_TEE_EVENT *TeeEvent; EFI_GPT_DATA *GptData; UINT32 EventSize; + EFI_TCG2_PROTOCOL *Tcg2Protocol; + EFI_TEE_MEASUREMENT_PROTOCOL *TeeProtocol; =20 if (mTcg2MeasureGptCount > 0) { return EFI_SUCCESS; } =20 + PrimaryHeader =3D NULL; + EntryPtr =3D NULL; + TeeEvent =3D NULL; + Tcg2Event =3D NULL; + + Tcg2Protocol =3D MeasureBootProtocols->Tcg2Protocol; + TeeProtocol =3D MeasureBootProtocols->TeeProtocol; + + if (Tcg2Protocol =3D=3D NULL && TeeProtocol =3D=3D NULL) { + ASSERT (FALSE); + return EFI_UNSUPPORTED; + } + Status =3D gBS->HandleProtocol (GptHandle, &gEfiBlockIoProtocolGuid, (VO= ID**)&BlockIo); if (EFI_ERROR (Status)) { return EFI_UNSUPPORTED; @@ -149,6 +228,7 @@ Tcg2MeasureGptTable ( if (EFI_ERROR (Status)) { return EFI_UNSUPPORTED; } + // // Read the EFI Partition Table Header // @@ -156,6 +236,7 @@ Tcg2MeasureGptTable ( if (PrimaryHeader =3D=3D NULL) { return EFI_OUT_OF_RESOURCES; } + Status =3D DiskIo->ReadDisk ( DiskIo, BlockIo->Media->MediaId, @@ -164,10 +245,20 @@ Tcg2MeasureGptTable ( (UINT8 *)PrimaryHeader ); if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_ERROR, "Failed to Read Partition Table Header!\n")); + DEBUG ((DEBUG_ERROR, "Failed to Read Partition Table Header!\n")); FreePool (PrimaryHeader); return EFI_DEVICE_ERROR; } + + // + // PrimaryHeader->SizeOfPartitionEntry should not be zero + // + if (PrimaryHeader->SizeOfPartitionEntry =3D=3D 0) { + DEBUG ((DEBUG_ERROR, "SizeOfPartitionEntry should not be zero!\n")); + FreePool (PrimaryHeader); + return EFI_BAD_BUFFER_SIZE; + } + // // Read the partition entry. // @@ -202,15 +293,14 @@ Tcg2MeasureGptTable ( } =20 // - // Prepare Data for Measurement + // Prepare Data for Measurement (TeeProtocol and Tcg2Protocol) // EventSize =3D (UINT32)(sizeof (EFI_GPT_DATA) - sizeof (GptData->Partitio= ns) + NumberOfPartition * PrimaryHeader->SizeOfPartiti= onEntry); Tcg2Event =3D (EFI_TCG2_EVENT *) AllocateZeroPool (EventSize + sizeof (E= FI_TCG2_EVENT) - sizeof(Tcg2Event->Event)); if (Tcg2Event =3D=3D NULL) { - FreePool (PrimaryHeader); - FreePool (EntryPtr); - return EFI_OUT_OF_RESOURCES; + Status =3D EFI_OUT_OF_RESOURCES; + goto Exit; } =20 Tcg2Event->Size =3D EventSize + sizeof (EFI_TCG2_EVENT) - sizeof(Tcg2Eve= nt->Event); @@ -243,22 +333,57 @@ Tcg2MeasureGptTable ( } =20 // - // Measure the GPT data + // Measure the GPT data by Tcg2Protocol // - Status =3D Tcg2Protocol->HashLogExtendEvent ( - Tcg2Protocol, - 0, - (EFI_PHYSICAL_ADDRESS) (UINTN) (VOID *) GptData, - (UINT64) EventSize, - Tcg2Event - ); - if (!EFI_ERROR (Status)) { - mTcg2MeasureGptCount++; - } - - FreePool (PrimaryHeader); - FreePool (EntryPtr); - FreePool (Tcg2Event); + if (Tcg2Protocol !=3D NULL) { + Status =3D Tcg2Protocol->HashLogExtendEvent ( + Tcg2Protocol, + 0, + (EFI_PHYSICAL_ADDRESS) (UINTN) (VOID *) GptData, + (UINT64) EventSize, + Tcg2Event + ); + if (!EFI_ERROR (Status)) { + mTcg2MeasureGptCount++; + } + DEBUG ((DEBUG_INFO, "DxeTpm2MeasureBootHandler - Tcg2 MeasureGptTable = - %r\n", Status)); + + } else if (TeeProtocol !=3D NULL) { + + // + // Measure the GPT data by TdProtocol + // + Status =3D CreateTeeEventFromTcg2Event (TeeProtocol, Tcg2Event, EventS= ize, &TeeEvent); + if (EFI_ERROR (Status)) { + goto Exit; + } + + Status =3D TeeProtocol->HashLogExtendEvent ( + TeeProtocol, + 0, + (EFI_PHYSICAL_ADDRESS) (UINTN) (VOID *) GptData, + (UINT64) EventSize, + TeeEvent + ); + if (!EFI_ERROR (Status)) { + mTcg2MeasureGptCount++; + } + DEBUG ((DEBUG_INFO, "DxeTpm2MeasureBootHandler - Tee MeasureGptTable -= %r\n", Status)); + } + +Exit: + if (PrimaryHeader !=3D NULL) { + FreePool (PrimaryHeader); + } + if (EntryPtr !=3D NULL) { + FreePool (EntryPtr); + } + if (Tcg2Event !=3D NULL) { + FreePool (Tcg2Event); + } + if (TeeEvent !=3D NULL) { + FreePool (TeeEvent); + } =20 return Status; } @@ -271,12 +396,12 @@ Tcg2MeasureGptTable ( PE/COFF image is external input, so this function will validate its data= structure within this image buffer before use. =20 - @param[in] Tcg2Protocol Pointer to the located TCG2 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. + @param[in] MeasureBootProtocols Pointer to the located MeasureBoot pro= tocol instances. + @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 inpu= t image. =20 @retval EFI_SUCCESS Successfully measure image. @retval EFI_OUT_OF_RESOURCES No enough resource to measure image. @@ -287,7 +412,7 @@ Tcg2MeasureGptTable ( EFI_STATUS EFIAPI Tcg2MeasurePeImage ( - IN EFI_TCG2_PROTOCOL *Tcg2Protocol, + IN MEASURE_BOOT_PROTOCOLS *MeasureBootProtocols, IN EFI_PHYSICAL_ADDRESS ImageAddress, IN UINTN ImageSize, IN UINTN LinkTimeBase, @@ -300,9 +425,22 @@ Tcg2MeasurePeImage ( EFI_IMAGE_LOAD_EVENT *ImageLoad; UINT32 FilePathSize; UINT32 EventSize; + EFI_TEE_EVENT *TeeEvent; + EFI_TEE_MEASUREMENT_PROTOCOL *TeeProtocol; + EFI_TCG2_PROTOCOL *Tcg2Protocol; =20 Status =3D EFI_UNSUPPORTED; ImageLoad =3D NULL; + TeeEvent =3D NULL; + + Tcg2Protocol =3D MeasureBootProtocols->Tcg2Protocol; + TeeProtocol =3D MeasureBootProtocols->TeeProtocol; + + if (Tcg2Protocol =3D=3D NULL && TeeProtocol =3D=3D NULL) { + ASSERT (FALSE); + return EFI_UNSUPPORTED; + } + FilePathSize =3D (UINT32) GetDevicePathSize (FilePath); =20 // @@ -334,7 +472,7 @@ Tcg2MeasurePeImage ( break; default: DEBUG (( - EFI_D_ERROR, + DEBUG_ERROR, "Tcg2MeasurePeImage: Unknown subsystem type %d", ImageType )); @@ -352,28 +490,125 @@ Tcg2MeasurePeImage ( // // Log the PE data // - Status =3D Tcg2Protocol->HashLogExtendEvent ( - Tcg2Protocol, - PE_COFF_IMAGE, - ImageAddress, - ImageSize, - Tcg2Event - ); - if (Status =3D=3D EFI_VOLUME_FULL) { - // - // Volume full here means the image is hashed and its result is extend= ed 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 =3D EFI_SUCCESS; + if (Tcg2Protocol !=3D NULL) { + Status =3D Tcg2Protocol->HashLogExtendEvent ( + Tcg2Protocol, + PE_COFF_IMAGE, + ImageAddress, + ImageSize, + Tcg2Event + ); + if (Status =3D=3D EFI_VOLUME_FULL) { + // + // Volume full here means the image is hashed and its result is exte= nded 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 =3D EFI_SUCCESS; + } + DEBUG ((DEBUG_INFO, "DxeTpm2MeasureBootHandler - Tcg2 MeasurePeImage -= %r\n", Status)); + + } else if (TeeProtocol !=3D NULL) { + + Status =3D CreateTeeEventFromTcg2Event (TeeProtocol, Tcg2Event, EventS= ize, &TeeEvent); + if (EFI_ERROR (Status)) { + goto Finish; + } + + Status =3D TeeProtocol->HashLogExtendEvent ( + TeeProtocol, + PE_COFF_IMAGE, + ImageAddress, + ImageSize, + TeeEvent + ); + if (Status =3D=3D EFI_VOLUME_FULL) { + // + // Volume full here means the image is hashed and its result is exte= nded 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 =3D EFI_SUCCESS; + } + DEBUG ((DEBUG_INFO, "DxeTpm2MeasureBootHandler - Tee MeasurePeImage - = %r\n", Status)); } =20 Finish: - FreePool (Tcg2Event); + if (Tcg2Event !=3D NULL) { + FreePool (Tcg2Event); + } + + if (TeeEvent !=3D NULL) { + FreePool (TeeEvent); + } =20 return Status; } =20 +/** + Get the measure boot protocols. + + There are 2 measure boot, TCG2 protocol based and Tee measurement protoc= ol based. + + @param MeasureBootProtocols Pointer to the located measure boot protoc= ol instances. + + @retval EFI_SUCCESS Sucessfully locate the measure boot protoc= ol instances (at least one instance). + @retval EFI_UNSUPPORTED Measure boot is not supported. +**/ +EFI_STATUS +EFIAPI +GetMeasureBootProtocols ( + MEASURE_BOOT_PROTOCOLS *MeasureBootProtocols + ) +{ + EFI_STATUS Status; + EFI_TCG2_PROTOCOL *Tcg2Protocol; + EFI_TEE_MEASUREMENT_PROTOCOL *TeeProtocol; + EFI_TCG2_BOOT_SERVICE_CAPABILITY Tcg2ProtocolCapability; + EFI_TEE_BOOT_SERVICE_CAPABILITY TeeProtocolCapability; + + TeeProtocol =3D NULL; + Status =3D gBS->LocateProtocol (&gEfiTeeMeasurementProtocolGuid, NULL, (= VOID **) &TeeProtocol); + if (EFI_ERROR (Status)) { + // + // Tee Measurement protocol is not installed. + // + DEBUG ((DEBUG_VERBOSE, "TeeMeasurementProtocol is not installed. - %r\= n", Status)); + } else { + ZeroMem (&TeeProtocolCapability, sizeof (TeeProtocolCapability)); + TeeProtocolCapability.Size =3D sizeof (TeeProtocolCapability); + Status =3D TeeProtocol->GetCapability (TeeProtocol, &TeeProtocolCapabi= lity); + if (EFI_ERROR (Status) || TeeProtocolCapability.TeeType.Type =3D=3D EF= I_TEE_TYPE_NONE) { + DEBUG ((DEBUG_ERROR, " TeeProtocol->GetCapability returns : %x, %r\n= ", TeeProtocolCapability.TeeType.Type, Status)); + TeeProtocol =3D NULL; + } + } + + Tcg2Protocol =3D NULL; + Status =3D gBS->LocateProtocol (&gEfiTcg2ProtocolGuid, NULL, (VOID **) &= Tcg2Protocol); + if (EFI_ERROR (Status)) { + // + // Tcg2 protocol is not installed. So, TPM2 is not present. + // + DEBUG ((DEBUG_VERBOSE, "Tcg2Protocol is not installed. - %r\n", Status= )); + } else { + Tcg2ProtocolCapability.Size =3D (UINT8) sizeof (Tcg2ProtocolCapability= ); + Status =3D Tcg2Protocol->GetCapability (Tcg2Protocol, &Tcg2ProtocolCap= ability); + if (EFI_ERROR (Status) || (!Tcg2ProtocolCapability.TPMPresentFlag)) { + // + // TPM device doesn't work or activate. + // + DEBUG ((DEBUG_ERROR, "TPMPresentFlag=3DFALSE %r\n", Status)); + Tcg2Protocol =3D NULL; + } + } + + MeasureBootProtocols->Tcg2Protocol =3D Tcg2Protocol; + MeasureBootProtocols->TeeProtocol =3D TeeProtocol; + + return (Tcg2Protocol =3D=3D NULL && TeeProtocol =3D=3D NULL) ? EFI_UNSUP= PORTED: EFI_SUCCESS; +} + /** 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 @@ -422,9 +657,8 @@ DxeTpm2MeasureBootHandler ( IN BOOLEAN BootPolicy ) { - EFI_TCG2_PROTOCOL *Tcg2Protocol; + MEASURE_BOOT_PROTOCOLS MeasureBootProtocols; EFI_STATUS Status; - EFI_TCG2_BOOT_SERVICE_CAPABILITY ProtocolCapability; EFI_DEVICE_PATH_PROTOCOL *DevicePathNode; EFI_DEVICE_PATH_PROTOCOL *OrigDevicePathNode; EFI_HANDLE Handle; @@ -435,28 +669,23 @@ DxeTpm2MeasureBootHandler ( EFI_PHYSICAL_ADDRESS FvAddress; UINT32 Index; =20 - Status =3D gBS->LocateProtocol (&gEfiTcg2ProtocolGuid, NULL, (VOID **) &= Tcg2Protocol); + MeasureBootProtocols.Tcg2Protocol =3D NULL; + MeasureBootProtocols.TeeProtocol =3D NULL; + + Status =3D GetMeasureBootProtocols(&MeasureBootProtocols); + if (EFI_ERROR (Status)) { // - // Tcg2 protocol is not installed. So, TPM2 is not present. + // None of Measured boot protocols (Tcg2, Tee) is installed. // Don't do any measurement, and directly return EFI_SUCCESS. // - DEBUG ((EFI_D_VERBOSE, "DxeTpm2MeasureBootHandler - Tcg2 - %r\n", Stat= us)); + DEBUG ((DEBUG_INFO, "None of Tcg2Protocol/TeeMeasurementProtocol is in= stalled.\n")); return EFI_SUCCESS; } =20 - ProtocolCapability.Size =3D (UINT8) sizeof (ProtocolCapability); - Status =3D Tcg2Protocol->GetCapability ( - Tcg2Protocol, - &ProtocolCapability - ); - if (EFI_ERROR (Status) || (!ProtocolCapability.TPMPresentFlag)) { - // - // TPM device doesn't work or activate. - // - DEBUG ((EFI_D_ERROR, "DxeTpm2MeasureBootHandler (%r) - TPMPresentFlag = - %x\n", Status, ProtocolCapability.TPMPresentFlag)); - return EFI_SUCCESS; - } + DEBUG ((DEBUG_INFO, "Tcg2Protocol =3D %p, TdProtocol =3D %p\n", + MeasureBootProtocols.Tcg2Protocol, + MeasureBootProtocols.TeeProtocol)); =20 // // Copy File Device Path @@ -502,8 +731,8 @@ DxeTpm2MeasureBootHandler ( // // Measure GPT disk. // - Status =3D Tcg2MeasureGptTable (Tcg2Protocol, Handle); - DEBUG ((EFI_D_INFO, "DxeTpm2MeasureBootHandler - Tcg2MeasureGp= tTable - %r\n", Status)); + Status =3D Tcg2MeasureGptTable (&MeasureBootProtocols, Handle); + if (!EFI_ERROR (Status)) { // // GPT disk check done. @@ -647,14 +876,13 @@ DxeTpm2MeasureBootHandler ( // Measure PE image into TPM log. // Status =3D Tcg2MeasurePeImage ( - Tcg2Protocol, + &MeasureBootProtocols, (EFI_PHYSICAL_ADDRESS) (UINTN) FileBuffer, FileSize, (UINTN) ImageContext.ImageAddress, ImageContext.ImageType, DevicePathNode ); - DEBUG ((EFI_D_INFO, "DxeTpm2MeasureBootHandler - Tcg2MeasurePeImage - = %r\n", Status)); } =20 // @@ -665,7 +893,7 @@ Finish: FreePool (OrigDevicePathNode); } =20 - DEBUG ((EFI_D_INFO, "DxeTpm2MeasureBootHandler - %r\n", Status)); + DEBUG ((DEBUG_INFO, "DxeTpm2MeasureBootHandler - %r\n", Status)); =20 return Status; } diff --git a/SecurityPkg/Library/DxeTpm2MeasureBootLib/DxeTpm2MeasureBootLi= b.inf b/SecurityPkg/Library/DxeTpm2MeasureBootLib/DxeTpm2MeasureBootLib.inf index 2506abbe7c8b..6c4860745f35 100644 --- a/SecurityPkg/Library/DxeTpm2MeasureBootLib/DxeTpm2MeasureBootLib.inf +++ b/SecurityPkg/Library/DxeTpm2MeasureBootLib/DxeTpm2MeasureBootLib.inf @@ -61,6 +61,7 @@ =20 [Protocols] gEfiTcg2ProtocolGuid ## SOMETIMES_CONSUMES + gEfiTeeMeasurementProtocolGuid ## SOMETIMES_CONSUMES gEfiFirmwareVolumeBlockProtocolGuid ## SOMETIMES_CONSUMES gEfiBlockIoProtocolGuid ## SOMETIMES_CONSUMES gEfiDiskIoProtocolGuid ## SOMETIMES_CONSUMES --=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 (#82797): https://edk2.groups.io/g/devel/message/82797 Mute This Topic: https://groups.io/mt/86646141/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- From nobody Sat May 4 22:10:20 2024 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+82796+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+82796+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=intel.com ARC-Seal: i=1; a=rsa-sha256; t=1635397216; cv=none; d=zohomail.com; s=zohoarc; b=oD2bj+RFE/iPoYRD8bd6Omlih8Q21pskgdIxRv+fJxjq4tf3+YyztCQChZ0Qm2+u4Yvcb91c2ffi6JrqKK7/Zq5vzV1gvSXtDH/Vr6Xbemozrk3zP/LL/dwiiRmROymr+mQkVex1o7QiBi6zihBBsgI8F/X5gZ95Badg6lKseys= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1635397216; 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=UvZx4Kv7DS+F4ker+Bgpq7MvDFeNGhJ5LOsbghqt2iY=; b=ZCE5Er4CuFPbT4UCtdM+vxeCSkjIjXC/WPK0y2wG1WKDMRo7pgmrsykGvAaeLviCQNuVNNGlcb78WzFp4GVYyoVAJqAWGaM27Wbuta6SgfnZ+p9CdK2h9Ygev6bsITOO0C9nML52hQfQml6LSa+nLpWJsUTcSCgLvTP01ZMtB7I= 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+82796+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 1635397216450891.8732530652384; Wed, 27 Oct 2021 22:00:16 -0700 (PDT) Return-Path: X-Received: by 127.0.0.2 with SMTP id MEGPYY1788612xt0yPeVaSTb; Wed, 27 Oct 2021 22:00:16 -0700 X-Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by mx.groups.io with SMTP id smtpd.web10.7118.1635397215257585054 for ; Wed, 27 Oct 2021 22:00:15 -0700 X-IronPort-AV: E=McAfee;i="6200,9189,10150"; a="291160696" X-IronPort-AV: E=Sophos;i="5.87,188,1631602800"; d="scan'208";a="291160696" X-Received: from orsmga008.jf.intel.com ([10.7.209.65]) by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 27 Oct 2021 22:00:14 -0700 X-IronPort-AV: E=Sophos;i="5.87,188,1631602800"; d="scan'208";a="498214407" X-Received: from mxu9-mobl1.ccr.corp.intel.com ([10.238.4.37]) by orsmga008-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 27 Oct 2021 22:00:12 -0700 From: "Min Xu" To: devel@edk2.groups.io Cc: Min Xu , Michael D Kinney , Liming Gao , Zhiguang Liu , Jiewen Yao , Jian J Wang , Sami Mujawar Subject: [edk2-devel] [PATCH V3 3/3] SecurityPkg: Support TeeMeasurementProtocol in DxeTpmMeasurementLib Date: Thu, 28 Oct 2021 12:59:29 +0800 Message-Id: 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: 0Z3k1UoRJKrvJ6QfL5a54n5qx1787277AA= Content-Transfer-Encoding: quoted-printable DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1635397216; bh=emedPTXNoZ7u4v3a2aQOHUrJqU4YfVBpHPK3wJ1tqs4=; h=Cc:Date:From:Reply-To:Subject:To; b=OLVKrpFA5XHIFmqNtb+ETA8MyEudBJsF6yzPHgdy2rBIsLoQ0pegE5h6TeWpeS+TngY +iZbal+TGNRgild6upMNu06TsBbrBRQ/Af9mSNJRI+8ktkBEIKNcodfqlpvAAlkmA1FQI VP+W9J0BvGL24RdD3FeoTvzF2jC34RrBYwA= X-ZohoMail-DKIM: pass (identity @groups.io) X-ZM-MESSAGEID: 1635397217482100001 Content-Type: text/plain; charset="utf-8" BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=3D3625 DxeTpmMeasurementLib supports TPM based measurement in DXE phase. After TeeMeasurementProtocol is introduced, TD based measurement needs to be supported in DxeTpmMeasurementLib as well. In TpmMeasureAndLogData, TEE based measurement will be first called. If it failed, TPM based measurement will be called sequentially. Currently there is an assumption that TEE based measurement and TPM based measurement won't be exist at the same time.If the assumption is not true in the future, we will revisit here then. Cc: Michael D Kinney Cc: Liming Gao Cc: Zhiguang Liu Cc: Jiewen Yao Cc: Jian J Wang Cc: Sami Mujawar Signed-off-by: Min Xu --- .../DxeTpmMeasurementLib.c | 88 ++++++++++++++++++- .../DxeTpmMeasurementLib.inf | 5 +- 2 files changed, 88 insertions(+), 5 deletions(-) diff --git a/SecurityPkg/Library/DxeTpmMeasurementLib/DxeTpmMeasurementLib.= c b/SecurityPkg/Library/DxeTpmMeasurementLib/DxeTpmMeasurementLib.c index 061136ee7860..1b856cfc7a0d 100644 --- a/SecurityPkg/Library/DxeTpmMeasurementLib/DxeTpmMeasurementLib.c +++ b/SecurityPkg/Library/DxeTpmMeasurementLib/DxeTpmMeasurementLib.c @@ -19,7 +19,8 @@ SPDX-License-Identifier: BSD-2-Clause-Patent =20 #include #include - +#include +#include =20 =20 /** @@ -149,6 +150,73 @@ Tpm20MeasureAndLogData ( return Status; } =20 +/** + Tee measure and log data, and extend the measurement result into a + specific TEE MR. + + @param[in] PcrIndex PCR Index. + @param[in] EventType Event type. + @param[in] EventLog Measurement event log. + @param[in] LogLen Event log length in bytes. + @param[in] HashData The start of the data buffer to be hashed, = extended. + @param[in] HashDataLen The length, in bytes, of the buffer referen= ced by HashData + + @retval EFI_SUCCESS Operation completed successfully. + @retval EFI_UNSUPPORTED Tdx device not available. + @retval EFI_OUT_OF_RESOURCES Out of memory. + @retval EFI_DEVICE_ERROR The operation was unsuccessful. +**/ +EFI_STATUS +EFIAPI +TeeMeasureAndLogData ( + IN UINT32 PcrIndex, + IN UINT32 EventType, + IN VOID *EventLog, + IN UINT32 LogLen, + IN VOID *HashData, + IN UINT64 HashDataLen + ) +{ + EFI_STATUS Status; + EFI_TEE_MEASUREMENT_PROTOCOL *TeeProtocol; + EFI_TEE_EVENT *EfiTeeEvent; + UINT32 MrIndex; + + Status =3D gBS->LocateProtocol (&gEfiTeeMeasurementProtocolGuid, NULL, (= VOID **) &TeeProtocol); + if (EFI_ERROR (Status)) { + return Status; + } + + Status =3D TeeProtocol->MapPcrToMrIndex (TeeProtocol, PcrIndex, &MrIndex= ); + if (EFI_ERROR (Status)) { + return EFI_INVALID_PARAMETER; + } + + EfiTeeEvent =3D (EFI_TEE_EVENT *) AllocateZeroPool (LogLen + sizeof (EFI= _TEE_EVENT)); + if(EfiTeeEvent =3D=3D NULL) { + return EFI_OUT_OF_RESOURCES; + } + + EfiTeeEvent->Size =3D (UINT32) LogLen + sizeof (EFI_TEE_EVENT) - sizeof = (EfiTeeEvent->Event); + EfiTeeEvent->Header.HeaderSize =3D sizeof (EFI_TEE_EVENT_HEADER); + EfiTeeEvent->Header.HeaderVersion =3D EFI_TEE_EVENT_HEADER_VERSION; + EfiTeeEvent->Header.MrIndex =3D MrIndex; + EfiTeeEvent->Header.EventType =3D EventType; + CopyMem (&EfiTeeEvent->Event[0], EventLog, LogLen); + + Status =3D TeeProtocol->HashLogExtendEvent ( + TeeProtocol, + 0, + (EFI_PHYSICAL_ADDRESS) (UINTN) HashData, + HashDataLen, + EfiTeeEvent + ); + FreePool (EfiTeeEvent); + + return Status; +} + + /** Tpm measure and log data, and extend the measurement result into a speci= fic PCR. =20 @@ -178,9 +246,9 @@ TpmMeasureAndLogData ( EFI_STATUS Status; =20 // - // Try to measure using Tpm20 protocol + // Try to measure using Tee measurement protocol // - Status =3D Tpm20MeasureAndLogData( + Status =3D TeeMeasureAndLogData ( PcrIndex, EventType, EventLog, @@ -189,6 +257,20 @@ TpmMeasureAndLogData ( HashDataLen ); =20 + if (EFI_ERROR (Status)) { + // + // Try to measure using Tpm20 protocol + // + Status =3D Tpm20MeasureAndLogData( + PcrIndex, + EventType, + EventLog, + LogLen, + HashData, + HashDataLen + ); + } + if (EFI_ERROR (Status)) { // // Try to measure using Tpm1.2 protocol diff --git a/SecurityPkg/Library/DxeTpmMeasurementLib/DxeTpmMeasurementLib.= inf b/SecurityPkg/Library/DxeTpmMeasurementLib/DxeTpmMeasurementLib.inf index 7d41bc41f95d..501d5d66e0fb 100644 --- a/SecurityPkg/Library/DxeTpmMeasurementLib/DxeTpmMeasurementLib.inf +++ b/SecurityPkg/Library/DxeTpmMeasurementLib/DxeTpmMeasurementLib.inf @@ -40,5 +40,6 @@ UefiBootServicesTableLib =20 [Protocols] - gEfiTcgProtocolGuid ## SOMETIMES_CONSUMES - gEfiTcg2ProtocolGuid ## SOMETIMES_CONSUMES + gEfiTcgProtocolGuid ## SOMETIMES_CONSUMES + gEfiTcg2ProtocolGuid ## SOMETIMES_CONSUMES + gEfiTeeMeasurementProtocolGuid ## SOMETIMES_CONSUMES --=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 (#82796): https://edk2.groups.io/g/devel/message/82796 Mute This Topic: https://groups.io/mt/86646140/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-