oss-fuzz/docs/reproducing.md

42 lines
1.7 KiB
Markdown
Raw Normal View History

2016-10-26 16:40:37 +00:00
# Reproducing oss-fuzz issues
You've been CC'ed on an oss-fuzz issue, now what? Before attempting a fix you should be able to reliably reproduce an issue.
It is much simpler if you have Docker installed ([how?](installing_docker.md), [why?](faq.md#why-do-you-use-docker)), but
is entirely possible to do without.
## Docker-based
Follow these steps:
2016-10-26 18:04:46 +00:00
- *Download testcase.* Each issue has a minimized testcase link. Download the testcase to a file.
- *Reproduce from nightly sources.* Run:
```bash
docker run --rm -v <testcase_file>:/testcase -t ossfuzz/<target> reproduce <fuzzer>`
```
It builds the fuzzer from nightly sources (in the image) and runs it with reproducer input.
- *Reproduce with local sources.* Run:
```bash
docker run --rm -v <local_sources>:/src/target_src -v <reproducer_file>:/testcase -t ossfuzz/<target> reproduce <fuzzer>
```
2016-10-26 18:05:14 +00:00
This is essentialy the previous command that addionally mounts local sources into the running container.
- *Fix the issue.* Use the previous command to verify you fixed the issue locally.
2016-10-26 18:48:51 +00:00
- *Submit the fix.* Clusterfuzz will automatically pick up the changes, recheck the testcase
2016-10-26 18:04:46 +00:00
and will close the issue.
2016-10-26 18:09:34 +00:00
## Manual
Manual process is documented on main [libFuzzer page](http://llvm.org/docs/LibFuzzer.html).
To manully reproduce the issue you have to:
- fetch the toolchain: http://llvm.org/docs/LibFuzzer.html#versions.
- build the target with toolchain and sanitizer: http://llvm.org/docs/LibFuzzer.html#building.
2016-10-26 18:09:55 +00:00
- build the fuzzer from target-related code in [targets/](../targets/).
2016-10-26 18:48:51 +00:00
- run the fuzzer on downloaded testcase
- develop a fix and submit it upstream
Clusterfuzz will automatically pick up the changes, recheck the testcase and will close the issue.