Skip to content
Source code of HAL-fuzz
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
configs Add stuff Nov 5, 2019
dictionaries
docs Add stuff Nov 5, 2019
experimental Add stuff Nov 5, 2019
hal_fuzz
libdislocator
libtokencap Add stuff Nov 5, 2019
llvm_mode Add stuff Nov 5, 2019
qemu_mode
testcases
tests Fix timer and nvic options Nov 22, 2019
unicorn_mode Fix and Dockerize Nov 10, 2019
utils Add stuff Nov 5, 2019
.gitignore Ignore Nov 5, 2019
Dockerfile Fix dockerfile Nov 11, 2019
LICENSE Add stuff Nov 5, 2019
Makefile
QuickStartGuide.txt Add stuff Nov 5, 2019
README-aflunicorn.md Add stuff Nov 5, 2019
README.md
afl-analyze.c
afl-as.c Add stuff Nov 5, 2019
afl-as.h
afl-cmin
afl-fuzz.c
afl-gcc.c Add stuff Nov 5, 2019
afl-gotcpu.c Add stuff Nov 5, 2019
afl-plot Add stuff Nov 5, 2019
afl-showmap.c Add stuff Nov 5, 2019
afl-tmin.c Add stuff Nov 5, 2019
afl-whatsdown Add stuff Nov 5, 2019
afl-whatsup Add stuff Nov 5, 2019
alloc-inl.h Add stuff Nov 5, 2019
config.h
csaw_input_generator.py Add stuff Nov 5, 2019
csaw_tester.py
csaw_tester0.py
csaw_tester1.py
csaw_tester12.py Add stuff Nov 5, 2019
csaw_tester13.py
csaw_tester14.py Add stuff Nov 5, 2019
csaw_tester16.py Add stuff Nov 5, 2019
csaw_tester17.py
csaw_tester4.py Add stuff Nov 5, 2019
csaw_tester5.py
csaw_tester7.py
csaw_tester8.py Add stuff Nov 5, 2019
csaw_tester_template.py
debug.h Add stuff Nov 5, 2019
dump_symbols.py
hal-fuzz Standalone script Nov 6, 2019
hash.h Add stuff Nov 5, 2019
requirements.txt
setup.sh
test-instr-argv.c Add stuff Nov 5, 2019
test-instr.c
test_atmel_6lowpan_udp_rx.sh
test_atmel_6lowpan_udp_rx_fuzz.sh Fixes Nov 11, 2019
test_atmel_6lowpan_udp_rx_parallel.sh
test_atmel_6lowpan_udp_tx.sh More scripts Nov 11, 2019
test_atmel_6lowpan_udp_tx_parallel.sh More scripts Nov 11, 2019
test_chad_blink.sh Fix script Nov 25, 2019
test_csaw_esc_csa.sh Add stuff Nov 5, 2019
test_csaw_esc_csb.sh Add stuff Nov 5, 2019
test_csaw_esc_csc.sh Add stuff Nov 5, 2019
test_csaw_esc_csd.sh Add stuff Nov 5, 2019
test_csaw_esc_cse.sh
test_csaw_esc_csf.sh
test_nop.sh Add stuff Nov 5, 2019
test_nucleo_blink_led.sh
test_nucleo_blink_led_parallel.sh Add stuff Nov 5, 2019
test_nxp_lwip_http.sh
test_nxp_lwip_http_parallel.sh
test_nxp_lwip_tcpecho.sh Add stuff Nov 5, 2019
test_nxp_lwip_tcpecho_parallel.sh Add stuff Nov 5, 2019
test_nxp_lwip_udpecho.sh Add stuff Nov 5, 2019
test_nxp_lwip_udpecho_parallel.sh More scripts Nov 11, 2019
test_nxp_uart.sh Add stuff Nov 5, 2019
test_p2im_car_controller.sh Add stuff Nov 5, 2019
test_p2im_console.sh Add stuff Nov 5, 2019
test_p2im_controllino.sh
test_p2im_drone.sh Add stuff Nov 5, 2019
test_read_hyperterminal.sh Add stuff Nov 5, 2019
test_read_hyperterminal_parallel.sh Add stuff Nov 5, 2019
test_rf_lock.sh Add stuff Nov 5, 2019
test_samr21_http_eth.sh Fix a few scripts Nov 22, 2019
test_samr21_http_parallel.sh Add stuff Nov 5, 2019
test_samr21_http_plain.sh Fix a few scripts Nov 22, 2019
test_samr21_http_plain_parallel.sh Add stuff Nov 5, 2019
test_samr21_http_tcp.sh Add stuff Nov 5, 2019
test_samr21_http_tcp_parallel.sh
test_simple_mbed.sh More scripts Nov 11, 2019
test_simple_mbed_fuzz.sh
test_simple_mbed_parallel.sh
test_st_plc.sh Add stuff Nov 5, 2019
test_st_plc_fuzz.sh More scripts Nov 11, 2019
test_stm32_tcp_echo.sh Fixes Nov 11, 2019
test_stm32_tcp_echo_client.sh Add stuff Nov 5, 2019
test_stm32_tcp_echo_client_parallel.sh More scripts Nov 11, 2019
test_stm32_tcp_echo_fuzz.sh
test_stm32_tcp_echo_parallel.sh Add stuff Nov 5, 2019
test_stm32_udp_echo.sh
test_stm32_udp_echo_client.sh
test_stm32_udp_echo_client_parallel.sh
test_wycinwyc.sh
test_wycinwyc_fuzz.sh Fixes Nov 11, 2019
types.h Add stuff Nov 5, 2019

