Skip to content

Latest commit

 

History

History
66 lines (55 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

66 lines (55 loc) · 2.32 KB

Contributing

Building from Source (Linux / macOS)

Prerequisites

Ubuntu / Debian

sudo apt install git make golang-go

Arch

sudo pacman -S git make go

macOS

brew install git make go

Steps

To build gofuzz from source you have to execute the following steps:

git clone https://github.com/CodeIntelligenceTesting/gofuzz.git
cd gofuzz
make test
make build

If everything went fine, you will find the newly created directory ./build/bin which includes the gofuzz CLI.

Adding new bug detectors

Bug detectors implement the Detector interface.

type Detector interface {
    Detect() error
}

The Detect function performs checks to detect specific classes of bugs and returns specialized errors representing the found bugs. The function can also guide the fuzzer towards producing interesting inputs that trigger the bugs of interest. You can have a look at the existing bug detectors. for more details.

Dependencies of the sanitizers package

ALL transitive dependencies of the sanitizers package must be excluded from instrumentation by gofuzz. Failing to do so may result in import cycles and thus can cause build failures. A possible scenario of this would be when a dependency foo calls a function/method for which the sanitizers package provides a hook. In this case, sanitizers imports foo which in turn would import sanitizers if instrumented. As a rule of thumb, make sure to keep the dependencies of the sanitizers package to the bare minimum.

Guiding the fuzzer

Bug detectors often look for certain patterns in the arguments passed to the hooked functions or methods. To work effectively, they can provide hints to the fuzzer so that it produces inputs containing these patterns. The fuzzer provides an API to achieve that. It has the following functions:

  • GuideTowardsEquality guides the fuzzer to produce a string that is equal to a target string.
  • GuideTowardsContainment guides the fuzzer to produce a string containing a target string.