Testing

Differences between revisions 8 and 12 (spanning 4 versions)
Revision 8 as of 2012-11-27 20:55:49
Size: 3203
Editor: jdstrand
Comment:
Revision 12 as of 2012-11-27 22:32:48
Size: 13204
Editor: jdstrand
Comment:
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:

||<tablestyle="float:right; font-size: 0.9em; width:30%; background:#F1F1ED; background-repeat: no-repeat; background-position: 98% 0.5ex; margin: 0 0 1em 1em; padding: 0.5em;"><<TableOfContents>>||
Line 10: Line 12:

== Introduction ==
In brief, Secure Boot works by placing the root of trust in firmware. While other implementations are possible, in practice the chain of trust is achieved via x509 certificates. A root CA is embedded in firmware such that it can then validate the signed bootloader, the signed bootloader can then validate the signed kernel or signed 2nd stage boot loader, and so on. Various key databases are used to provide flexibility and maintain strong security:
 * DB (aka, 'signature database'): contains the trusted keys used for authenticating any applications or drivers executed in the UEFI environment
 * DBX (aka, 'forbidden signature database' or 'signature database blacklist'): contains a set of explicitly untrusted keys and binary hashes. Any application or driver signed by these keys or matching these hashes will be blocked from execution.
 * KEK (key exchange keys database): contains the set of keys trusted for updating DB and DBX
 * PK (platform key - while PK is often referred to simply as a single public key, it could be implemented as a database). Only updates signed with PK can update the KEK database.

The suggested implementation by UEFI:
 * OEM key in PK
 * OS vendor keys in KEK and DB. OEM may also have a key in KEK and DB

Systems shipping with Windows 8 will typically use the following:
 * OEM key in PK
 * 'Microsoft Corporation KEK CA' key in KEK
 * 'Microsoft Windows Production PCA' and 'Microsoft Corporation UEFI CA' keys in DB (note, the 'Microsoft Corporation UEFI CA' is not guaranteed to be present in DB-- while recommended, this is EFI firmware vendor/OEM dependent)

In order to boot on the widest range of systems, Ubuntu uses the following chain of trust:
 0. Microsoft sign's Canonical's 'shim' 1st stage bootloader with their 'Microsoft Corporation UEFI CA'. When the system boots and secure boot is enabled, firmware verfies that this 1st stage bootloader (from the 'shim-signed' package) is signed with a key in DB (in this case 'Microsoft Corporation UEFI CA')
 0. The second stage bootloader (grub-efi-amd64-signed) is signed with Canonical's 'Canonical Ltd. Secure Boot Signing' key. The shim 1st stage bootloader verifies that the 2nd stage grub2 bootloader is signed with this key.
 0. The 2nd stage grub2 bootloader boots an Ubuntu kernel (as of 2012/11, if the kernel (linux-signed) is signed with the 'Canonical Ltd. Secure Boot Signing' key, then grub2 will boot the kernel which will in turn apply quirks and call !ExitBootServices. If the kernel is unsigned, grub2 will call !ExitBootServices before booting the unsigned kernel)
 0. If signed kernel modules are supported, the signed kernel will verify them during kernel boot

Since the above gives the ability to control boot to the OEM and Microsoft, users may want to:
 * install their own key in PK, KEK and DB, then re-sign grub2 and use it without shim (and optionally sign the kernel with their own key)
 * install their own key in PK and KEK, Canonical's key in KEK and DB and Microsoft's key in KEK. This gives control of boot to Canonical, but allows for the grub-efi-amd64-signed and linux-signed packages and any DB/DBX updates from Microsoft and Canonical to work without re-signing.

It is important that when testing a minimum of shim boot, Canonical-signed grub2 boot and user-signed grub2 boot are covered.

'''IMPORTANT:''' Canonical's implementation is primarily about hardware-enablement, not system security and this page focuses on how to test Secure Boot, not enabling Secure Boot to harden your system. If you want to use Secure Boot as a security mechanism, the easiest solution is to use your own keys.
Line 51: Line 83:
=== Maintenance ===
`uvt update` does not work because the boot process requires manual intervention. As such, keeping the VM up to date consists of:
 0. {{{$ sudo start [-rf] <vmname>}}}
 0. Selecting the image to boot
 0. {{{$ uvt cmd -r -p <vmprefix> 'apt-get update && apt-get -y --force-yes dist-upgrade && apt-get autoremove --purge'}}}
 0. {{{$ uvt stop <vmname>}}}
 0. {{{$ uvt snapshot <vmname>}}}
