]> git.proxmox.com Git - mirror_edk2.git/blobdiff - OvmfPkg/README
OvmfPkg: Update DSC/FDF to use NetworkPkg's include fragment file.
[mirror_edk2.git] / OvmfPkg / README
index 33ff9432bb3ea42788344ad733260dadbaee3bba..c014d07bfbdb033774cbe7905fd852c25377fd46 100644 (file)
@@ -115,8 +115,8 @@ $ OvmfPkg/build.sh -a X64 qemu
 And to run a 64-bit UEFI bootable ISO image:\r
 $ OvmfPkg/build.sh -a X64 qemu -cdrom /path/to/disk-image.iso\r
 \r
 And to run a 64-bit UEFI bootable ISO image:\r
 $ OvmfPkg/build.sh -a X64 qemu -cdrom /path/to/disk-image.iso\r
 \r
-To build a 32-bit OVMF without debug messages using GCC 4.5:\r
-$ OvmfPkg/build.sh -a IA32 -b RELEASE -t GCC45\r
+To build a 32-bit OVMF without debug messages using GCC 4.8:\r
+$ OvmfPkg/build.sh -a IA32 -b RELEASE -t GCC48\r
 \r
 === SMM support ===\r
 \r
 \r
 === SMM support ===\r
 \r
@@ -224,24 +224,123 @@ longer.)
   basic virtio-net driver, located in OvmfPkg/VirtioNetDxe.\r
 \r
 * Also independently of the iPXE NIC drivers, Intel's proprietary E1000 NIC\r
   basic virtio-net driver, located in OvmfPkg/VirtioNetDxe.\r
 \r
 * Also independently of the iPXE NIC drivers, Intel's proprietary E1000 NIC\r
-  driver (PROEFI) can be embedded in the OVMF image at build time:\r
-\r
-  - Download UEFI drivers for the e1000 NIC\r
-    - http://downloadcenter.intel.com/Detail_Desc.aspx?agr=Y&DwnldID=17515&lang=eng\r
-    - Install the drivers into a directory called Intel3.5 in your WORKSPACE.\r
+  driver (from the BootUtil distribution) can be embedded in the OVMF image at\r
+  build time:\r
+\r
+  - Download BootUtil:\r
+    - Navigate to\r
+      https://downloadcenter.intel.com/download/19186/Ethernet-Intel-Ethernet-Connections-Boot-Utility-Preboot-Images-and-EFI-Drivers\r
+    - Click the download link for "PREBOOT.EXE".\r
+    - Accept the Intel Software License Agreement that appears.\r
+    - Unzip "PREBOOT.EXE" into a separate directory (this works with the\r
+      "unzip" utility on platforms different from Windows as well).\r
+    - Copy the "APPS/EFI/EFIx64/E3522X2.EFI" driver binary to\r
+      "Intel3.5/EFIX64/E3522X2.EFI" in your WORKSPACE.\r
+    - Intel have stopped distributing an IA32 driver binary (which used to\r
+      match the filename pattern "E35??E2.EFI"), thus this method will only\r
+      work for the IA32X64 and X64 builds of OVMF.\r
 \r
   - Include the driver in OVMF during the build:\r
 \r
   - Include the driver in OVMF during the build:\r
-    - Add "-D E1000_ENABLE" to your build command,\r
+    - Add "-D E1000_ENABLE" to your build command (only when building\r
+      "OvmfPkg/OvmfPkgIa32X64.dsc" or "OvmfPkg/OvmfPkgX64.dsc").\r
     - For example: "build -D E1000_ENABLE".\r
 \r
 * When a matching iPXE driver is configured for a NIC as described above, it\r
   takes priority over other drivers that could possibly drive the card too:\r
 \r
     - For example: "build -D E1000_ENABLE".\r
 \r
 * When a matching iPXE driver is configured for a NIC as described above, it\r
   takes priority over other drivers that could possibly drive the card too:\r
 \r
