History

Nick Terrell e68db76b4b Update .gitignore		2019-11-20 16:36:40 -08:00
..
.gitignore	Update .gitignore	2019-11-20 16:36:40 -08:00
block_decompress.c	[Fuzz] Improve data generation #1723	2019-09-10 16:14:43 -07:00
block_round_trip.c	[fuzz] Fix leak in block_round_trip	2019-09-13 10:32:38 -07:00
dictionary_decompress.c	Use range instead of the generic uint32 method to use less bytes when generating necessary numbers.	2019-09-12 12:40:12 -07:00
dictionary_loader.c	[fuzz] Add dictionary_loader fuzzer	2019-11-01 15:54:24 -07:00
dictionary_round_trip.c	Fix more merge conflicts	2019-11-05 15:54:05 -05:00
fuzz_data_producer.c	Use range instead of the generic uint32 method to use less bytes when generating necessary numbers.	2019-09-12 12:40:12 -07:00
fuzz_data_producer.h	Update tests/fuzz/fuzz_data_producer.h	2019-09-12 12:45:28 -07:00
fuzz_helpers.h	It's time for all of rng seed code to go. Goodbye	2019-09-12 13:10:34 -07:00
fuzz.h	It's time for all of rng seed code to go. Goodbye	2019-09-12 13:10:34 -07:00
fuzz.py	[fuzz] Add dictionary_loader fuzzer	2019-11-01 15:54:24 -07:00
Makefile	Fix 2 bugs in dictionary loading	2019-11-01 16:52:07 -07:00
README.md	[Fuzz] Improve data generation #1723	2019-09-09 08:43:22 -07:00
regression_driver.c	[fuzz] Add a DEBUGLOG(3) statement to print file	2019-08-22 17:27:15 -07:00
simple_compress.c	Use range instead of the generic uint32 method to use less bytes when generating necessary numbers.	2019-09-12 12:40:12 -07:00
simple_decompress.c	Combining fuzz_data_producer restrict calls into a single function	2019-09-11 10:09:29 -07:00
simple_round_trip.c	Fix more merge conflicts	2019-11-05 15:54:05 -05:00
stream_decompress.c	Use range instead of the generic uint32 method to use less bytes when generating necessary numbers.	2019-09-12 12:40:12 -07:00
stream_round_trip.c	[fuzz] Increase output buffer size of stream_round_trip	2019-10-18 13:39:08 -07:00
zstd_frame_info.c	All tests should give some portion of data to the producer and use the rest.	2019-09-10 16:52:38 -07:00
zstd_helpers.c	Fix FUZZ_rand32() bug	2019-11-05 16:43:24 -05:00
zstd_helpers.h	Use range instead of the generic uint32 method to use less bytes when generating necessary numbers.	2019-09-12 12:40:12 -07:00

README.md

Fuzzing

Each fuzzing target can be built with multiple engines. Zstd provides a fuzz corpus for each target that can be downloaded with the command:

make corpora

It will download each corpus into ./corpora/TARGET.

fuzz.py

fuzz.py is a helper script for building and running fuzzers. Run ./fuzz.py -h for the commands and run ./fuzz.py COMMAND -h for command specific help.

Generating Data

fuzz.py provides a utility to generate seed data for each fuzzer.

make -C ../tests decodecorpus
./fuzz.py gen TARGET

By default it outputs 100 samples, each at most 8KB into corpora/TARGET-seed, but that can be configured with the --number, --max-size-log and --seed flags.

Build

It respects the usual build environment variables CC, CFLAGS, etc. The environment variables can be overridden with the corresponding flags --cc, --cflags, etc. The specific fuzzing engine is selected with LIB_FUZZING_ENGINE or --lib-fuzzing-engine, the default is libregression.a. Alternatively, you can use Clang's built in fuzzing engine with --enable-fuzzer. It has flags that can easily set up sanitizers --enable-{a,ub,m}san, and coverage instrumentation --enable-coverage. It sets sane defaults which can be overridden with flags --debug, --enable-ubsan-pointer-overflow, etc. Run ./fuzz.py build -h for help.

Running Fuzzers

./fuzz.py can run libfuzzer, afl, and regression tests. See the help of the relevant command for options. Flags not parsed by fuzz.py are passed to the fuzzing engine. The command used to run the fuzzer is printed for debugging.

LibFuzzer

# Build the fuzz targets
./fuzz.py build all --enable-fuzzer --enable-asan --enable-ubsan --cc clang --cxx clang++
# OR equivalently
CC=clang CXX=clang++ ./fuzz.py build all --enable-fuzzer --enable-asan --enable-ubsan
# Run the fuzzer
./fuzz.py libfuzzer TARGET <libfuzzer args like -jobs=4>

where TARGET could be simple_decompress, stream_round_trip, etc.

MSAN

Fuzzing with libFuzzer and MSAN is as easy as:

CC=clang CXX=clang++ ./fuzz.py build all --enable-fuzzer --enable-msan
./fuzz.py libfuzzer TARGET <libfuzzer args>

fuzz.py respects the environment variables / flags MSAN_EXTRA_CPPFLAGS, MSAN_EXTRA_CFLAGS, MSAN_EXTRA_CXXFLAGS, MSAN_EXTRA_LDFLAGS to easily pass the extra parameters only for MSAN.

AFL

The default LIB_FUZZING_ENGINE is libregression.a, which produces a binary that AFL can use.

# Build the fuzz targets
CC=afl-clang CXX=afl-clang++ ./fuzz.py build all --enable-asan --enable-ubsan
# Run the fuzzer without a memory limit because of ASAN
./fuzz.py afl TARGET -m none

Regression Testing

The regression test supports the all target to run all the fuzzers in one command.

CC=clang CXX=clang++ ./fuzz.py build all --enable-asan --enable-ubsan
./fuzz.py regression all
CC=clang CXX=clang++ ./fuzz.py build all --enable-msan
./fuzz.py regression all