{"id":15033158,"url":"https://github.com/aflplusplus/libafl","last_synced_at":"2025-05-11T03:49:08.802Z","repository":{"id":37043890,"uuid":"306484908","full_name":"AFLplusplus/LibAFL","owner":"AFLplusplus","description":"Advanced Fuzzing Library - Slot your Fuzzer together in Rust! Scales across cores and machines. For Windows, Android, MacOS, Linux, no_std, ...","archived":false,"fork":false,"pushed_at":"2025-05-09T23:45:56.000Z","size":25702,"stargazers_count":2234,"open_issues_count":118,"forks_count":370,"subscribers_count":26,"default_branch":"main","last_synced_at":"2025-05-11T03:48:52.751Z","etag":null,"topics":["afl","afl-fuzz","aflplusplus","binary-only","coverage-guided","frida","fuzzing","fuzzing-framework","libafl","rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AFLplusplus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"AFLplusplus","patreon":null,"open_collective":"AFLplusplusEU","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-10-22T23:53:37.000Z","updated_at":"2025-05-09T22:14:23.000Z","dependencies_parsed_at":"2024-01-17T10:18:13.393Z","dependency_job_id":"385543cb-9d1d-4e1d-9aa3-ea2d64672425","html_url":"https://github.com/AFLplusplus/LibAFL","commit_stats":{"total_commits":2816,"total_committers":163,"mean_commits":17.2760736196319,"dds":0.7240767045454546,"last_synced_commit":"25386bfb5fcc7a9fb46e9b881bced5f07ea10700"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AFLplusplus%2FLibAFL","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AFLplusplus%2FLibAFL/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AFLplusplus%2FLibAFL/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AFLplusplus%2FLibAFL/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AFLplusplus","download_url":"https://codeload.github.com/AFLplusplus/LibAFL/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253514559,"owners_count":21920334,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["afl","afl-fuzz","aflplusplus","binary-only","coverage-guided","frida","fuzzing","fuzzing-framework","libafl","rust"],"created_at":"2024-09-24T20:20:15.532Z","updated_at":"2025-05-11T03:49:08.775Z","avatar_url":"https://github.com/AFLplusplus.png","language":"Rust","readme":"# LibAFL, the fuzzer library.\n\n \u003cimg align=\"right\" src=\"https://raw.githubusercontent.com/AFLplusplus/Website/main/static/libafl_logo.svg\" alt=\"LibAFL logo\" width=\"250\" heigh=\"250\"\u003e\n\nAdvanced Fuzzing Library - Slot your own fuzzers together and extend their features using Rust.\n\nLibAFL 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.\nSome highlight features currently include:\n- `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).\n- `scalable`: `Low Level Message Passing`, `LLMP` for short, allows LibAFL to scale almost linearly over cores, and via TCP to multiple machines.\n- `adaptable`: You can replace each part of LibAFL. For example, `BytesInput` is just one potential form input:\nfeel free to add an AST-based input for structured fuzzing, and more.\n- `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.\n- `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.\n\n## Core concepts\n\nLibAFL 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:\n+ `SanitizerCoverage`, in [libafl_targets](./libafl_targets)\n+ `Frida`, in [libafl_frida](./libafl_frida)\n+ `QEMU` user-mode and system mode, including hooks for emulation, in [libafl_qemu](./libafl_qemu)\n+ `TinyInst`, in [libafl_tinyinst](./libafl_tinyinst) by [elbiazo](https://github.com/elbiazo)\n\n## Building and installing\n\n#### Install the Dependencies\n- **The Rust development language**\n    - 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).\n- **LLVM tools**\n    - 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/)\n    - (In `libafl_concolic`, we only support LLVM version newer than 18)\n- Just:\n    - We use [just](https://github.com/casey/just) to build the fuzzers in `fuzzers/` directory. You can find instructions to install it in your environment [in the Just Programmer's Manual](https://just.systems/man/en/packages.html).\n \n#### Clone the LibAFL repository with\n```sh\ngit clone https://github.com/AFLplusplus/LibAFL\n```\n#### Build the library using\n```sh\ncargo build --release\n```\n#### Build the API documentation with\n```sh\ncargo doc\n```\n#### Browse the LibAFL book (WIP!) with (requires [mdbook](https://rust-lang.github.io/mdBook/index.html))\n```sh\ncd docs \u0026\u0026 mdbook serve\n```\n## Getting started \nWe collect all example fuzzers in [`./fuzzers`](./fuzzers/).\nBe sure to read their documentation (and source), this is *the natural way to get started!*\n```sh\njust run\n```\nYou can run each example fuzzer with this following command, as long as the fuzzer directory has a `Justfile` 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.\n\n### Resources \n- [Installation guide](./docs/src/getting_started/setup.md)\n- [Online API documentation](https://docs.rs/libafl/)\n- The LibAFL book (WIP) [online](https://aflplus.plus/libafl-book) or in the [repo](./docs/src/)\n- Our research [paper](https://www.s3.eurecom.fr/docs/ccs22_fioraldi.pdf)\n- Our RC3 [talk](http://www.youtube.com/watch?v=3RWkT1Q5IV0 \"Fuzzers Like LEGO\") explaining the core concepts\n- 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\n- The Fuzzing101 [solutions](https://github.com/epi052/fuzzing-101-solutions) \u0026 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)\n- 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).\n- [A LibAFL Introductory Workshop](https://www.atredis.com/blog/2023/12/4/a-libafl-introductory-workshop), by [Jordan Whitehead](https://github.com/jordan9001)\n\n## Contributors\n\nLibAFL is written and maintained by\n\n * [Andrea Fioraldi](https://twitter.com/andreafioraldi) \u003candrea@aflplus.plus\u003e\n * [Dominik Maier](https://twitter.com/domenuk) \u003cdominik@aflplus.plus\u003e\n * [s1341](https://twitter.com/srubenst1341) \u003cgithub@shmarya.net\u003e\n * [Dongjia Zhang](https://github.com/tokatoka) \u003ctoka@aflplus.plus\u003e\n * [Addison Crump](https://github.com/addisoncrump) \u003cme@addisoncrump.info\u003e\n * [Romain Malmain](https://github.com/rmalmain) \u003crmalmain@pm.me\u003e\n\n## Contributing\n\nPlease check out **[CONTRIBUTING.md](CONTRIBUTING.md)** for the contributing guideline.\n\n## Debugging\n\nYour fuzzer doesn't work as expected? Try reading [DEBUGGING.md](./docs/src/DEBUGGING.md) to understand how to debug your problems.\n\n## Cite\nIf you use LibAFL for your academic work, please cite the following paper:\n\n```bibtex\n@inproceedings{libafl,\n author       = {Andrea Fioraldi and Dominik Maier and Dongjia Zhang and Davide Balzarotti},\n title        = {{LibAFL: A Framework to Build Modular and Reusable Fuzzers}},\n booktitle    = {Proceedings of the 29th ACM conference on Computer and communications security (CCS)},\n series       = {CCS '22},\n year         = {2022},\n month        = {November},\n location     = {Los Angeles, U.S.A.},\n publisher    = {ACM},\n}\n```\n\n#### License\n\n\u003csup\u003e\nLicensed under either of \u003ca href=\"LICENSE-APACHE\"\u003eApache License, Version\n2.0\u003c/a\u003e or \u003ca href=\"LICENSE-MIT\"\u003eMIT license\u003c/a\u003e at your option.\n\u003c/sup\u003e\n\n\u003cbr\u003e\n\n\u003csub\u003e\nUnless you explicitly state otherwise, any contribution intentionally submitted\nfor inclusion in this crate by you, as defined in the Apache-2.0 license, shall\nbe dual licensed as above, without any additional terms or conditions.\n\u003c/sub\u003e\n","funding_links":["https://github.com/sponsors/AFLplusplus","https://opencollective.com/AFLplusplusEU"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faflplusplus%2Flibafl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faflplusplus%2Flibafl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faflplusplus%2Flibafl/lists"}