-                 | e1000  ne2k_pci  pcnet  rtl8139  virtio-net-pci\r
-    -------------+------------------------------------------------\r
-    iPXE         |   x       x        x       x           x\r
-    VirtioNetDxe |                                        x\r
-    Intel PROEFI |   x\r
+                         | e1000  ne2k_pci  pcnet  rtl8139  virtio-net-pci\r
+    ---------------------+------------------------------------------------\r
+    iPXE                 |   x       x        x       x           x\r
+    VirtioNetDxe         |                                        x\r
+    Intel BootUtil (X64) |   x\r
+\r
+=== HTTPS Boot ===\r
+\r
+HTTPS Boot is an alternative solution to PXE. It replaces the tftp server\r
+with a HTTPS server so the firmware can download the images through a trusted\r
+and encrypted connection.\r
+\r
+* To enable HTTPS Boot, you have to build OVMF with -D HTTP_BOOT_ENABLE and\r
+  -D TLS_ENABLE. The former brings in the HTTP stack from NetworkPkg while\r
+  the latter enables TLS support in both NetworkPkg and CryptoPkg.\r
+\r
+* By default, there is no trusted certificate. The user has to import the\r
+  certificates either manually with "Tls Auth Configuration" utility in the\r
+  firmware UI or through the fw_cfg entry, etc/edk2/https/cacerts.\r
+\r
+  -fw_cfg name=etc/edk2/https/cacerts,file=<certdb>\r
+\r
+  The blob for etc/edk2/https/cacerts has to be in the format of Signature\r
+  Database(*1). You can use p11-kit(*2) or efisiglit(*3) to create the\r
+  certificate list.\r
+\r
+  If you want to create the certificate list based on the CA certificates\r
+  in your local host, p11-kit will be a good choice. Here is the command to\r
+  create the list:\r
+\r
+  p11-kit extract --format=edk2-cacerts --filter=ca-anchors \\r
+    --overwrite --purpose=server-auth <certdb>\r
+\r
+  If you only want to import one certificate, efisiglist is the tool for you:\r
+\r
+  efisiglist -a <cert file> -o <certdb>\r
+\r
+  Please note that the certificate has to be in the DER format.\r
+\r
+  You can also append a certificate to the existing list with the following\r
+  command:\r
+\r
+  efisiglist -i <old certdb> -a <cert file> -o <new certdb>\r
+\r
+  NOTE: You may need the patch to make efisiglist generate the correct header.\r
+  (https://github.com/rhboot/pesign/pull/40)\r
+\r
+* Besides the trusted certificates, it's also possible to configure the trusted\r
+  cipher suites for HTTPS through another fw_cfg entry: etc/edk2/https/ciphers.\r
+\r
+  -fw_cfg name=etc/edk2/https/ciphers,file=<cipher suites>\r
+\r
+  OVMF expects a binary UINT16 array which comprises the cipher suites HEX\r
+  IDs(*4). If the cipher suite list is given, OVMF will choose the cipher\r
+  suite from the intersection of the given list and the built-in cipher\r
+  suites. Otherwise, OVMF just chooses whatever proper cipher suites from the\r
+  built-in ones.\r
+\r
+  While the tool(*5) to create the cipher suite array is still under\r
+  development, the array can be generated with the following script:\r
+\r
+  export LC_ALL=C\r
+  openssl ciphers -V \\r
+  | sed -r -n \\r
+     -e 's/^ *0x([0-9A-F]{2}),0x([0-9A-F]{2}) - .*$/\\\\x\1 \\\\x\2/p' \\r
+  | xargs -r -- printf -- '%b' > ciphers.bin\r
+\r
+  This script creates ciphers.bin that contains all the cipher suite IDs\r
+  supported by openssl according to the local host configuration.\r
+\r
+  You may want to enable only a limited set of cipher suites. Then, you\r
+  should check the validity of your list first:\r
+\r
+  openssl ciphers -V <cipher list>\r
+\r
+  If all the cipher suites in your list map to the proper HEX IDs, go ahead\r
+  to modify the script and execute it:\r
+\r
+  export LC_ALL=C\r
+  openssl ciphers -V <cipher list> \\r
+  | sed -r -n \\r
+     -e 's/^ *0x([0-9A-F]{2}),0x([0-9A-F]{2}) - .*$/\\\\x\1 \\\\x\2/p' \\r
+  | xargs -r -- printf -- '%b' > ciphers.bin\r
+\r
+* In the future (after release 2.12), QEMU should populate both above fw_cfg\r
+  files automatically from the local host configuration, and enable the user\r
+  to override either with dedicated options or properties.\r
+\r
+(*1) See "31.4.1 Signature Database" in UEFI specification 2.7 errata A.\r
+(*2) p11-kit: https://github.com/p11-glue/p11-kit/\r
+(*3) efisiglist: https://github.com/rhboot/pesign/blob/master/src/efisiglist.c\r
+(*4) https://wiki.mozilla.org/Security/Server_Side_TLS#Cipher_names_correspondence_table\r
+(*5) update-crypto-policies: https://gitlab.com/redhat-crypto/fedora-crypto-policies\r
 \r
 === OVMF Flash Layout ===\r
 \r
 \r
 === OVMF Flash Layout ===\r
 \r
@@ -303,25 +402,6 @@ main firmware (MAINFV) into RAM memory at address 0x800000. The
 remaining OVMF firmware then uses this decompressed firmware\r
 volume image.\r
 \r
 remaining OVMF firmware then uses this decompressed firmware\r
 volume image.\r
 \r
-=== UNIXGCC Debug ===\r
-\r
-If you build with the UNIXGCC toolchain, then debugging will be disabled\r
-due to larger image sizes being produced by the UNIXGCC toolchain. The\r
-first choice recommendation is to use GCC44 or newer instead.\r
-\r
-If you must use UNIXGCC, then you can override the build options for\r
-particular libraries and modules in the .dsc to re-enable debugging\r
-selectively. For example:\r
-  [Components]\r
-  OvmfPkg/Library/PlatformBootManagerLib/PlatformBootManagerLib.inf {\r
-    <BuildOptions>\r
-      GCC:*_*_*_CC_FLAGS             = -UMDEPKG_NDEBUG\r
-  }\r
-  MdeModulePkg/Universal/BdsDxe/BdsDxe.inf {\r
-    <BuildOptions>\r
-      GCC:*_*_*_CC_FLAGS             = -UMDEPKG_NDEBUG\r
-  }\r
-\r
 === UEFI Windows 7 & Windows 2008 Server ===\r
 \r
 * One of the '-vga std' and '-vga qxl' QEMU options should be used.\r
 === UEFI Windows 7 & Windows 2008 Server ===\r
 \r
 * One of the '-vga std' and '-vga qxl' QEMU options should be used.\r