README.md

hal-fuzz: An HLE-based fuzzer for blob firmware

hal-fuzz is the sleeker, faster, fuzzing-oriented version of HALucinator. It was developed as part of our paper "HALucinator: Firmware Re-Hosting through Abstraction Layer Emulation" at USENIX 2020.

It was also used by the Shellphish hacking team to win the 2019 CSAW Embedded Security Challenge(https://github.com/TrustworthyComputing/csaw_esc_2019), by leveraging its rehosting, fuzzing, and debugging capabilities. Check out a video of hal-fuzz grilling up a challenge automatically here: https://drive.google.com/file/d/1m4VzTQUBMb1xOZN9GmWQZS-Qij3v0koF/view

If you're interested in re-hosting entire multi-node systems, or re-hosting firmware needing complex interactions with the outside world, you might want to try the original, found here: https://github.com/embedded-sec/halucinator

Cite us!

Using hal-fuzz for research? Please cite our USENIX paper. More details at: http://subwire.net/publication/halucinator/

What is this crazy thing?

hal-fuzz is a generic emulator based on the principle of High Level Emulation (HLE), where we replace hardware-related library functions in the binary with high-level Python replacements. While these replacements are created manually, we show (and you can experience yourself) that these high-level replacements are shockingly easy to write. Most of them simply take arguments from the program, and do almost nothing of consequence. In fact, many do nothing at all, and are simply nop-outs.

In this fuzzing-oriented version, we replace the combo of full-system QEMU and Avatar used to create an instrumentable environment with AFL-Unicorn(https://github.com/Battelle/afl-unicorn ). This removes the significant bulk of the previous system, and adds AFL's fork-server and block coverage information. While we tried to engineer the system such that handlers written for one work with the other, we noticed that handlers used simply for fuzzing could be much shorter (and therefore much more performant) and opted to split up the system. This version also forgoes concepts such as the Peripheral Server from the original HALucinator for the same reasons.

In order to make hal-fuzz work at a reasonable speed, we made a number of notable optimizations:

  • Deterministic Timers: Timers are based on block counts, not real time. This enables deterministic fuzzing of otherwise-asynchronous code.
  • Native Handlers: Normal AFL-Unicorn/Python suffers from performance issues when transitioning between Unicorn and its Python bindings. Unfortunately, Unicorn also does not provide a "conditional hook"; you can hook every block in the program, but not a specific block. We therefore provide a native library to enable this in a performant way, causing a massive (about 8x) speedup.
  • Interrupts and "faux-terrupts": Interrupts are a part of life in embedded. Unfortunately, one aspect that was lost when QEMU was slimmed-down into Unicorn was the entire notion of interrupts. We add this notion back, in the usual HLE way, using a model of the Cortex-M NVIC. This implements the entry and exit procedures described in the ISA docs well enough to run actual RTOS bits. However, many firmware/libraries will not actually need full interrupt support, and instead need something simpler, like an asynchronous callback. This callback is passed as a function pointer, and is expected to be called in an Interrupt Service Routine (ISR). Under normal circumstances, which ISR you use is hardware-dependent. We'd prefer not to worry about that with HLE, so we created the new concept of "faux-terrupts", where a handler (or any Python hook) can freely enter interrupt mode with the IRQ of its chosing, and execute these callbacks, without needing hardware-specific knowledge. As part of this, we also enable the manipulation of the ARM Cortex M status registers from Unicorn, a feature currently missing from the mainline version.

More details can be found in the paper.

How do I use it?

Initial setup

Shortcut: Docker

Do you not hate Docker? Skip all the stuff below and try our Dockerfile (note that we don't suggest this for real-world fuzzing of anything, but it's a great way to play around!)

Simply:

docker build .

...and eventually...

docker run -it <image_hash> /bin/bash

and you'll be dropped into a shell with everything set up!

If you want to fuzz, make sure you do the following on the host, as root or AFL will get mad:

echo core >/proc/sys/kernel/core_pattern
cd /sys/devices/system/cpu
echo performance | tee cpu*/cpufreq/scaling_governor

The old-fashioned way

If you're on Ubuntu 18.04, first make yourself a Python virtual environment:

mkvirtualenv -p /usr/bin/python3 halfuzz

...and then run:

./setup.sh

You'll need to be a user with sudo permissions.
Cross your fingers.

Now what?

If all goes well, you can now use the ./hal-fuzz script to use the tool.

Other useful points of interest include the test_*.sh scripts found in the root directly. The "fuzz" scripts will start single-threaded AFL for that sample, the "parallel" scripts will start a huge parallel AFL ssession (be careful!) and the plain ones will simply run the binary once (useful for triage and debugging).

The csaw_tester_*.py scripts relate to our use of hal-fuzz in the 2019 CSAW Embedded Systems Challenge. These are for debugging, fuzzing, or validating challenge solutions. More info on what these do and why can be found on the CSAW ESC website.

Getting symbols

As we mention in the paper, you need a few things in order to use this tool, the first of which is the location of the libraries in the binary-under-test. There are two ways to get this information, which are provided to the system as a yml file:

  • Dump the symbols from an ELF: If you're compiling a piece of firmware yourself, or are otherwise lucky enough to have symbols around, do this. We have a nice angr script (dump_symbols.py) that will do this for you, creating the needed yml file. In the future, we hope to add a loader (e.g., angr's CLE loader) to automate most of this.

  • Use LibMatch: We created our own library-matcher as part of our paper, found here: (https://github.com/subwire/libmatch ) This tool also outputs the yml format you need. If you've got a real blob, this is the way to go. You'll of course need the SDK you think your firmware was built with in order to do this.

Writing Handlers and Models

hal-fuzz doesn't do much without Handlers and Models. If your firmware uses a library we already have Handlers for, great! (see ./configs/hal/ for what's already supported) You can skip this part.

If not, you need to make some. This isn't hard (as we evaluate in the paper) and shouldn't take too long at all.

Handlers are the high-level replacement functions that make hardware-dependent behaviors disappear. Models are data abstractions to allow for handlers to share a common object, such as a virtual serial port or I2C bus. Models also facilitate a common interface with the outside host.

Your goal in writing handlers is to create two things: The python handler code itself, and a YML file mapping the actual symbol names to your handlers.

Handler code: A handler is a python function that takes the emulator's state (uc) as an argument, and transforms this state to appear as it would if the function was run. The three primary steps in most handlers are: 1) collecting arguments, 2) performing the actual behavior, and 3) returning a value. For example, consider a function that adds 2 to the argument and returns it; it would look like this:

def add_two(uc):
    number = uc.regs.r0 # Get the argument
    number += 2         # Add two
    uc.regs.r0 = number # Return the result

Now this isn't the kind of function you'd normally want to intercept. What about something with hardware in it? Let's say we have a function that takes n bytes from a serial port, and writes them into a buffer. We use the SerialModel for this. For example:

def serial_read(uc):
    serial_id = uc.regs.r0 # arg0, which serial port
    buff_ptr = uc.regs.r1 # arg1, where's the data going?
    len = uc.regs.r2 # arg2, how much data?
    buff_len = uc.regs.r3 # arg3, how long is that buffer?
    the_data = SerialModel.rx(serial_id, len) # get the actual data
    assert(buff_ptr != 0) # crash if we get a null pointer!
    assert(len <= buff_len) # crash if somebody's being bad!
    uc.mem[buff_ptr] = the_data # write it out to memory
    uc.regs.r0 = 0 # indicate success

In the above, we see a few new concepts. The function's arguments and their type should be looked up in the HAL, library, or SDK's documentation. Based on this info, we can help out our fuzzer by adding some preconditions that, if violated, tell us something has gone horribly wrong.

See the numerous included examples (in hal_fuzz.handlers) for ideas and inspiration on writing your own handlers.

YAML file: You can create a YAML file for the HAL or library you're handling so that it can be quickly re-used for any new firmware image. You may map multiple functions to the same handler, reuse other handlers, or leave the handler function name blank to just nop out the function. Note that you should use the nop-out when you can, we dynamically re-write the binary to add nop-outs to avoid calling Python code for performance reasons!

Following on from the above examples, we might do something like:

handlers:
    HAL_Serial_Read:
        handler: hal_fuzz.handlers.my_hal.serial_read
    HAL_Serial_Init:
        handler: 
    HAL_add_two:
        handler: hal_fuzz.handlers.my_hal.add_two

Once you have this YAML file for your HAL or library, just include it in your firmware's configuration (see below)

Configuring hal-fuzz

We use a YAML configuration file per binary to set up emulation. In this file, you need to specify the memory map, which libraries are in use, and any ancillary options that affect emulation, such as the configuration of peripherals you'd like.

Numerous examples exist in ./tests of how to do this, but the basic layout for a typical firmware sample is:

  • include: The include directive accepts a list of other yml files to include. If they contain duplicate entries, they will be merged, allowing you to override settings as you desire. We provide YAML files for each HAL (as they typically do not change) and for the basic layout of the ISA-specified memory map, which can/should be included first. Make sure to include the file containing the recovered symbols created earlier!

  • memory_map: This is where you tell hal-fuzz how to load the binary. Of course, since we're dealing with blobs, this information needs to be figured out first. Make sure to use the "file=" attribute to load the firmware itself into memory somewhere!

  • handlers: Wihle most of the handler configuration is simply included from a pre-existing file, if you have any firmware-specific overrides, you can put them here. These could include things like removing the CRC from LwIP, switching error handlers from crashes to hangs, or anything your analysis could benefit from.

Command-line options

With the emulation environment configured, now it's time to run the tool. hal-fuzz accepts many command-line options (queried with ./hal-fuzz --help) which are described in detail here.

  • -c: This is the required option where you specify the YAML file for your firmware.
  • -d/--debug: This enables debug instrumentation. Fuzzing something? TURN THIS OFF to massively boost your execution speed. None of the other debugging-related options will work without this on, however
  • -t/--trace-syms: Print to the screen a trace of the called functions, as annotated by your collected symbol table. This is extrmeely useful for rapid debugging and development of handlers, or diagnosing crashes
  • -M/--trace-memory: Print to the screen a full memory trace. This is EXTREMELY SLOW and will produce more output than you might expect, but is the best way to triage certain kinds of crashes. You're not getting this kind of data out of your average emulator!
  • -b/--breakpoint: Set a breakpoint, and drop into the SparklyUnicorn(tm) debugger. See below for details. You can set furhter breakpoints after you hit the first one (TODO: Fix this)
  • input: The final, positional argument is a file to be fed in as the "fuzz".

Using hal-fuzz with AFL

Ready to fuzz some drones? Great! If you've followed the steps above, hal-fuzz is already ready to use with AFL. See our examples (e.g., ./test_st_plc_parallel.sh) for examples. The basic usage is:

./afl-fuzz -U -m none -i ./path/to/inputs -o ./path/to/outputs -- ./hal-fuzz -c ./path/to/firmware.yml @@

Note that the first time you start, AFL will probably warn you about your system settings. Just follow its instructions and you'll be all set.

If you're using Docker, do these steps to the host, not to the container!

Debugging with hal-fuzz

Found a crash? Great! You can track it down with the provided tools.

As a first step, the -d, -t, and -M options above might be all you need -- they'll quickly tell you where in the binary the crash occured, and a quick trace of how the culprit data got there.

If you need anything beyond that, such as single-stepping through the binary, you can do this via the new SparklyUnicorn(tm) debugger. Just pass -b followed by an address, and you'll be dropped into an ipdb shell, with the binary halted. (NOTE: at this time, Unicorn only lets us break on the first instruction in a basic block! This is the price we pay for performance)

Once your breakpoint is hit, you're left with the Unicorn object itself (uc), which has been instrumented with many new features (it's sparkly!).

  • Stepping: Typing "uc.step()" will single-step the binary. Want a live stack or register view? Try "uc.step; uc.regs; uc.stack". ipdb lets you simply repeatedly press enter to repeat the last command, giving you GDB-like convenience.

  • Registers: Typing "uc.regs" produces a register view. You can read and write the reigsters using uc.regs.register, like "uc.regs.r0 = 0".

  • Stack: Similarly, uc.stack produces a stack view, annotated with points-to register information. You can expand this using uc.stack.pp(start_offset, end_offset), or slice it for the raw data, as uc.stack[-4:16]

  • Memory: As with the stack, memory is available at uc.mem, and can be sliced to read and write the emulator's memory.

  • Breakpoints: You can control breakpoints using add_breakpoint() and remove_breakpoint()

