From 53c368d71ba43da7414ac86c58291a11da05ba84 Mon Sep 17 00:00:00 2001 From: Gerd Hoffmann Date: Mon, 16 Jan 2023 18:58:21 +0100 Subject: [PATCH 1/2] bootctl: add kernel-identity command The command takes a kernel as argument and checks what kind of kernel the image is. Returns one of uki, pe or unknown. --- man/bootctl.xml | 13 +++++ meson.build | 2 + src/boot/bootctl-uki.c | 110 +++++++++++++++++++++++++++++++++++++++++ src/boot/bootctl-uki.h | 3 ++ src/boot/bootctl.c | 4 ++ 5 files changed, 132 insertions(+) create mode 100644 src/boot/bootctl-uki.c create mode 100644 src/boot/bootctl-uki.h diff --git a/man/bootctl.xml b/man/bootctl.xml index c9edf77b373..2479d5fcd6b 100644 --- a/man/bootctl.xml +++ b/man/bootctl.xml @@ -217,6 +217,19 @@ + + <command>kernel</command> Commands + + + + kernel + + Takes a kernel image as argument. Checks what kind of kernel the image is. Returns + one of uki, pe or unknown. + + + + Options The following options are understood: diff --git a/meson.build b/meson.build index 64f2e00be5f..5d6ab2a7bdf 100644 --- a/meson.build +++ b/meson.build @@ -2622,6 +2622,8 @@ if conf.get('HAVE_BLKID') == 1 and conf.get('HAVE_GNU_EFI') == 1 'src/boot/bootctl-status.h', 'src/boot/bootctl-systemd-efi-options.c', 'src/boot/bootctl-systemd-efi-options.h', + 'src/boot/bootctl-uki.c', + 'src/boot/bootctl-uki.h', 'src/boot/bootctl-util.c', 'src/boot/bootctl-util.h'], include_directories : includes, diff --git a/src/boot/bootctl-uki.c b/src/boot/bootctl-uki.c new file mode 100644 index 00000000000..1a439afaae8 --- /dev/null +++ b/src/boot/bootctl-uki.c @@ -0,0 +1,110 @@ +/* SPDX-License-Identifier: LGPL-2.1-or-later */ + +#include "bootctl.h" +#include "bootctl-uki.h" +#include "fd-util.h" +#include "parse-util.h" +#include "pe-header.h" + +#define MAX_SECTIONS 96 + +static const uint8_t dos_file_magic[2] = "MZ"; +static const uint8_t pe_file_magic[4] = "PE\0\0"; + +static const uint8_t name_osrel[8] = ".osrel"; +static const uint8_t name_linux[8] = ".linux"; +static const uint8_t name_initrd[8] = ".initrd"; + +static int pe_sections(FILE *uki, struct PeSectionHeader **ret, size_t *ret_n) { + _cleanup_free_ struct PeSectionHeader *sections = NULL; + struct DosFileHeader dos; + struct PeHeader pe; + size_t scount; + uint64_t soff, items; + int rc; + + items = fread(&dos, 1, sizeof(dos), uki); + if (items != sizeof(dos)) + return log_error_errno(SYNTHETIC_ERRNO(EIO), "DOS header read error"); + if (memcmp(dos.Magic, dos_file_magic, sizeof(dos_file_magic)) != 0) + goto no_sections; + + rc = fseek(uki, le32toh(dos.ExeHeader), SEEK_SET); + if (rc < 0) + return log_error_errno(errno, "seek to PE header"); + items = fread(&pe, 1, sizeof(pe), uki); + if (items != sizeof(pe)) + return log_error_errno(SYNTHETIC_ERRNO(EIO), "PE header read error"); + if (memcmp(pe.Magic, pe_file_magic, sizeof(pe_file_magic)) != 0) + goto no_sections; + + soff = le32toh(dos.ExeHeader) + sizeof(pe) + le16toh(pe.FileHeader.SizeOfOptionalHeader); + rc = fseek(uki, soff, SEEK_SET); + if (rc < 0) + return log_error_errno(errno, "seek to PE section headers"); + + scount = le16toh(pe.FileHeader.NumberOfSections); + if (scount > MAX_SECTIONS) + goto no_sections; + sections = new(struct PeSectionHeader, scount); + if (!sections) + return log_oom(); + items = fread(sections, sizeof(*sections), scount, uki); + if (items != scount) + return log_error_errno(SYNTHETIC_ERRNO(EIO), "PE section header read error"); + + *ret = TAKE_PTR(sections); + *ret_n = scount; + return 0; + +no_sections: + *ret = NULL; + *ret_n = 0; + return 0; +} + +static int find_pe_section(struct PeSectionHeader *sections, size_t scount, + const uint8_t *name, size_t namelen, size_t *ret) { + for (size_t s = 0; s < scount; s++) { + if (memcmp_nn(sections[s].Name, sizeof(sections[s].Name), + name, namelen) == 0) { + if (ret) + *ret = s; + return 1; + } + } + return 0; +} + +static bool is_uki(struct PeSectionHeader *sections, size_t scount) { + return (find_pe_section(sections, scount, name_osrel, sizeof(name_osrel), NULL) && + find_pe_section(sections, scount, name_linux, sizeof(name_linux), NULL) && + find_pe_section(sections, scount, name_initrd, sizeof(name_initrd), NULL)); +} + +int verb_kernel_identify(int argc, char *argv[], void *userdata) { + _cleanup_fclose_ FILE *uki = NULL; + _cleanup_free_ struct PeSectionHeader *sections = NULL; + size_t scount; + int rc; + + uki = fopen(argv[1], "re"); + if (!uki) + return log_error_errno(errno, "Failed to open UKI file '%s': %m", argv[1]); + + rc = pe_sections(uki, §ions, &scount); + if (rc < 0) + return EXIT_FAILURE; + + if (sections) { + if (is_uki(sections, scount)) { + puts("uki"); + return EXIT_SUCCESS; + } + puts("pe"); + return EXIT_SUCCESS; + } + + puts("unknown"); + return EXIT_SUCCESS; +} diff --git a/src/boot/bootctl-uki.h b/src/boot/bootctl-uki.h new file mode 100644 index 00000000000..3c1fb5bc6ad --- /dev/null +++ b/src/boot/bootctl-uki.h @@ -0,0 +1,3 @@ +/* SPDX-License-Identifier: LGPL-2.1-or-later */ + +int verb_kernel_identify(int argc, char *argv[], void *userdata); diff --git a/src/boot/bootctl.c b/src/boot/bootctl.c index b443f9970b2..901533cf096 100644 --- a/src/boot/bootctl.c +++ b/src/boot/bootctl.c @@ -9,6 +9,7 @@ #include "bootctl-set-efivar.h" #include "bootctl-status.h" #include "bootctl-systemd-efi-options.h" +#include "bootctl-uki.h" #include "build.h" #include "dissect-image.h" #include "escape.h" @@ -150,6 +151,8 @@ static int help(int argc, char *argv[], void *userdata) { " remove Remove systemd-boot from the ESP and EFI variables\n" " is-installed Test whether systemd-boot is installed in the ESP\n" " random-seed Initialize random seed in ESP and EFI variables\n" + "\n%3$skernel Commands:%4$s\n" + " kernel-identify Identify kernel image type.\n" "\n%3$sOptions:%4$s\n" " -h --help Show this help\n" " --version Print version\n" @@ -406,6 +409,7 @@ static int bootctl_main(int argc, char *argv[]) { { "update", VERB_ANY, 1, 0, verb_install }, { "remove", VERB_ANY, 1, 0, verb_remove }, { "is-installed", VERB_ANY, 1, 0, verb_is_installed }, + { "kernel-identify", 2, 2, 0, verb_kernel_identify }, { "list", VERB_ANY, 1, 0, verb_list }, { "set-default", 2, 2, 0, verb_set_efivar }, { "set-oneshot", 2, 2, 0, verb_set_efivar }, From a05255981ba5b04f1cf54ea656fbce1dfd9c3a68 Mon Sep 17 00:00:00 2001 From: Gerd Hoffmann Date: Tue, 17 Jan 2023 22:06:06 +0100 Subject: [PATCH 2/2] bootctl: add kernel-inspect command Takes a kernel image as argument. Prints details about the kernel. Signed-off-by: Gerd Hoffmann --- man/bootctl.xml | 6 ++++ src/boot/bootctl-uki.c | 79 ++++++++++++++++++++++++++++++++++++++++++ src/boot/bootctl-uki.h | 1 + src/boot/bootctl.c | 1 + 4 files changed, 87 insertions(+) diff --git a/man/bootctl.xml b/man/bootctl.xml index 2479d5fcd6b..0d796bedc19 100644 --- a/man/bootctl.xml +++ b/man/bootctl.xml @@ -227,6 +227,12 @@ Takes a kernel image as argument. Checks what kind of kernel the image is. Returns one of uki, pe or unknown. + + + kernel + + Takes a kernel image as argument. Prints details about the kernel. + diff --git a/src/boot/bootctl-uki.c b/src/boot/bootctl-uki.c index 1a439afaae8..aa2868fb11f 100644 --- a/src/boot/bootctl-uki.c +++ b/src/boot/bootctl-uki.c @@ -14,6 +14,8 @@ static const uint8_t pe_file_magic[4] = "PE\0\0"; static const uint8_t name_osrel[8] = ".osrel"; static const uint8_t name_linux[8] = ".linux"; static const uint8_t name_initrd[8] = ".initrd"; +static const uint8_t name_cmdline[8] = ".cmdline"; +static const uint8_t name_uname[8] = ".uname"; static int pe_sections(FILE *uki, struct PeSectionHeader **ret, size_t *ret_n) { _cleanup_free_ struct PeSectionHeader *sections = NULL; @@ -108,3 +110,80 @@ int verb_kernel_identify(int argc, char *argv[], void *userdata) { puts("unknown"); return EXIT_SUCCESS; } + +static int read_pe_section(FILE *uki, const struct PeSectionHeader *section, + void **ret, size_t *ret_n) { + _cleanup_free_ void *data = NULL; + uint32_t size, bytes; + uint64_t soff; + int rc; + + soff = le32toh(section->PointerToRawData); + size = le32toh(section->VirtualSize); + + if (size > 16 * 1024) + return log_error_errno(SYNTHETIC_ERRNO(E2BIG), "PE section too big"); + + rc = fseek(uki, soff, SEEK_SET); + if (rc < 0) + return log_error_errno(errno, "seek to PE section"); + + data = malloc(size+1); + if (!data) + return log_oom(); + ((uint8_t*) data)[size] = 0; /* safety NUL byte */ + + bytes = fread(data, 1, size, uki); + if (bytes != size) + return log_error_errno(SYNTHETIC_ERRNO(EIO), "PE section read error"); + + *ret = TAKE_PTR(data); + if (ret_n) + *ret_n = size; + return 0; +} + +static void inspect_uki(FILE *uki, struct PeSectionHeader *sections, size_t scount) { + _cleanup_free_ char *cmdline = NULL; + _cleanup_free_ char *uname = NULL; + size_t idx; + + if (find_pe_section(sections, scount, name_cmdline, sizeof(name_cmdline), &idx)) + read_pe_section(uki, sections + idx, (void**)&cmdline, NULL); + + if (find_pe_section(sections, scount, name_uname, sizeof(name_uname), &idx)) + read_pe_section(uki, sections + idx, (void**)&uname, NULL); + + if (cmdline) + printf(" Cmdline: %s\n", cmdline); + if (uname) + printf(" Version: %s\n", uname); +} + +int verb_kernel_inspect(int argc, char *argv[], void *userdata) { + _cleanup_fclose_ FILE *uki = NULL; + _cleanup_free_ struct PeSectionHeader *sections = NULL; + size_t scount; + int rc; + + uki = fopen(argv[1], "re"); + if (!uki) + return log_error_errno(errno, "Failed to open UKI file '%s': %m", argv[1]); + + rc = pe_sections(uki, §ions, &scount); + if (rc < 0) + return EXIT_FAILURE; + + if (sections) { + if (is_uki(sections, scount)) { + puts("Kernel Type: uki"); + inspect_uki(uki, sections, scount); + return EXIT_SUCCESS; + } + puts("Kernel Type: pe"); + return EXIT_SUCCESS; + } + + puts("Kernel Type: unknown"); + return EXIT_SUCCESS; +} diff --git a/src/boot/bootctl-uki.h b/src/boot/bootctl-uki.h index 3c1fb5bc6ad..effb984d805 100644 --- a/src/boot/bootctl-uki.h +++ b/src/boot/bootctl-uki.h @@ -1,3 +1,4 @@ /* SPDX-License-Identifier: LGPL-2.1-or-later */ int verb_kernel_identify(int argc, char *argv[], void *userdata); +int verb_kernel_inspect(int argc, char *argv[], void *userdata); diff --git a/src/boot/bootctl.c b/src/boot/bootctl.c index 901533cf096..7dd1a2f5f29 100644 --- a/src/boot/bootctl.c +++ b/src/boot/bootctl.c @@ -410,6 +410,7 @@ static int bootctl_main(int argc, char *argv[]) { { "remove", VERB_ANY, 1, 0, verb_remove }, { "is-installed", VERB_ANY, 1, 0, verb_is_installed }, { "kernel-identify", 2, 2, 0, verb_kernel_identify }, + { "kernel-inspect", 2, 2, 0, verb_kernel_inspect }, { "list", VERB_ANY, 1, 0, verb_list }, { "set-default", 2, 2, 0, verb_set_efivar }, { "set-oneshot", 2, 2, 0, verb_set_efivar },