Skip to content

Latest commit

 

History

History
74 lines (52 loc) · 2.92 KB

README.md

File metadata and controls

74 lines (52 loc) · 2.92 KB
Raw

golang-fuzz

A tool for generating, building and running fuzzing tests for various fuzzing engines using a standard format, without affecting fuzzing performance. No need to implement different types of Fuzz functions. The following fuzzing engines are supported:

The Fuzz function

In order to use golang-fuzz to generate and build your fuzz tests, you will need to create an exported fuzzing function in your package. The name of this function should be formatted as FuzzXxx.

Note that, unlike a native fuzzing function, this function should not be placed in a test file (_test.go) and should only have one parameter. This parameter should be a type that is supported by the native Go fuzzing engine (https://go.dev/security/fuzz/).

A Fuzz function can be implemented as follows:

func Fuzz(data []byte) int { // data can be any type supported by the native Go fuzzing engine
    // Your test logic goes here
    // ...

    /*
    The fuzz function should return an integer. This can be different than 0 to improve fuzzing performance.
    Returning 0 means that the input is accepted and may be added to the corpus.
    Returning -1 will cause libFuzzer or go-fuzz to not add that input to the corpus, regardless of coverage.
    Returning 1 will cause go-fuzz to increase priority of the given input.
    Fuzzing engines that do not support the returning value will treat it the same as returning 0.
    */
    return 0
}

See the example folder for a fuzzing test example.

Usage

To use golang-fuzz, run the following command:

golang-fuzz [options] PACKAGE_PATH [run_args]

Where PACKAGE_PATH is the path to the Go package containing the Fuzz function.

Options

The following options are available:

  • -func: the name of the Fuzz function (default: "Fuzz")
  • -run: run fuzzer after building
  • -corpus: the corpus directory (optional) (default: "corpus")
  • -keep: keep generated fuzz file (always true for native)
  • -x: print the commands
  • -o: output file
  • -v: show verbose output

Fuzzing engines:

  • -native: generate native Go fuzzing test to run with go test -fuzz
  • -libfuzzer: build libFuzzer binary
  • -gofuzz: build go-fuzz binary
  • -afl: build AFL++ binary
  • -all: build all supported fuzzing engines

Build flag options:

  • -<fuzzer>.list: list build flags
  • -<fuzzer>.flags: additional build flags
  • -libfuzzer.clangflags: clang build flags (default: "-g -O1 -fsanitize=fuzzer")

Notes

  • Package main is not supported by go-fuzz.