From Fedora Project Wiki

(Drop 'conver existing VM' section, since in general it's not going to work, as grub needs changing)
(Start reorganizing the page, and modernizing the virt steps)
Line 1: Line 1:
  
= Testing secureboot with KVM =
+
= Using UEFI in a QEMU/KVM VM =
  
This page documents how to test Fedora 18+ [[Secureboot]] support inside
+
== Installing 'UEFI for QEMU' nightly builds ==
a KVM VM. The audience here is QA folks that want to test secureboot, and
 
any other curious parties.
 
  
== Install OVMF ==
+
UEFI for x86 QEMU/KVM VMs is called OVMF (Open Virtual Machine Firmware). It comes
 
 
OVMF (Open Virtual Machine Firmware) is basically UEFI for KVM. It comes
 
 
from EDK2 (EFI Development Kit), which is the UEFI reference implementation.
 
from EDK2 (EFI Development Kit), which is the UEFI reference implementation.
  
 
Unfortunately there are licensing issues which prevent us getting EDK2/OVMF
 
Unfortunately there are licensing issues which prevent us getting EDK2/OVMF
into Fedora (see [[#EDK2 Licensing Issues]] at the end of this document for more info). So we
+
into Fedora (see [[#EDK2 Licensing Issues]] for more info). So we
 
have to grab external packages.
 
have to grab external packages.
 
== Running EDK2/OVMF nightly builds ==
 
  
 
Gerd Hoffman, Red Hatter and QEMU developer, has a yum repo on his personal
 
Gerd Hoffman, Red Hatter and QEMU developer, has a yum repo on his personal
Line 21: Line 15:
 
including EDK2/OVMF.
 
including EDK2/OVMF.
  
Here's how to pull down the nightly builds:
+
Here's how to pull down the nightly builds for x86:
  
 
   sudo wget http://www.kraxel.org/repos/firmware.repo -O /etc/yum.repos.d/firmware.repo
 
   sudo wget http://www.kraxel.org/repos/firmware.repo -O /etc/yum.repos.d/firmware.repo
 +
  sudo yum install edk2.git-ovmf-x64
  
  # Disable by default, likely preferred for QA
+
== Install a Fedora VM with UEFI ==
  sudo sed -i -e "s/enabled=1/enabled=0/g" /etc/yum.repos.d/firmware.repo
 
  sudo yum --enablerepo=qemu-firmware-jenkins install edk2.git-ovmf-x64
 
  
The OVMF image is at:
+
{{admon/note | This examples assume you are using Fedora 21 packages. | UEFI VMs can be installed with older Fedora versions, but since as of Fedora 21 this stuff is still under active development, it's recommended to run the latest bits. }}
 
 
  /usr/share/edk2.git/ovmf-x64/OVMF-pure-efi.fd
 
 
 
Since these are nightly builds, occasionally things break. To work around this, use the following commands to get the February
 
26th 2014 nightly build:
 
 
 
  sudo wget http://drsmith2.fedorapeople.org/edk2.git/edk2.git-0-20140226.b491.gb9b77ab.x86_64.rpm
 
  sudo wget http://drsmith2.fedorapeople.org/edk2.git/edk2.git-ovmf-ia32-0-20140226.b491.gb9b77ab.x86_64.rpm
 
  sudo rpm -ivh edk2.git-0-20140226.b491.gb9b77ab.x86_64.rpm edk2.git-ovmf-ia32-0-20140226.b491.gb9b77ab.x86_64.rpm
 
 
 
== Install an F18+ VM with UEFI ==
 
  
 
First we need to install a guest using UEFI instead of traditional bios.
 
First we need to install a guest using UEFI instead of traditional bios.
Anaconda will put all the right bits in place for us. You can probably
+
Anaconda will put all the right bits in place for us.
convert an existing bios guest to use UEFI but I haven't found steps to do
 
so.
 
 
 
Newer OVMF builds can use a network install, older builds were slow when using a network install. If the network install seems slow, switch to using a DVD install.
 
  
 
Here's an example F20 install:
 
Here's an example F20 install:
  
   sudo virt-install --name f20-uefi --ram 2048 --boot loader=/usr/share/edk2.git/ovmf-x64/OVMF-pure-efi.fd --disk /var/lib/libvirt/images/f20-uefi.qcow,format=qcow2,size=10 --os-variant fedora20 --cdrom /path/to/Fedora-20-x86_64-netinst.iso
+
   sudo virt-install --name f20-uefi \
 
+
    --ram 2048 --disk size=20 \
(If you'd like to create a rawhide guest, you combine the above command with the following info: <https://fedoraproject.org/wiki/Releases/Rawhide?rd=Rawhide#Point_installer_to_Rawhide>)
+
    --boot loader_type=pflash,loader_ro=yes,loader=/usr/share/edk2.git/ovmf-x64/OVMF_CODE-pure-efi.fd,nvram_template=/usr/share/edk2.git/ovmf-x64/OVMF_VARS-pure-efi.fd \
 
+
    --location https://dl.fedoraproject.org/pub/fedora/linux/releases/20/Fedora/x86_64/os/
Follow the install to completion, log in and do firstboot, then move along.
 
Secure boot isn't set up yet.
 
  
 
== Booting the VM with OVMF ==
 
== Booting the VM with OVMF ==
Line 73: Line 49:
  
 
The above commands just get Fedora going, we haven't set up secure boot yet.
 
The above commands just get Fedora going, we haven't set up secure boot yet.
 +
 +
= Testing Secureboot in a VM =
 +
 +
These steps describe how to test Fedora [[Secureboot]] support inside a KVM VM. The audience here is QA folks that want to test secureboot, and
 +
any other curious parties. This requires configuring the VM to use UEFI, so it builds upon the previous UEFI steps.
  
 
== Grab LockDown_ms.efi ==
 
== Grab LockDown_ms.efi ==
Line 129: Line 110:
  
 
At this point reboot the guest. After logging in, you should see 'Secure boot enabled' in dmesg. Success!
 
At this point reboot the guest. After logging in, you should see 'Secure boot enabled' in dmesg. Success!
 
= Misc bits =
 
 
== EDK2 Licensing Issues ==
 
 
EDK2 contains a FAT filesystem driver that is licensed under terms that
 
make it not acceptable for packaging in Fedora. Particularly that there's
 
a usage restricition only allowing the code to be used in a UEFI
 
implementation. More details here at [http://tianocore.sourceforge.net/wiki/Edk2-fat-driver Edk2-fat-driver]
 
 
The driver is critical functionality so removing it is not an option.
 
  
 
== Testing F18 DVD Secure Boot in a VM ==
 
== Testing F18 DVD Secure Boot in a VM ==
Line 159: Line 129:
 
* Select 'EFI DVD/CDROM'
 
* Select 'EFI DVD/CDROM'
 
* Once anaconda starts, grab shell, log in, verify secure boot is enabled
 
* Once anaconda starts, grab shell, log in, verify secure boot is enabled
 +
 +
= Notes =
 +
 +
== EDK2 Licensing Issues ==
 +
 +
EDK2 contains a FAT filesystem driver that is licensed under terms that
 +
make it not acceptable for packaging in Fedora. Particularly that there's
 +
a usage restricition only allowing the code to be used in a UEFI
 +
implementation. More details here at [http://tianocore.sourceforge.net/wiki/Edk2-fat-driver Edk2-fat-driver]
 +
 +
The driver is critical functionality so removing it is not an option.
 +
 +
== Using UEFI with AArch64 VMs ==
 +
 +
[[Architectures/ARM/AArch64|Fedora's AArch64 releases]] will only run on UEFI, so require UEFI inside the VM. However the steps are slightly different. See this page for complete documentation: https://fedoraproject.org/wiki/Architectures/AArch64/Install_with_QEMU
  
 
== Extra links ==
 
== Extra links ==

Revision as of 20:22, 23 November 2014

Using UEFI in a QEMU/KVM VM

Installing 'UEFI for QEMU' nightly builds

UEFI for x86 QEMU/KVM VMs is called OVMF (Open Virtual Machine Firmware). It comes from EDK2 (EFI Development Kit), which is the UEFI reference implementation.

Unfortunately there are licensing issues which prevent us getting EDK2/OVMF into Fedora (see #EDK2 Licensing Issues for more info). So we have to grab external packages.

Gerd Hoffman, Red Hatter and QEMU developer, has a yum repo on his personal site that provides nightly builds of a whole bunch of QEMU/KVM firmware, including EDK2/OVMF.

Here's how to pull down the nightly builds for x86:

 sudo wget http://www.kraxel.org/repos/firmware.repo -O /etc/yum.repos.d/firmware.repo
 sudo yum install edk2.git-ovmf-x64

Install a Fedora VM with UEFI

Note.png
This examples assume you are using Fedora 21 packages.
UEFI VMs can be installed with older Fedora versions, but since as of Fedora 21 this stuff is still under active development, it's recommended to run the latest bits.

First we need to install a guest using UEFI instead of traditional bios. Anaconda will put all the right bits in place for us.

Here's an example F20 install:

 sudo virt-install --name f20-uefi \
   --ram 2048 --disk size=20 \
   --boot loader_type=pflash,loader_ro=yes,loader=/usr/share/edk2.git/ovmf-x64/OVMF_CODE-pure-efi.fd,nvram_template=/usr/share/edk2.git/ovmf-x64/OVMF_VARS-pure-efi.fd \
   --location https://dl.fedoraproject.org/pub/fedora/linux/releases/20/Fedora/x86_64/os/

Booting the VM with OVMF

If Fedora doesn't boot, try the following steps. First you'll need to be at the EFI Internal Shell. If you see a 'Shell> ' prompt you are in the shell. If OVMF doesn't drop you into the EFI Internal Shell automatically, do the following:

  1. Wait until the TianoCore splash screen pops up, hit ESC
  2. Select 'Boot Manager'
  3. Select 'EFI Internal Shell'

Once in the EFI Internal Shell, here are the commands you need to boot Fedora (assuming your guest only has a CDROM attached):

 fs0:
 \EFI\fedora\shim.efi

The above commands just get Fedora going, we haven't set up secure boot yet.

Testing Secureboot in a VM

These steps describe how to test Fedora Secureboot support inside a KVM VM. The audience here is QA folks that want to test secureboot, and any other curious parties. This requires configuring the VM to use UEFI, so it builds upon the previous UEFI steps.

Grab LockDown_ms.efi

Since OVMF doesn't ship with any SecureBoot keys installed, we need to install some to mimic what an MS certified UEFI machine will ship with. But here's a crappy thing about OVMF and KVM: right now there's no way to persist UEFI config across VM start/stop, although we'll come close with the script we'll create below.

Note.png
Improvements in Fedora 20
With qemu 1.6 and later, a -pflash bios.bin option, is supposed to enable persistent EFI variables. This may or may not also require -no-kvm.

So if we want to test SecureBoot, we need to install the MS keys and enable secureboot on every VM restart.

Luckily there's a tool that does all this for us, called LockDown_ms.efi. This is derived from code in efitools.git.

Inside the guest, do:

 sudo wget http://fedorapeople.org/~crobinso/secureboot/LockDown_ms.efi -O /boot/efi/EFI/fedora/LockDown_ms.efi

Automate SecureBoot startup

As mentioned above, we have to install the MS keys and enable secureboot on every VM restart. Luckily, OVMF by default runs a script at startup, called startup.nsh. We'll use this to automate startup. All we really need in the script are the following commands:

 fs0:
 \EFI\fedora\LockDown_ms.efi
 \EFI\fedora\shim.efi

But, life is complicated by the fact that if you are rebooting the VM where LockDown_ms.efi has been loaded, it can't be loaded a second time (without powering off the VM). If you try, you'll get a "Error reported: Security Violation" message when loading LockDown_ms.efi and the script will stop. So, the script needs to check if SecureBoot is already on before trying to load LockDown_ms.efi.

Inside the guest, as root edit /boot/efi/startup.nsh and add the following text:

 fs0:
 # If we don't have the secure boot dmp file, assume this is the first
 # time this script has been run and secure boot is off.
 set __lockdown 0
 if not exist SecureBoot.dmp then
   set __lockdown 1
 # Otherwise we check the current state of the 'SecureBoot' variable
 # to see if LockDown_ms.efi has already been loaded.
 else
   dmpstore SecureBoot -s SecureBoot.tmp
   comp SecureBoot.dmp SecureBoot.tmp
   if not %lasterror% == 0 then
     set __lockdown 1
   endif
   rm SecureBoot.tmp
 endif
 if %__lockdown% == 1 then
   \EFI\fedora\LockDown_ms.efi
   dmpstore SecureBoot -s SecureBoot.dmp
 endif
 \EFI\fedora\shim.efi

Verify SecureBoot

At this point reboot the guest. After logging in, you should see 'Secure boot enabled' in dmesg. Success!

Testing F18 DVD Secure Boot in a VM

Since we can't easily alter the DVD to add LockDown_ms.efi, we get it into the VM using a mini disk image:

 wget http://fedorapeople.org/~crobinso/secureboot/lockdown.qcow2
 sudo virsh attach-disk $VMNAME --target hdb --source lockdown.qcow2 --subdriver qcow2 --config

Then do

  • Launch the VM, drop to the EFI shell
  • If your guest only has a CDROM attached, lockdown.qcow2 should be fs0
  • Shell> fs0:
  • fs0:\> LockDown_ms.efi
  • fs0:\> exit
  • Back in the config screen, Select 'Boot Manager'
  • Select 'EFI DVD/CDROM'
  • Once anaconda starts, grab shell, log in, verify secure boot is enabled

Notes

EDK2 Licensing Issues

EDK2 contains a FAT filesystem driver that is licensed under terms that make it not acceptable for packaging in Fedora. Particularly that there's a usage restricition only allowing the code to be used in a UEFI implementation. More details here at Edk2-fat-driver

The driver is critical functionality so removing it is not an option.

Using UEFI with AArch64 VMs

Fedora's AArch64 releases will only run on UEFI, so require UEFI inside the VM. However the steps are slightly different. See this page for complete documentation: https://fedoraproject.org/wiki/Architectures/AArch64/Install_with_QEMU

Extra links