oss-fuzz/README.md at 7d492166664198de6d79e5544a09f4275f99db82

This directory contains an example software project that has most of the traits of ideal support for fuzzing.

Files in my-api-repo

Imagine that these files reside in your project's repository:

my_api.h: and my_api.cpp implement the API we want to test/fuzz. The function DoStuff() inside my_api.cpp contains a bug. (Find it!)
do_stuff_unittest.cpp: is a unit test for DoStuff(). Unit tests are not necessary for fuzzing but are generally a good practice.
do_stuff_fuzzer.cpp: is a fuzz target for DoStuff().
do_stuff_test_data: corpus directory for do_stuff_fuzzer.cpp.
do_stuff_fuzzer.dict: a fuzzing dictionary file for DoStuff(). Optional, but may improve fuzzing in many cases.
Makefile: is a build file (the same can be done with other build systems):
- accepts external compiler flags via $CC, $CXX, $CFLAGS, $CXXFLAGS
- accepts external fuzzing engine via $LIB_FUZZING_ENGINE, by default uses standalone_fuzz_target_runner.cpp
- builds the fuzz target(s) and their corpus archive(s)
- make check executes do_stuff_fuzzer.cpp on do_stuff_test_data/*, thus ensures that the fuzz target is up to date and uses it as a regression test.
standalone_fuzz_target_runner.cpp: is a simple standalone runner for fuzz targets. You may use it to execute a fuzz target on given files w/o having to link in libFuzzer or other fuzzing engine.

oss-fuzz/projects/example
- Dockerfile: sets up the build environment
- build.sh: builds the fuzz target(s). The smaller this file the better (most of the logic should be inside the project's build system).
- project.yaml: short project description and contact info.