A minimal Linux that runs as a coreboot or LinuxBoot ROM payload to provide a secure, flexible boot environment for laptops, workstations and servers.
Go to file
Thierry Laurion f6232aa70f
Change disk encryption -> LUKS Disk Key and other relative/relative verbiage, remove irrelevant DEBUG trace under kexec-unseal-key
TODO:
- $(pcrs) call sometimes fail in DEBUG call, outputting too many chars to be inserted in kmesg. Call removed here since redundant (PCR6 already extended with LUKS header)
- Notes added for TPM2 simplification over TPM1 in code as TODO

Signed-off-by: Thierry Laurion <insurgo@riseup.net>
2024-04-11 14:44:13 -04:00
.circleci CircleCI: save_cache depends on librem_14 instead of nitropad-nv41 (so more boards can be built reusing cache and where nv41 will be rebuilt if coreboot level cache was not saved) 2024-03-25 16:40:21 -04:00
.github Create FUNDING.yml 2023-11-01 10:48:34 -04:00
bin bin/fetch_coreboot_crossgcc_archive.sh: ln -s again if link exists 2024-01-10 13:26:55 -05:00
blobs blobs/xx20/download_parse_me.sh: cleanup and don't continue if hash is good 2024-01-04 14:21:13 -05:00
boards Move boards/UNTESTED_* boards to untested_boards/UNMAINTAINED_*, remove them from CircleCI, add Makefile helper and document untested_boards/README.md 2024-03-25 16:05:57 -04:00
branding/Heads Adapt NV41/NS50 changes, unify bootsplash file usage for branding 2023-11-20 09:40:52 -05:00
build porting Makefile to use a modular build system for each package 2016-08-02 19:25:47 -04:00
config linux configs: align with purism; remove TMPFS, add sysctl requirements 2024-04-01 16:15:16 -04:00
initrd Change disk encryption -> LUKS Disk Key and other relative/relative verbiage, remove irrelevant DEBUG trace under kexec-unseal-key 2024-04-11 14:44:13 -04:00
install ignore everything in install/ 2018-02-05 16:04:23 -05:00
modules modules/coreboot CircleCI: adapt to coreboot version bumps 2024-03-25 15:15:52 -04:00
packages ignore fetched files 2016-08-02 21:24:15 -04:00
patches patches/coreboot-4.22.01/0001-x230-fhd-variant.patch: adapt patch for Makefile.inc (Makefile.mk doesn't exist under 4.22) 2024-03-25 15:15:58 -04:00
targets all scripts: replace TRACE manual strings with dynamic tracing by bash debug 2024-02-01 15:48:27 -05:00
unmaintained_boards Move boards/UNTESTED_* boards to untested_boards/UNMAINTAINED_*, remove them from CircleCI, add Makefile helper and document untested_boards/README.md 2024-03-25 16:05:57 -04:00
.gitattributes Add overrides for Makefile syntax highlighting 2023-01-18 11:51:38 -05:00
.gitignore librem_11: Add loadkeys (from kbd), optionally enabled 2023-09-29 15:29:19 -04:00
.gitlab-ci.yml.deprecated Merge pull request #867 from Tonux599/kgpe-d16_411_measured-boot 2020-12-02 18:23:55 -05:00
COPYING Add GPL license (issue #115) 2017-02-26 10:53:11 -05:00
FAQ.md Change disk encryption -> LUKS Disk Key and other relative/relative verbiage, remove irrelevant DEBUG trace under kexec-unseal-key 2024-04-11 14:44:13 -04:00
Makefile Makefile: add real.gitclean target which calls 'git clean -fxd' 2024-04-11 14:39:11 -04:00
README.md qemu: Deduplicate Qemu targets/documentation, extract from boards 2023-12-18 16:49:10 -05:00

Heads booting on an x230

Heads: the other side of TAILS

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

Flashing Heads into the boot ROM

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".

Documentation

Please refer to Heads-wiki for your Heads' documentation needs.

Building heads

make BOARD=board_name where board_name is the name of the board directory under ./boards directory.

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.

The various components that are downloaded are in the ./modules directory and include:

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

Notes:

  • 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.
  • Currently only tested in QEMU, the Thinkpad x230, Librem series and the Chell Chromebook. ** Xen does not work in QEMU. Signing, HOTP, and TOTP do work; see below.
  • Building for the Lenovo X220 requires binary blobs to be placed in the blobs/x220/ folder. See the readme.md file in that folder
  • Building for the Librem 13 v2/v3 or Librem 15 v3/v4 requires binary blobs to be placed in the blobs/librem_skl folder. See the readme.md file in that folder

QEMU:

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.

coreboot console messages

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.