| commit | 1d3f684f408d25f89a362d2387773cd650d50039 | [log] [tgz] |
|---|---|---|
| author | Nicholas Bishop <nicholasbishop@google.com> | Wed Oct 05 18:40:18 2022 |
| committer | Chromeos LUCI <chromeos-scoped@luci-project-accounts.iam.gserviceaccount.com> | Thu Oct 06 23:13:24 2022 |
| tree | 475dfb80148cb0fa8fe5ff6c3283009623dc3336 | |
| parent | 10bf4b503d61b9d95f7c634747f0536291727863 [diff] |
Drop use_test_key and embedded pubkey data The public key is read from the `.vbpubk` section of the binary, so the key embedded in crdyboot with `include_bytes!` is no longer used. Drop it, and all the code associated with `use_test_key`. When building via xtask, the default test key is now always used. In a signed release build, the appropriate public key will be added by scripts outside this repo. BUG=b:250621098 TEST=cargo xtask check && cargo xtask update-disk TEST=cargo xtask qemu --secure-boot TEST=cargo xtask qemu --secure-boot --ia32 Change-Id: Ibc1dd744090bf38d08828b5ff30895464aba3e3e Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crdyboot/+/3936783 Tested-by: Nicholas Bishop <nicholasbishop@google.com> Reviewed-by: Jeffery Miller <jefferymiller@google.com> Auto-Submit: Nicholas Bishop <nicholasbishop@google.com> Commit-Queue: Nicholas Bishop <nicholasbishop@google.com>
Pronounced CUR-dee-boot.
Crdyboot is a UEFI bootloader for ChromeOS Flex. It is not yet in use.
Crdyboot acts as a bridge between UEFI firmware and the Chromebook style of booting. It uses vboot to select and validate an appropriate kernel partition, then launches that kernel using the Linux EFI stub.
The project is organized as a Rust workspace containing several packages:
vboot package is a thin wrapper around the C vboot library. It also exposes a DiskIo trait through which it can read and write blocks to a disk. This package is no_std, and can be built for both the UEFI targets and the host target. Building for the host allows tests to be run on the host.libcrdy package is where most of the bootloader is implemented. It implements the DiskIo trait using the uefi crate, and uses the vboot package to load and verify a kernel. It then boots into that kernel using the EFI stub. This package is also no_std and can also be built for both UEFI targets and the host target for testing purposes.crdyboot package provides the actual bootloader executable. It contains the embedded key used to verify the kernel data, the SBAT data used for revocation, and sets up logging and allocation. Then it uses libcrdy to load, verify, and run the kernel.xtask package contains a host executable that provides the various xtask commands shown below. It's like a fancy Makefile for running various dev and test operations.enroller subdirectory contains a small UEFI application that enrolls a test key in the PK, KEK, and db variables. This is used to set up the test VM, and can also be used on real hardware (see the “Testing on real hardware” section).Install Rust: https://rustup.rs
Install tools used for image signing and running in a VM:
sudo apt install efitools gdisk ovmf ovmf-ia32 qemu-system-x86 sbsigntool
After installing qemu, add your user to the kvm group. You will need to log out and back in for this to take effect:
sudo adduser ${USER} kvm
Before running any other commands in the repository, run this setup command:
cargo xtask setup <reven-verity-image-path>
This will copy the reven image to a local directory and run various setup commands. The image must have rootfs verification enabled (i.e. build_image must be run without -r or --no-enable-rootfs-verification). Any kind of image (base, dev, or test) is allowed.
To check formatting, lint, test, build crdyboot, and install to the image:
cargo xtask check
To just build crdyboot and install to the image (a quicker subset of check):
cargo xtask build
Then run it in QEMU:
cargo xtask qemu [--ia32] [--secure-boot]
Some additional build options can be set in crdyboot.toml (in the root of the repo). This file will be created automatically if it doesn't already exist by copying xtask/default.toml. The defaults are appropriate for development. In a release build, verbose logging should be turned off.
To test secure boot with real hardware you will need to enroll custom keys. Write workspace/enroller.bin to a USB, and write workspace/disk.bin to a second USB, e.g. using writedisk.
Boot the DUT and enter the boot setup. Find the secure boot settings and change it to setup mode. (The details will vary from one vendor to another.)
Plug in the enroller USB and reboot. Use the boot menu to select the USB and wait for it to complete.
Unplug the enroller USB and plug in the cloudready USB, then reboot. Use the boot menu to select the USB.
An older pure-Rust version can be found in the pure-rust-20210729 branch. Since then we have switched to building the C vboot library and loading/verifying the kernel through that library.