Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Sentinel-One/efi_fuzz

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/Sentinel-One/efi_fuzz
Owner: Sentinel-One
Created: 2020-09-30T16:15:20.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2024-07-15T17:50:32.000Z (4 months ago)
Last Synced: 2024-07-15T21:54:44.459Z (4 months ago)
Language: Python
Size: 6.48 MB
Stars: 133
Watchers: 10
Forks: 15
Open Issues: 9
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

awesome-uefi-security - efi_fuzz - guided emulator-based NVRAM fuzzer for UEFI (based on qiling). (Tools :hammer:)

README

[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/efi_fuzz/community)
___

# efi_fuzz
A simple, coverage-guided fuzzer for UEFI NVRAM variables.
Based on [Qiling](https://github.com/qilingframework/qiling) and [AFL++](https://github.com/AFLplusplus/AFLplusplus).\
Written by Itai Liba ([@liba2k](https://twitter.com/liba2k)) and Assaf Carlsbad ([@assaf_carlsbad](https://twitter.com/assaf_carlsbad)).

## Usage

### Using Docker environment

1. Build image:\
`docker build -t efi_fuzz .`

2. Test environment:\
`docker run -v $PWD:/efi_fuzz -it efi_fuzz sh -c "cd efi_fuzz/tests/ && pytest -s -v -W ignore::DeprecationWarning"`

3. Use the environment:\
`docker run -v $PWD:/efi_fuzz -it efi_fuzz sh -c "cd /efi_fuzz ; bash"`

4. Prepare the emulated NVRAM environment (You will have to provide the rom image): \
`python3 scripts/prepare_nvram.py rom.bin nvram.pickle`

5. Prepare the initial corpus for the NVRAM variables: \
`python3 scripts/prepare_afl_corpus.py rom.bin afl_inputs`

6. Perform a dry run of the fuzzer: \
`python3 efi_fuzz.py `

7. If successful, move on to full-fledged fuzzing: \
`afl-fuzz -i afl_inputs/ -o afl_outputs/ -U -- python3 efi_fuzz.py @@`

### Install Environment locally
1. If running on Windows, install WSL. We recommend WSL2 as opposed to the original WSL, which tends to be slow sometimes. The full installation instructions for Windows 10 can be found here: https://docs.microsoft.com/en-us/windows/wsl/install-win10

2. Inside the WSL distribution, install some necessary packages that will allow us to compile C source code:\
`sudo apt install build-essential automake`

3. Install AFL++ with Unicorn mode support. \
3.1. Clone the repository: \
`git clone https://github.com/AFLplusplus/AFLplusplus` \
3.2. Build core AFL++ binaries: \
`make` \
3.3. Build the Unicorn support feature: \
`cd unicorn_mode` \
`./build_unicorn_support.sh` \
3.4. Install everything: \
`make install`

4. Acquire and unpack the UEFI firmware you wish to fuzz. For the full technical details on how this is done is practice, see [here](https://labs.sentinelone.com/moving-from-common-sense-knowledge-about-uefi-to-actually-dumping-uefi-firmware/) or [here](https://www.amazon.com/Rootkits-Bootkits-Reversing-Malware-Generation/dp/1593277164).

5. Clone the fuzzer and install required dependencies: \
`git clone https://github.com/Sentinel-One/efi_fuzz` \
`pip install -r efi_fuzz/requirements.txt`

Triton is required for taint propagation. \
Instructions for installing Triton can be found here: \
[https://triton.quarkslab.com/documentation/doxygen/#install_sec](https://triton.quarkslab.com/documentation/doxygen/#install_sec)

6. Prepare the emulated NVRAM environment: \
`python scripts/prepare_nvram.py rom.bin nvram.pickle`

7. Prepare the initial corpus for the NVRAM variables: \
`python scripts/prepare_afl_corpus.py rom.bin afl_inputs`

8. Perform a dry run of the fuzzer: \
`python efi_fuzz.py `

9. If successful, move on to full-fledged fuzzing: \
`afl-fuzz -i afl_inputs/ -o afl_outputs/ -U -- python efi_fuzz.py @@`

## Command-line options
* `-e, --end`: Specify an end address for the emulation.
* `-t, --timeout`: Specify a new timeout value for the emulation, in ms.
* `-o, --output`: Specify output format for debugging purposes. Valid values are: `trace`, `disasm`, `debug` and `off` (defaults to `off`).
* `-n, --no-sanitize`: Disable the memory sanitizer (defaults to `False`).
* `-u, --track-uninitialized`: Keeps track of uninitialized memory via Triton and taint propagation (EXPERIMENTAL!).
* `-x, --extra-modules`: A list of extra modules to load to satisfy the dependencies of the target.

## Further reading
Further information regarding UEFI firmware in general and _efi_fuzz_ in particular can be found here:
* [Moving From Common-Sense Knowledge About UEFI To Actually Dumping UEFI Firmware](https://labs.sentinelone.com/moving-from-common-sense-knowledge-about-uefi-to-actually-dumping-uefi-firmware/)
* [Moving From Manual Reverse Engineering of UEFI Modules To Dynamic Emulation of UEFI Firmware](https://labs.sentinelone.com/moving-from-manual-re-of-uefi-modules-to-dynamic-emulation-of-uefi-firmware/)
* [Moving From Dynamic Emulation of UEFI Modules To Coverage-Guided Fuzzing of UEFI Firmware](https://labs.sentinelone.com/moving-from-dynamic-emulation-of-uefi-modules-to-coverage-guided-fuzzing-of-uefi-firmware/)