Heads is a configuration for laptops and servers that tries to bring more security to commodity hardware. Among its goals are:

• Use free software on the boot path
• Move the root of trust into hardware (or at least the ROM bootblock)
• Measure and attest to the state of the firmware
• Measure and verify all filesystems

NOTE: It is a work in progress and not yet ready for non-technical users. If you're interested in contributing, please get in touch. Installation requires disassembly of your laptop or server, external SPI flash programmers, possible risk of destruction and significant frustration.

More information is available in the 33C3 presentation of building "Slightly more secure systems".

The doc/ directory contains technical reference documentation for the Heads codebase. Start here:

For user-facing documentation and guides, see Heads-wiki.

We welcome contributions to the Heads project! Before contributing, please read our Contributing Guidelines for information on how to get started, submit issues, and propose changes.

Heads builds inside a versioned Docker image. The supported and tested workflow uses the provided Docker wrappers — no host-side QEMU or swtpm installation is needed.

Quick start (requires Docker CE):

./docker_repro.sh make BOARD=x230-hotp-maximized
./docker_repro.sh make BOARD=qemu-coreboot-fbwhiptail-tpm2 run

No hardware required for testing — Docker provides the full build stack and QEMU runtime with software TPM (swtpm) and the bundled canokey-qemu virtual OpenPGP smartcard. Build and test entirely in software before flashing real hardware.

Build targets are the directory names under boards/. For the current set of tested and maintained targets, see doc/BOARDS_AND_TESTERS.md.

For full details — wrapper scripts, Nix local dev, reproducibility verification, and maintainer workflow — see doc/docker.md.

For CI cache/workspace behavior and the CircleCI job graph, see doc/circleci.md.

For QEMU board testing see doc/qemu.md.

For troubleshooting build issues see doc/faq.md and doc/build-freshness.md.

In order to build reproducible firmware images, Heads builds a specific version of gcc and uses it to compile the Linux kernel and various tools that go into the initrd. Unfortunately this means the first step is a little slow since it will clone the musl-cross-make tree and build gcc...

Once that is done, the top level Makefile will handle most of the remaining details -- it downloads the various packages, verifies the hashes, applies Heads specific patches, configures and builds them with the cross compiler, and then copies the necessary parts into the initrd directory.

There are still dependencies on the build system's coreutils in /bin and /usr/bin/, but any problems should be detectable if you end up with a different hash than the official builds.

Heads builds a curated set of packages (from modules/). Key components enabled by most board configs include:

• musl-cross-make — cross-compiler toolchain
• coreboot — minimal firmware replacing vendor BIOS/UEFI
• Linux — minimal kernel payload (no built-in initrd; boots with external initrd such as initrd.cpio.xz)
• busybox — core utilities
• kexec — Linux kernel executor (loads kernels from boot partition, USB, network)
• tpmtotp — TPM-based TOTP/HOTP one-time password generator
• cryptsetup — LUKS disk encryption

The full build also includes: lvm2, tpm2-tools, flashrom/flashprog, dropbear (SSH), fbwhiptail (GUI), qrencode, and many others. See individual modules/* files and board configs for the complete picture.

We also recommend installing Qubes OS, although there Heads can kexec into any Linux or multiboot kernel.

• Building coreboot's cross compilers can take a while. Luckily this is only done once.
• Builds are finally reproducible! The reproduciblebuilds tag tracks any regressions.
• Current tested and maintained boards are tracked in doc/BOARDS_AND_TESTERS.md. Board targets themselves live under boards/.
• Xen does not work in QEMU. Signing, HOTP, and TOTP do work; see below.
• Blob requirements are board- or board-family-specific. Check the relevant documentation under blobs/ for the target you are building.
• Purism boards use Purism-managed coreboot blob paths from the Purism fork (for example 3rdparty/purism-blobs/... via CONFIG_IFD_BIN_PATH and CONFIG_ME_BIN_PATH in config/coreboot-librem_*.config). Heads should not maintain those vendor blob payloads. Runtime firmware notes for Librem blob jail are in blobs/librem_jail/README.
• Lenovo xx20 boards such as X220 and X230 use the shared xx20 blob flow documented in blobs/xx20/readme.md. X220-specific notes are in blobs/x220/readme.md.
• Other boards can source blobs from board-family directories under blobs/ (for example xx20/xx30/xx80, t420, t440p, w541) or from fork-specific paths configured in coreboot configs (for example Dasharo boards using 3rdparty/dasharo-blobs/...). Vendor blob payloads remain maintained by their upstream vendors/forks.
• T480 and T480s blob requirements are documented in blobs/xx80/README.md. Other families have their own docs under blobs/, for example t420/, t440p/, and w541/.

OS booting can be tested in QEMU using a software TPM. HOTP can be tested by forwarding a USB token from the host to the guest.

For more information and setup instructions, refer to the qemu documentation.

The coreboot console messages are stored in the CBMEM region and can be read by the Linux payload with the cbmem --console | less command. There is lots of interesting data about the state of the system.