Update README.md #2518
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 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. | ||
|
|
||
| ## Why LibAFL ? | ||
|
|
||
| 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 | ||
| ``` | ||
| #### Build the library using | ||
|
|
||
| ```sh | ||
| cargo build --release | ||
| ``` | ||
| #### Build the API documentation with | ||
|
|
||
| ```sh | ||
| cargo doc | ||
| ``` | ||
| #### 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!* | ||
| ```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. | ||
|
|
||
| ### Ressources | ||
|
There was a problem hiding this comment. @tokatoka Thanks for the merge! The latest version correspond more to what Dom asked :-) |
||
| - [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) | ||
|
|
||
| ## Contributors | ||
|
|
||
| LibAFL is written and maintained by | ||
|
|
||
| * [Andrea Fioraldi](https://twitter.com/andreafioraldi) <andrea@aflplus.plus> | ||
| * [Dominik Maier](https://twitter.com/domenuk) <dominik@aflplus.plus> | ||
| * [s1341](https://twitter.com/srubenst1341) <github@shmarya.net> | ||
| * [Dongjia Zhang](https://github.com/tokatoka) <toka@aflplus.plus> | ||
| * [Addison Crump](https://github.com/addisoncrump) <me@addisoncrump.info> | ||
| * [Romain Malmain](https://github.com/rmalmain) <rmalmain@pm.me> | ||
|
|
||
| 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 | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Title case:
Building and Installing