forked from AFLplusplus/LibAFL
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update README.md Re-structure the first page to be a bit more appealing - Regrouping getting started and fuzzer example in one sub-section - Separate installation guide in a different sub-section - Moving 'Why LibAFL'' further in the page - Removing spacing/newline to group info together * Update README.md - Fixing typo - Improving layout * Update README.md Cleaner readme - overview and why libafl merged - resources and quick started cleaned * Update README.md - Build instruction before getting started * Update README.md * Update README.md - Separate Why LibAFL and Overview section * Update README.md * Update README.md * Update README.md --------- Co-authored-by: Dongjia "toka" Zhang <[email protected]>
- Loading branch information
Showing
1 changed file
with
44 additions
and
84 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,18 +4,7 @@ | |
|
|
||
| Advanced Fuzzing Library - Slot your own fuzzers together and extend their features using Rust. | ||
|
|
||
| LibAFL is written and maintained by | ||
|
|
||
| * [Andrea Fioraldi](https://twitter.com/andreafioraldi) <[email protected]> | ||
| * [Dominik Maier](https://twitter.com/domenuk) <[email protected]> | ||
| * [s1341](https://twitter.com/srubenst1341) <[email protected]> | ||
| * [Dongjia Zhang](https://github.com/tokatoka) <[email protected]> | ||
| * [Addison Crump](https://github.com/addisoncrump) <[email protected]> | ||
| * [Romain Malmain](https://github.com/rmalmain) <[email protected]> | ||
|
|
||
| ## Why LibAFL? | ||
|
|
||
| LibAFL gives you many of the benefits of an off-the-shelf fuzzer, while being completely customizable. | ||
| LibAFL is a collection of reusable pieces of fuzzers, written in Rust, it gives you many of the benefits of an off-the-shelf fuzzer, while being completely customizable. | ||
| Some highlight features currently include: | ||
| - `fast`: We do everything we can at compile time, keeping runtime overhead minimal. Users reach 120k execs/sec in frida-mode on a phone (using all cores). | ||
| - `scalable`: `Low Level Message Passing`, `LLMP` for short, allows LibAFL to scale almost linearly over cores, and via TCP to multiple machines. | ||
|
|
@@ -24,103 +13,74 @@ feel free to add an AST-based input for structured fuzzing, and more. | |
| - `multi platform`: LibAFL was confirmed to work on *Windows*, *MacOS*, *Linux*, and *Android* on *x86_64* and *aarch64*. `LibAFL` can be built in `no_std` mode to inject LibAFL into obscure targets like embedded devices and hypervisors. | ||
| - `bring your own target`: We support binary-only modes, like Frida-Mode, as well as multiple compilation passes for sourced-based instrumentation. Of course it's easy to add custom instrumentation backends. | ||
|
|
||
| ## Overview | ||
|
|
||
| LibAFL is a collection of reusable pieces of fuzzers, written in Rust. | ||
| It is fast, multi-platform, no_std compatible, and scales over cores and machines. | ||
|
|
||
| It offers a main crate that provide building blocks for custom fuzzers, [libafl](./libafl), a library containing common code that can be used for targets instrumentation, [libafl_targets](./libafl_targets), and a library providing facilities to wrap compilers, [libafl_cc](./libafl_cc). | ||
|
|
||
| LibAFL offers integrations with popular instrumentation frameworks. At the moment, the supported backends are: | ||
|
|
||
| + SanitizerCoverage, in [libafl_targets](./libafl_targets) | ||
| + Frida, in [libafl_frida](./libafl_frida) | ||
| + QEMU user-mode and system mode, including hooks for emulation, in [libafl_qemu](./libafl_qemu) | ||
| + TinyInst, in [libafl_tinyinst](./libafl_tinyinst) by [elbiazo](https://github.com/elbiazo) | ||
|
|
||
| ## Getting started | ||
|
|
||
| 1. Install the Dependecies | ||
| - The Rust development language. | ||
| We highly recommend *not* to use e.g. your Linux distribition package as this is likely outdated. So rather install | ||
| Rust directly, instructions can be found [here](https://www.rust-lang.org/tools/install). | ||
|
|
||
| - LLVM tools | ||
| The LLVM tools (including clang, clang++) are needed (newer than LLVM 15.0.0 up to LLVM 18.1.3) | ||
| If you are using Debian/Ubuntu, again, we highly recommmend that you install the package from [here](https://apt.llvm.org/) | ||
|
|
||
| (In `libafl_concolic`, we only support LLVM version newer than 18) | ||
|
|
||
| - Cargo-make | ||
| We use cargo-make to build the fuzzers in `fuzzers/` directory. You can install it with | ||
|
|
||
| ```sh | ||
| cargo install cargo-make | ||
| ``` | ||
|
|
||
| 2. Clone the LibAFL repository with | ||
|
|
||
| ## Core concepts | ||
|
|
||
| LibAFL is fast, multi-platform, no_std compatible, and scales over cores and machines. It offers a main crate that provide building blocks for custom fuzzers, [libafl](./libafl), a library containing common code that can be used for targets instrumentation, [libafl_targets](./libafl_targets), and a library providing facilities to wrap compilers, [libafl_cc](./libafl_cc). It offers integrations with popular instrumentation frameworks. At the moment, the supported backends are: | ||
| + `SanitizerCoverage`, in [libafl_targets](./libafl_targets) | ||
| + `Frida`, in [libafl_frida](./libafl_frida) | ||
| + `QEMU` user-mode and system mode, including hooks for emulation, in [libafl_qemu](./libafl_qemu) | ||
| + `TinyInst`, in [libafl_tinyinst](./libafl_tinyinst) by [elbiazo](https://github.com/elbiazo) | ||
|
|
||
| ## Building and installing | ||
|
|
||
| #### Install the Dependencies | ||
| - **The Rust development language** | ||
| - We highly recommend *not* to use e.g. your Linux distribution package as this is likely outdated. So rather install Rust directly, instructions can be found [here](https://www.rust-lang.org/tools/install). | ||
| - **LLVM tools** | ||
| - The LLVM tools (including clang, clang++) are needed (newer than LLVM 15.0.0 up to LLVM 18.1.3) If you are using Debian/Ubuntu, again, we highly recommmend that you install the package from [here](https://apt.llvm.org/) | ||
| - (In `libafl_concolic`, we only support LLVM version newer than 18) | ||
| - Cargo-make: | ||
| - We use cargo-make to build the fuzzers in `fuzzers/` directory. You can install it with `cargo install cargo-make` | ||
|
|
||
| #### Clone the LibAFL repository with | ||
| ```sh | ||
| git clone https://github.com/AFLplusplus/LibAFL | ||
| ``` | ||
|
|
||
| 3. Build the library using | ||
|
|
||
| #### Build the library using | ||
| ```sh | ||
| cargo build --release | ||
| ``` | ||
|
|
||
| 4. Build the API documentation with | ||
|
|
||
| #### Build the API documentation with | ||
| ```sh | ||
| cargo doc | ||
| ``` | ||
|
|
||
| 5. Browse the LibAFL book (WIP!) with (requires [mdbook](https://rust-lang.github.io/mdBook/index.html)) | ||
|
|
||
| #### Browse the LibAFL book (WIP!) with (requires [mdbook](https://rust-lang.github.io/mdBook/index.html)) | ||
| ```sh | ||
| cd docs && mdbook serve | ||
| ``` | ||
|
|
||
| ## Getting started | ||
| We collect all example fuzzers in [`./fuzzers`](./fuzzers/). | ||
| Be sure to read their documentation (and source), this is *the natural way to get started!* | ||
|
|
||
| You can run each example fuzzer with | ||
|
|
||
| ```sh | ||
| cargo make run | ||
| ``` | ||
| You can run each example fuzzer with this following command, as long as the fuzzer directory has `Makefile.toml` file. The best-tested fuzzer is [`./fuzzers/inprocess/libfuzzer_libpng`](./fuzzers/inprocess/libfuzzer_libpng), a multicore libfuzzer-like fuzzer using LibAFL for a libpng harness. | ||
|
|
||
| as long as the fuzzer directory has `Makefile.toml` file. | ||
|
|
||
| The best-tested fuzzer is [`./fuzzers/inprocess/libfuzzer_libpng`](./fuzzers/inprocess/libfuzzer_libpng), a multicore libfuzzer-like fuzzer using LibAFL for a libpng harness. | ||
|
|
||
| ## Resources | ||
|
|
||
| + [Installation guide](./docs/src/getting_started/setup.md) | ||
|
|
||
| + [Online API documentation](https://docs.rs/libafl/) | ||
|
|
||
| + The LibAFL book (WIP) [online](https://aflplus.plus/libafl-book) or in the [repo](./docs/src/) | ||
| ### Resources | ||
| - [Installation guide](./docs/src/getting_started/setup.md) | ||
| - [Online API documentation](https://docs.rs/libafl/) | ||
| - The LibAFL book (WIP) [online](https://aflplus.plus/libafl-book) or in the [repo](./docs/src/) | ||
| - Our research [paper](https://www.s3.eurecom.fr/docs/ccs22_fioraldi.pdf) | ||
| - Our RC3 [talk](http://www.youtube.com/watch?v=3RWkT1Q5IV0 "Fuzzers Like LEGO") explaining the core concepts | ||
| - Our Fuzzcon Europe [talk](https://www.youtube.com/watch?v=PWB8GIhFAaI "LibAFL: The Advanced Fuzzing Library") with a (a bit but not so much outdated) step-by-step discussion on how to build some example fuzzers | ||
| - The Fuzzing101 [solutions](https://github.com/epi052/fuzzing-101-solutions) & series of [blog posts](https://epi052.gitlab.io/notes-to-self/blog/2021-11-01-fuzzing-101-with-libafl/) by [epi](https://github.com/epi052) | ||
| - Blogpost on binary-only fuzzing lib libaf_qemu, [Hacking TMNF - Fuzzing the game server](https://blog.bricked.tech/posts/tmnf/part1/), by [RickdeJager](https://github.com/RickdeJager). | ||
| - [A LibAFL Introductory Workshop](https://www.atredis.com/blog/2023/12/4/a-libafl-introductory-workshop), by [Jordan Whitehead](https://github.com/jordan9001) | ||
|
|
||
| + Our research [paper](https://www.s3.eurecom.fr/docs/ccs22_fioraldi.pdf) | ||
| ## Contributors | ||
|
|
||
| + Our RC3 [talk](http://www.youtube.com/watch?v=3RWkT1Q5IV0 "Fuzzers Like LEGO") explaining the core concepts | ||
|
|
||
| + Our Fuzzcon Europe [talk](https://www.youtube.com/watch?v=PWB8GIhFAaI "LibAFL: The Advanced Fuzzing Library") with a (a bit but not so much outdated) step-by-step discussion on how to build some example fuzzers | ||
|
|
||
| + The Fuzzing101 [solutions](https://github.com/epi052/fuzzing-101-solutions) & series of [blog posts](https://epi052.gitlab.io/notes-to-self/blog/2021-11-01-fuzzing-101-with-libafl/) by [epi](https://github.com/epi052) | ||
|
|
||
| + Blogpost on binary-only fuzzing lib libaf_qemu, [Hacking TMNF - Fuzzing the game server](https://blog.bricked.tech/posts/tmnf/part1/), by [RickdeJager](https://github.com/RickdeJager). | ||
|
|
||
| + [A LibAFL Introductory Workshop](https://www.atredis.com/blog/2023/12/4/a-libafl-introductory-workshop), by [Jordan Whitehead](https://github.com/jordan9001) | ||
| LibAFL is written and maintained by | ||
|
|
||
| ## Contributing | ||
| * [Andrea Fioraldi](https://twitter.com/andreafioraldi) <[email protected]> | ||
| * [Dominik Maier](https://twitter.com/domenuk) <[email protected]> | ||
| * [s1341](https://twitter.com/srubenst1341) <[email protected]> | ||
| * [Dongjia Zhang](https://github.com/tokatoka) <[email protected]> | ||
| * [Addison Crump](https://github.com/addisoncrump) <[email protected]> | ||
| * [Romain Malmain](https://github.com/rmalmain) <[email protected]> | ||
|
|
||
| Please check out [CONTRIBUTING.md](CONTRIBUTING.md) for the contributing guideline. | ||
|
|
||
| ## Cite | ||
|
|
||
| If you use LibAFL for your academic work, please cite the following paper: | ||
|
|
||
| ```bibtex | ||
|
|
||