Skip to main content

Tools for ovmf / armvirt firmware volumes

This is a small collection of tools for edk2 firmware images. They support decoding and printing the content of firmware volumes. Variable stores (OVMF_VARS.fd) can be modified, for example to enroll secure boot certificates.

virt-fw-dump

Decodes and prints the content of firmware volumes.

Usage: virt-fw-dump -i <file>.

Try virt-fw-dump --help for more info, there are some options to filter output.

virt-fw-vars

Print and edit variable store volumes. Currently focused on enrolling certificates and enabling secure boot.

Print variables: virt-fw-vars -i <file> --print.

Enroll certificates:

virt-fw-vars \
    --input <template> \
    --output <vars> \
    --enroll-redhat \
    --secure-boot

Try virt-fw-vars --help for more usage information.

virt-fw-vars can handle edk2 variable stores (which are flash firmware volumes) and AWS uefi variable stores. The input format is detected automatically and the same format is used for output.

Working with edk2 variable stores requires a firmware volume as input. Typically the OVMF_VARS.fd file created when building OVMF is used for that (it is an empty variable store).

aws variable stores can also be created from scratch and written to a file with using the --output-aws option.

virt-fw-sigdb

Print and edit efi signature database files, example:

virt-fw-sigdb -i /etc/pki/ca-trust/extracted/edk2/cacerts.bin --print

Try virt-fw-sigdb --help for more usage information.

host-efi-vars

Read efi variables from linux efivarfs and decode/print them.

kernel-bootcfg

Manage efi boot configuration for UKIs (unified kernel images) when using direkt boot (without boot loader like grub or systemd-boot).

pe-dumpinfo

Information dump for pe (the format used by efi) binaries.

pe-listsigs

List signatures and certificate chain for pe binaries. Can also extract certificates & signatures.

using the python modules

There isn't much documentation yet, sorry. Best code reads to get started are probably the test cases (see tests/tests.py) and the code for the virt-fw-vars utility (see virt/firmware/vars.py).

install

Release: pip3 install virt-firmware

Snapshot: pip3 install git+https://gitlab.com/kraxel/virt-firmware.git

TODO list

  • Add more documentation.

contributing

I take MRs.

There is an AI review bot active on the repo which will comment on MRs. It is good at spell checking. Sometimes it offers useful suggestions or catches inconsistencies in the patches. Sometimes it asks for stupid stuff like careful error checking in test cases. Sometimes it suggests to check for error conditions which can not happen, but the bot is apparently not clever enough to see that. Sometimes it suggests code reorganizations where it is more a matter of taste or personal preference whenever you take the one or the other way.

So, don't take the bot too serious.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

virt_firmware-26.8.1.tar.gz (167.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

virt_firmware-26.8.1-py3-none-any.whl (164.8 kB view details)

Uploaded Python 3

File details

Details for the file virt_firmware-26.8.1.tar.gz.

File metadata

  • Download URL: virt_firmware-26.8.1.tar.gz
  • Upload date:
  • Size: 167.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.14.7

File hashes

Hashes for virt_firmware-26.8.1.tar.gz
Algorithm Hash digest
SHA256 56a163c04fdcaff32e2d2df787c26f42b48a345d8f7fa961e70c7d294fb05a64
MD5 e06c24eaa74d109d64722a70ed8b4874
BLAKE2b-256 58e99318c7da63ca45a5ec081afad7b5caaacdd396288e45d951beab40f95e1d

See more details on using hashes here.

File details

Details for the file virt_firmware-26.8.1-py3-none-any.whl.

File metadata

  • Download URL: virt_firmware-26.8.1-py3-none-any.whl
  • Upload date:
  • Size: 164.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.14.7

File hashes

Hashes for virt_firmware-26.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b3747ade95d42ccce7df6260cf368212b99fd773749a6b44317c519f943fae83
MD5 5caa0bc2c90be3c1e88ac155b3f06d27
BLAKE2b-256 4aa2e7f8fdcf0778906a9a9a8ebeab1e59e5a26897fc4635f63a8d7c898804ec

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

26.8.1 This release

2 files

26.8

2 files

26.7.4

2 files

26.7.3

2 files

26.7.2

2 files

26.7.1

2 files

26.6

2 files

26.5.4

2 files

26.5.3

2 files

26.5.2

2 files

26.4

2 files

26.2

2 files

25.12

2 files

25.10

2 files

25.9

2 files

25.7.3

2 files

25.7.2

2 files

25.7

2 files

25.4.1

2 files

25.4

2 files

25.3

2 files

24.11

2 files

24.7

2 files

24.4

2 files

24.2

2 files

24.1.1

2 files

24.1

2 files

23.11

2 files

23.10

2 files

23.9

2 files

23.6

2 files

23.5

2 files

23.4

2 files

1.8

2 files

1.7

2 files

1.6

2 files

1.5

2 files

1.4

2 files

1.3

2 files

1.2

2 files

1.1

2 files

1.0

2 files

0.98

2 files

0.97

2 files

0.96

2 files

0.95

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page