https://github.com/angr/phuzzer

The new phuzzing framework!
https://github.com/angr/phuzzer

Last synced: about 1 month ago
JSON representation

The new phuzzing framework!

• Host: GitHub
• URL: https://github.com/angr/phuzzer
• Owner: angr
• License: bsd-2-clause
• Created: 2019-04-30T21:19:23.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-06-14T17:26:14.000Z (6 months ago)
• Last Synced: 2024-11-01T19:36:30.979Z (about 1 month ago)
• Language: Python
• Size: 173 KB
• Stars: 154
• Watchers: 13
• Forks: 24
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• security-study-tutorial - This module provides a Python wrapper for interacting with fuzzers, such as AFL

README

        
# Phuzzer

This module provides a Python wrapper for interacting with fuzzers, such as AFL (American Fuzzy Lop: http://lcamtuf.coredump.cx/afl/).

It supports starting an AFL instance, adding slave workers, injecting and retrieving testcases, and checking various performance metrics.

It is based on the module that Shellphish used in Mechanical Phish (our CRS for the Cyber Grand Challenge) to interact with AFL.

## Installation

/!\ We recommend installing our Python packages in a Python virtual environment. That is how we do it, and you'll likely run into problems if you do it otherwise.

The fuzzer has some dependencies.

First, here's a probably-incomplete list of debian packages that might be useful:

    sudo apt-get install build-essential gcc-multilib libtool automake autoconf bison debootstrap debian-archive-keyring libtool-bin

    sudo apt-get build-dep qemu

Then, the fuzzer also depends on a few modules: `shellphish-afl`, `driller` and `tracer`.

    pip install git+https://github.com/shellphish/shellphish-afl

    pip install git+https://github.com/shellphish/driller

    pip install git+https://github.com/angr/tracer

    

That'll pull a ton of other stuff, compile qemu about 4 times, and set everything up.

Then, install this fuzzer wrapper:

    pip install git+https://github.com/angr/phuzzer

## Usage

There are two ways of using this package.

The easy way is to use the `shellphuzz` script, which allows you to specify various options, enable [driller](https://sites.cs.ucsb.edu/~vigna/publications/2016_NDSS_Driller.pdf), etc.

The script has explanations about its usage with `--help`.

A quick example:

```

# fuzz with 4 AFL cores

python -m phuzzer -i -c 4 /path/to/binary

# perform symbolic-assisted fuzzing with 4 AFL cores and 2 symbolic tracing (drilling) cores.

python -m phuzzer -i -c 4 -d 2 /path/to/binary

```

You can also use it programmatically, but we have no documentation for that.

For now, `import fuzzer` or look at the shellphuz script and figure it out ;-)