Using UEFI with QEMU

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
m (typo in yum command: s/jenkings/jenkins/)
(copy useful information from QA:Testcase Virtualization UEFI)
 
(10 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
= Firmware installation =
  
= Testing secureboot with KVM =
+
== Installing 'UEFI for QEMU' nightly builds ==
  
This page documents how to test Fedora 18 [[Secureboot]] support inside
+
UEFI for x86 QEMU/KVM VMs is called OVMF (Open Virtual Machine Firmware). It comes
a KVM VM. The audience here is QA folks that want to test secureboot, and
+
any other curious parties.
+
 
+
== Install OVMF ==
+
 
+
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.
  
  sudo rpm -ivh http://fedorapeople.org/~crobinso/secureboot/edk2.manual-0-0.20130221.944c84a6.x86_64.rpm
+
Gerd Hoffmann, 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.
  
== Install an F18 VM with UEFI ==
+
Here's how to pull down the nightly builds for x86:
  
First we need to install a guest using UEFI instead of traditional bios.
+
  sudo wget http://www.kraxel.org/repos/firmware.repo -O /etc/yum.repos.d/firmware.repo
Anaconda will put all the right bits in place for us. You can probably
+
  sudo yum install edk2.git-ovmf-x64
convert an existing bios guest to use UEFI but I haven't found steps to do
+
so.
+
  
I recommend using a DVD, network installs seem to be sloooow using OVMF:
+
Note, these are nightly builds, and may occasionally be broken.
  
  sudo virt-install --name f18-uefi --ram 2048 --boot loader=/usr/share/edk2.manual/ovmf-x64/OVMF-pure-efi.fd --disk /var/lib/libvirt/images/f18-uefi.qcow,format=qcow2,size=10 --os-variant fedora18 --cdrom /path/to/Fedora-18-x86_64-DVD.iso
+
== Configure libvirtd to advertise UEFI support ==
  
Follow the install to completion, log in and do firstboot, then move along.
+
Libvirt needs to know about UEFI->NVRAM config file mapping, so it can advertise it to tools like virt-manager/virt-install.
Secure boot isn't set up yet.
+
  
== Grab LockDown_ms.efi ==
+
As root, edit /etc/libvirt/qemu.conf, and add this section at the top of the file:
  
Since OVMF doesn't ship with any SecureBoot keys installed, we need to
+
  nvram = [
install some to mimic what an MS certified UEFI machine will ship with.
+
    "/usr/share/edk2.git/ovmf-x64/OVMF_CODE-pure-efi.fd:/usr/share/edk2.git/ovmf-x64/OVMF_VARS-pure-efi.fd",
But here's a crappy thing about OVMF and KVM: right now there's no way to
+
  ]
persist UEFI config across VM start/stop. 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.
+
Then restart libvirtd: <code>sudo systemctl restart libvirtd</code>
This is derived from code in [http://git.kernel.org/?p=linux/kernel/git/jejb/efitools.git;a=summary efitools.git].
+
  
Inside the guest, do:
+
= Creating a VM =
  
  sudo wget http://fedorapeople.org/~crobinso/secureboot/LockDown_ms.efi -O /boot/efi/EFI/fedora/LockDown_ms.efi
+
== virt-manager ==
  
== Enable SecureBoot and verify it's all working ==
+
Create a new VM in virt-manager. When you get to the final page of the 'New VM' wizard, do the following:
  
As mentioned above, this needs to be done on every VM boot.
+
* Click 'Customize before install', then select 'Finish'
 +
* On the 'Overview' screen, Change the 'Firmware' field to select the 'UEFI x86_64' option.
 +
* Click 'Begin Installation'
 +
* The boot screen you'll see should use <code>linuxefi</code> commands to boot the installer, and you should be able to run <code>efibootmgr</code> inside that system, to verify that you're running an UEFI OS.
  
# Wait until the TianoCore splash screen pops up, hit ESC
+
== virt-install ==
# Select 'Boot Manager'
+
# Select 'EFI Internal Shell'
+
# <code>Shell> fs0:</code>
+
# <code>fs0:\> \EFI\fedora\LockDown_ms.efi </code>
+
# <code>fs0:\> \EFI\fedora\shim.efi </code>
+
# Guest boots, log in, should see 'Secure boot enabled' in dmesg
+
  
 +
Add <code>--boot uefi</code> to your <code>virt-install</code> command. Example:
  
= Misc bits =
+
  sudo virt-install --name f20-uefi \
 +
    --ram 2048 --disk size=20 \
 +
    --boot uefi \
 +
    --location https://dl.fedoraproject.org/pub/fedora/linux/releases/22/Workstation/x86_64/os/
  
== EDK2 Licensing Issues ==
+
= Testing Secureboot in a VM =
  
EDK2 contains a FAT filesystem driver that is licensed under terms that
+
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
make it not acceptable for packaging in Fedora. Particularly that there's
+
any other curious parties. This requires configuring the VM to use UEFI, so it builds upon the previous UEFI steps.
a usage restricition only allowing the code to be used in a UEFI
+
implementation. More details here at [http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=Edk2-fat-driver Edk2-fat-driver]
+
  
The driver is critical functionality so removing it is not an option.
+
== Grab LockDown_ms.efi ==
  
== Running EDK2 nightly builds ==
+
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.
 +
Luckily there's a tool that does all this for us, called LockDown_ms.efi.
 +
This is derived from code in [http://git.kernel.org/?p=linux/kernel/git/jejb/efitools.git;a=summary efitools.git].
  
Gerd Hoffman, Red Hatter and QEMU developer, has a yum repo on his personal
+
Inside the guest, do:
site that provides nightly builds of a whole bunch of QEMU/KVM firmware,
+
including EDK2/OVMF.
+
  
Currently though, latest OVMF broke F18 SecureBoot: running the above steps
+
  sudo wget http://fedorapeople.org/~crobinso/secureboot/LockDown_ms.efi -O /boot/efi/EFI/fedora/LockDown_ms.efi
will give the following error when trying to boot shim.efi:
+
  
  Error reported: Security Violation
+
Now we need to enroll the keys in UEFI.
  
There's a fix in upstream <code>pesign</code>, but as of this writing, shim
+
* Reboot the VM
in F18 hasn't been regenerated to pick up the fix.
+
* When the TianoCore splash screen pops up, hit ESC
 +
* Select 'Boot Manager'
 +
* Select 'EFI Internal Shell'
 +
* Hit ESC to skip startup.nsh, or wait for the 5 second timeout.
 +
* Shell> fs0:
 +
* FS0:\> \EFI\fedora\LockDown_ms.efi
 +
* FS0:\> reset
 +
* The VM will restart. Let it boot into Fedora as normal. Log in
 +
* You should see the string 'Secure boot enabled' in dmesg. Secureboot is now enabled for every subsequent boot.
  
Regardless, here's how to pull down the nightly builds:
+
== Testing Fedora CD/DVD Secure Boot in a VM ==
  
  sudo wget http://www.kraxel.org/repos/firmware.repo -O /etc/yum.repos.d/firmware.repo
+
Once you have a secureboot configured VM as described above, it's easy to use this to test ISO media secureboot support.
  
  # Disable by default, likely preferred for QA
+
* Use virt-manager to attach the ISO media to your VM
  sudo sed -i -e "s/enabled=1/enabled=0/g" /etc/yum.repos.d/firmware.repo
+
* Use virt-manager to change the VM boot settings to boot off the CDROM
  sudo yum --enablerepo=qemu-firmware-jenkins install edk2.git-ovmf-x64
+
* Start the VM
 +
* Switch to a terminal inside the VM, verify Secureboot is enabled by checking dmesg
  
The OVMF image is at:
+
= Notes =
  
  /usr/share/edk2.git/ovmf-x64/OVMF-pure-efi.fd
+
== EDK2 Licensing Issues ==
  
== Pointing an existing guest at OVMF ==
+
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]
  
To alter an existing guest to use OVMF, or change the OVMF build it uses, do
+
The driver is critical functionality so removing it is not an option.
<code>sudo virsh edit $vmname</code> and add
+
  
  <domain>
+
== Using UEFI with AArch64 VMs ==
    ...
+
    <os>
+
    ...
+
      <loader>/path/to/OVMF-pure-efi.fd</loader>
+
  
== Testing F18 DVD Secure Boot in a VM ==
+
[[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
  
Since we can't easily alter the DVD to add LockDown_ms.efi, we get it into
+
= Extra links =
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
+
* <code>Shell> fs0:</code>
+
* <code>fs0:\> LockDown_ms.efi </code>
+
* <code>fs0:\> exit </code>
+
* Back in the config screen, Select 'Boot Manager'
+
* Select 'EFI DVD/CDROM'
+
* Once anaconda starts, grab shell, log in, verify secure boot is enabled
+
 
+
== Extra links ==
+
  
 +
* [[QA:Testcase Virtualization UEFI]]
 +
* [http://www.linux-kvm.org/page/OVMF KVM wiki OVMF page]
 
* [https://wiki.ubuntu.com/SecurityTeam/SecureBoot Ubuntu secureboot page]
 
* [https://wiki.ubuntu.com/SecurityTeam/SecureBoot Ubuntu secureboot page]
 
* [http://en.opensuse.org/openSUSE:UEFI_Secure_boot_using_qemu-kvm OpenSUSE secureboot page]
 
* [http://en.opensuse.org/openSUSE:UEFI_Secure_boot_using_qemu-kvm OpenSUSE secureboot page]
* [http://www.linux-kvm.org/page/OVMF KVM wiki OVMF page]
 
  
 
[[Category:Virtualization]] [[Category:QA]]
 
[[Category:Virtualization]] [[Category:QA]]

Latest revision as of 11:08, 1 July 2015

Contents

[edit] Firmware installation

[edit] 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 Hoffmann, 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

Note, these are nightly builds, and may occasionally be broken.

[edit] Configure libvirtd to advertise UEFI support

Libvirt needs to know about UEFI->NVRAM config file mapping, so it can advertise it to tools like virt-manager/virt-install.

As root, edit /etc/libvirt/qemu.conf, and add this section at the top of the file:

 nvram = [
    "/usr/share/edk2.git/ovmf-x64/OVMF_CODE-pure-efi.fd:/usr/share/edk2.git/ovmf-x64/OVMF_VARS-pure-efi.fd",
 ]

Then restart libvirtd: sudo systemctl restart libvirtd

[edit] Creating a VM

[edit] virt-manager

Create a new VM in virt-manager. When you get to the final page of the 'New VM' wizard, do the following:

  • Click 'Customize before install', then select 'Finish'
  • On the 'Overview' screen, Change the 'Firmware' field to select the 'UEFI x86_64' option.
  • Click 'Begin Installation'
  • The boot screen you'll see should use linuxefi commands to boot the installer, and you should be able to run efibootmgr inside that system, to verify that you're running an UEFI OS.

[edit] virt-install

Add --boot uefi to your virt-install command. Example:

 sudo virt-install --name f20-uefi \
   --ram 2048 --disk size=20 \
   --boot uefi \
   --location https://dl.fedoraproject.org/pub/fedora/linux/releases/22/Workstation/x86_64/os/

[edit] 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.

[edit] 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. 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

Now we need to enroll the keys in UEFI.

  • Reboot the VM
  • When the TianoCore splash screen pops up, hit ESC
  • Select 'Boot Manager'
  • Select 'EFI Internal Shell'
  • Hit ESC to skip startup.nsh, or wait for the 5 second timeout.
  • Shell> fs0:
  • FS0:\> \EFI\fedora\LockDown_ms.efi
  • FS0:\> reset
  • The VM will restart. Let it boot into Fedora as normal. Log in
  • You should see the string 'Secure boot enabled' in dmesg. Secureboot is now enabled for every subsequent boot.

[edit] Testing Fedora CD/DVD Secure Boot in a VM

Once you have a secureboot configured VM as described above, it's easy to use this to test ISO media secureboot support.

  • Use virt-manager to attach the ISO media to your VM
  • Use virt-manager to change the VM boot settings to boot off the CDROM
  • Start the VM
  • Switch to a terminal inside the VM, verify Secureboot is enabled by checking dmesg

[edit] Notes

[edit] 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.

[edit] 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

[edit] Extra links