TODOs / Limitations / Help Wanted / Roadmap

hal-fuzz is a research prototype. While we feel it's extremely useful as-is, there are many rough edges to be worked on, which we look forward to addressing.

Here's an (incomplete) list:

  • Multiple architectures: We only support M-profile ARM CPUs at this time, since that's all we had in our evaluation. I have left TODOs in the code where things would need to be chnaged to fix this, and Unicorn itself supports a number of architectures, so there's no reason this couldn't be implemented given some time. Note that, very sadly, Cortex-M4F CPUs are NOT supported due to missing FPU support; this is a generic limitation that QEMU itself is still in the process of solving, and it will take an indeterminate amount of time for this to trickle down to Unicorn.

  • Integrate angr's archinfo and cle: As part of the above, we should use archinfo to abstract architecture-dependent stuff. This includes, but is not limited to: the "return" instruction, register information, calling conventions, various kinds of endness, and so on. CLE would provide us instant support for numerous binary formats, particularly to cover the situation where you're compiling your own firmware and have more than just a blob. Still, CLE also has support for loading blobs, even automatically, using plugins.

  • Modernize Handlers: The way we write handlers changed a few times during hal-fuzz's development to make things easier, such as the creation of faux-terrupts, and SparklyUnicorn. This would dramatically cut down in the ugliness of handler code, and make implementation even easier for the analyst. Using some kind of type or calling-convention information would be the ultimate in handler creation, and could allow for semi-automation of the process.

You can’t perform that action at this time.