Crate ziggy

ziggy

ziggy is a fuzzer manager for Rust projects which is built to:

• launch different fuzzers in parallel with a shared corpus
• create and monitor continuous fuzzing pipelines

Feature set

• 🤹 handling of different fuzzing processes in parallel (honggfuzz, AFL++)
• 🗃️ one shared corpus for all fuzzers
• 🤏 effortless corpus minimization
• 📊 insightful monitoring
• 🎯 easy coverage report generation
• 😶‍🌫️ Arbitrary trait support

Features will also include:

• 🐇 LibAFL integration
• 📨 notification of new crashes via bash hook

Usage example

First, install ziggy and its dependencies by running:

cargo install --force ziggy cargo-afl honggfuzz grcov

Here is the output of the tool’s help:

$ cargo ziggy
A multi-fuzzer management utility for all of your Rust fuzzing needs 🧑‍🎤

Usage: cargo ziggy <COMMAND>

Commands:
  build      Build the fuzzer and the runner binaries
  fuzz       Fuzz targets using different fuzzers in parallel
  run        Run a specific input or a directory of inputs to analyze backtrace
  minimize   Minimize the input corpus using the given fuzzing target
  cover      Generate code coverage information using the existing corpus
  plot       Plot AFL++ data using afl-plot
  add-seeds  Add seeds to the running AFL++ fuzzers
  triage     Triage crashes found with casr - currently only works for AFL++
  help       Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

To create a fuzzer, simply add ziggy as a dependency.

[dependencies]
ziggy = { version = "1.2", default-features = false }

Then use the fuzz! macro inside your main to create a harness.

fn main() {
    ziggy::fuzz!(|data: &[u8]| {
        println!("{data:?}");
    });
}

For a well-documented fuzzer, see the url example.

The output directory

After you’ve launched your fuzzer, you’ll find a couple of items in the output directory:

• the corpus directory containing the full corpus
• the crashes directory containing any crashes detected by the fuzzers
• the logs directory containing a fuzzer log files
• the afl directory containing AFL++’s output
• the honggfuzz directory containing Honggfuzz’s output
• the queue directory that is used by ziggy to pass items from AFL++ to Honggfuzz

Note about coverage

The cargo cover command will not generate coverage for the dependencies of your fuzzed project by default.

If this is something you would like to change, you can use the following trick:

CARGO_HOME=.cargo cargo ziggy cover 

This will clone every dependency into a .cargo directory and this directory will be included in the generated coverage.

ziggy logs

If you want to see ziggy’s internal logs, you can set RUST_LOG=INFO.

Macros

• fuzz
  Fuzz a closure-like block of code by passing an object of arbitrary type.