9eee25479b | ||
---|---|---|
docs | ||
infra | ||
targets | ||
.gitignore | ||
CONTRIBUTING | ||
LICENSE | ||
README.md |
README.md
OSS-Fuzz - continuous fuzzing of open source software
Status: Beta. We are preparing the project for public release. We are polishing the documentation and the process.
FAQ | Ideal Fuzzing Integration | New Target Guide | Reproducing Bug Reports | All Targets | Targets issue tracker
Create New Issue for questions or feedback.
Why OSS-Fuzz?
Fuzz testing is a well-known technique for uncovering various kinds of programming errors in software. Many detectable errors (e.g. buffer overruns) have real security implications.
We successfully deployed guided in-process fuzzing of Chrome components and now want to share the experience and the service with the openssource community.
OSS-Fuzz aims to make common open source software more secure by combining modern fuzzing techniques and scalable distributed execution.
At the first stage of the project we use libFuzzer with Sanitizers. More fuzzing engines will be added later. ClusterFuzz provides distributed fuzzer execution environment and reporting.
Process Overview
The following process is used for targets in OSS-Fuzz:
- A maintainer of an opensource project or an outside volunteer creates one or more Fuzz Target and integrates it with the project's build and test system.
- These targets are accepted to OSS-Fuzz.
- When ClusterFuzz finds a bug, an issue is automatically reported in the OSS-Fuzz issue tracker (example). (Why different tracker?). Project owners are CC-ed to the bug report.
- The bug is fixed upstream.
- ClusterFuzz automatically verifies the fix, adds a comment and closes the issue.
- 7 days after the fix is verified or after 90 days after reporting, the issue becomes public (exact guidelines).
Accepting New Targets
In order to be accepted to OSS-Fuzz, an open-source target must have a significant user base and/or be critical to the global IT infrastructure.
To submit a new target to OSS-Fuzz:
- create a pull request with a change to targets/README.md providing the following information:
- target home site and details
- source code repository location
- a link to target security issue reporting process OR
- an e-mail of the engineering contact person to be CCed on issue. This has to be an e-mail linked to a Google Account that belongs to an established target committer (according to VCS logs). If this is not you or address differs from VCS, an informal e-mail verification will be required. This e-mail will also be publicly listed in our Targets page.
- once accepted by an OSS-Fuzz project member, follow the New Target Guide to write the code.
Bug Disclosure Guidelines
Following Google's standard disclosure policy OSS-Fuzz will adhere to following disclosure principles:
- 90-day deadline. After notifying target authors, we will open reported issues in 90 days, or 7 days after the fix is released.
- Weekends and holidays. If a deadline is due to expire on a weekend or US public holiday, the deadline will be moved to the next normal work day.
- Grace period. We will have a 14-day grace period. If a 90-day deadline will expire but upstream engineers let us know before the deadline that a patch is scheduled for release on a specific day within 14 days following the deadline, the public disclosure will be delayed until the availability of the patch.
More Documentation
- New Target Guide walks through steps necessary to add new targets to OSS-Fuzz.
- Ideal Integration describes the ideal way to integrate fuzz targets with your project.
- Running and Building Fuzzers documents the process for fuzzers that are part of target source code repository.
- Running and Building External Fuzzers documents the process for fuzzers that are part of OSS-Fuzz source code repository.
- Fuzzer execution environment documents the environment under which your fuzzers will be run.
- Targets List lists OSS targets added to OSS-Fuzz.
- Chrome's Efficient Fuzzer Guide while contains some chrome-specifics, is an excellent documentation on making your fuzzer better.
Build status
This page gives the latest build logs for each target.
Trophies
This page gives a list of publically viewable (fixed) bugs found by OSS-Fuzz.