The UEFI firmware parser is a simple module and set of scripts for parsing, extracting, and recreating UEFI firmware volumes. This includes parsing modules for BIOS, OptionROM, Intel ME and other formats too. Please use the example scripts for parsing tutorials.
$ sudo python ./setup.py installRequirements
- Python development headers, usually found in the
python-devpackage. - The compression/decompression features will use the python headers and
gcc. pefileis optional, and may be used for additional parsing.
Example scripts are provided in /scripts
$ python ./scripts/fv_parser.py -h
usage: fv_parser.py [-h] [-b] [-c] [-f] [-d] [-m] [-p] [-q] [-o OUTPUT] [-e]
[-g GENERATE] [-t]
file [file ...]
Parse, and optionally output, details and data on UEFI-related firmware.
positional arguments:
file The file(s) to work on
optional arguments:
-h, --help show this help message and exit
-b, --brute The input is a blob and may contain FV headers.
-c, --capsule The input file is a firmware capsule, do not search.
-f, --ff The input file is a firmware file.
-d, --flash The input file is a flash descriptor.
-m, --me The input file is an Intel ME container.
-p, --pfs The input file is a Dell PFS.HDR update.
-q, --quiet Do not show info.
-o OUTPUT, --output OUTPUT
Dump EFI Files to this folder.
-e, --extract Extract all files/sections/volumes.
-g GENERATE, --generate GENERATE
Generate a FDF, implies extraction
-t, --test Test file parsing, output name/success.Features
- UEFI Firmware Volumes, Capsules, FileSystems, Files, Sections parsing
- Intel PCH Flash Descriptors
- Intel ME modules parsing (for ARC5)
- Dell PFS (HDR) updates parsing
- Tiano/EFI, and native LZMA (7z) [de]compression
- Complete UEFI Firmware volume object heirarchy display
- Firmware descriptor [re]generation using the parsed input volumes
- Firmware File Section injection
GUID Injection
Injection or GUID replacement (no addition/subtraction yet) can be performed on sections within a UEFI firmware file, or on UEFI firmware files within a firmware filesystem.
$ python ./scripts/fv_injector.py -h
usage: fv_injector.py [-h] [-c] [-p] [-f] [--guid GUID] --injection INJECTION
[-o OUTPUT]
file
Search a file for UEFI firmware volumes, parse and output.
positional arguments:
file The file to work on
optional arguments:
-h, --help show this help message and exit
-c, --capsule The input file is a firmware capsule.
-p, --pfs The input file is a Dell PFS.
-f, --ff Inject payload into firmware file.
--guid GUID GUID to replace (inject).
--injection INJECTION
Pre-generated EFI file to inject.
-o OUTPUT, --output OUTPUT
Name of the output file.Note: when injecting into a firmware file the user will be prompted for which section to replace. At the moment this is not-yet-scriptable.
IDA Python support
There is an included script to generate additional GUID labels to import into IDA Python using Snare's plugins. Using the -g LABEL the script will generate a Python dictionary-formatted output. This project will try to keep up-to-date with popular vendor GUIDs automatically.
$ python ./scripts/uefi_guids.py -h
usage: uefi_guids.py [-h] [-c] [-b] [-d] [-g GENERATE] [-u] file
Output GUIDs for files, optionally write GUID structure file.
positional arguments:
file The file to work on
optional arguments:
-h, --help show this help message and exit
-c, --capsule The input file is a firmware capsule, do not search.
-b, --brute The input file is a blob, search for firmware volume
headers.
-d, --flash The input file is a flash descriptor.
-g GENERATE, --generate GENERATE
Generate a behemonth-style GUID output.
-u, --unknowns When generating also print unknowns.Supported Vendors
This module has been tested on BIOS/UEFI/firmware updates from the following vendors. Not every update for every product will parse, some may required a-prioi decompression or extraction from the distribution update mechanism (typically a PE).
- ASRock
- Dell
- Gigabyte
- Intel
- Lenovo
- HP
- MSI
- VMware