Rooba
/
oss-fuzz
mirror of https://github.com/google/oss-fuzz.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
oss-fuzz/docs/index.md

69 lines
2.9 KiB
Markdown
Raw Normal View History

Add jekyll generator for docs. (#2660) * Add jekyll generator for docs. * Add content for index.md
2019-08-06 20:29:19 +00:00
---
layout: default
title: OSS-Fuzz
permalink: /
nav_order: 1
has_children: true
[Docs] Clarify fuzzing process and new projects procedure (#2673)
2019-08-09 19:24:43 +00:00
has_toc: false
Add jekyll generator for docs. (#2660) * Add jekyll generator for docs. * Add content for index.md
2019-08-06 20:29:19 +00:00
---
# OSS-Fuzz
Delete unnecessary files and fix format in some MD pages (#4115) * style: Clean up the repo * Bolster the `.gitignore` * Follow `CONTRIBUTING.md` guidelines and wrap `README.md` to 80 characters and seperate links for readability * Remove pesky Unicode dash in `CONTRIBUTING.md` * Remove `.DS_STORE` files * Rename `#project.yaml#` to something logical and enable stntax highlighting * Updates from reviewers * Greatly reduce `.gitignore` to only macOS `.DS_Store` and Vim temporary files * Apply markdown style to `docs/index.md` * small comma grammatical change * http -> https
2020-07-16 22:27:29 +00:00
[Fuzz testing] is a well-known technique for uncovering programming errors in
software. Many of these detectable errors, like [buffer overflow], can have
serious security implications. Google has found [thousands] of security
vulnerabilities and stability bugs by deploying [guided in-process fuzzing of
Chrome components], and we now want to share that service with the open source
community.
[Fuzz testing]: https://en.wikipedia.org/wiki/Fuzz_testing
[buffer overflow]: https://en.wikipedia.org/wiki/Buffer_overflow
[docs] Change "hundreds of bugs" to "thousands of bugs" :) (#2674) * [docs] Change "hundreds of bugs" to "thousands of bugs" :) * include AFL crashes too
2019-08-09 19:35:14 +00:00
[thousands]: https://bugs.chromium.org/p/chromium/issues/list?q=label%3AStability-LibFuzzer%2CStability-AFL%20-status%3ADuplicate%2CWontFix&can=1
Delete unnecessary files and fix format in some MD pages (#4115) * style: Clean up the repo * Bolster the `.gitignore` * Follow `CONTRIBUTING.md` guidelines and wrap `README.md` to 80 characters and seperate links for readability * Remove pesky Unicode dash in `CONTRIBUTING.md` * Remove `.DS_STORE` files * Rename `#project.yaml#` to something logical and enable stntax highlighting * Updates from reviewers * Greatly reduce `.gitignore` to only macOS `.DS_Store` and Vim temporary files * Apply markdown style to `docs/index.md` * small comma grammatical change * http -> https
2020-07-16 22:27:29 +00:00
[guided in-process fuzzing of Chrome components]: https://security.googleblog.com/2016/08/guided-in-process-fuzzing-of-chrome.html
Update docs, add python support. (#4878)
2020-12-21 21:43:26 +00:00
In cooperation with the [Core Infrastructure Initiative] and the [OpenSSF],
OSS-Fuzz aims to make common open source software more secure and stable by
combining modern fuzzing techniques with scalable, distributed execution.
[ClusterFuzzLite] Support local runs (#6987)
2022-01-19 22:24:47 +00:00
Projects that do not qualify for OSS-Fuzz (e.g. closed source) can run their own
instances of [ClusterFuzz] or [ClusterFuzzLite].
Delete unnecessary files and fix format in some MD pages (#4115) * style: Clean up the repo * Bolster the `.gitignore` * Follow `CONTRIBUTING.md` guidelines and wrap `README.md` to 80 characters and seperate links for readability * Remove pesky Unicode dash in `CONTRIBUTING.md` * Remove `.DS_STORE` files * Rename `#project.yaml#` to something logical and enable stntax highlighting * Updates from reviewers * Greatly reduce `.gitignore` to only macOS `.DS_Store` and Vim temporary files * Apply markdown style to `docs/index.md` * small comma grammatical change * http -> https
2020-07-16 22:27:29 +00:00
[Core Infrastructure Initiative]: https://www.coreinfrastructure.org/
Update docs, add python support. (#4878)
2020-12-21 21:43:26 +00:00
[OpenSSF]: https://www.openssf.org/
Delete unnecessary files and fix format in some MD pages (#4115) * style: Clean up the repo * Bolster the `.gitignore` * Follow `CONTRIBUTING.md` guidelines and wrap `README.md` to 80 characters and seperate links for readability * Remove pesky Unicode dash in `CONTRIBUTING.md` * Remove `.DS_STORE` files * Rename `#project.yaml#` to something logical and enable stntax highlighting * Updates from reviewers * Greatly reduce `.gitignore` to only macOS `.DS_Store` and Vim temporary files * Apply markdown style to `docs/index.md` * small comma grammatical change * http -> https
2020-07-16 22:27:29 +00:00
Centipede integration (#8046) * Add Centipede as a fuzzer * Specify dictionary param of Centipede * Update docs * Mark Centipede as experimental * More accurate description * Remove garbage * Simplify code * Move mkdir to dockerfile * Add the weak.c trick * Install deps with Centipede's script & uninstall new deps * Fix doc * Reuse libweak_sancov_stubs.so * Reorganise flags * format * Consistent file type * Reuse the weak references defined in Centipede * Replace the shared library of weak symbols with a static one * Correct the place to call mkdir * Allow 2G of SHM for Centipede * Create dirs in run_fuzzer * Keep Centipede up-to-date * Avoid duplicating Centipede's binary * The params of Centipede and their explanations * The engine info of centipede * Save the target binary (with san) in a subdir of the project * Set the target (with san) dir in check_build * Create the target (with san) first to avoid side-effects * Fic clone * Fix format * Add periods * Fix comments * Fix dirs * Fix parameters * Adding Centipede as a fuzzing engine for Scarecrow * Add CI support * Represent sanitizer with a variable * Remove the unnecessary definition of FUZZER_OUT * Reorganise binary directories * format * A minor note * Present issues with dirs that alread exist * Use os.path.join to join path * Make a function to get the out/ in check build * Reusing existing flags in .bazel * Avoid hardcoding sanitizer, set rss_limit_mb=4096, leave address_space_limit_mb disabled * Better ways to add bazel build options * A better way to add bazel flags * Remove redundant --bazelrc * Better Cohesion * Avoid code duplication * Simplify code * Exit on crash
2022-09-06 02:34:58 +00:00
We support the [libFuzzer], [AFL++], [Honggfuzz], and [Centipede] fuzzing engines in
Delete unnecessary files and fix format in some MD pages (#4115) * style: Clean up the repo * Bolster the `.gitignore` * Follow `CONTRIBUTING.md` guidelines and wrap `README.md` to 80 characters and seperate links for readability * Remove pesky Unicode dash in `CONTRIBUTING.md` * Remove `.DS_STORE` files * Rename `#project.yaml#` to something logical and enable stntax highlighting * Updates from reviewers * Greatly reduce `.gitignore` to only macOS `.DS_Store` and Vim temporary files * Apply markdown style to `docs/index.md` * small comma grammatical change * http -> https
2020-07-16 22:27:29 +00:00
combination with [Sanitizers], as well as [ClusterFuzz], a distributed fuzzer
execution environment and reporting tool.
[docs] Change "hundreds of bugs" to "thousands of bugs" :) (#2674) * [docs] Change "hundreds of bugs" to "thousands of bugs" :) * include AFL crashes too
2019-08-09 19:35:14 +00:00
Delete unnecessary files and fix format in some MD pages (#4115) * style: Clean up the repo * Bolster the `.gitignore` * Follow `CONTRIBUTING.md` guidelines and wrap `README.md` to 80 characters and seperate links for readability * Remove pesky Unicode dash in `CONTRIBUTING.md` * Remove `.DS_STORE` files * Rename `#project.yaml#` to something logical and enable stntax highlighting * Updates from reviewers * Greatly reduce `.gitignore` to only macOS `.DS_Store` and Vim temporary files * Apply markdown style to `docs/index.md` * small comma grammatical change * http -> https
2020-07-16 22:27:29 +00:00
[libFuzzer]: https://llvm.org/docs/LibFuzzer.html
Use afl++ in docs. (#5049)
2021-01-26 23:28:08 +00:00
[AFL++]: https://github.com/AFLplusplus/AFLplusplus
Delete unnecessary files and fix format in some MD pages (#4115) * style: Clean up the repo * Bolster the `.gitignore` * Follow `CONTRIBUTING.md` guidelines and wrap `README.md` to 80 characters and seperate links for readability * Remove pesky Unicode dash in `CONTRIBUTING.md` * Remove `.DS_STORE` files * Rename `#project.yaml#` to something logical and enable stntax highlighting * Updates from reviewers * Greatly reduce `.gitignore` to only macOS `.DS_Store` and Vim temporary files * Apply markdown style to `docs/index.md` * small comma grammatical change * http -> https
2020-07-16 22:27:29 +00:00
[Honggfuzz]: https://github.com/google/honggfuzz
Centipede integration (#8046) * Add Centipede as a fuzzer * Specify dictionary param of Centipede * Update docs * Mark Centipede as experimental * More accurate description * Remove garbage * Simplify code * Move mkdir to dockerfile * Add the weak.c trick * Install deps with Centipede's script & uninstall new deps * Fix doc * Reuse libweak_sancov_stubs.so * Reorganise flags * format * Consistent file type * Reuse the weak references defined in Centipede * Replace the shared library of weak symbols with a static one * Correct the place to call mkdir * Allow 2G of SHM for Centipede * Create dirs in run_fuzzer * Keep Centipede up-to-date * Avoid duplicating Centipede's binary * The params of Centipede and their explanations * The engine info of centipede * Save the target binary (with san) in a subdir of the project * Set the target (with san) dir in check_build * Create the target (with san) first to avoid side-effects * Fic clone * Fix format * Add periods * Fix comments * Fix dirs * Fix parameters * Adding Centipede as a fuzzing engine for Scarecrow * Add CI support * Represent sanitizer with a variable * Remove the unnecessary definition of FUZZER_OUT * Reorganise binary directories * format * A minor note * Present issues with dirs that alread exist * Use os.path.join to join path * Make a function to get the out/ in check build * Reusing existing flags in .bazel * Avoid hardcoding sanitizer, set rss_limit_mb=4096, leave address_space_limit_mb disabled * Better ways to add bazel build options * A better way to add bazel flags * Remove redundant --bazelrc * Better Cohesion * Avoid code duplication * Simplify code * Exit on crash
2022-09-06 02:34:58 +00:00
[Centipede]: https://github.com/google/centipede
Delete unnecessary files and fix format in some MD pages (#4115) * style: Clean up the repo * Bolster the `.gitignore` * Follow `CONTRIBUTING.md` guidelines and wrap `README.md` to 80 characters and seperate links for readability * Remove pesky Unicode dash in `CONTRIBUTING.md` * Remove `.DS_STORE` files * Rename `#project.yaml#` to something logical and enable stntax highlighting * Updates from reviewers * Greatly reduce `.gitignore` to only macOS `.DS_Store` and Vim temporary files * Apply markdown style to `docs/index.md` * small comma grammatical change * http -> https
2020-07-16 22:27:29 +00:00
[Sanitizers]: https://github.com/google/sanitizers
[ClusterFuzz]: https://github.com/google/clusterfuzz
[ClusterFuzzLite] Support local runs (#6987)
2022-01-19 22:24:47 +00:00
[ClusterFuzzLite]: https://google.github.io/clusterfuzzlite/
Add jekyll generator for docs. (#2660) * Add jekyll generator for docs. * Add content for index.md
2019-08-06 20:29:19 +00:00
Add docs for Java/JVM fuzzing (#5298) Related: https://github.com/google/oss-fuzz/issues/5178
2021-03-05 15:22:24 +00:00
Currently, OSS-Fuzz supports C/C++, Rust, Go, Python and Java/JVM code. Other
languages supported by [LLVM] may work too. OSS-Fuzz supports fuzzing x86_64
and i386 builds.
Add jekyll generator for docs. (#2660) * Add jekyll generator for docs. * Add content for index.md
2019-08-06 20:29:19 +00:00
Delete unnecessary files and fix format in some MD pages (#4115) * style: Clean up the repo * Bolster the `.gitignore` * Follow `CONTRIBUTING.md` guidelines and wrap `README.md` to 80 characters and seperate links for readability * Remove pesky Unicode dash in `CONTRIBUTING.md` * Remove `.DS_STORE` files * Rename `#project.yaml#` to something logical and enable stntax highlighting * Updates from reviewers * Greatly reduce `.gitignore` to only macOS `.DS_Store` and Vim temporary files * Apply markdown style to `docs/index.md` * small comma grammatical change * http -> https
2020-07-16 22:27:29 +00:00
[LLVM]: https://llvm.org
Add jekyll generator for docs. (#2660) * Add jekyll generator for docs. * Add content for index.md
2019-08-06 20:29:19 +00:00
[docs] Update the main docs page to mention fuzzing docs. (#3220) * [docs] Update the main docs page to mention fuzzing docs. * Add an FAQ entry too * update the main readme and move the faq question up
2020-01-13 01:14:20 +00:00
## Learn more about fuzzing
Delete unnecessary files and fix format in some MD pages (#4115) * style: Clean up the repo * Bolster the `.gitignore` * Follow `CONTRIBUTING.md` guidelines and wrap `README.md` to 80 characters and seperate links for readability * Remove pesky Unicode dash in `CONTRIBUTING.md` * Remove `.DS_STORE` files * Rename `#project.yaml#` to something logical and enable stntax highlighting * Updates from reviewers * Greatly reduce `.gitignore` to only macOS `.DS_Store` and Vim temporary files * Apply markdown style to `docs/index.md` * small comma grammatical change * http -> https
2020-07-16 22:27:29 +00:00
This documentation describes how to use OSS-Fuzz service for your open source
project. To learn more about fuzzing in general, we recommend reading [libFuzzer
tutorial] and the other docs in [google/fuzzing] repository. These and some
other resources are listed on the [useful links] page.
[docs] Update the main docs page to mention fuzzing docs. (#3220) * [docs] Update the main docs page to mention fuzzing docs. * Add an FAQ entry too * update the main readme and move the faq question up
2020-01-13 01:14:20 +00:00
[google/fuzzing]: https://github.com/google/fuzzing/tree/master/docs
[libFuzzer tutorial]: https://github.com/google/fuzzing/blob/master/tutorial/libFuzzerTutorial.md
Delete unnecessary files and fix format in some MD pages (#4115) * style: Clean up the repo * Bolster the `.gitignore` * Follow `CONTRIBUTING.md` guidelines and wrap `README.md` to 80 characters and seperate links for readability * Remove pesky Unicode dash in `CONTRIBUTING.md` * Remove `.DS_STORE` files * Rename `#project.yaml#` to something logical and enable stntax highlighting * Updates from reviewers * Greatly reduce `.gitignore` to only macOS `.DS_Store` and Vim temporary files * Apply markdown style to `docs/index.md` * small comma grammatical change * http -> https
2020-07-16 22:27:29 +00:00
[useful links]: {{ site.baseurl }}/reference/useful-links/#tutorials
[docs] Update the main docs page to mention fuzzing docs. (#3220) * [docs] Update the main docs page to mention fuzzing docs. * Add an FAQ entry too * update the main readme and move the faq question up
2020-01-13 01:14:20 +00:00
Add jekyll generator for docs. (#2660) * Add jekyll generator for docs. * Add content for index.md
2019-08-06 20:29:19 +00:00
## Trophies
Update index.md
2021-06-06 02:21:15 +00:00
As of June 2021, OSS-Fuzz has found over [30,000] bugs in [500] open source
Delete unnecessary files and fix format in some MD pages (#4115) * style: Clean up the repo * Bolster the `.gitignore` * Follow `CONTRIBUTING.md` guidelines and wrap `README.md` to 80 characters and seperate links for readability * Remove pesky Unicode dash in `CONTRIBUTING.md` * Remove `.DS_STORE` files * Rename `#project.yaml#` to something logical and enable stntax highlighting * Updates from reviewers * Greatly reduce `.gitignore` to only macOS `.DS_Store` and Vim temporary files * Apply markdown style to `docs/index.md` * small comma grammatical change * http -> https
2020-07-16 22:27:29 +00:00
projects.
Add jekyll generator for docs. (#2660) * Add jekyll generator for docs. * Add content for index.md
2019-08-06 20:29:19 +00:00
Update index.md
2021-06-06 02:21:15 +00:00
[30,000]: https://bugs.chromium.org/p/oss-fuzz/issues/list?q=-status%3AWontFix%2CDuplicate%20-component%3AInfra&can=1
[500]: https://github.com/google/oss-fuzz/tree/master/projects
Update docs, add python support. (#4878)
2020-12-21 21:43:26 +00:00