From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp1.migadu.com ([2001:41d0:303:e224::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms8.migadu.com with LMTPS id iKGgEqMmtmX1aQEA62LTzQ:P1 (envelope-from ) for ; Sun, 28 Jan 2024 11:04:19 +0100 Received: from aspmx1.migadu.com ([2001:41d0:303:e224::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp1.migadu.com with LMTPS id iKGgEqMmtmX1aQEA62LTzQ (envelope-from ) for ; Sun, 28 Jan 2024 11:04:19 +0100 X-Envelope-To: larch@yhetil.org Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=lunabee.space header.s=purelymail2 header.b=kUhKC5Nf; dkim=fail ("headers rsa verify failed") header.d=purelymail.com header.s=purelymail2 header.b=EGDXT+2a; dmarc=pass (policy=none) header.from=gnu.org; spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org" ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1706436259; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding:resent-cc: resent-from:resent-sender:resent-message-id:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=cFohuDBkhiNdLklaV4nr5f0PwKZhNNOr/1FgOTdQ/0g=; b=lRCS5aWrWUbqysdNz52Gp/ge8N8om/KM1SoZxxuOCnQYzIRYq9G6dfn5OZuEEcMRPXHMyR SctaEK2nB0KdD3L0rKfh/a/vrGzC2Y9KPwch1kj7SUYBurvjE+GbNZorZ8rNYKC4dpoeV0 t1L7DrOhnE34/nxDInYt5+XyXujAnP2lgfOT9R5LyrIeGjnXgHXf2Xkrd4PRZGazkxDgXm bT1x8Qu3/6pvRr9EsTYSdUCd8vpg37OasiCu+web7xfX1m/qo1hZt6zp7j3T2NXUhSt0Q1 2lj7MsdOrqZ/qyKUW2h8x5q8tOwW/U4q+EQwkH6Yeed+iKEoFT+HJ3uAVxG2hA== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=lunabee.space header.s=purelymail2 header.b=kUhKC5Nf; dkim=fail ("headers rsa verify failed") header.d=purelymail.com header.s=purelymail2 header.b=EGDXT+2a; dmarc=pass (policy=none) header.from=gnu.org; spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org" ARC-Seal: i=1; s=key1; d=yhetil.org; t=1706436259; a=rsa-sha256; cv=none; b=s9F+0OZPwJQHw0spdP52I36Wh2hpFhIutM4kuUtQ3pFf0bK4WboTSVqrib+G5O/qEwt2oV uIxNG5l9sZebVfHiQtBJvqFB2GF7VXL/vO5gyKvN6Q7whr5weuf6Ndxgs0Yaahw7W6xdxB HI37le43zAJM5/1FQ2P5zUNdLdrh6aBKx932NgDJCqcxhCKLZHCBvi28iVwYt42Qoinaam as/ahoTxGbq2zWiS56TeEPErengU78UKzKzGyXQEahPUvWrUfFn6kMyVjydLMPjWjNQO8R wkUQPV0XDCcZOIownkHM6wPUcdsAYiyVWt/AWWiSSbe+miUGfTcHRAduM9t9Vw== Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id CEE101F05C for ; Sun, 28 Jan 2024 11:04:18 +0100 (CET) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rU218-0007p9-CE; Sun, 28 Jan 2024 05:03:59 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rU215-0007oV-5o for guix-patches@gnu.org; Sun, 28 Jan 2024 05:03:56 -0500 Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rU214-0006mc-Tc for guix-patches@gnu.org; Sun, 28 Jan 2024 05:03:54 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rU21C-00040U-Ff for guix-patches@gnu.org; Sun, 28 Jan 2024 05:04:02 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#68524] [PATCH v2 2/2] gnu: bootloaders: Add uefi-uki-bootloader. Resent-From: Lilah Tascheter Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Sun, 28 Jan 2024 10:04:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 68524 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 68524@debbugs.gnu.org Cc: vagrant@debian.org, Lilah Tascheter , herman@rimm.ee, efraim@flashner.co.il Received: via spool by 68524-submit@debbugs.gnu.org id=B68524.170643621815338 (code B ref 68524); Sun, 28 Jan 2024 10:04:02 +0000 Received: (at 68524) by debbugs.gnu.org; 28 Jan 2024 10:03:38 +0000 Received: from localhost ([127.0.0.1]:56628 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rU20n-0003zJ-KI for submit@debbugs.gnu.org; Sun, 28 Jan 2024 05:03:38 -0500 Received: from sendmail.purelymail.com ([34.202.193.197]:38470) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rU20f-0003yP-TG for 68524@debbugs.gnu.org; Sun, 28 Jan 2024 05:03:33 -0500 DKIM-Signature: a=rsa-sha256; b=kUhKC5Nf+fJ6l/lOCHlQqpDckhrg+zkmeLugvtEZg3z4EcXPbSKKQD1qbAiKZQEN36CmA91VA/i+q3/eB6L52x/fqdgV31bCAq8JOcMhoMq5bgNVHXgmahsUGYbqQCRswo7hR3tGqFrMQcJYPYvjYU+ln7Q3pPvQ/JnS2wHqr4ts8HfSUMC9UF4Cy6V464PQBkzqu/YMZ9I5y08cFjxwlBNUXdFB6S5we7JxdAqDJtxqdmcn4H3mbqofXj5261Yz/9w9GF+q+TqlIkp1WvSySe9Lr7tOjTtpOnJEdobdIIIDAjHGpzIr/yRa+qovTxa9OX61CqB3W9m1X4ZNbFGCrQ==; s=purelymail2; d=lunabee.space; v=1; bh=us+EFDXms9fDRtQBeGDoDSsswTmzdHRQy5lzdw8+3gY=; h=Received:From:To:Subject; DKIM-Signature: a=rsa-sha256; b=EGDXT+2aVT7KPMrNo+7HP+Wjppoit2QVachhvPmjPQAXOgTmCvNjD+sUyTvCTeriHQ2MQCBEM+9aGPQA/BUE1XvQnrYyIvfca15o1iutcOZa1Wcv8TDX2RvPb1gXHB+5Y9qqOT3w2rJ9S80oTXi1bZnbC4z3cHAl1Nf5dJ2lRwL/fYzYxJN0cpdNpmPU3ZwuYGvqG7FPRjebgA+rDlFmI+U8rlLWs4X3r8NPUicRvRWY2vlD4+F+14fj8i9aKn5tdtmSMIF/NDS4DcQeZAjZB5PFrCIXVeNpUvcpwnp1geP50o01NGytpcfPVjltqYcYVgrJ3gFuX6KR7fVTVB9wjw==; s=purelymail2; d=purelymail.com; v=1; bh=us+EFDXms9fDRtQBeGDoDSsswTmzdHRQy5lzdw8+3gY=; h=Feedback-ID:Received:From:To:Subject; Feedback-ID: 8937:2070:null:purelymail X-Pm-Original-To: 68524@debbugs.gnu.org Received: by smtp.purelymail.com (Purelymail SMTP) with ESMTPSA id -1308848491; (version=TLSv1.3 cipher=TLS_AES_256_GCM_SHA384); Sun, 28 Jan 2024 10:03:15 +0000 (UTC) Date: Sun, 28 Jan 2024 03:51:41 -0600 Message-ID: <22f2967a552454baade056c60a37c02e36a048a5.1706435500.git.lilah@lunabee.space> In-Reply-To: References: MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable X-MIME-Autoconverted: from 8bit to quoted-printable by Purelymail X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , From: Lilah Tascheter via Guix-patches Reply-To: Lilah Tascheter Errors-To: guix-patches-bounces+larch=yhetil.org@gnu.org Sender: guix-patches-bounces+larch=yhetil.org@gnu.org X-Migadu-Flow: FLOW_IN X-Migadu-Country: US X-Migadu-Spam-Score: -7.16 X-Spam-Score: -7.16 X-Migadu-Queue-Id: CEE101F05C X-Migadu-Scanner: mx12.migadu.com X-TUID: jryz0YvC4Oxq * doc/guix.texi (Bootloader Configuration)[bootloader,targets]: Document uefi-uki-bootloader and uefi-uki-signed-bootloader. (Keyboard Layout, Networking, and Partitioning)[Disk Partitioning]: Note use of uefi-uki-bootloader and uefi-uki-signed-bootloader. * gnu/bootloader/uki.scm: New file. * gnu/local.mk (GNU_SYSTEM_MODULES): Add bootloader/uki.scm. Change-Id: I2097da9f3dd35137b3419f6d0545de26d53cb6da --- doc/guix.texi | 45 ++++++++++---- gnu/bootloader/uki.scm | 129 +++++++++++++++++++++++++++++++++++++++++ gnu/local.mk | 1 + 3 files changed, 163 insertions(+), 12 deletions(-) create mode 100644 gnu/bootloader/uki.scm diff --git a/doc/guix.texi b/doc/guix.texi index c458befb76..30fd5d022b 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -2723,12 +2723,13 @@ Keyboard Layout and Networking and Partitioning for @command{cryptsetup luksFormat}. You can check which key derivation function is being used by a device by running @command{cryptsetup luksDump @var{device}}, and looking for the PBKDF field of your -keyslots. +keyslots. UEFI stub bootloaders, such as @code{uefi-uki-bootloader}, can +however use the default, more secure key derivation function. @end quotation =20 -Assuming you want to store the root partition on @file{/dev/sda2}, the -command sequence to format it as a LUKS2 partition would be along these -lines: +Assuming you want to store the root partition on @file{/dev/sda2} and use = GRUB +as your bootloader, the command sequence to format it as a LUKS2 partition= would +be along these lines: =20 @example cryptsetup luksFormat --type luks2 --pbkdf pbkdf2 /dev/sda2 @@ -41136,8 +41137,9 @@ Bootloader Configuration The bootloader to use, as a @code{bootloader} object. For now @code{grub-bootloader}, @code{grub-efi-bootloader}, @code{grub-efi-removable-bootloader}, @code{grub-efi-netboot-bootloader}, -@code{grub-efi-netboot-removable-bootloader}, @code{extlinux-bootloader} -and @code{u-boot-bootloader} are supported. +@code{grub-efi-netboot-removable-bootloader}, @code{extlinux-bootloader}, +@code{u-boot-bootloader}, @code{uefi-uki-bootloader}, and +@code{uefi-uki-signed-bootloader} are supported. =20 @cindex ARM, bootloaders @cindex AArch64, bootloaders @@ -41244,6 +41246,25 @@ Bootloader Configuration unbootable. @end quotation =20 +@vindex uefi-uki-bootloader +@code{uefi-uki-bootloader} boots a linux kernel directly through UEFI, wit= hout +an intermediary like GRUB. The main practical advantage of this is allowin= g +root/store encryption without an extra GRUB password entry and slow decryp= tion +step. + +@vindex uefi-uki-signed-bootloader +@code{uefi-uki-signed-bootloader} is like @code{uefi-uki-bootloader}, exce= pt +that it is a procedure that returns a bootloader compatible with UEFI secu= re +boot. You must provide it with two paths: an out-of-store secure boot db +certificate (in PEM format), and out-of-store db key, in that order. + +@quotation Warning +When using @code{uefi-uki-bootloader} or @code{uefi-uki-signed-bootloader}= , +@emph{do not} turn off your computer if a system reconfigure failed at +installing the bootloader. Until bootloader installation succeeds, your s= ystem +is in an unbootable state. +@end quotation + @item @code{targets} This is a list of strings denoting the targets onto which to install the bootloader. @@ -41252,12 +41273,12 @@ Bootloader Configuration For @code{grub-bootloader}, for example, they should be device names understood by the bootloader @command{installer} command, such as @code{/dev/sda} or @code{(hd0)} (@pxref{Invoking grub-install,,, grub, -GNU GRUB Manual}). For @code{grub-efi-bootloader} and -@code{grub-efi-removable-bootloader} they should be mount -points of the EFI file system, usually @file{/boot/efi}. For -@code{grub-efi-netboot-bootloader}, @code{targets} should be the mount -points corresponding to TFTP root directories served by your TFTP -server. +GNU GRUB Manual}). For @code{grub-efi-bootloader}, +@code{grub-efi-removable-bootloader}, @code{uefi-uki-bootloader}, and +@code{uefi-uki-signed-bootloader}, they should be mount points of the EFI = file +system, usually @file{/boot/efi}. For @code{grub-efi-netboot-bootloader}, +@code{targets} should be the mount points corresponding to TFTP root direc= tories +served by your TFTP server. =20 @item @code{menu-entries} (default: @code{'()}) A possibly empty list of @code{menu-entry} objects (see below), denoting diff --git a/gnu/bootloader/uki.scm b/gnu/bootloader/uki.scm new file mode 100644 index 0000000000..0ef62295d6 --- /dev/null +++ b/gnu/bootloader/uki.scm @@ -0,0 +1,129 @@ +;;; GNU Guix --- Functional package management for GNU +;;; Copyright =C2=A9 2024 Lilah Tascheter +;;; +;;; This file is part of GNU Guix. +;;; +;;; GNU Guix is free software; you can redistribute it and/or modify it +;;; under the terms of the GNU General Public License as published by +;;; the Free Software Foundation; either version 3 of the License, or (at +;;; your option) any later version. +;;; +;;; GNU Guix is distributed in the hope that it will be useful, but +;;; WITHOUT ANY WARRANTY; without even the implied warranty of +;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;;; GNU General Public License for more details. +;;; +;;; You should have received a copy of the GNU General Public License +;;; along with GNU Guix. If not, see . + +(define-module (gnu bootloader uki) + #:use-module (gnu bootloader) + #:use-module (gnu packages bootloaders) + #:use-module (gnu packages efi) + #:use-module (gnu packages linux) + #:use-module (guix gexp) + #:use-module (guix modules) + #:use-module (srfi srfi-1) + #:export (uefi-uki-bootloader uefi-uki-signed-bootloader)) + +;; config generator makes script creating uki images +;; install runs script +;; install device is path to uefi dir +(define vendor "Guix") +(define script-loc "/boot/install-uki.scm") + +(define* (uefi-uki-configuration-file #:optional cert privkey) + (lambda* (config entries #:key (old-entries '()) #:allow-other-keys) + + (define (menu-entry->args e) + (let* ((boot (bootloader-configuration-bootloader config)) + (stub (bootloader-package boot))) + #~(list "--os-release" #$(menu-entry-label e) + "--linux" #$(menu-entry-linux e) "--initrd" #$(menu-entry-init= rd e) + "--cmdline" (string-join (list #$@(menu-entry-linux-arguments = e))) + "--stub" #$(file-append stub "/libexec/" (systemd-stub-name)) + #$@(if cert #~("--secureboot-certificate" #$cert) #~()) + #$@(if privkey #~("--secureboot-private-key" #$privkey) #~()))= )) + + (define (enum-filenames . args) ; same args as iota + (map (lambda (n) (string-append (number->string n) ".efi")) + (apply iota (map length args)))) + + (program-file "install-uki" + (with-imported-modules (source-module-closure '((guix build syscalls= ) + (guix build utils))) + #~(let* ((target (cadr (command-line))) + (vendir (string-append target "/EFI/" #$vendor)) + (schema (string-append vendir "/boot.mgr")) + (findmnt #$(file-append util-linux "/bin/findmnt")) + (efibootmgr #$(file-append efibootmgr "/sbin/efibootmgr")= )) + (use-modules (guix build syscalls) (guix build utils) + (ice-9 popen) (ice-9 textual-ports)) + + (define (out name) (string-append vendir "/" name)) + (define disk + (call-with-port + (open-pipe* OPEN_READ findmnt "-fnro" "SOURCE" "-T" target= ) + (lambda (port) (get-line port)))) ; only 1 line: the devic= e + + ;; delete all boot entries and files we control + (when (file-exists? schema) + (call-with-input-file schema + (lambda (port) + (for-each (lambda (l) + (unless (string-null? l) + (system* efibootmgr "-B" "-L" l "-q"))) + (string-split (get-string-all port) #\lf))))) + (when (directory-exists? vendir) (delete-file-recursively vend= ir)) + (mkdir-p vendir) + + (define (install port boot? oos) + (lambda (args label name) + (let ((minbytes (* 2 (stat:size (stat #$script-loc))))) + (put-string port label) + (put-char port #\lf) + (force-output port) ; make sure space is alloc'd + (apply invoke #$(file-append ukify "/bin/ukify") + "build" "-o" (out name) args) + ;; make sure we have enough space for next install-uki.s= cm + (when (and oos (< (free-disk-space vendir) minbytes)) (o= os)) + (invoke efibootmgr (if boot? "-c" "-C") "-L" label "-d" = disk + "-l" (string-append "\\EFI\\" #$vendor "\\" name) "-q"= )))) + + (call-with-output-file schema + (lambda (port) ; prioritize latest UKIs in limited ESP space + (for-each (install port #t #f) + (list #$@(map-in-order menu-entry->args entries)) + (list #$@(map-in-order menu-entry-label entries)) + (list #$@(enum-filenames entries))) + (for-each ; old-entries can fail (out of space) we don't c= are + (lambda (args label name) + (define (cleanup . _) ; do exit early if out of space = tho + (when (file-exists? (out name)) (delete-file (out na= me))) + (exit)) + (with-exception-handler cleanup + (lambda _ ((install port #f cleanup) args label name= )))) + (list #$@(map-in-order menu-entry->args old-entries)) + (list #$@(map-in-order menu-entry-label old-entries)) + (list #$@(enum-filenames old-entries entries)))))))))) + +(define install-uefi-uki + #~(lambda (bootloader target mount-point) + (invoke (string-append mount-point #$script-loc) + (string-append mount-point target)))) + +(define* (make-uefi-uki-bootloader #:optional cert privkey) + (bootloader + (name 'uefi-uki) + (package systemd-stub) + (installer install-uefi-uki) + (disk-image-installer #f) + (configuration-file script-loc) + (configuration-file-generator (uefi-uki-configuration-file cert privke= y)))) + +;; IMPORTANT NOTE: if bootloader install fails, do not turn off your compu= ter! until +;; install succeeds, your system is unbootable. +(define uefi-uki-bootloader (make-uefi-uki-bootloader)) +;; use ukify genkey to generate cert and privkey. DO NOT include in store. +(define (uefi-uki-signed-bootloader cert privkey) + (make-uefi-uki-bootloader cert privkey)) diff --git a/gnu/local.mk b/gnu/local.mk index ab63bd5881..0a15251ddf 100644 --- a/gnu/local.mk +++ b/gnu/local.mk @@ -90,6 +90,7 @@ GNU_SYSTEM_MODULES =3D=09=09=09=09\ %D%/bootloader/extlinux.scm \ %D%/bootloader/u-boot.scm \ %D%/bootloader/depthcharge.scm \ + %D%/bootloader/uki.scm \ %D%/ci.scm=09=09=09=09=09\ %D%/compression.scm=09=09=09=09\ %D%/home.scm=09=09=09=09=09\ --=20 2.41.0