SYS-OSS/FRET-LibAFL
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

more reworked docs

Browse Source
This commit is contained in:
Dominik Maier 2021-04-23 05:45:46 +02:00
parent 16f0e2cc05
commit 1a033406e7
2 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/src/getting_started/build.md
View File

@ -6,19 +6,20 @@ LibAFL, as most of the Rust projects, can be built using `cargo` from the root d
$ cargo build --release
```
Note that the `--release` flag is optional for development, but it is needed for fuzzing at a decent speed,
otherwise you will experience a slowdown of even more than 10x.
Note that the `--release` flag is optional for development, but you needed to add it to fuzzing at a decent speed.
Slowdowns of 10x or more are not uncommon for Debug builds.
The LibAFL repository is composed by multiple crates, and the top-level Cargo.toml is just an orchestrator that groups these crates
in a workspace. Building from the root directory will build all the crates in the workspace.
The LibAFL repository is composed of multiple crates.
The top-level Cargo.toml is the workspace file grouping these crates.
Calling `cargo build` from the root directory will compile all crates in the workspace.
## Build example fuzzers
## Build Example Fuzzers
You can notice that in the repository there is a `fuzzers/` folder.
This folder contains a set of crates that are not part of the workspace, so that are not built issuing `cargo build` from the top-level directory.
We group example fuzzers in the `./fuzzers` directory of the LibAFL repository.
The directory contains a set of crates that are not part of the workspace.
These crates are examples of fuzzers using particular features of LibAFL combined sometimes with instrumentation backends (e.g. [SanitizerCoverage](https://clang.llvm.org/docs/SanitizerCoverage.html), [Frida](https://frida.re/), ...).
Each of these example fuzzers uses particular features of LibAFL, sometimes combined with different instrumentation backends (e.g. [SanitizerCoverage](https://clang.llvm.org/docs/SanitizerCoverage.html), [Frida](https://frida.re/), ...).
The user can use these crates as examples and as skeleton for its custom fuzzer using a similar set of features.
You can use these crates as examples and as skeletons for custom fuzzers with similar featuresets.
To build an example fuzzer you have to invoke cargo from its folder (`fuzzers/[FUZZER_NAME]).
To build an example fuzzer you have to invoke cargo from its respective folder (`fuzzers/[FUZZER_NAME]).

2
docs/src/libafl.md
View File

@ -4,6 +4,6 @@
This version of the LibAFL book is coupled with the release 1.0 beta of the library.
This document is still incomplete, and extremely work-in-progress. The structure and the concepts explained here will likely change a lot in the future, as the structure of LibAFL itself will change.
This document is still work-in-progress and incomplete. The structure and the concepts explained here are subject to change in future revisions, as the structure of LibAFL itself will evolve.
The HTML version of this book is available online at PLACEHOLDER and offline from the LibAFL repository in the docs/ folder.