Add READMEs
This commit is contained in:
parent
934eb7a22d
commit
95c22f569a
2 changed files with 26 additions and 0 deletions
23
fuzz/README.md
Normal file
23
fuzz/README.md
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
# Fuzzing
|
||||
|
||||
This folder contains a Cargo package for a fuzz target that can be used for fuzzing with [american fuzzy lop](https://github.com/google/AFL). Fuzzing has found many rare bugs and unhandled edge cases that cause crashes and is invaluable for improving the reliability of hyperbuild.
|
||||
|
||||
## Inputs
|
||||
|
||||
Initial inputs can be found in the [in](./in) folder.
|
||||
|
||||
## Building
|
||||
|
||||
```bash
|
||||
cargo afl build
|
||||
```
|
||||
|
||||
## Running
|
||||
|
||||
```bash
|
||||
cargo afl fuzz -i in -o out target/debug/hyperbuild-fuzz-target
|
||||
```
|
||||
|
||||
## Results
|
||||
|
||||
Inputs that cause a crash are found in the `out/crashes` folder.
|
||||
Reference in a new issue