From nobody Sun Feb 8 22:22:20 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+89751+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+89751+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=intel.com ARC-Seal: i=1; a=rsa-sha256; t=1652686969; cv=none; d=zohomail.com; s=zohoarc; b=LxAde6STcneA7D3ArRUBe7xY695uWAH6Ixr+5EHvIH5lYmR+BeertorGlGugTbIm+ZcfGu62AR44qQWzQNbtTG5dYvOLvuSkEVUvGJbFRxxY0nIJ7Pr9mees9aqGJcWE2e9BuLzI29Eld2f/IFafXClZy0lxNiuFfiTH4+cMJtc= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1652686969; 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=nmKEyljXbuCY6ZStgNQNvGe/2gWJzSdwqq+Rw3+5GiE=; b=InAFUBKG+AiMrMY8Oz4iQ1zXKqLtTWCsQGGI9Wmu0Hiyq8Q72pS3Wbr/J1af8XR+OJG2bjmiF7044zXsn1b2Q7q1V6/YAzalAvg48/jhGkijS3kSkGNGBW7I+HuAVuEMRUDoV5OY3QkZ8eO5NTgJAdrm/e+JFpE5Q463rO5O45Y= 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+89751+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 1652686969822619.2304017865931; Mon, 16 May 2022 00:42:49 -0700 (PDT) Return-Path: X-Received: by 127.0.0.2 with SMTP id QTmwYY1788612xV2idBrXxsI; Mon, 16 May 2022 00:42:48 -0700 X-Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by mx.groups.io with SMTP id smtpd.web08.26033.1652686966576873864 for ; Mon, 16 May 2022 00:42:48 -0700 X-IronPort-AV: E=McAfee;i="6400,9594,10348"; a="258330456" X-IronPort-AV: E=Sophos;i="5.91,229,1647327600"; d="scan'208";a="258330456" X-Received: from orsmga004.jf.intel.com ([10.7.209.38]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 16 May 2022 00:42:39 -0700 X-IronPort-AV: E=Sophos;i="5.91,229,1647327600"; d="scan'208";a="699418937" X-Received: from mxu9-mobl1.ccr.corp.intel.com ([10.249.170.79]) by orsmga004-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 16 May 2022 00:42:38 -0700 From: "Min Xu" To: devel@edk2.groups.io Cc: Min Xu , Jiewen Yao , Jian J Wang , Gerd Hoffmann Subject: [edk2-devel] [PATCH V4 1/9] Security: Add HashLibTdx Date: Mon, 16 May 2022 15:42:15 +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: oC5ZHv6qN2f6IKAMburB7I1nx1787277AA= Content-Transfer-Encoding: quoted-printable DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1652686968; bh=vGqZMrxAbErPi6gwx+6V8WF126D2GHLHhzXf9KK+H/g=; h=Cc:Date:From:Reply-To:Subject:To; b=Bmz4i0+FBfQIKQeS5hUIZGiPY7sE5k/MnoX1N97XFClMihwTX3pKtDbr6BGftNZ/Lrm WM5uiSVglzYLt/3a/eDCDj16H8ljCWYfOgIgGJhGS8rcKbK5efMZajLuJr40wWKqsvW2B /L6ptJKgdrs5JFu95BCBntWcMW3ePNvfqEE= X-ZohoMail-DKIM: pass (identity @groups.io) X-ZM-MESSAGEID: 1652687872380100001 Content-Type: text/plain; charset="utf-8" RFC: https://bugzilla.tianocore.org/show_bug.cgi?id=3D3853 This library provides hash service by registered hash handler in Td guest. Currently only SHA384 is supported. After that the hash value is extended to Td RTMR registers which is similar to TPM PCRs. Cc: Jiewen Yao Cc: Jian J Wang Cc: Gerd Hoffmann Reviewed-by: Jiewen Yao Signed-off-by: Min Xu --- SecurityPkg/Library/HashLibTdx/HashLibTdx.c | 207 ++++++++++++++++++ SecurityPkg/Library/HashLibTdx/HashLibTdx.inf | 37 ++++ SecurityPkg/SecurityPkg.dsc | 10 + 3 files changed, 254 insertions(+) create mode 100644 SecurityPkg/Library/HashLibTdx/HashLibTdx.c create mode 100644 SecurityPkg/Library/HashLibTdx/HashLibTdx.inf diff --git a/SecurityPkg/Library/HashLibTdx/HashLibTdx.c b/SecurityPkg/Libr= ary/HashLibTdx/HashLibTdx.c new file mode 100644 index 000000000000..75d96ee64b44 --- /dev/null +++ b/SecurityPkg/Library/HashLibTdx/HashLibTdx.c @@ -0,0 +1,207 @@ +/** @file + This library is HashLib for Tdx. + +Copyright (c) 2021 - 2022, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include +#include +#include +#include +#include +#include +#include +#include + +EFI_GUID mSha384Guid =3D HASH_ALGORITHM_SHA384_GUID; + +// +// Currently TDX supports SHA384. +// +HASH_INTERFACE mHashInterface =3D { + { 0 }, NULL, NULL, NULL +}; + +UINTN mHashInterfaceCount =3D 0; + +/** + Start hash sequence. + + @param HashHandle Hash handle. + + @retval EFI_SUCCESS Hash sequence start and HandleHandle return= ed. + @retval EFI_OUT_OF_RESOURCES No enough resource to start hash. +**/ +EFI_STATUS +EFIAPI +HashStart ( + OUT HASH_HANDLE *HashHandle + ) +{ + HASH_HANDLE HashCtx; + + if (mHashInterfaceCount =3D=3D 0) { + ASSERT (FALSE); + return EFI_UNSUPPORTED; + } + + HashCtx =3D 0; + mHashInterface.HashInit (&HashCtx); + + *HashHandle =3D HashCtx; + + return EFI_SUCCESS; +} + +/** + Update hash sequence data. + + @param HashHandle Hash handle. + @param DataToHash Data to be hashed. + @param DataToHashLen Data size. + + @retval EFI_SUCCESS Hash sequence updated. +**/ +EFI_STATUS +EFIAPI +HashUpdate ( + IN HASH_HANDLE HashHandle, + IN VOID *DataToHash, + IN UINTN DataToHashLen + ) +{ + if (mHashInterfaceCount =3D=3D 0) { + ASSERT (FALSE); + return EFI_UNSUPPORTED; + } + + mHashInterface.HashUpdate (HashHandle, DataToHash, DataToHashLen); + + return EFI_SUCCESS; +} + +/** + Hash sequence complete and extend to PCR. + + @param HashHandle Hash handle. + @param PcrIndex PCR to be extended. + @param DataToHash Data to be hashed. + @param DataToHashLen Data size. + @param DigestList Digest list. + + @retval EFI_SUCCESS Hash sequence complete and DigestList is returne= d. +**/ +EFI_STATUS +EFIAPI +HashCompleteAndExtend ( + IN HASH_HANDLE HashHandle, + IN TPMI_DH_PCR PcrIndex, + IN VOID *DataToHash, + IN UINTN DataToHashLen, + OUT TPML_DIGEST_VALUES *DigestList + ) +{ + TPML_DIGEST_VALUES Digest; + EFI_STATUS Status; + + if (mHashInterfaceCount =3D=3D 0) { + ASSERT (FALSE); + return EFI_UNSUPPORTED; + } + + ZeroMem (DigestList, sizeof (*DigestList)); + + mHashInterface.HashUpdate (HashHandle, DataToHash, DataToHashLen); + mHashInterface.HashFinal (HashHandle, &Digest); + + CopyMem ( + &DigestList->digests[0], + &Digest.digests[0], + sizeof (Digest.digests[0]) + ); + DigestList->count++; + + ASSERT (DigestList->count =3D=3D 1 && DigestList->digests[0].hashAlg =3D= =3D TPM_ALG_SHA384); + + Status =3D TdExtendRtmr ( + (UINT32 *)DigestList->digests[0].digest.sha384, + SHA384_DIGEST_SIZE, + (UINT8)PcrIndex + ); + + ASSERT (!EFI_ERROR (Status)); + return Status; +} + +/** + Hash data and extend to RTMR. + + @param PcrIndex PCR to be extended. + @param DataToHash Data to be hashed. + @param DataToHashLen Data size. + @param DigestList Digest list. + + @retval EFI_SUCCESS Hash data and DigestList is returned. +**/ +EFI_STATUS +EFIAPI +HashAndExtend ( + IN TPMI_DH_PCR PcrIndex, + IN VOID *DataToHash, + IN UINTN DataToHashLen, + OUT TPML_DIGEST_VALUES *DigestList + ) +{ + HASH_HANDLE HashHandle; + EFI_STATUS Status; + + if (mHashInterfaceCount =3D=3D 0) { + ASSERT (FALSE); + return EFI_UNSUPPORTED; + } + + ASSERT (TdIsEnabled ()); + + HashStart (&HashHandle); + HashUpdate (HashHandle, DataToHash, DataToHashLen); + Status =3D HashCompleteAndExtend (HashHandle, PcrIndex, NULL, 0, DigestL= ist); + + return Status; +} + +/** + This service register Hash. + + @param HashInterface Hash interface + + @retval EFI_SUCCESS This hash interface is registered successfu= lly. + @retval EFI_UNSUPPORTED System does not support register this inter= face. + @retval EFI_ALREADY_STARTED System already register this interface. +**/ +EFI_STATUS +EFIAPI +RegisterHashInterfaceLib ( + IN HASH_INTERFACE *HashInterface + ) +{ + ASSERT (TdIsEnabled ()); + + // + // Only SHA384 is allowed. + // + if (!CompareGuid (&mSha384Guid, &HashInterface->HashGuid)) { + return EFI_UNSUPPORTED; + } + + if (mHashInterfaceCount !=3D 0) { + ASSERT (FALSE); + return EFI_OUT_OF_RESOURCES; + } + + CopyMem (&mHashInterface, HashInterface, sizeof (*HashInterface)); + mHashInterfaceCount++; + + return EFI_SUCCESS; +} diff --git a/SecurityPkg/Library/HashLibTdx/HashLibTdx.inf b/SecurityPkg/Li= brary/HashLibTdx/HashLibTdx.inf new file mode 100644 index 000000000000..946132124c85 --- /dev/null +++ b/SecurityPkg/Library/HashLibTdx/HashLibTdx.inf @@ -0,0 +1,37 @@ +## @file +# Provides hash service by registered hash handler in Tdx. +# +# This library is HashLib for Tdx. Currently only SHA384 is supported. +# +# Copyright (c) 2020 - 2021, Intel Corporation. All rights reserved.
+# SPDX-License-Identifier: BSD-2-Clause-Patent +# +## + +[Defines] + INF_VERSION =3D 0x00010005 + BASE_NAME =3D HashLibTdx + FILE_GUID =3D 77F6EA3E-1ABA-4467-A447-926E8CEB2D13 + MODULE_TYPE =3D BASE + VERSION_STRING =3D 1.0 + LIBRARY_CLASS =3D HashLib|SEC DXE_DRIVER + +# +# The following information is for reference only and not required by the = build tools. +# +# VALID_ARCHITECTURES =3D X64 +# + +[Sources] + HashLibTdx.c + +[Packages] + MdePkg/MdePkg.dec + SecurityPkg/SecurityPkg.dec + +[LibraryClasses] + BaseLib + BaseMemoryLib + DebugLib + PcdLib + TdxLib diff --git a/SecurityPkg/SecurityPkg.dsc b/SecurityPkg/SecurityPkg.dsc index 73a93c2285b1..0d8c997b2f40 100644 --- a/SecurityPkg/SecurityPkg.dsc +++ b/SecurityPkg/SecurityPkg.dsc @@ -72,6 +72,7 @@ MmUnblockMemoryLib|MdePkg/Library/MmUnblockMemoryLib/MmUnblockMemoryLibN= ull.inf SecureBootVariableLib|SecurityPkg/Library/SecureBootVariableLib/SecureBo= otVariableLib.inf SecureBootVariableProvisionLib|SecurityPkg/Library/SecureBootVariablePro= visionLib/SecureBootVariableProvisionLib.inf + TdxLib|MdePkg/Library/TdxLib/TdxLib.inf =20 [LibraryClasses.ARM, LibraryClasses.AARCH64] # @@ -92,6 +93,12 @@ [LibraryClasses.RISCV64] RngLib|MdePkg/Library/BaseRngLibTimerLib/BaseRngLibTimerLib.inf =20 +[LibraryClasses.X64.SEC] + HashLib|SecurityPkg/Library/HashLibTdx/HashLibTdx.inf + +[LibraryClasses.X64.DXE_DRIVER] + HashLib|SecurityPkg/Library/HashLibTdx/HashLibTdx.inf + [LibraryClasses.common.PEIM] PeimEntryPoint|MdePkg/Library/PeimEntryPoint/PeimEntryPoint.inf PeiServicesLib|MdePkg/Library/PeiServicesLib/PeiServicesLib.inf @@ -283,6 +290,9 @@ # SecurityPkg/RandomNumberGenerator/RngDxe/RngDxe.inf =20 +[Components.X64] + SecurityPkg/Library/HashLibTdx/HashLibTdx.inf + [Components.IA32, Components.X64] SecurityPkg/VariableAuthenticated/SecureBootConfigDxe/SecureBootConfigDx= e.inf =20 --=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 (#89751): https://edk2.groups.io/g/devel/message/89751 Mute This Topic: https://groups.io/mt/91135109/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-