Line 52: Line 92:

== Semi-automated secure boot VM setup for testing ==

=== Bootloader signed with user key ===
This emulates a configuration where a user or enterprise is using its own keys in PK, KEK and DB and follows the procedures in http://jk.ozlabs.org/docs/sbkeysync-maintaing-uefi-key-databases/. This configuration allows the greatest flexibility in testing as we control PK and KEK, so we can update all aspects of secure boot as needed.

 0. Boot an OVMF virtual UEFI machine (see above)
 0. Install some packages:{{{
$ sudo apt-get install sbsigntool openssl grub-efi-amd64-signed
}}}
 0. Install the signed bootloader:{{{
$ sudo grub-install --uefi-secure-boot
}}}
 0. Reboot the VM and 'Boot from File' as above
 0. Download [[http://bazaar.launchpad.net/~ubuntu-bugcontrol/qa-regression-testing/master/view/head:/notes_testing/secure-boot/sb-setup|sb-setup]] from lp:qa-regression-testing/notes_testing/secure-boot/ to `/tmp/sb-setup`
 0. Enroll the user keys (not, output may vary):{{{
$ /tmp/sb-setup enroll
Creating keystore...
  mkdir '/etc/secureboot/keys'
  mkdir '/etc/secureboot/keys/PK'
  mkdir '/etc/secureboot/keys/KEK'
  mkdir '/etc/secureboot/keys/db'
  mkdir '/etc/secureboot/keys/dbx'
done

Creating keys... done

Generating key updates...
  using GUID=bffda19f-f76b-49a4-8bfc-556cb5165538
  create EFI_SIGNATURE_LIST
  create signed updates...
    test-cert.der.siglist.PK.signed
    test-cert.der.siglist.KEK.signed
    test-cert.der.siglist.db.signed
  done
done

Initializing keystore...
  adding to /etc/secureboot/keys/PK/
  adding to /etc/secureboot/keys/KEK/
  adding to /etc/secureboot/keys/db/
done

Filesystem keystore:
  /etc/secureboot/keys/db/test-cert.der.siglist.db.signed [2116 bytes]
  /etc/secureboot/keys/KEK/test-cert.der.siglist.KEK.signed [2116 bytes]
  /etc/secureboot/keys/PK/test-cert.der.siglist.PK.signed [2116 bytes]
firmware keys:
  PK:
  KEK:
  db:
  dbx:
filesystem keys:
  PK:
    /CN=test-key
     from /etc/secureboot/keys/PK/test-cert.der.siglist.PK.signed
  KEK:
    /CN=test-key
     from /etc/secureboot/keys/KEK/test-cert.der.siglist.KEK.signed
  db:
    /CN=test-key
     from /etc/secureboot/keys/db/test-cert.der.siglist.db.signed
  dbx:
New keys in filesystem:
 /etc/secureboot/keys/db/test-cert.der.siglist.db.signed
 /etc/secureboot/keys/KEK/test-cert.der.siglist.KEK.signed
 /etc/secureboot/keys/PK/test-cert.der.siglist.PK.signed
Commit to keystore? (y|N) y
Filesystem keystore:
  /etc/secureboot/keys/db/test-cert.der.siglist.db.signed [2116 bytes]
  /etc/secureboot/keys/KEK/test-cert.der.siglist.KEK.signed [2116 bytes]
  /etc/secureboot/keys/PK/test-cert.der.siglist.PK.signed [2116 bytes]
firmware keys:
  PK:
  KEK:
  db:
  dbx:
filesystem keys:
  PK:
    /CN=test-key
     from /etc/secureboot/keys/PK/test-cert.der.siglist.PK.signed
  KEK:
    /CN=test-key
     from /etc/secureboot/keys/KEK/test-cert.der.siglist.KEK.signed
  db:
    /CN=test-key
     from /etc/secureboot/keys/db/test-cert.der.siglist.db.signed
  dbx:
New keys in filesystem:
 /etc/secureboot/keys/db/test-cert.der.siglist.db.signed
 /etc/secureboot/keys/KEK/test-cert.der.siglist.KEK.signed
 /etc/secureboot/keys/PK/test-cert.der.siglist.PK.signed
Inserting key update /etc/secureboot/keys/db/test-cert.der.siglist.db.signed into db
Inserting key update /etc/secureboot/keys/KEK/test-cert.der.siglist.KEK.signed into KEK
Inserting key update /etc/secureboot/keys/PK/test-cert.der.siglist.PK.signed into PK
Signing '/boot/efi/EFI/ubuntu/grubx64.efi'
warning: overwriting existing signature
}}}
 0. Reboot and verify secure boot is enabled:{{{
 - Device Manager ->
   - Secure Boot Configuration ->
     - Verify 'Attempt Secure Boot' is selected and 'Secure Boot Mode' is in
       'Standard Mode' ('Custom Mode' is also ok)
     - Change 'Secure Boot Mode' to 'Custom Mode' by highlighting 'Standard
       Mode' and pressing 'Enter'
     - Select Custom Boot Options ->
       - PK Options ->
         - Verify 'Enroll PK' is grayed out. Delete PK should have '[ ]' (or
           possibly a GUID).
         - Press Esc
       - KEK Options ->
         - Delete KEK ->
           - Verify a GUID is listed
           - Press 'Esc', twice
       - DB Options
         - Delete signature ->
           - Verify a GUID is listed
           - Press 'Esc', twice
       - DBX Options
         - Delete signature ->
           - Verify no GUIDs are listed
           - Press 'Esc', twice
}}}
 0. Press 'Esc' until at the main EFI configure screen, then 'Boot from File' normally (notice now there is a grubx64.efi.bak listed-- this is the grubx64.efi as installed by 'sudo grub-install --uefi-secure-boot'. Ie, the one signed with Canonical's key)
 0. Verify the machine booted with secure boot (note, can also use `sbsigdb` from newer versions of sbsigntool if it is available):{{{
$ sudo apt-get install fwts
$ sudo fwts uefidump - | grep Secure
Name: SecureBoot.
  Value: 0x01 (Secure Boot Mode On).
}}}

In the above, a CA is setup in /etc/secureboot/key-material (private key: test-key.rsa, public pem: test-cert.pem, public der: test-cert.der). A keystore is created in /etc/secureboot/keys/ and signed updates (using the keys in /etc/secureboot/key-material) are created for PK, KEK and DB.

=== Shim bootloader signed with Microsoft key ===
This is the expected configuration for new machines with default hardware and has Microsoft's UEFI key in KEK and DB.
 * TODO

=== Bootloader signed with Canonical key ===
This emulates a configuration which supports machines with Canonical's key in KEK and DB.
 * TODO

Testing Secure Boot (Draft)

Much of this is based on the UEFI work:

Testing infrastructure uses the security team's TestingEnvironment.

Introduction

In brief, Secure Boot works by placing the root of trust in firmware. While other implementations are possible, in practice the chain of trust is achieved via x509 certificates. A root CA is embedded in firmware such that it can then validate the signed bootloader, the signed bootloader can then validate the signed kernel or signed 2nd stage boot loader, and so on. Various key databases are used to provide flexibility and maintain strong security:

  • DB (aka, 'signature database'): contains the trusted keys used for authenticating any applications or drivers executed in the UEFI environment
  • DBX (aka, 'forbidden signature database' or 'signature database blacklist'): contains a set of explicitly untrusted keys and binary hashes. Any application or driver signed by these keys or matching these hashes will be blocked from execution.
  • KEK (key exchange keys database): contains the set of keys trusted for updating DB and DBX
  • PK (platform key - while PK is often referred to simply as a single public key, it could be implemented as a database). Only updates signed with PK can update the KEK database.

The suggested implementation by UEFI:

  • OEM key in PK
  • OS vendor keys in KEK and DB. OEM may also have a key in KEK and DB

Systems shipping with Windows 8 will typically use the following:

  • OEM key in PK
  • 'Microsoft Corporation KEK CA' key in KEK
  • 'Microsoft Windows Production PCA' and 'Microsoft Corporation UEFI CA' keys in DB (note, the 'Microsoft Corporation UEFI CA' is not guaranteed to be present in DB-- while recommended, this is EFI firmware vendor/OEM dependent)

In order to boot on the widest range of systems, Ubuntu uses the following chain of trust:

  1. Microsoft sign's Canonical's 'shim' 1st stage bootloader with their 'Microsoft Corporation UEFI CA'. When the system boots and secure boot is enabled, firmware verfies that this 1st stage bootloader (from the 'shim-signed' package) is signed with a key in DB (in this case 'Microsoft Corporation UEFI CA')
  2. The second stage bootloader (grub-efi-amd64-signed) is signed with Canonical's 'Canonical Ltd. Secure Boot Signing' key. The shim 1st stage bootloader verifies that the 2nd stage grub2 bootloader is signed with this key.
  3. The 2nd stage grub2 bootloader boots an Ubuntu kernel (as of 2012/11, if the kernel (linux-signed) is signed with the 'Canonical Ltd. Secure Boot Signing' key, then grub2 will boot the kernel which will in turn apply quirks and call ExitBootServices. If the kernel is unsigned, grub2 will call ExitBootServices before booting the unsigned kernel)

  4. If signed kernel modules are supported, the signed kernel will verify them during kernel boot

Since the above gives the ability to control boot to the OEM and Microsoft, users may want to:

  • install their own key in PK, KEK and DB, then re-sign grub2 and use it without shim (and optionally sign the kernel with their own key)
  • install their own key in PK and KEK, Canonical's key in KEK and DB and Microsoft's key in KEK. This gives control of boot to Canonical, but allows for the grub-efi-amd64-signed and linux-signed packages and any DB/DBX updates from Microsoft and Canonical to work without re-signing.

It is important that when testing a minimum of shim boot, Canonical-signed grub2 boot and user-signed grub2 boot are covered.

IMPORTANT: Canonical's implementation is primarily about hardware-enablement, not system security and this page focuses on how to test Secure Boot, not enabling Secure Boot to harden your system. If you want to use Secure Boot as a security mechanism, the easiest solution is to use your own keys.

Installation

  1. Obtain an OVMF image capable of performing secure boot by either:
  2. Put the image in /usr/share/qemu and use a relative path to OVMF.Fd for now (see LP: #1074207)

  3. Install Ubuntu using the secure boot capable UEFI OVMF firmware (downloaded as bios.bin):

    $ uvt new --loader=OVMF.Fd --with-ovmf-uefi quantal amd64 sb

    This can also be performed with a virt-install command:

    $ virt-install --connect=qemu:///system --name=sb-quantal-amd64 --arch=x86_64 --ram=768 \
    --disk=path=<path to>/sb-quantal-amd64.qcow2,size=8,format=qcow2,bus=ide,sparse=True \
    --virt-type=kvm --accelerate --hvm --cdrom=<path to>/quantal-desktop-amd64.iso \
    --os-type=linux --os-variant=generic26 --graphics=vnc --network=network=default,model=virtio \
    --video=cirrus --noreboot --boot=loader=OVMF.Fd

Both of the above commands creates the sb-quantal-amd64 machine. Note that when using uvt there is a limitation in that a preseeded ISO cannot be used. uvt will skip the postinstall phase and you will have to perform the install manually. You will know that you are using the OVMF EFI image if the machine comes up with 'Try Ubuntu' (ie, not the graphical install). Using the manual partitioner to create a 250M EFI partition as the first partition and then setting up a '/' and swap partition is known to work.

Caveats:

  • The installer doesn't reboot after install without pressing 'Enter'
  • On reboot and all boots, you must go into the efi config screen to boot from a file off the disk. Eg, from the main EFI configure screen:

     - Boot Maintenance Manager ->
       - Boot From File ->
         - NO VOLUME LABEL,[!PciRoot(0x0)/Pci(0x1,0x1)/Ata(Primary,Master,0x0)/HD(1,GPT,...)] ->
           - <EFI> ->
             - <ubuntu> ->
               - grubx64.efi
  • Because the postinstall isn't run via uvt, after install, you may want to:

    • sudo apt-get install openssh-server screen vim gnome-panel

    • Use ssh-copy-id to copy your key over

    • Optionally update sources.list for your mirror
  • When using uvt, the intial pristine snapshot is not created. After setting up, use uvt snapshot sb-quantal-amd64

  • Because the firmware needs to be able to interact with the hardware and is limited in what it supports, the following are used when using uvt:

    • IDE disks (ie, can't use virtio)
    • cirrus video driver
    Currently the virtio network driver is used-- if you want to try out PXE booting via EFI, this will likely also need to change.

See https://wiki.ubuntu.com/UEFI/OVMF for other ways of using the OVMF file.

Maintenance

uvt update does not work because the boot process requires manual intervention. As such, keeping the VM up to date consists of:

  1. $ sudo start [-rf] <vmname>

  2. Selecting the image to boot
  3. $ uvt cmd -r -p <vmprefix> 'apt-get update && apt-get -y --force-yes dist-upgrade && apt-get autoremove --purge'

  4. $ uvt stop <vmname>

  5. $ uvt snapshot <vmname>

Include: Nothing found for "== Resources =="!

What is UEFI Secure Boot?

UEFI Secure boot is a verification mechanism for ensuring that code launched by firmware is trusted.

Proper, secure use of UEFI Secure Boot requires that each binary loaded at boot is validated against known keys, located in firmware, that denote trusted vendors and sources for the binaries, or trusted specific binaries that can be identified via cryptographic hashing.

Most x86 hardware comes from the factory pre-loaded with Microsoft keys. This means we can generally rely on the firmware on these systems to trust binaries that are signed by Microsoft, and the Linux community heavily relies on this assumption for Secure Boot to work. This is the same process used by Red Hat and SUSE, for instance.

Many ARM and other architectures also support UEFI Secure Boot, but may not be pre-loading keys in firmware. On these architectures, it may be necessary to re-sign boot images with a certificate that is loaded in firmware by the owner of the hardware.

Initial implementation plan: Implementation Plan.

Supported architectures

  • amd64: A shim binary signed by Microsoft and grub binary signed by Canonical are provided in the Ubuntu main archive as shim-signed or grub-efi-amd64-signed.

  • arm64: As of 20.04 ('focal'), a shim binary signed by Microsoft and grub binary signed by Canonical are provided in the Ubuntu main archive as shim-signed or grub-efi-arm64-signed. There is a GRUB bug under investigation that needs to be resolved before this works end to end.

Testing UEFI Secure Boot

If you're interested in testing Secure Boot on your system, consult the how-to here: UEFI/SecureBoot/Testing.

How UEFI Secure Boot works on Ubuntu

On Ubuntu, all pre-built binaries intended to be loaded as part of the boot process, with the exception of the initrd image, are signed by Canonical's UEFI certificate, which itself is implicitly trusted by being embedded in the shim loader, itself signed by Microsoft.

On architectures or systems where pre-loaded signing certificates from Microsoft are not available or loaded in firmware, users may replace the existing signatures on shim or grub and load them as they wish, verifying against their own certificates imported in the system's firmware.

As the system boots, firmware loads the shim binary as specified in firmware BootEntry variables. Ubuntu installs its own BootEntry at installation time and may update it any time the GRUB bootloader is updated. Since the shim binary is signed by Microsoft; it is validated and accepted by the firmware when verifying against certificates already present in firmware. Since the shim binary embeds a Canonical certificate as well as its own trust database, further elements of the boot environment can, in addition to being signed by one of the acceptable certificates pre-loaded in firmware, be signed by Canonical's UEFI key.

The next thing loaded by shim is the second-stage image. This can be one of two things: either GRUB, if the system is booting normally; or MokManager, if key management is required, as configured by firmware variables (usually changed when the system was previously running).

If booting normally; the GRUB binary (grub*.efi) is loaded and its validation is attempted against all previously-known trusted sources. The GRUB binary for Ubuntu is signed by the Canonical UEFI key, so it is successfully validated and the boot process continues.

If booting to proceed with key management tasks, the MokManager binary (mm*.efi) is loaded. This binary is explicitly trusted by shim by being signed by an ephemeral key that only exists while the shim binary is being built. This means only the MokManager binary built with a particular shim binary will be allowed to run and limits the possibility of compromise from the use of compromised tools. MokManager allows any user present at the system console to enroll keys, remove trusted keys, enroll binary hashes and toggle Secure Boot validation at the shim level, but most tasks require a previously set password to be entered to confirm that the user at console is indeed the person who requested changes. Such passwords only survive across a single run of shim / MokManager; and are cleared as soon as the process is completed or cancelled. Once key management is completed, the system is rebooted and does not simply continue with booting, since the key management changes may be required to successfully complete the boot.

Once the system continues booting to GRUB; the GRUB process loads any required configuration (usually loading configuration from the ESP (EFI System Partition), pointing to another configuration file on the root or boot partition), which will point it to the kernel image to load.

EFI applications up to this point having full access to the system firmware, including access to changing trusted firmware variables, the kernel to load must also be validated against the trust database. Official Ubuntu kernels being signed by the Canonical UEFI key, they are successfully validated, and control is handed over to the kernel. Initrd images are not validated.

In the case of unofficial kernels, or kernels built by users, additional steps need to be taken if users wish to load such kernels while retaining the full capabilities of UEFI Secure Boot. All kernels must be signed to be allowed to load by GRUB when UEFI Secure Boot is enabled, so the user will require to proceed with their own signing. Alternatively, users may wish to disable validation in shim while booted with Secure Boot enabled on an official kernel by using 'sudo mokutil --disable-validation', providing a password when prompted, and rebooting; or to disable Secure Boot in firmware altogether.

Up to this point, any failure to validate an image to load is met with a critical error which stops the boot process. The system will not continue booting, and may automatically reboot after a period of time given that other BootEntry variables may contain boot paths that are valid and trusted.

Once loaded, validated kernels will disable the firmware's Boot Services, thus dropping privileges and effectively switching to user mode; where access to trusted variables is limited to read-only. Given the broad permissions afforded to kernel modules, any module not built into the kernel will also need to be validated upon loading. Modules built and shipped by Canonical with the official kernels are signed by the Canonical UEFI key and as such, are trusted. Custom-built modules will require the user to take the necessary steps to sign the modules before they loading them is allowed by the kernel. This can be achieved by using the 'kmodsign' command [see {How to sign} section].

Unsigned modules are simply refused by the kernel. Any attempt to insert them with insmod or modprobe will fail with an error message.

Given that many users require third-party modules for their systems to work properly or for some devices to function; and that these third-party modules require building locally on the system to be fitted to the running kernel, Ubuntu provides tooling to automate and simplify the signing process.

How can I do non-automated signing of drivers?

Some projects may require the use of custom kernel drivers that are not set up in such a way as to work with DKMS. In these cases, people should make use of the tools included in the shim-signed package: the update-secureboot-policy script is available to generate a new MOK (if no DKMS-built modules have triggered generating one already).

Use the following command to enroll an existing key into shim:

sudo update-secureboot-policy --enroll-key

If no MOK exists, the script will exit with a message to that effect. If the key is already enrolled, the script will exit, doing nothing. If the key exists but it not shown to be enrolled, the user will be prompted for a password to use after reboot, so that the key can be enrolled.

One can generate a new MOK using the following command:

sudo update-secureboot-policy --new-key

And then enroll the newly-generated key into shim with the previously-mentioned command for that task.

Kernel modules can then be signed with the kmodsign command (see UEFI/SecureBoot/Signing) as part of their build process.

Security implications in Machine-Owner Key management

The MOK generated at installation time or on upgrade is machine-specific, and only allowed by the kernel or shim to sign kernel modules, by use of a specific KeyUsage OID (1.3.6.1.4.1.2312.16.1.2) denoting the limitations of the MOK.

Recent shim versions include logic to follow the limitations of module-signing-only keys. These keys will be allowed to be enrolled in the firmware in shim's trust database, but will be ignored when shim or GRUB validate images to load in firmware. Shim's verify() function will only successfully validate images signed by keys that do not include the "Module-signing only" (1.3.6.1.4.1.2312.16.1.2) KeyUsage OID. The Ubuntu kernels use the global trust database (which includes both shim's and the firmware's) and will accept any of the included keys as signing keys when loading kernel modules.

Given the limitations imposed on the automatically generated MOK and the fact that users with superuser access to the system and access to the system console to enter the password required when enrolling keys already have high-level access to the system; the generated MOK key is kept on the filesystem as regular files owned by root with read-only permissions. This is deemed sufficient to limit access to the MOK for signing by malicious users or scripts, especially given that no MOK exists on the system unless it requires third-party drivers. This limits the possibility of compromise from the misuse of a generated MOK key to signing a malicious kernel module. This is equivalent to compromise of the userland applications which would already be possible with superuser access to the system, and securing this is out of the scope of UEFI Secure Boot.

Previous systems may have had Secure Boot validation disabled in shim. As part of the upgrade process, these systems will be migrated to re-enabling Secure Boot validation in shim and enrolling a new MOK key when applicable.

MOK generation and signing process

The key generation and signing process is slightly different based on whether we are dealing with a brand new installation or an upgrade of system previously running Ubuntu; these two cases are clearly marked below.

In all cases, if the system is not booting in UEFI mode, no special kernel module signing steps or key generation will happen.

If Secure Boot is disabled, MOK generation and enrollment still happens, as the user may later enable Secure Boot. They system should work properly if that is the case.

The user installs Ubuntu on a new system

The user steps through the installer. Early on, when preparing to install and only if the system requires third-party modules to work, the user is prompted for a system password that is clearly marked as being required after the install is complete, and while the system is being installed, a new MOK is automatically generated without further user interaction.

Third-party drivers or kernel modules required by the system will be automatically built when the package is installed, and the build process includes a signing step. The signing step automatically uses the MOK generated earlier to sign the module, such that it can be immediately loaded once the system is rebooted and the MOK is included in the system's trust database.

Once the installation is complete and the system is restarted, at first boot the user is presented with the MokManager program (part of the installed shim loader), as a set of text-mode panels that all the user to enroll the generated MOK. The user selects "Enroll MOK", is shown a fingerprint of the certificate to enroll, and is prompted to confirm the enrollment. Once confirmed, the new MOK will be entered in firmware and the user will be asked to reboot the system.

When the system reboots, third-party drivers signed by the MOK just enrolled will be loaded as necessary.

The user upgrades an UEFI-enabled Ubuntu system to a new release where the system requires third-party drivers

On upgrade, the shim and shim-signed packages are upgraded. The shim-signed package's post-install tasks proceeds to generate a new MOK, and prompts the user for a password that is clearly mentioned as being required once the upgrade process is completed and the system rebooted.

During the upgrade, the kernel packages and third-party modules are upgraded. Third-party modules are rebuilt for the new kernels and their post-build process proceeds to automatically sign them with the MOK.

After upgrade, the user is recommended to reboot their system.

On reboot, the user is presented with the MokManager program (part of the installed shim loader), as a set of text-mode panels that all the user to enroll the generated MOK. The user selects "Enroll MOK", is shown a fingerprint of the certificate to enroll, and is prompted to confirm the enrollment. The user is also presented with a prompt to re-enable Secure Boot validation (in the case it was found to be disabled); and MokManager again requires confirmation from the user. Once all steps are confirmed, shim validation is re-enabled, the new MOK will be entered in firmware and the user will be asked to reboot the system.

When the system reboots, third-party drivers signed by the MOK just enrolled will be loaded as necessary.

In all cases, once the system is running with UEFI Secure Boot enabled and a recent version of shim; the installation of any new DKMS module (third-party driver) will proceed to sign the built module with the MOK. This will happen without user interaction if a valid MOK key exists on the system and appears to already be enrolled.

If no MOK exists or the existing MOK is not enrolled, a new key will automatically created just before signing and the user will be prompted to enroll the key by providing a password which will be required upon reboot.

Semi-automated secure boot VM setup for testing

Bootloader signed with user key

This emulates a configuration where a user or enterprise is using its own keys in PK, KEK and DB and follows the procedures in http://jk.ozlabs.org/docs/sbkeysync-maintaing-uefi-key-databases/. This configuration allows the greatest flexibility in testing as we control PK and KEK, so we can update all aspects of secure boot as needed.

  1. Boot an OVMF virtual UEFI machine (see above)
  2. Install some packages:

    $ sudo apt-get install sbsigntool openssl grub-efi-amd64-signed
  3. Install the signed bootloader:

    $ sudo grub-install --uefi-secure-boot
  4. Reboot the VM and 'Boot from File' as above
  5. Download sb-setup from lp:qa-regression-testing/notes_testing/secure-boot/ to /tmp/sb-setup

  6. Enroll the user keys (not, output may vary):

    $ /tmp/sb-setup enroll
    Creating keystore...
      mkdir '/etc/secureboot/keys'
      mkdir '/etc/secureboot/keys/PK'
      mkdir '/etc/secureboot/keys/KEK'
      mkdir '/etc/secureboot/keys/db'
      mkdir '/etc/secureboot/keys/dbx'
    done
    
    Creating keys... done
    
    Generating key updates...
      using GUID=bffda19f-f76b-49a4-8bfc-556cb5165538
      create EFI_SIGNATURE_LIST
      create signed updates...
        test-cert.der.siglist.PK.signed
        test-cert.der.siglist.KEK.signed
        test-cert.der.siglist.db.signed
      done
    done
    
    Initializing keystore...
      adding to /etc/secureboot/keys/PK/
      adding to /etc/secureboot/keys/KEK/
      adding to /etc/secureboot/keys/db/
    done
    
    Filesystem keystore:
      /etc/secureboot/keys/db/test-cert.der.siglist.db.signed [2116 bytes]
      /etc/secureboot/keys/KEK/test-cert.der.siglist.KEK.signed [2116 bytes]
      /etc/secureboot/keys/PK/test-cert.der.siglist.PK.signed [2116 bytes]
    firmware keys:
      PK:
      KEK:
      db:
      dbx:
    filesystem keys:
      PK:
        /CN=test-key
         from /etc/secureboot/keys/PK/test-cert.der.siglist.PK.signed
      KEK:
        /CN=test-key
         from /etc/secureboot/keys/KEK/test-cert.der.siglist.KEK.signed
      db:
        /CN=test-key
         from /etc/secureboot/keys/db/test-cert.der.siglist.db.signed
      dbx:
    New keys in filesystem:
     /etc/secureboot/keys/db/test-cert.der.siglist.db.signed
     /etc/secureboot/keys/KEK/test-cert.der.siglist.KEK.signed
     /etc/secureboot/keys/PK/test-cert.der.siglist.PK.signed
    Commit to keystore? (y|N) y
    Filesystem keystore:
      /etc/secureboot/keys/db/test-cert.der.siglist.db.signed [2116 bytes]
      /etc/secureboot/keys/KEK/test-cert.der.siglist.KEK.signed [2116 bytes]
      /etc/secureboot/keys/PK/test-cert.der.siglist.PK.signed [2116 bytes]
    firmware keys:
      PK:
      KEK:
      db:
      dbx:
    filesystem keys:
      PK:
        /CN=test-key
         from /etc/secureboot/keys/PK/test-cert.der.siglist.PK.signed
      KEK:
        /CN=test-key
         from /etc/secureboot/keys/KEK/test-cert.der.siglist.KEK.signed
      db:
        /CN=test-key
         from /etc/secureboot/keys/db/test-cert.der.siglist.db.signed
      dbx:
    New keys in filesystem:
     /etc/secureboot/keys/db/test-cert.der.siglist.db.signed
     /etc/secureboot/keys/KEK/test-cert.der.siglist.KEK.signed
     /etc/secureboot/keys/PK/test-cert.der.siglist.PK.signed
    Inserting key update /etc/secureboot/keys/db/test-cert.der.siglist.db.signed into db
    Inserting key update /etc/secureboot/keys/KEK/test-cert.der.siglist.KEK.signed into KEK
    Inserting key update /etc/secureboot/keys/PK/test-cert.der.siglist.PK.signed into PK
    Signing '/boot/efi/EFI/ubuntu/grubx64.efi'
    warning: overwriting existing signature
  7. Reboot and verify secure boot is enabled:

     - Device Manager ->
       - Secure Boot Configuration ->
         - Verify 'Attempt Secure Boot' is selected and 'Secure Boot Mode' is in
           'Standard Mode' ('Custom Mode' is also ok)
         - Change 'Secure Boot Mode' to 'Custom Mode' by highlighting 'Standard
           Mode' and pressing 'Enter'
         - Select Custom Boot Options ->
           - PK Options ->
             - Verify 'Enroll PK' is grayed out. Delete PK should have '[ ]' (or
               possibly a GUID).
             - Press Esc
           - KEK Options ->
             - Delete KEK ->
               - Verify a GUID is listed
               - Press 'Esc', twice
           - DB Options
             - Delete signature ->
               - Verify a GUID is listed
               - Press 'Esc', twice
           - DBX Options
             - Delete signature ->
               - Verify no GUIDs are listed
               - Press 'Esc', twice
  8. Press 'Esc' until at the main EFI configure screen, then 'Boot from File' normally (notice now there is a grubx64.efi.bak listed-- this is the grubx64.efi as installed by 'sudo grub-install --uefi-secure-boot'. Ie, the one signed with Canonical's key)
  9. Verify the machine booted with secure boot (note, can also use sbsigdb from newer versions of sbsigntool if it is available):

    $ sudo apt-get install fwts
    $ sudo fwts uefidump - | grep Secure
    Name: SecureBoot.
      Value: 0x01 (Secure Boot Mode On).

In the above, a CA is setup in /etc/secureboot/key-material (private key: test-key.rsa, public pem: test-cert.pem, public der: test-cert.der). A keystore is created in /etc/secureboot/keys/ and signed updates (using the keys in /etc/secureboot/key-material) are created for PK, KEK and DB.

Shim bootloader signed with Microsoft key

This is the expected configuration for new machines with default hardware and has Microsoft's UEFI key in KEK and DB.

  • TODO

Bootloader signed with Canonical key

This emulates a configuration which supports machines with Canonical's key in KEK and DB.

  • TODO

UEFI/SecureBoot/Testing (last edited 2022-10-06 15:10:39 by dannf)