From 051f116b718929131f3b97055f688b38fec9f47b Mon Sep 17 00:00:00 2001 From: Julian Stecklina Date: Thu, 24 Nov 2022 11:19:30 +0100 Subject: [PATCH] doc: added small README --- README.md | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 95eb8f1..c8770ae 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,26 @@ +# Lanzaboote +![GitHub branch checks state](https://img.shields.io/github/checks-status/blitz/lanzaboote/master) +[![made-with-rust](https://img.shields.io/badge/Made%20with-Rust-1f425f.svg)](https://www.rust-lang.org/) +[![GitHub license](https://img.shields.io/github/license/Naereen/StrapDown.js.svg)](https://github.com/Naereen/StrapDown.js/blob/master/LICENSE) -# UEFI Helpers +🚧🚧🚧 **This is not working yet. Come back later.*** 🚧🚧🚧 -How to boot a VM: https://rust-osdev.github.io/uefi-rs/HEAD/tutorial/vm.html +This repository contains experimental tooling for Secure Boot on +[NixOS](https://nixos.org/). -``` -nix build --builders "" && cp -f result/bin/lanzaboote.efi esp/EFI/Linux/lanzaboote.efi && qemu-uefi -drive format=raw,file=fat:rw:esp -``` +## lanzatool + +`lanzatool` is a Linux command line application that takes a +[bootspec](https://github.com/NixOS/rfcs/pull/125) document and +installs the boot files into the UEFI +[ESP](https://en.wikipedia.org/wiki/EFI_system_partition). + +## lanzaboote + +`lanzaboote` is a UEFI application that is started by systemd-boot (or +any other EFI boot loader) and loads a Linux kernel and initrd without +breaking the Secure Boot chain of trust. + +The information what kernel with what command line and initrd to boot +is embedded into the `lanzaboote` by `lanzatool`.