2016-11-16 17:56:10 +00:00
# Reproducing OSS-Fuzz issues
2016-10-26 16:40:37 +00:00
2016-11-19 01:20:49 +00:00
You've been CC'ed on an OSS-Fuzz issue
2016-11-21 21:32:02 +00:00
([examples](https://bugs.chromium.org/p/oss-fuzz/issues/list?can=1& q=Type%3ABug%2CBug-Security)), now what?
2016-11-23 17:47:53 +00:00
Before attempting to fix the bug, you should be able to reliably reproduce it.
2016-10-27 03:48:30 +00:00
2016-11-21 21:22:34 +00:00
Every issue has a reproducer (aka "testcase") file attached.
2016-11-21 21:40:43 +00:00
Download it. If the issue is not public, you will need to login using your
[Google account ](https://support.google.com/accounts/answer/176347?hl=en )
that the bug report CCs.
2016-11-19 01:18:02 +00:00
This file contains the bytes that were fed to the [Fuzz Target ](http://libfuzzer.info/#fuzz-target ).
2016-11-23 17:47:53 +00:00
If you have already [integrated ](ideal_integration.md ) the fuzz target with your build and test system,
2016-11-21 21:40:43 +00:00
all you do is run:
2016-11-23 17:47:53 +00:00
< pre >
./fuzz_target_binary < b > < i > $testcase_file< / i > < / b >
< / pre >
2016-11-27 02:15:25 +00:00
Depending on the nature of the bug, the fuzz target binary needs to be built with the appropriate [sanitizer ](https://github.com/google/sanitizers )
2016-11-19 01:18:02 +00:00
(e.g. if this is a buffer overflow, with [AddressSanitizer ](http://clang.llvm.org/docs/AddressSanitizer.html )).
2016-11-21 21:21:11 +00:00
If you are not sure how to build the fuzzer using the project's build system,
2016-11-23 17:47:53 +00:00
you may also use Docker ([how?](installing_docker.md), [why? ](faq.md#why-do-you-use-docker )) commands
to replicate the exact build steps used by OSS-Fuzz and then feed the reproducer input to the fuzz target.
2016-10-26 16:40:37 +00:00
2016-11-23 17:47:53 +00:00
- *Reproduce using latest OSS-Fuzz build:*
2016-10-26 18:04:46 +00:00
2016-10-26 21:59:27 +00:00
< pre >
2016-11-29 19:14:04 +00:00
docker run --rm -ti -v < b > < i > $testcase_file< / i > < / b > :/testcase ossfuzz/< b > < i > $project< / i > < / b > reproduce < b > < i > $fuzzer< / i > < / b >
2016-10-26 21:59:27 +00:00
< / pre >
2016-10-26 18:04:46 +00:00
2016-11-27 02:15:25 +00:00
It builds the fuzzer from the most recent successful OSS-Fuzz build (usually last night's sources)
2016-11-21 21:25:39 +00:00
and feeds the testcase file to the target function.
2016-11-29 19:14:04 +00:00
E.g. for [libxml2 ](../target/libxml2 ) project with fuzzer named `libxml2_xml_read_memory_fuzzer` , it will be:
2016-10-26 21:13:17 +00:00
2016-10-26 22:10:58 +00:00
< pre >
2016-10-27 03:40:55 +00:00
docker run --rm -ti -v < b > < i > ~/Downloads/testcase< / i > < / b > :/testcase ossfuzz/< b > < i > libxml2< / i > < / b > reproduce < b > < i > libxml2_xml_read_memory_fuzzer< / i > < / b >
2016-10-26 22:10:58 +00:00
< / pre >
2016-11-23 17:47:53 +00:00
- *Reproduce using local source checkout:*
2016-10-26 18:04:46 +00:00
2016-10-27 03:40:55 +00:00
< pre >
2016-11-29 19:14:04 +00:00
docker run --rm -ti -v < b > < i > $local_source_checkout_dir< / i > < / b > :/src/< b > < i > $project< / i > < / b > \
-v < b > < i > $testcase_file< / i > < / b > :/testcase ossfuzz/< b > < i > $project< / i > < / b > reproduce < b > < i > $fuzzer< / i > < / b >
2016-10-27 03:40:55 +00:00
< / pre >
2016-10-26 18:04:46 +00:00
2016-11-19 02:54:10 +00:00
This is essentially the previous command that additionally mounts local sources into the running container.
2016-11-27 02:15:25 +00:00
- *Fix issue*. Write a patch to fix the issue in your local checkout and then use the previous command to verify the fix (i.e. no crash occurred).
2016-11-02 19:43:54 +00:00
[Use gdb ](debugging.md#debugging-fuzzers-with-gdb ) if needed.
2016-11-29 19:14:04 +00:00
- *Submit fix*. Submit the fix in the project's repository. ClusterFuzz will automatically pick up the changes, recheck the testcase and will close the issue (in < 1 day).
2016-11-23 17:47:53 +00:00
- *Improve fuzzing support*. Consider [improving fuzzing support ](ideal_integration.md ) in your project's build and test system.