OvmfPkg/IntelTdx/README

   1 TDVF Overview
   2 -------------
   3
   4 <b>Intel Trust Domain Extension (TDX)</b> is Intel Architecture extension
   5 to provide trusted, isolated VM execution by removing CSP software
   6 (hypervisor etc) from the TCB. <b>TDX Virtual Firmware (TDVF)</b> is an
   7 EDK II based project to enable UEFI support for TDX based Virtual
   8 Machines. It provides the capability to launch a TD.
   9
  10 The <b>Intel? TDX Virtual Firmware Design Guide</b> is at
  11 https://www.intel.com/content/dam/develop/external/us/en/documents/tdx-virtual-firmware-design-guide-rev-1.01.pdf.
  12
  13 More information can be found at:
  14 https://www.intel.com/content/www/us/en/developer/articles/technical/intel-trust-domain-extensions.html
  15
  16
  17 Configurations and Features
  18 ----------------------------
  19
  20 There are 2 configurations for TDVF.
  21
  22 <b>Config-A:</b>
  23  - Merge the *basic* TDVF feature to existing OvmfX64Pkg.dsc. (Align
  24    with existing SEV)
  25  - Threat model: VMM is NOT out of TCB. (We don?t make things worse)
  26  - The OvmfX64Pkg.dsc includes SEV/TDX/normal OVMF basic boot capability.
  27    The final binary can run on SEV/TDX/normal OVMF.
  28  - No changes to existing OvmfPkgX64 image layout.
  29  - No need to add additional security features if they do not exist today.
  30  - No need to remove features if they exist today.
  31  - RTMR is not supported.
  32  - PEI phase is NOT skipped in either Td or Non-Td.
  33
  34 <b>Config-B:</b>
  35  - (*) Add a standalone IntelTdx.dsc to a TDX specific directory for a *full*
  36    feature TDVF.(Align with existing SEV)
  37  - (*) Threat model: VMM is out of TCB. (We need necessary change to prevent
  38    attack from VMM)
  39  - (*) IntelTdx.dsc includes TDX/normal OVMF basic boot capability. The final
  40    binary can run on TDX/normal OVMF.
  41  - It might eventually merge with AmdSev.dsc, but NOT at this point of
  42    time. And we don?t know when it will happen. We need sync with AMD in
  43    the community after both of us think the solutions are mature to merge.
  44  - Need to add necessary security feature as mandatory requirement, such
  45    as RTMR based Trusted Boot support.
  46  - Need to measure the external input from Host VMM, such as TdHob, CFV.
  47  - Need to measure other external input, such as FW_CFG data, os loader,
  48    initrd, etc.
  49  - Need to remove unnecessary attack surfaces, such as network stack.
  50
  51 In current stage, <b>Config-A</b> has been merged into edk2-master branch.
  52 The corresponding pkg file is OvmfPkg/OvmfPkgX64.dsc.
  53
  54 <b>Config-B</b> is split into several waves. The corresponding pkg file is
  55 OvmfPkg/IntelTdx/IntelTdxX64.dsc. The features with (*) have been implemented
  56 and merged into edk2-master branch. Others are in upstreaming progress.
  57
  58 Build
  59 ------
  60 - Build the TDVF (Config-A) target:
  61 `cd /path/to/edk2`
  62 `source edksetup.sh`
  63 `build.sh -p OvmfPkg/OvmfPkgX64.dsc -a X64 -t GCC5`
  64
  65 - Build the TDVF (Config-B) target:
  66 `cd /path/to/edk2`
  67 `set PACKAGES_PATH=/path/to/edk2/OvmfPkg`
  68 `source edksetup.sh`
  69 `build.sh -p OvmfPkg/IntelTdx/IntelTdxX64.dsc -a X64 -t GCC5`
  70
  71 Usage
  72 -----
  73
  74 Assuming TDX-QEMU/TDX-KVM are already built, one can start a TD virtual
  75 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):
  76
  77 `qemu_system_x86 \`
  78 `   -machine ...,confidential-guest-support=tdx0 \`
  79 `   -object tdx-guest,id=tdx0,[sept-ve-disable=off] \`
  80 `   -drive if=pflash,format=raw,unit=0,file=/path/to/OVMF_CODE.fd \`
  81 `   -drive if=pflash,format=raw,unit=1,file=/path/to/OVMF_VARS.fd \`
  82
  83 Note:
  84 TDX-QEMU/TDX-KVM are still in upstreaming progress. Please refer to:
  85  - kvm  : https://github.com/intel/tdx/tree/kvm-upstream
  86  - qemu : https://github.com/intel/qemu-tdx/blob/tdx-qemu-upstream-rfc-v3
  87
  88 Once above 2 upstreaming are completed a minimum qemu/kvm version will be updated here.