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

Update README.md

This commit is contained in:
inferno-chromium 2016-11-30 08:26:02 -08:00 committed by GitHub
parent efe15ead8a
commit 832d367b37
1 changed files with 18 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
infra/base-images/base-libfuzzer/README.md
View File

@ -1,7 +1,7 @@
# base-libfuzzer
> Abstract base image for libfuzzer builders.
Every project image supports multiple commands that can be invoked through docker after building the image:
Every project image supports multiple commands that can be invoked through docker after the image is built:
<pre>
docker run --rm -ti ossfuzz/<b><i>$project</i></b> <i>&lt;command&gt;</i> <i>&lt;arguments...&gt;</i>
@ -11,36 +11,35 @@ docker run --rm -ti ossfuzz/<b><i>$project</i></b> <i>&lt;command&gt;</i> <i>&lt
| Command | Description |
|---------|-------------|
| `compile` (default) | build all fuzzers
| `reproduce <fuzzer_name> <fuzzer_options>` | build all fuzzers and run specified one with `/testcase` content.
| `run <fuzzer_name> <fuzzer_options...>` | build all fuzzers and run specified one with given options.
| `compile` (default) | build all fuzz targets
| `reproduce <fuzzer_name> <fuzzer_options>` | build all fuzz targets and run specified one with testcase `/testcase` and given options.
| `run <fuzzer_name> <fuzzer_options...>` | build all fuzz targets and run specified one with given options.
| `/bin/bash` | drop into shell, execute `compile` script to start build.
# Examples
- *reproduce an issue using the latest OSS-Fuzz build:*
- *Reproduce using latest OSS-Fuzz build:*
<pre>
docker run --rm -ti -v <b><i>$testcase_file</i></b>:/testcase ossfuzz/<b><i>$project</i></b> reproduce <b><i>$fuzzer</i></b>
</pre>
- *reproduce using the local source code:*
- *Reproduce using local source checkout:*
<pre>
docker run --rm -ti -v <b><i>$project_checkout_dir</i></b>:/src/<b><i>$project</i></b> \
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>
</pre>
# Image Files Layout
| Location | Description |
| -------- | ---------- |
| `/out/` (`$OUT`) | build artifacts should be copied here |
| `/src/` (`$SRC`) | place to checkout source files |
| `/work/`(`$WORK`) | used to store intermediate files |
| `/usr/lib/libfuzzer.a` | libfuzzer static library |
| `/out/` (`$OUT`) | Directory to store build artifacts (fuzz targets, dictionaries, options files, seed corpus archives). |
| `/src/` (`$SRC`) | Directory to checkout source files |
| `/work/`(`$WORK`) | Directory for storing intermediate files |
| `/usr/lib/libfuzzer.a` | Location of prebuilt libFuzzer library that needs to be linked into all fuzz targets (`-lfuzzer`). |
While files layout is fixed within a container, `$SRC`, `$OUT`, `$WORK` are
provided to be able to write retargetable scripts.
@ -48,7 +47,7 @@ provided to be able to write retargetable scripts.
## Compiler Flags
You *must* use special compiler flags to build your project and fuzzers.
You *must* use special compiler flags to build your project and fuzz targets.
These flags are provided in following environment variables:
| Env Variable | Description
@ -58,17 +57,17 @@ These flags are provided in following environment variables:
| `$CFLAGS` | C compiler flags.
| `$CXXFLAGS` | C++ compiler flags.
Many well-crafted build scripts will automatically use these variables. If not,
passing them manually to a build tool might be required.
Most well-crafted build scripts will automatically use these variables. If not,
pass them manually to the build tool.
# Child Image Interface
## Sources
Child image has to checkout all sources it needs to compile fuzzers into
`$SRC` directory. When the image is executed, a directory could be mounted
on top of these with local checkouts using
Child image has to checkout all sources that it needs to compile fuzz targets into
`$SRC` directory. When the image is executed, a directory could be mounted on top
of these with local checkouts using
`docker run -v $HOME/my_project:/src/my_project ...`.
## Other Required Files
@ -77,4 +76,4 @@ Following files have to be added by child images:
| File Location | Description |
| ------------- | ----------- |
| `$SRC/build.sh` | build script to build the project and its fuzzers |
| `$SRC/build.sh` | build script to build the project and its fuzz targets |