From be92e09206c2e4bb388e7c9127f048689841dd01 Mon Sep 17 00:00:00 2001 From: Min M Xu Date: Fri, 19 Apr 2024 08:11:27 +0800 Subject: OvmfPkg/IntelTdx: Update TDVF README BZ: https://bugzilla.tianocore.org/show_bug.cgi?id=4756 There are below updates in this patch: 1. Rename README to README.md so that it can be show as markdown document. 2. Update some information about TDVF. 2. Fix some typo. Cc: Jiewen Yao Cc: Gerd Hoffmann Signed-off-by: Min Xu Acked-by: Gerd Hoffmann Reviewed-by: Jiewen Yao --- OvmfPkg/IntelTdx/README.md | 95 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 95 insertions(+) create mode 100644 OvmfPkg/IntelTdx/README.md (limited to 'OvmfPkg/IntelTdx/README.md') diff --git a/OvmfPkg/IntelTdx/README.md b/OvmfPkg/IntelTdx/README.md new file mode 100644 index 0000000000..c168167c12 --- /dev/null +++ b/OvmfPkg/IntelTdx/README.md @@ -0,0 +1,95 @@ +TDVF Overview +------------- + +**Intel Trust Domain Extension (TDX)** is Intel Architecture extension +to provide trusted, isolated VM execution by removing CSP software +(hypervisor etc) from the TCB. **TDX Virtual Firmware (TDVF)** is an +EDK II based project to enable UEFI support for TDX based Virtual +Machines. It provides the capability to launch a TD. + +The **Intel TDX Virtual Firmware Design Guide** is at +https://www.intel.com/content/dam/develop/external/us/en/documents/tdx-virtual-firmware-design-guide-rev-1.01.pdf. + +More information can be found at: +https://www.intel.com/content/www/us/en/developer/articles/technical/intel-trust-domain-extensions.html + + +Configurations and Features +---------------------------- + +There are 2 configurations for TDVF. + +**Config-A:** + - Merge the *basic* TDVF feature to existing **OvmfPkgX64.dsc**. (Align + with existing SEV) + - Threat model: VMM is **NOT** out of TCB. (We don't make things worse) + - The OvmfPkgX64.dsc includes SEV/TDX/normal OVMF basic boot capability. + The final binary can run on SEV/TDX/normal OVMF. + - No changes to existing OvmfPkgX64 image layout. + - No need to remove features if they exist today. + - PEI phase is **NOT** skipped in either TD or Non-TD. + - RTMR based measurement (CC_MEASUREMENT) is supported as an optional requirement. + - External inputs from Host VMM are measured, such as TdHob, CFV. + - Other external inputs are measured, such as FW_CFG data, os loader, + initrd, etc. + +**Config-B:** + - Add a standalone **IntelTdxX64.dsc** to a TDX specific directory + (**OvmfPkg/IntelTdx**) for a *full* feature TDVF.(Align with existing SEV) + - Threat model: VMM is out of TCB. (We need necessary change to prevent + attack from VMM) + - IntelTdxX64.dsc includes TDX/normal OVMF basic boot capability. The final + binary can run on TDX/normal OVMF. + - It might eventually merge with AmdSev.dsc, but NOT at this point of + time. And we don't know when it will happen. We need sync with AMD in + the community after both of us think the solutions are mature to merge. + - RTMR based measurement (CC_MEASUREMENT) is supported as a mandatory requirement. + - External inputs from Host VMM are measured, such as TdHob, CFV. + - Other external inputs are measured, such as FW_CFG data, os loader, + initrd, etc. + - PEI phase is skipped to remove unnecessary attack surface. + - DXE FV is split into 2 FVs (DXEFV & NCCFV) to remove the unnecessary attack + surface in a TD guest.. + - When launching a TD guest, only drivers in DXEFV are loaded. + - When launching a Non-TD guest, dirvers in both DXEFV and NCCFV are + loaded. + +Build +------ +- Build the TDVF (Config-A) target: +``` +cd /path/to/edk2 +source edksetup.sh + +## without CC_MEASUREMENT enabled +build -p OvmfPkg/OvmfPkgX64.dsc -a X64 -t GCC5 -b RELEASE + +## CC_MEASUREMENT enabled +build -p OvmfPkg/OvmfPkgX64.dsc -a X64 -t GCC5 -D CC_MEASUREMENT_ENABLE=TRUE -b RELEASE +``` + +- Build the TDVF (Config-B) target: +``` +cd /path/to/edk2 +source edksetup.sh +build -p OvmfPkg/IntelTdx/IntelTdxX64.dsc -a X64 -t GCC5 -b RELEASE +``` + +Usage +----- + +Assuming TDX-QEMU/TDX-KVM are already built, one can start a TD virtual +machine as [launching-td-guest](https://github.com/intel/qemu-tdx/blob/tdx-qemu-upstream-rfc-v3/docs/system/i386/tdx.rst#launching-a-td-tdx-vm): + +`qemu_system_x86 \` +` -machine ...,confidential-guest-support=tdx0 \` +` -object tdx-guest,id=tdx0,[sept-ve-disable=off] \` +` -drive if=pflash,format=raw,unit=0,file=/path/to/OVMF_CODE.fd \` +` -drive if=pflash,format=raw,unit=1,file=/path/to/OVMF_VARS.fd \` + +Note: +TDX-QEMU/TDX-KVM are still in upstreaming progress. Please refer to: + - kvm : https://github.com/intel/tdx/tree/kvm-upstream + - qemu : https://github.com/intel/qemu-tdx/blob/tdx-qemu-upstream-rfc-v3 + +Once above 2 upstreaming are completed a minimum qemu/kvm version will be updated here. -- cgit v1.2.3