Compare commits

..

2 Commits

Author SHA1 Message Date
Ani Sinha f81190fdd1
Merge 9f026bfd96 into c946b13575 2024-11-22 21:09:58 +01:00
Ani Sinha 9f026bfd96 measure: introduce support for a .fmw section
UKIs container can be used to bundle a firmware image that can be measured and
used on a confidential computing environment. Add support to introduce a .fmw
section in UKI that can be used for a firmware image. ukify tool has been
also changed to support addition of a firmware image in UKI. For example:

ukify.py build \
        --stub ./build/src/boot/efi/linuxx64.efi.stub \
        --linux bzImage \
        --cmdline='blah blah debug' \
        --firmware ~/OVMF.fd \
        --output=root/efi/boot/bootx64.efi

Co-authored-by: harald.hoyer@gmail.com
2024-11-12 15:38:46 +05:30
4 changed files with 34 additions and 44 deletions

View File

@ -75,6 +75,9 @@
<listitem><para>An optional <literal>.ucode</literal> section with an initrd containing microcode, to <listitem><para>An optional <literal>.ucode</literal> section with an initrd containing microcode, to
be handed to the kernel before any other initrd. This initrd must not be compressed.</para></listitem> be handed to the kernel before any other initrd. This initrd must not be compressed.</para></listitem>
<listitem><para>An optional <literal>.fmw</literal> section with the firmware image.
</para></listitem>
<listitem><para>An optional <literal>.splash</literal> section with an image (in the Windows <listitem><para>An optional <literal>.splash</literal> section with an image (in the Windows
<filename>.BMP</filename> format) to show on screen before invoking the kernel.</para></listitem> <filename>.BMP</filename> format) to show on screen before invoking the kernel.</para></listitem>
@ -91,15 +94,6 @@
the same matching procedure. If a match is found, that <literal>.dtbauto</literal> section will be the same matching procedure. If a match is found, that <literal>.dtbauto</literal> section will be
loaded and will override <varname>.dtb</varname> if present.</para></listitem> loaded and will override <varname>.dtb</varname> if present.</para></listitem>
<listitem><para>Zero or more <literal>.efifwauto</literal> sections for the firmware image. It works
in many ways similar to <varname>.dtbauto</varname> sections. <filename>systemd-stub</filename>
will always use the first matching one. The match is performed by first selecting the most appropriate
entry in the <varname>.hwids</varname> section based on the hardware IDs supplied by SMBIOS (see below).
If a suitable entry is found, the <varname>compatible</varname> string from that entry will be used to
perform the matching procedure for firmware blobs in <varname>.efifwauto</varname> section. The first
matching firmware will be loaded.
</para></listitem>
<listitem><para>Zero or more <literal>.hwids</literal> sections with hardware IDs of the machines to <listitem><para>Zero or more <literal>.hwids</literal> sections with hardware IDs of the machines to
match DeviceTrees. <filename>systemd-stub</filename> will use the SMBIOS data to calculate hardware IDs match DeviceTrees. <filename>systemd-stub</filename> will use the SMBIOS data to calculate hardware IDs
of the machine (as per <ulink of the machine (as per <ulink

View File

@ -23,6 +23,6 @@ const char* const unified_sections[_UNIFIED_SECTION_MAX + 1] = {
[UNIFIED_SECTION_PROFILE] = ".profile", [UNIFIED_SECTION_PROFILE] = ".profile",
[UNIFIED_SECTION_DTBAUTO] = ".dtbauto", [UNIFIED_SECTION_DTBAUTO] = ".dtbauto",
[UNIFIED_SECTION_HWIDS] = ".hwids", [UNIFIED_SECTION_HWIDS] = ".hwids",
[UNIFIED_SECTION_FIRMWARE] = ".efifwauto", [UNIFIED_SECTION_FIRMWARE] = ".fmw",
NULL, NULL,
}; };

View File

@ -104,7 +104,7 @@ static int help(int argc, char *argv[], void *userdata) {
" --linux=PATH Path to Linux kernel image file %7$s .linux\n" " --linux=PATH Path to Linux kernel image file %7$s .linux\n"
" --osrel=PATH Path to os-release file %7$s .osrel\n" " --osrel=PATH Path to os-release file %7$s .osrel\n"
" --cmdline=PATH Path to file with kernel command line %7$s .cmdline\n" " --cmdline=PATH Path to file with kernel command line %7$s .cmdline\n"
" --firmware=PATH Path to firmware image file %7$s .efifwauto\n" " --firmware=PATH Path to firmware image file %7$s .fmw\n"
" --initrd=PATH Path to initrd image file %7$s .initrd\n" " --initrd=PATH Path to initrd image file %7$s .initrd\n"
" --ucode=PATH Path to microcode image file %7$s .ucode\n" " --ucode=PATH Path to microcode image file %7$s .ucode\n"
" --splash=PATH Path to splash bitmap file %7$s .splash\n" " --splash=PATH Path to splash bitmap file %7$s .splash\n"

View File

@ -242,7 +242,7 @@ class UkifyConfig:
efi_arch: str efi_arch: str
hwids: Path hwids: Path
initrd: list[Path] initrd: list[Path]
firmware: list[Path] firmware: Path
join_profiles: list[Path] join_profiles: list[Path]
json: Union[Literal['pretty'], Literal['short'], Literal['off']] json: Union[Literal['pretty'], Literal['short'], Literal['off']]
linux: Optional[Path] linux: Optional[Path]
@ -365,12 +365,12 @@ class Uname:
DEFAULT_SECTIONS_TO_SHOW = { DEFAULT_SECTIONS_TO_SHOW = {
'.linux': 'binary', '.linux': 'binary',
'.initrd': 'binary', '.initrd': 'binary',
'.fmw': 'binary',
'.ucode': 'binary', '.ucode': 'binary',
'.splash': 'binary', '.splash': 'binary',
'.dtb': 'binary', '.dtb': 'binary',
'.dtbauto': 'binary', '.dtbauto': 'binary',
'.hwids': 'binary', '.hwids': 'binary',
'.efifwauto': 'binary',
'.cmdline': 'text', '.cmdline': 'text',
'.osrel': 'text', '.osrel': 'text',
'.uname': 'text', '.uname': 'text',
@ -1215,7 +1215,7 @@ def make_uki(opts: UkifyConfig) -> None:
('.splash', opts.splash, True), ('.splash', opts.splash, True),
('.pcrpkey', pcrpkey, True), ('.pcrpkey', pcrpkey, True),
('.initrd', initrd, True), ('.initrd', initrd, True),
*(('.efifwauto', fw, True) for fw in opts.firmware), ('.fmw', opts.firmware, True),
('.ucode', opts.microcode, True), ('.ucode', opts.microcode, True),
] # fmt: skip ] # fmt: skip
@ -1272,7 +1272,7 @@ def make_uki(opts: UkifyConfig) -> None:
'.osrel', '.osrel',
'.cmdline', '.cmdline',
'.initrd', '.initrd',
'.efifwauto', '.fmw',
'.ucode', '.ucode',
'.splash', '.splash',
'.dtb', '.dtb',
@ -1735,13 +1735,9 @@ CONFIG_ITEMS = [
), ),
ConfigItem( ConfigItem(
'--firmware', '--firmware',
metavar='PATH',
type=Path, type=Path,
action='append', help='firmware file [.fmw section]',
default=[],
help='firmware file [.efifwauto section]',
config_key='UKI/Firmware', config_key='UKI/Firmware',
config_push=ConfigItem.config_list_prepend,
), ),
ConfigItem( ConfigItem(
'--microcode', '--microcode',