├── .gitignore ├── src ├── design │ ├── design.md │ ├── architecture.md │ └── metadata.md ├── tutorial │ ├── intro.md │ └── tutorial.md ├── advanced_features │ ├── advanced_features.md │ ├── no_std │ │ └── no_std.md │ └── concolic │ │ └── concolic.md ├── core_concepts │ ├── core_concepts.md │ ├── generator.md │ ├── mutator.md │ ├── stage.md │ ├── observer.md │ ├── input.md │ ├── corpus.md │ ├── feedback.md │ └── executor.md ├── getting_started │ ├── getting_started.md │ ├── build.md │ ├── setup.md │ └── crates.md ├── message_passing │ ├── configurations.md │ ├── spawn_instances.md │ └── message_passing.md ├── libafl.md ├── SUMMARY.md ├── introduction.md └── baby_fuzzer.md ├── book.toml ├── README.md └── .github └── workflows └── build_and_publish.yml /.gitignore: -------------------------------------------------------------------------------- 1 | book 2 | -------------------------------------------------------------------------------- /src/design/design.md: -------------------------------------------------------------------------------- 1 | # 设计 2 | 3 | 在这一章中，我们讨论了我们是如何在考虑到核心概念的情况下设计这个库的，同时考虑代码重用和可扩展性。 4 | -------------------------------------------------------------------------------- /src/tutorial/intro.md: -------------------------------------------------------------------------------- 1 | # 介绍 2 | 3 | > ## 正在建设中! 4 | > 本节正在建设中。 5 | > 请稍后再来检查 (或打开一个PR) 。 6 | -------------------------------------------------------------------------------- /src/advanced_features/advanced_features.md: -------------------------------------------------------------------------------- 1 | # Advanced Features 2 | 3 | 除了摸索器的核心构建模块，LibAFL还具有更多高级/小众摸索技术的功能。 4 | 5 | 下面的章节专门介绍这些功能。 6 | -------------------------------------------------------------------------------- /src/core_concepts/core_concepts.md: -------------------------------------------------------------------------------- 1 | # 核心概念 2 | 3 | LibAFL是围绕一些核心概念设计的，我们认为这些概念可以有效地抽象出大多数其他的模糊器设计。 4 | 5 | 在这里，我们讨论这些概念，并提供一些与其他模糊器相关的例子。 6 | -------------------------------------------------------------------------------- /src/tutorial/tutorial.md: -------------------------------------------------------------------------------- 1 | # 教程 2 | 3 | 在本章中，我们将使用Rust中的 [Lain](https://github.com/microsoft/lain) 突变器构建一个自定义模糊器。 4 | 5 | 本教程将向你介绍如何编写LibAFL的扩展，如Feedbacks和Testcase的元数据。 6 | -------------------------------------------------------------------------------- /src/getting_started/getting_started.md: -------------------------------------------------------------------------------- 1 | # 入门 2 | 3 | 要开始使用LibAFL，有一些初始步骤要做。 4 | 5 | 在本章中，我们将讨论如何使用 Rust 的 `cargo` 命令下载和构建 LibAFL。 6 | 我们还描述了LibAFL的组件结构，即所谓的 `crate`，以及每个单独 `crate` 的目的。 7 | -------------------------------------------------------------------------------- /book.toml: -------------------------------------------------------------------------------- 1 | [book] 2 | authors = ["Andrea Fioraldi", "Dominik Maier"] 3 | language = "zh" 4 | multilingual = false 5 | src = "src" 6 | title = "LibAFL模糊测试库" 7 | 8 | [output.html] 9 | 10 | [output.linkcheck] 11 | optional = true 12 | -------------------------------------------------------------------------------- /src/message_passing/configurations.md: -------------------------------------------------------------------------------- 1 | # 配置 Configurations 2 | 3 | 单个模糊器节点的配置与多节点模糊计算有关。 4 | 本章介绍了如何在一个模糊测试集群中运行具有不同配置的节点 5 | 在一个模糊测试集群中运行不同配置的节点。 6 | 例如，这允许一个用 ASAN 编译的节点知道它需要为一个没有 ASAN 的节点重新运行新的测试案例，而同样的二进制/配置则不需要。 7 | 8 | > ## 正在建设中! 9 | > 本节正在建设中。 10 | > 请稍后再来检查 (或打开PR) 。 11 | -------------------------------------------------------------------------------- /src/core_concepts/generator.md: -------------------------------------------------------------------------------- 1 | # 生成器 Generator 2 | 3 | 生成器(Generator) 是一个旨在从头生成输入的组件。 4 | 5 | 通常情况下，随机发生器被用来生成随机输入。 6 | 7 | 生成器在传统上较少用于反馈驱动的模糊测试，但也有例外，如 Nautilus，它使用语法生成器来创建初始语料库，并使用子树生成器作为其语法突变器的突变。 8 | 9 | 在代码中，[`Generator`](https://docs.rs/libafl/0/libafl/generators/trait.Generator.html)是一个 `trait`。 10 | -------------------------------------------------------------------------------- /src/core_concepts/mutator.md: -------------------------------------------------------------------------------- 1 | # 突变器 Mutator 2 | 3 | 突变器(Mutator) 是一个接受一个或多个输入并生成一个新的派生输入的实体。 4 | 5 | 突变器可以被组成，它们通常与特定的输入类型相联系。 6 | 7 | 例如，可以有一个 Mutator 在输入上应用不止一种类型的突变。考虑一个字节流的通用突变器，比特翻转只是可能的突变之一，但不是唯一的突变，还有，例如，随机替换一个字节的块的拷贝。 8 | 9 | 在LibAFL中，[`Mutator`](https://docs.rs/libafl/0/libafl/mutators/trait.Mutator.html)是一个 `trait`。 10 | -------------------------------------------------------------------------------- /src/core_concepts/stage.md: -------------------------------------------------------------------------------- 1 | # 阶段 Stage 2 | 3 | 阶段(Stage) 是一个对 从语料库中得到的单一输入 进行操作的实体。 4 | 5 | 例如，一个突变阶段，给定一个语料库的输入，应用一个突变器并执行一次或多次生成的输入。例如，AFL使用输入的性能分数来选择应该调用多少次破坏性的突变。这也可以取决于其他参数，例如，如果我们想只是应用一个连续的比特翻转，那么输入的长度也可以是一个固定的值。 6 | 7 | 一个阶段也可以是一个分析阶段，例如，Redqueen的着色阶段旨在为测试案例引入更多的熵，或者AFL的修剪阶段旨在减少测试案例的大小。 8 | 9 | 在LibAFL代码库中，有几个实现 [`Stage`](https://docs.rs/libafl/0/libafl/stages/trait.Stage.html) 特性的阶段。 10 | -------------------------------------------------------------------------------- /src/core_concepts/observer.md: -------------------------------------------------------------------------------- 1 | # 观察者 Oberrver 2 | 3 | 观察者(Oberrver)，或称观察通道，是一个实体，它向模糊器提供在被测程序执行期间观察到的信息。 4 | 5 | 观察者所包含的信息在不同的执行过程中是不被保留的。 6 | 7 | 例如，在执行过程中填充的覆盖率共享 map，以报告由 AFL 和 HonggFuzz 等模糊器使用的执行边缘，可以被认为是一个观察通道。 8 | 这种信息在不同的运行中并不保留，它是对程序的动态属性的观察。 9 | 10 | 就代码而言，在库中，这个实体由 [`Oberrver`](https://docs.rs/libafl/0/libafl/observers/trait.Observer.html) 特性描述。 11 | 12 | 除了保存与目标的最后一次执行有关的易失性数据外，实现这一特性的结构可以定义一些执行钩子，在每个模糊情况前后执行。在这个钩子中，观察者可以修改模糊器的状态。 13 | -------------------------------------------------------------------------------- /src/core_concepts/input.md: -------------------------------------------------------------------------------- 1 | # 输入 Input 2 | 3 | 从形式上看，程序的输入(Input)是指从外部来源获取的影响程序行为的数据。 4 | 5 | 在我们的抽象模糊器模型中，我们将输入定义为程序输入 (或其一部分) 的内部表示。 6 | 7 | 在直接的情况下，程序的输入是一个字节数组，在AFL这样的模糊器中，我们正是存储和操作这些字节数组。 8 | 9 | 但情况并不总是这样。一个程序可能期望的输入不是字节数组 (例如一连串的系统调用)，而模糊器并不以程序消耗输入的相同方式来表示。 10 | 11 | 以语法模糊器为例，输入通常是抽象语法树，因为它是一种数据结构，在保持有效性的同时可以很容易地进行操作，但程序期望输入是一个字节数组，所以在执行之前，树被序列化为一个字节的顺序。 12 | 13 | 在Rust代码中，[`Input`](https://docs.rs/libafl/0/libafl/inputs/trait.Input.html) 是一个 `trait`，只能由可序列化的结构来实现，并且只有拥有的数据作为字段。 14 | -------------------------------------------------------------------------------- /src/core_concepts/corpus.md: -------------------------------------------------------------------------------- 1 | # 语料库 Corpus 2 | 3 | 语料库(Corpus) 是存储测试案例的地方。我们将一个测试案例定义为一个输入和一组相关的元数据，例如，执行时间。 4 | 5 | 语料库可以用不同的方式存储测试用例，例如在磁盘上，或在内存中，或实现缓存以加快磁盘存储。 6 | 7 | 通常，当一个测试案例被认为是有趣的时候，它就会被添加到语料库中，但是语料库也被用来存储实现目标的测试案例 (比如说，测试程序崩溃) 。 8 | 9 | 与语料库相关的是，模糊检验器应要求从语料库中挑选下一个测试案例进行模糊检验。LibAFL中的分类法是CorpusScheduler，该实体代表了从语料库中提取测试案例的策略，例如FIFO。 10 | 11 | 谈到代码，[`Corpus`](https://docs.rs/libafl/0/libafl/corpus/trait.Corpus.html) 和 [`CorpusScheduler`](https://docs.rs/libafl/0/libafl/corpus/trait.CorpusScheduler.html) 是 trait。 12 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # LibAFL 文档书 2 | 3 | 这个项目作为一本书，包含了 LibAFL 源码以外的文档。 4 | 5 | 在这里你可以找到教程、例子和详细的解释。 6 | 7 | 要想获得API文档，请在 LibAFl 根目录下运行 `cargo doc`。 8 | 9 | ## 使用方法 10 | 11 | 要构建这本书，你需要 [mdBook](https://github.com/rust-lang/mdBook)。 12 | 13 | `mdbook build` 来构建，`mdbook serve` 来在本地提供本书。 14 | 15 | ## 说明 16 | 17 | 本书由 [zu1k](https://github.com/zu1k) 翻译，HTML 版本可在 [https://libafl-book-zh.zu1k.com](https://libafl-book-zh.zu1k.com) 在线获取 18 | 19 | 本书对应英文原版 [4f6f76e](https://github.com/AFLplusplus/LibAFL/tree/4f6f76e85710d3d8d3fd7bea49e2c3f3b152b0e9)，不保证后续的更新，相信读者深入学习LibAFL后可不借助翻译阅读英文文档。 20 | 21 | 本书内容的版权由 [LibAFL](https://github.com/AFLplusplus/LibAFL) 的作者持有 22 | -------------------------------------------------------------------------------- /.github/workflows/build_and_publish.yml: -------------------------------------------------------------------------------- 1 | name: Build and Publish 2 | 3 | on: 4 | push: 5 | branches: [ master ] 6 | pull_request: 7 | branches: [ master ] 8 | 9 | jobs: 10 | build-and-publish: 11 | runs-on: ubuntu-20.04 12 | concurrency: 13 | group: ${{ github.workflow }}-${{ github.ref }} 14 | steps: 15 | - uses: actions/checkout@v2 16 | 17 | - name: Setup mdBook 18 | uses: peaceiris/actions-mdbook@v1 19 | with: 20 | mdbook-version: 'latest' 21 | 22 | - run: mdbook build 23 | 24 | - name: Deploy 25 | uses: peaceiris/actions-gh-pages@v3 26 | if: ${{ github.ref == 'refs/heads/master' }} 27 | with: 28 | github_token: ${{ secrets.GITHUB_TOKEN }} 29 | publish_dir: ./book/html -------------------------------------------------------------------------------- /src/core_concepts/feedback.md: -------------------------------------------------------------------------------- 1 | # 反馈 Feedback 2 | 3 | 反馈(Feedback) 是一个将被测程序的执行结果分类为有趣或不有趣的实体。 4 | 通常情况下，如果一个执行是有趣的，那么用于输入目标程序的相应输入就会被添加到一个语料库中。 5 | 6 | 大多数时候，反馈的概念与观察者有很深的联系，但它们是不同的概念。 7 | 8 | 反馈，在大多数情况下，处理一个或多个观察者报告的信息，以决定执行是否有趣。 9 | `有趣` 的概念是抽象的，但通常它与新颖性搜索有关 (即有趣的输入是那些达到控制流图中以前未见过的边缘的输入) 。 10 | 11 | 举个例子，给定一个报告所有内存分配大小的观察者，可以用一个最大化反馈来最大化这些大小，以运动内存消耗方面的病态输入。 12 | 13 | 在代码方面，该库提供了 [`Feedback`](https://docs.rs/libafl/0/libafl/feedbacks/trait.Feedback.html) 和 [`FeedbackState`](https://docs.rs/libafl/0/libafl/feedbacks/trait.FeedbackState.html) 特性。 14 | 第一个用于实现一个算子，在给定最后一次执行的观察者的状态时，告诉他们这次执行是否有趣。第二个是与 `反馈` 联系在一起的，它是反馈希望在模糊器的状态中坚持的数据的状态，例如，在基于边缘覆盖率的反馈的情况下，持有到目前为止看到的所有边缘的累积图。 15 | 16 | 多个反馈可以结合成布尔公式，例如，如果一个执行触发了新的代码路径，或者执行时间比平均执行时间短，就可以认为它是有趣的。[`feedback_or`](https://docs.rs/libafl/0/libafl/macro.feedback_or.html). 17 | 18 | TODO目标反馈和快速反馈逻辑运算符 19 | -------------------------------------------------------------------------------- /src/libafl.md: -------------------------------------------------------------------------------- 1 | # LibAFL模糊测试库 2 | 3 | AFL++ logo 4 | 5 | *作者: Andrea Fioraldi 和 Dominik Maier* 6 | 7 | 欢迎来到 LibAFL，一个高级模糊测试库，本书是对该库的一个简单介绍。 8 | 9 | 此版本的 `LibAFL Book` 是与该库的 `1.0` 测试版结合在一起的。 10 | 11 | 本文件仍在进行中，并不完整。这里解释的结构和概念在未来的修订中可能会有变化，因为 LibAFL 的结构本身也会有变化。 12 | 13 | 本书的 HTML 版本可在 [https://aflplus.plus/libafl-book/](https://aflplus.plus/libafl-book/) 在线获取，也可从 LibAFL 仓库中的 `docs/` 文件夹中离线获取。 14 | 15 | 使用这个文件夹中的 `mdbook build` 来构建它，或者运行 `mdbook serve` 来查看该书。 16 | 17 | 本书的简体中文版本由 [zu1k](https://github.com/zu1k) 翻译(借助DeepL翻译引擎)，HTML 版本可在 [https://libafl-book-zh.zu1k.com](https://libafl-book-zh.zu1k.com) 在线获取，仓库 [zu1k/libafl-book-zh](https://github.com/zu1k/libafl-book-zh)，当前查看版本对应英文原版 [4f6f76e](https://github.com/AFLplusplus/LibAFL/tree/4f6f76e85710d3d8d3fd7bea49e2c3f3b152b0e9)。 18 | -------------------------------------------------------------------------------- /src/design/architecture.md: -------------------------------------------------------------------------------- 1 | # 架构 2 | 3 | LibAFL 的架构是围绕着一些实体建立的，以允许代码重用和低成本的抽象。 4 | 5 | 最初，我们开始考虑用一种面向对象的语言来实现 LibAFL，比如 C++。当我们了解到Rust时，我们立即改变了想法，因为我们意识到，虽然Rust允许某种OOP模式，但我们可以用一种更理智的方法来构建这个库，就像[本博文](https://kyren.github.io/2018/09/14/rustconf-talk.html) 中描述的关于Rust中的游戏设计。 6 | 7 | LibAFL 的代码重用方式是基于组件而不是子类的，但库中仍有一些OOP模式。 8 | 9 | 考虑到类似的模糊器，你可以观察到大多数时候被修改的数据结构是与测试案例和模糊器全局状态有关的。 10 | 11 | 除了之前描述的实体外，我们引入了 [`Testcase`](https://docs.rs/libafl/0.6/libafl/corpus/testcase/struct.Testcase.html) 和 [`State`](https://docs.rs/libafl/0.6/libafl/state/struct.StdState.html) 实体。测试案例是存储在语料库中的输入及其元数据的容器 (因此，在实现中，语料库存储测试案例)，状态包含在运行模糊器时演变的所有元数据，包括语料库。 12 | 13 | 在实现中，状态只包含可序列化的自有对象，它本身也是可序列化的。有些模糊器可能希望在暂停时序列化其状态，或者在进行进程内模糊处理时，在崩溃时序列化，并在新进程中反序列化，以继续模糊处理，并保留所有元数据。 14 | 15 | 此外，我们将 `actions` 的实体，如 CorpusScheduler 和 Feedbacks，归入一个共同的地方，即 [`Fuzzer'](https://docs.rs/libafl/0.6.1/libafl/fuzzer/struct.StdFuzzer.html)。 16 | -------------------------------------------------------------------------------- /src/advanced_features/no_std/no_std.md: -------------------------------------------------------------------------------- 1 | # 在 `no_std` 环境中使用 LibAFL 2 | 3 | 可以在 `no_std` 环境中使用 LibAFL，例如自定义平台，如微控制器、内核、管理程序等等。 4 | 5 | 你可以简单地将 LibAFL 添加到你的 `Cargo.toml` 文件中: 6 | 7 | ```toml 8 | libafl = { path = "path/to/libafl/", default-features = false} 9 | ``` 10 | 11 | 然后构建你的项目，例如为 `aarch64-unknown-none` 使用: 12 | 13 | ```sh 14 | cargo build --no-default-features --target aarch64-unknown-none 15 | ``` 16 | 17 | ## 使用自定义时间戳 18 | 19 | LibAFL 对 `no_std` 的最小输入量是一个单调增长的时间戳。 20 | 为此，在你项目的任何地方，你需要实现 `external_current_millis` 函数，它以毫秒为单位返回当前时间。 21 | 22 | // 假设这是一个来自自定义stdlib的时钟源，你想使用它，它以秒为单位返回当前时间。 23 | 24 | ```c 25 | int my_real_seconds(void) 26 | { 27 | return *CLOCK; 28 | } 29 | ``` 30 | 31 | 而在这里我们在 Rust 中使用它，`external_current_millis` 会被LibAFL调用。 32 | 注意，它需要是 `no_mangle`，以便在链接时被 LibAFL 接受。 33 | 34 | ```rust,ignore 35 | #[no_mangle] 36 | pub extern "C" fn external_current_millis() -> u64 { 37 | unsafe { my_real_seconds()*1000 } 38 | } 39 | ``` 40 | -------------------------------------------------------------------------------- /src/getting_started/build.md: -------------------------------------------------------------------------------- 1 | # 构建 LibAFL 2 | 3 | LibAFL 和大多数 Rust 项目一样，可以使用 `cargo` 从项目的根目录下构建: 4 | 5 | ```sh 6 | $ cargo build --release 7 | ``` 8 | 9 | 请注意，`--release`在开发测试时是可选项，但使用Debug版本进行模糊测试可能会有10倍以上的性能损失，正式使用时你需要添加 `--release` 标志才能获得正常的速度。 10 | 11 | LibAFL资源库是由多个板块组成的。 12 | 顶层的 [`Cargo.toml`](https://github.com/AFLplusplus/LibAFL/blob/main/Cargo.toml) 是将这些板块分组的工作区文件。 13 | 从根目录调用 `cargo build` 将编译工作区中的所有板块。 14 | 15 | ## 构建示例模糊器 16 | 17 | 对于有经验的 rustaceans 来说，最好的起点是阅读并改编示例模糊器。 18 | 19 | 我们将这些模糊程序放在 LibAFL 资源库的 [`./fuzzers`](https://github.com/AFLplusplus/LibAFL/tree/main/fuzzers) 目录下，该目录包含一组不属于工作区的crates。 20 | 21 | 这些示例模糊器中的每一个都使用了 LibAFL 的特定功能，有时与不同的插桩后端相结合 (例如 [SanitizerCoverage](https://clang.llvm.org/docs/SanitizerCoverage.html), [Frida](https://frida.re/), ...) 。 22 | 23 | 你可以使用这些 crates 作为例子，并作为具有类似功能集的自定义模糊器的骨架。 24 | 每个模糊器的目录中都有一个 `README.md` 文件，描述模糊器及其特性。 25 | 26 | 要建立一个例子的模糊器，你必须从其各自的文件夹 (`fuzzers/[FUZZER_NAME]`) 调用 `cargo build --release`。 27 | -------------------------------------------------------------------------------- /src/SUMMARY.md: -------------------------------------------------------------------------------- 1 | # 摘要 2 | 3 | [LibAFL模糊测试库](./libafl.md) 4 | 5 | [简介](./introduction.md) 6 | 7 | - [入门](./getting_started/getting_started.md) 8 | - [设置](./getting_started/setup.md) 9 | - [构建](./getting_started/build.md) 10 | - [Crates](./getting_started/crates.md) 11 | 12 | - [简单的模糊器实例](./baby_fuzzer.md) 13 | 14 | - [核心概念](./core_concepts/core_concepts.md) 15 | - [观察者 Observer](./core_concepts/observer.md) 16 | - [执行器 Executor](./core_concepts/executor.md) 17 | - [反馈 Feedback](./core_concepts/feedback.md) 18 | - [输入 Input](./core_concepts/input.md) 19 | - [语料库 Corpus](./core_concepts/corpus.md) 20 | - [突变器 Mutator](./core_concepts/mutator.md) 21 | - [生成器 Generator](./core_concepts/generator.md) 22 | - [阶段 Stage](./core_concepts/stage.md) 23 | 24 | - [设计](./design/design.md) 25 | - [架构](./design/architecture.md) 26 | - [元数据](./design/metadata.md) 27 | 28 | - [消息传递](./message_passing/message_passing.md) 29 | - [派生实例](./message_passing/spawn_instances.md) 30 | - [配置](./message_passing/configurations.md) 31 | 32 | - [教程](./tutorial/tutorial.md) 33 | - [简介](./tutorial/intro.md) 34 | 35 | - [高级功能](./advanced_features/advanced_features.md) 36 | - [Concolic Tracing和混合模糊](./advanced_features/concolic/concolic.md) 37 | - [LibAFL在 `no_std` 环境下 (内核、管理程序...) ](./advanced_features/no_std/no_std.md) 38 | -------------------------------------------------------------------------------- /src/message_passing/spawn_instances.md: -------------------------------------------------------------------------------- 1 | # 派生实例 2 | 3 | 多个模糊器实例可以通过不同的方式产生。 4 | 5 | ## 手动，通过一个TCP端口 6 | 7 | 做多线程的直接方法是使用 `LlmpRestartingEventManager`，特别是使用 `setup_restarting_mgr_std`。 8 | 9 | 它抽象化了所有讨厌的细节，如崩溃处理时的重启 (针对内存模糊器) 和多线程。 10 | 有了它，你手动启动的每个实例都会尝试连接到本地机器上的一个 TCP 端口。 11 | 12 | 如果这个端口还没有被绑定，这个实例就会成为代理，它自己会绑定到这个端口以等待新的客户。 13 | 14 | 如果该端口已经被绑定，EventManager 将尝试连接到它。 15 | 该实例成为客户端，现在可以与所有其他节点通信。 16 | 17 | 手动启动节点的好处是，你可以有多个具有不同配置的节点，比如客户端在有 ASAN 和没有 ASAN 的情况下进行模糊处理。 18 | 19 | 虽然它被称为 `restarting` 管理器，但它在Unix操作系统上使用 `fork` 作为优化，在 Windows 上只实际从头开始重启。 20 | 21 | ## 启动器 Launcher 22 | 23 | 启动器(Launcher) 是 lazy 模式启动多线程。 24 | 25 | 你可以使用 `Launcher::builder` 来创建一个产生多个节点的模糊器，所有这些节点都使用重新启动的事件管理器。 26 | 27 | 看一个例子: 28 | 29 | ```rust,ignore 30 | Launcher::builder() 31 | .configuration(EventConfig::from_name(&configuration)) 32 | .shmem_provider(shmem_provider) 33 | .monitor(mon) 34 | .run_client(&mut run_client) 35 | .cores(cores) 36 | .broker_port(broker_port) 37 | .stdout_file(stdout_file) 38 | .remote_broker_addr(broker_addr) 39 | .build() 40 | .launch() 41 | ``` 42 | 43 | 首先启动一个代理，然后根据传递给 `cores` 的值生成 `n` 个客户端。 44 | 这个值是一个字符串，表示要绑定的核心，例如， `0,2,5` 或 `0-3`。 45 | 对于每个客户端，`run_client` 将被调用。 46 | 在Windows上，启动器将重新启动每个客户端，而在Unix上，它将使用`fork`。 47 | 48 | ## 其他方式 49 | 50 | LlmpEvenManager 系列是派生实例的最简单的方法，但对于不明显的目标，你可能需要想出其他的解决方案。 51 | 52 | LLMP 甚至在理论上是 `no_std` 兼容的，甚至完全不同的 EventManagers 也可以用于消息传递。 53 | 54 | 如果你遇到这种情况，请阅读当前的实现或与我们联系。 -------------------------------------------------------------------------------- /src/introduction.md: -------------------------------------------------------------------------------- 1 | # 简介 2 | 3 | 模糊器是安全研究人员和开发人员的重要工具。 4 | 一系列最先进的工具，如 [AFL++](https://github.com/AFLplusplus/AFLplusplus)、[libFuzzer](https://llvm.org/docs/LibFuzzer.html) 或 [honggfuzz](https://github.com/google/honggfuzz) 都可供用户使用。它们以一种非常有效的方式完成它们的工作，发现成千上万的bug。 5 | 6 | 然而，从一个高级用户的角度来看，这些工具是有限的，它们的设计并没有把可扩展性作为第一等公民。 7 | 通常情况下，模糊器开发者可以选择 Fork 这些现有的工具，或者从头开始创建一个新的模糊器。在这些情况下，研究人员最终得到有大量的模糊器，它们之间互不兼容，其先进的部分进能够被其自己使用。 8 | 在这个过程中，需要一遍又一遍的重新发明轮子，而这些过程完全可以被避免。 9 | 10 | 为了解决这个问题，我们创建了LibAFL，这是一个库，它不只是一个模糊器，而是一个可重复使用的个体模糊器的集合。 11 | LibAFL是用Rust编写的，它可以帮助你开发一个为你的特定需求而定制的模糊器。 12 | 无论是一个特定的目标，一个特定的插桩后端，还是一个自定义的突变器，你都可以利用现有的碎片来制作你能想到的最快、最有效的模糊器。 13 | 14 | ## 为什么使用 LibAFL? 15 | 16 | LibAFL为你提供了许多现成的模糊器的优点，同时又是完全可定制的。 17 | 18 | 目前的一些亮点功能包括: 19 | 20 | - **多平台**: LibAFL 几乎可以在任何 Rust编译器 支持的地平台工作，我们已经在 *Windows*、*Android*、*MacOS* 和 *Linux* 上使用，在 *x86_64*、*aarch64* 上使用 21 | - **移植性**: LibAFL 可以在 `no_std` 模式下构建，这意味着它不需要依赖特定的操作系统。通过定义一个分配器和映射页面的方法，你可以把LibAFL注入到其他目标平台，如嵌入式设备、管理程序，甚至可能是WebAssembly 22 | - **适应性**: 鉴于多年来对 *AFLplusplus* 的开发经验和我们对模糊测试的学术背景，我们可以将最近的模糊测试发展趋势融入到LibAFL的设计中，使其面向未来。 23 | 举个例子，相对于老式的模糊器， `BytesInput` 只是输入的潜在形式之一，你可以自由地使用和修改抽象语法树，以实现结构化的模糊处理。 24 | - **扩展性**: 作为LibAFL的一部分，我们开发了 `低水平消息传递`，简称 `LLMP`，它允许LibAFL在核心上几乎线性扩展。也就是说，如果你选择使用这个功能--毕竟这是你的模糊器。 25 | 使用LLMP的 `broker2broker` 功能，通过TCP扩展到多台机器也是可能的 26 | - **快速**: 我们在编译时尽一切努力，使运行时的开销尽可能小 27 | - **任何目标**: 我们支持纯二进制模式，如 **QEMU-Mode**、**Frida-Mode**、**ASAN**、**CmpLog**，以及基于资源的插桩的多个编译通道。当然，我们也支持自定义插桩，正如你在基于谷歌Atheris的Python例子中看到的那样 28 | - **可用性**: 这个问题由你来决定。尽情发挥吧! 29 | -------------------------------------------------------------------------------- /src/design/metadata.md: -------------------------------------------------------------------------------- 1 | # 元数据 2 | 3 | LibAFL 中的元数据是一个自包含的结构，持有与状态或测试案例相关的数据。 4 | 5 | 在代码方面，元数据可以被定义为一个在 SerdeAny 寄存器中注册的Rust结构。 6 | 7 | ```rust 8 | extern crate libafl; 9 | extern crate serde; 10 | 11 | use libafl::SerdeAny; 12 | use serde::{Serialize, Deserialize}; 13 | 14 | #[derive(Debug, Serialize, Deserialize, SerdeAny)] 15 | pub struct MyMetadata { 16 | //... 17 | } 18 | ``` 19 | 20 | 这个结构必须是静态的，所以它不能持有对借用对象的引用。 21 | 22 | 作为 `libafl_derive` 中的 `proc-macro`，用户可以使用 `libafl::impl_serdeany!(MyMetadata);` 来替代 `derive(SerdeAny)`。 23 | 24 | ## 用法 25 | 26 | 元数据对象主要用于 [`SerdeAnyMap`](https://docs.rs/libafl/0.5.0/libafl/bolts/serdeany/serdeany_registry/struct.SerdeAnyMap.html) 和 [`NamedSerdeAnyMap`](https://docs.rs/libafl/0.5.0/libafl/bolts/serdeany/serdeany_registry/struct.NamedSerdeAnyMap.html) 中。 27 | 28 | 通过这些 map，用户可以按类型 (和名称) 检索实例。在内部，这些实例被存储为SerdeAny trait 对象。 29 | 30 | 想拥有一套元数据的结构必须实现 [`HasMetadata`](https://docs.rs/libafl/0.5.0/libafl/state/trait.HasMetadata.html) trait。 31 | 32 | 默认情况下，Testcase 和 State实现了它，并持有一个 SerdeAnyMap 测试案例。 33 | 34 | ## 序列化和反序列化 35 | 36 | 我们对存储状态的元数据感兴趣，以便在崩溃或模糊器停止的情况下不会丢失它们。要做到这一点，它们必须使用 Serde 进行序列化和非序列化。 37 | 38 | 由于元数据是作为 trait 对象存储在 SerdeAnyMap 中的，所以默认情况下它们不能用 Serde 进行反序列化。 39 | 40 | 为了解决这个问题，在 LibAFL 中，每个 SerdeAny 结构都必须在一个全局注册表中注册，该注册表可以跟踪类型并允许对注册的类型进行 (反) 序列化。 41 | 42 | 通常情况下，`impl_serdeany` 宏为用户创建一个构造函数来填充注册表。然而，当在 `no_std` 模式下使用 LibAFL 时，这个操作必须在 `main` 函数的任何其他操作之前手动进行。 43 | 44 | 要做到这一点，开发者需要知道模糊器内部使用的每个元数据类型，并在 `main` 的开头为每个元数据调用 `RegistryBuilder::register::()`。 45 | -------------------------------------------------------------------------------- /src/getting_started/setup.md: -------------------------------------------------------------------------------- 1 | # 设置 2 | 3 | 第一步是下载 LibAFL 和所有没有被 `cargo` 自动安装的依赖项。 4 | 5 | > ### 命令行符号 6 | > 7 | > 在本章和全书中，我们展示了一些终端内容。终端输入的行都以`$`开头，但你不需要输入`$`字符； 8 | > 它表示每个命令的开始。不以"$"开头的行通常显示的是 > 前一条命令的输出。 9 | > 此外，PowerShell特定的例子将使用`>`而不是`$`。 10 | 11 | 虽然技术上你不需要安装 LibAFL，而是可以直接使用 crates.io 的版本，但我们还是建议下载或克隆 GitHub版本，这样你就可以得到示例模糊器、额外的实用程序和最新的补丁。 12 | 13 | 最简单的方法是使用 `git`: 14 | 15 | ```sh 16 | $ git clone git@github.com:AFLplusplus/LibAFL.git 17 | ``` 18 | 19 | 你也可以在 类UNIX 的机器上，下载一个压缩的存档，然后用以下方法解压: 20 | 21 | ```sh 22 | $ wget https://github.com/AFLplusplus/LibAFL/archive/main.tar.gz 23 | $ tar xvf LibAFL-main.tar.gz 24 | $ rm LibAFL-main.tar.gz 25 | $ ls LibAFL-main # this is the extracted folder 26 | ``` 27 | 28 | ## 安装 Clang 29 | 30 | LibAFL 的外部依赖之一是 Clang C/C++ 编译器。 31 | 虽然大部分代码都是纯Rust语言编写，但我们仍然需要一个C语言编译器，因为稳定的Rust仍然不支持LibAFL某些部分可能需要的功能，比如弱连接以及LLVM内置链接。 32 | 对于这些部分，我们使用C语言来向我们的Rust代码库暴露缺少的功能。 33 | 34 | 此外，如果你想对 C/C++ 应用程序进行源码级模糊测试，你可能需要Clang及其插桩选项来编译被测程序。 35 | 36 | 在Linux上，你可以使用你的发行版的软件包管理器来获取Clang，但这些软件包并不总是最新的。 37 | 相反，我们建议使用来自 LLVM 的 Debian/Ubuntu 预编译包，这些包可以通过他们的 [官方仓库](https://apt.llvm.org/) 获得。 38 | 39 | 对于Microsoft Windows，你可以下载 LLVM 定期生成的 [安装包](https://llvm.org/builds/)。 40 | 41 | 尽管 Clang 是 MacOS 上的默认C编译器，但我们不鼓励使用苹果公司提供的编译器，而鼓励使用从 [Homebrew](https://brew.sh/) 安装的版本: `brew install llvm`。 42 | 43 | 另外，你也可以下载LLVM源码并自行构建，按照 [这里](https://clang.llvm.org/get_started.html) 的方法。 44 | 45 | ## 安装 Rust 46 | 47 | 如果你没有安装 Rust，你可以很容易地按照 [这里](https://www.rust-lang.org/tools/install) 描述的步骤来安装它。 48 | 49 | 请注意，Linux 发行版中的 Rust 版本可能已经过时，LibAFL 总是使用最新的**稳定**版本，可通过 `rustup upgrade` 获得。 50 | 51 | 我们建议先安装 Clang 和 LLVM，然后再安装 Rust。 52 | -------------------------------------------------------------------------------- /src/getting_started/crates.md: -------------------------------------------------------------------------------- 1 | # Crates 2 | 3 | LibAFL 是由不同的 crate 组成的。 4 | crate 是 Rust 的 Cargo 构建系统中的一个独立的库，你可以通过把它添加到你的项目的 `Cargo.toml` 文件中来使用，比如: 5 | 6 | ```toml 7 | [dependencies] 8 | libafl = { version = "*" } 9 | ``` 10 | 11 | 对于 LibAFL 来说，每个 crate 都有其独立的用途，用户可能不需要在其项目中使用所有的 crate。 12 | 13 | 按照项目根目录下的文件夹的命名惯例，它们是: 14 | 15 | ### [`libafl`](https://github.com/AFLplusplus/LibAFL/tree/main/libafl) 16 | 17 | 这是 主crate，包含了构建模糊器所需的所有组件。 18 | 19 | 这个板块有许多 Feature标志，可以启用和禁用 LibAFL 的某些方面。 20 | 这些特性可以在 [LibAFL's `Cargo.toml`](https://github.com/AFLplusplus/LibAFL/blob/main/libafl/Cargo.toml) "`[features]`"下找到，并且通常在那里有注释说明。 21 | 一些值得注意的特性是。 22 | 23 | - `std`: 启用代码中使用Rust标准库的部分。如果没有这个标志，LibAFL是 `no_std` 兼容的，这将禁用一系列功能，但允许我们在嵌入式环境中使用LibAFL，阅读 [no_std`部分](../advanced_features/no_std/no_std.md) 了解更多细节 24 | - `derive`: 可以使用 LibAFL 的 libafl_derive 中定义的 `derive(...)` 宏 25 | - `rand_trait`: 允许你在需要与Rust的 [`rand` crate](https://crates.io/crates/rand) 兼容的地方使用LibAFL的非常快速 (*但不安全！*) 的随机数发生器 26 | - `llmp_bind_public`: 使 LibAFL 的 LLMP 绑定到一个公共的TCP端口，其他的fuzzers节点可以通过这个端口与这个实例通信 27 | - `introspection`: 为LibAFL添加性能统计 28 | 29 | 你可以通过在你的 `Cargo.toml` 中为 LibAFL 使用 `features = ["feature1", "feature2", ...]` 来选择特性。 30 | 在这个列表中，默认情况下，`std`、`derive` 和 `rand_trait` 已经被设置。你可以通过在你的 `Cargo.toml` 中设置 `default-features = false` 来选择禁用它们。 31 | 32 | ### libafl_sugar 33 | 34 | sugar crate 抽离了 LibAFL API 的大部分复杂性。 35 | 它的目标不是高灵活性，而是高层次和易于使用。 36 | 它不像从每个单独的组件中缝合你的模糊器那样灵活，但允许你用最少的代码行建立一个模糊器。 37 | 要看它的运行情况，请看一下[`libfuzzer_stb_image_sugar`示例模糊器](https://github.com/AFLplusplus/LibAFL/tree/main/fuzzers/libfuzzer_stb_image_sugar)。 38 | 39 | ### libafl_derive 40 | 41 | 这是一个与 `libafl` crate 配对的 proc-macro 板块。 42 | 43 | 目前，它只是暴露了 `derive(SerdeAny)` 宏，可以用来定义 Metadata 结构，详见关于 [Metadata](../design/metadata.md) 的部分。 44 | 45 | ### libafl_targets 46 | 47 | 这个板块提供了与目标交互的代码，并对其进行检测。 48 | 为了在编译时启用和禁用功能，使用功能标志来启用和禁用这些功能。 49 | 50 | 目前，支持的标志有: 51 | 52 | - `pcguard_edges`: 定义了 SanitizerCoverage trace-pc-guard 钩子来跟踪 map 中的执行边 53 | - `pcguard_hitcounts`: 定义了 SanitizerCoverage trace-pc-guard 钩子，以追踪 map 中已执行的边和hitcounts (如AFL) 54 | - `libfuzzer`: 提供了一个 libFuzzer 风格的兼容层 55 | - `value_profile`: 定义了 SanitizerCoverage trace-cmp 钩子，以跟踪 map 中每个比较的匹配位 56 | 57 | ### libafl_cc 58 | 59 | 这是一个提供实用程序的库，用于包装编译器和创建源码级模糊器。 60 | 61 | 目前，只有Clang编译器被支持。 62 | 为了更深入地了解它，请看一下教程和例子。 63 | 64 | ### libafl_frida 65 | 66 | 这个库将 LibAFL 与 Frida 作为插桩分析的后端连接起来。 67 | 68 | 有了这个库，你就可以对 Linux/MacOS/Windows/Android 上的目标进行覆盖率采集。 69 | 70 | 此外，它还支持 CmpLog 和 AddressSanitizer 插桩和 aarch64 的运行时。 71 | 72 | ### libafl_qemu 73 | 74 | 这个库将 LibAFL 与 QEMU 用户模式连接起来，以模糊 ELF 跨平台二进制文件。 75 | 76 | 它可以在 Linux 上工作，并且可以在没有碰撞的情况下收集边缘覆盖率! 77 | 它还支持大量的钩子和插桩选项。 78 | -------------------------------------------------------------------------------- /src/message_passing/message_passing.md: -------------------------------------------------------------------------------- 1 | # 消息传递 2 | 3 | LibAFL 提供了一个标准的机制，用于在进程和机器上进行低开销的消息传递。 4 | 我们使用消息传递来通知其他连接的客户端/模糊器/节点关于新的测试案例、元数据和关于当前运行的统计数据。 5 | 根据个人需要，LibAFL 也可以将测试案例的内容写到磁盘上，同时仍然使用事件来通知其他模糊器，使用一个 `OnDiskCorpus`. 6 | 7 | 在我们的测试中，消息传递可以很好地在多个运行中的模糊器实例之间分享新的测试案例和元数据，以进行多核模糊处理。 8 | 具体来说，它比在共享语料库上使用内存锁要好得多，也比通过文件系统共享测试案例要好得多，就像 AFL 传统的做法。 9 | 用起来 `htop` 中 `所有核心都是绿色的`，也就是说，没有内核交互。 10 | 11 | `EventManager` 接口用于使用 `Low Level Message Passing` 发送事件，这是一种通过共享内存或TCP的自定义消息传递机制。 12 | 13 | ## 低水平消息传递（LLMP） 14 | 15 | LibAFL 有一个合理的无锁消息传递机制，可以很好地跨核扩展，使用其 *broker2broker* 机制，甚至可以通过TCP连接机器。 16 | 大多数模糊测试的例子都使用这种机制，如果你想在一个以上的核心上进行模糊测试，它是最好的 `事件管理器`。 17 | 在下文中，我们将描述 `LLMP` 的内部工作原理。 18 | 19 | `LLMP` 有一个 `broker` 进程，可以将任何客户进程发送的消息转发给所有其他客户。 20 | broker 也可以拦截和过滤它收到的消息，而不是转发它们。 21 | broker 过滤的信息的一个常见用例是每个客户直接发送给 broker 的状态信息。 22 | broker 用这些信息来绘制一个简单的用户界面，其中有所有客户的最新信息，然而其他客户不需要接收这些信息。 23 | 24 | ### 通过共享内存的快速本地消息 25 | 26 | 在整个 LibAFL 中，我们使用了一个围绕不同操作系统的共享 map 的包装器，称为 `ShMem`，它是 `LLMP` 的骨干。 27 | 每个client，通常是试图分享统计数据和新的测试案例的摸索者，都会映射一个输出的 `ShMem` map。 28 | 除了极少数的例外，只有这个客户写到这个 map 上，因此，我们不会在竞赛条件下运行，可以不用锁。 29 | broker 从所有客户的 `ShMem` 映射中读取。 30 | 它定期检查所有传入的客户端映射，然后将新消息转发到由所有连接的客户端映射的 出站广播-`ShMem。 31 | 32 | 为了发送新消息，客户端在其共享内存的末端放置一个新消息，然后更新一个静态字段来通知代理。 33 | 一旦传出的映射已满，发送者使用各自的 `ShMemProvider` 分配一个新的 `ShMem`。 34 | 然后，它使用页面结束 (`EOP`) 消息发送所需信息，将连接进程中新分配的页面映射到旧的页面。 35 | 一旦接收者映射了新的页面，就把它标记为安全的，可以从发送进程中解除映射 (如果我们在短时间内有超过一个EOP，就可以避免竞赛条件)，然后继续从新的 `ShMem` 中读取。 36 | 37 | Client 对 broker 的映射模式如下: 38 | 39 | ```text 40 | [client0] [client1] ... [clientN] 41 | | | / 42 | [client0_out] [client1_out] ... [clientN_out] 43 | | / / 44 | |________________/ / 45 | |________________________________/ 46 | \|/ 47 | [broker] 48 | ``` 49 | 50 | broker 在所有传入的 map 上循环，并检查新的消息。 51 | 在 `std` 构建中，broker 会在循环后睡眠几毫秒，因为我们不需要消息立即到达。 52 | 在 broker 收到来自客户端N的新消息后，(`clientN_out->current_id != last_message->message_id`) broker 会将消息内容复制到自己的广播共享内存。 53 | 54 | 客户端定期地，例如在完成 `n` 次突变后，通过检查是否有新的消息进入 (`current_broadcast_map->current_id != last_message->message_id`) 。 55 | 虽然 broker 使用相同的 EOP 机制为其传出的 map 映射新的 `ShMem`，但它从不解除旧页面的映射。 56 | 这种额外的内存开销有一个很好的目的: 通过保留所有的广播页面，我们确保新的客户可以在以后的时间点加入到模糊测试活动中来，他们只需要从头到尾重新阅读所有广播的信息。 57 | 58 | 所以传出的消息在传出的广播 `Shmem` 上是这样流动的: 59 | 60 | ```text 61 | [broker] 62 | | 63 | [current_broadcast_shmem] 64 | | 65 | |___________________________________ 66 | |_________________ \ 67 | | \ \ 68 | | | | 69 | \|/ \|/ \|/ 70 | [client0] [client1] ... [clientN] 71 | ``` 72 | 73 | 要在 LibAFL 中使用 `LLMP`，你通常要使用 `LlmpEventManager` 或其重启的变体。 74 | 如果使用 LibAFL 的 `Launcher`，它们是默认的。 75 | 76 | 如果你想使用 `LLMP` 的原始形式，没有任何 `LibAFL` 的抽象，看看 [./libafl/examples](https://github.com/AFLplusplus/LibAFL/blob/main/libafl/examples/llmp_test/main.rs) 中的 `llmp_test` 例子。 77 | 你可以使用 `cargo run --example llmp_test` 以适当的模式运行这个例子，正如其帮助输出所指出的。 78 | 首先，你必须使用 `LlmpBroker::new()` 创建一个broker 。 79 | 然后，在其他线程中创建一些 `LlmpClients`，并使用 `LlmpBroker::register_client` 在主线程中注册它们。 80 | 最后，调用 `LlmpBroker::loop_forever()`。 81 | 82 | ### B2B: 通过TCP连接模糊器 83 | 84 | 对于 `broker2broker` 的通信，所有的广播信息都通过网络套接字转发。 85 | 为了方便起见，我们在 broker 中产生了一个额外的客户线程，它可以像其他客户那样读取广播共享内存。 86 | 对于 b2b 的通信，这个 b2b 客户端监听来自其他远程 broker 的 TCP 连接。 87 | 它在任何时候都保持一个开放的套接字池，用于连接其他远程的b2b broker。 88 | 当在本地 broker 共享内存中收到一个新消息时，b2b 客户端将通过 TCP 将其转发给所有连接的远程 broker。 89 | 另外，broker 可以从所有连接的 (远程) broker 那里接收消息，并通过客户端 `ShMem` 转发给本地broker。 90 | 91 | 作为附带说明，用于 b2b 通信的 tcp 监听器也用于新客户试图连接到本地 broker 时的初始握手，简单地交换初始 `ShMem` 描述。 92 | -------------------------------------------------------------------------------- /src/core_concepts/executor.md: -------------------------------------------------------------------------------- 1 | # 执行器 Executor 2 | 3 | 在不同的fuzzers中，这种执行被测程序的概念意味着每次运行都是一样的。 4 | 例如，对于像 libFuzzer 这样的内存模糊器来说，执行是对一个被测试函数的调用，而对于像 [kAFL](https://github.com/IntelLabs/kAFL) 这样的基于管理程序的模糊器来说，每次运行都会从一个快照启动整个操作系统。 5 | 6 | 在我们的模型中，执行者(Executor) 是一个实体，它不仅定义了如何执行目标，还定义了所有与目标的单一运行有关的易失性操作。 7 | 8 | 因此，执行者负责告知程序模糊器要在运行中使用的输入，例如写到一个内存位置或作为参数传递给约束函数。 9 | 10 | 在我们的模型中，它还可以持有一组与每个执行程序相关的观察者。 11 | 12 | 在 Rust 中，我们将这个概念与 [`Executor`](https://docs.rs/libafl/0/libafl/executors/trait.Executor.html) trait 绑定。实现这个特性的结构如果想持有一组观察者，也必须实现 [`HasObservers`](https://docs.rs/libafl/0/libafl/executors/trait.HasObservers.html)。 13 | 14 | 默认情况下，我们实现了一些常用的执行器，如 [`InProcessExecutor`](https://docs.rs/libafl/0/libafl/executors/inprocess/struct.InProcessExecutor.html)，其目标是提供进程中崩溃检测的线程函数。另一个执行器是 [`ForkserverExecutor`](https://docs.rs/libafl/0/libafl/executors/forkserver/struct.ForkserverExecutor.html)，它实现了一个类似于 AFL 的机制，用来生成子进程进行模糊处理。 15 | 16 | 在创建执行器时，一个常见的模式是包装现有的执行器，例如 [`TimeoutExecutor`](https://docs.rs/libafl/0.6.1/libafl/executors/timeout/struct.TimeoutExecutor.html) 包装了一个执行器，并在调用被包装的执行器的原始运行函数之前安装一个超时回调。 17 | 18 | ## InProcessExecutor 19 | 20 | 让我们从基本情况开始: `InProcessExecutor`。 21 | 这个执行器使用 [_SanitizerCoverage_](https://clang.llvm.org/docs/SanitizerCoverage.html) 作为其后端，你可以在 `libafl_targets/src/sancov_pcguards` 中找到相关代码。在这里，我们分配了一个名为 `EDGES_MAP` 的 map，然后我们的编译器包装器编译约束函数，将覆盖率写入这个 map 中。 22 | 当你想尽可能快地执行约束函数时，你很可能想使用 `InprocessExecutor`。 23 | 24 | 这里需要注意的是，当你的约束函数有可能出现堆损坏的问题时，你要使用另一个分配器，这样损坏的堆就不会影响到模糊器本身。(例如，我们在一些模糊器中采用 MiMalloc) 。另外，你也可以启用 AddressSanitizer 来编译你的约束函数，以确保你能捕捉到这些堆的错误。 25 | 26 | ## ForkserverExecutor 27 | 28 | 接下来，我们来看看 `ForkserverExecutor`。在这种情况下，是 `afl-cc` (来自AFLplus/AFLplus) 在编译约束函数代码，因此，我们不能再使用 `EDGES_MAP`。希望我们有 [_a way_](https://github.com/AFLplusplus/AFLplusplus/blob/2e15661f184c77ac1fbb6f868c894e946cbb7f17/instrumentation/afl-compiler-rt.o.c#L270) 告诉 forkserver 哪个 map 来记录覆盖率。 29 | 30 | 你可以从 forkserver 的例子中看到: 31 | 32 | ```rust,ignore 33 | //Coverage map shared between observer and executor 34 | let mut shmem = StdShMemProvider::new().unwrap().new_shmem(MAP_SIZE).unwrap(); 35 | //let the forkserver know the shmid 36 | shmem.write_to_env("__AFL_SHM_ID").unwrap(); 37 | let mut shmem_buf = shmem.as_mut_slice(); 38 | ``` 39 | 40 | 这里我们建立一个共享内存区域: `shmem`，并将其写入环境变量 `__AFL_SHM_ID`。然后，被检测的二进制文件或 forkerver 会找到这个共享内存区域 (来自上述环境变量) 来记录其覆盖范围。在你的fuzzer方面，你可以将这个shmem map传递给你的 `Observer`，以获得与任何 `Feedback` 相结合的覆盖率反馈。 41 | 42 | `ForkserverExecutor` 的另一个特点是共享内存测试案例。在正常情况下，突变的输入是通过 `.cur_input` 文件在 forkerver 和被测二进制之间传递。你可以通过用共享内存传递输入来提高你的 forkserver 模糊器的性能。 43 | 参见 AFL++ 的 [_documentation_](https://github.com/AFLplusplus/AFLplusplus/blob/stable/instrumentation/README.persistent_mode.md#5-shared-memory-fuzzing) 或 `forkserver_simple/src/program.c` 中的fuzzer例子以供参考。 44 | 45 | 这很简单，当你调用 `ForkserverExecutor::new()` 并将 `use_shmem_testcase` 设为true时，`ForkserverExecutor` 会将事情设置好，你的约束函数就可以从 `__AFL_FUZZ_TESTCASE_BUF` 获取输入。 46 | 47 | ## InprocessForkExecutor 48 | 49 | 最后，我们来谈谈 `InProcessForkExecutor`。 50 | `InProcessForkExecutor` 与 `InprocessExecutor` 只有一个区别: 它在运行约束函数之前进行 fork，仅此而已。 51 | 但为什么我们要这样做呢？好吧，在某些情况下，你可能会发现你的约束函数非常不稳定，或者你的约束函数对全局状态造成了破坏。在这种情况下，你想在子进程中执行约束函数运行之前将其 fork，这样就不会破坏事情。 52 | 然而，我们必须照顾到共享内存，是子进程在运行约束函数代码，并将覆盖范围写到 map 上。 53 | 我们必须使 map 在父进程和子进程之间共享，所以我们将再次使用共享内存。你应该用 `pointer_maps` (用于 `libafl_targes`) 功能来编译你的约束函数，这样，我们可以有一个指针: `EDGES_MAP_PTR`，可以指向任何覆盖图。 54 | 在你的fuzzer方面，你可以分配一个共享内存区域，让 `EDGES_MAP_PTR` 指向你的共享内存。 55 | 56 | ```rust,ignore 57 | let mut shmem; 58 | unsafe{ 59 | shmem = StdShMemProvider::new().unwrap().new_shmem(MAX_EDGES_NUM).unwrap(); 60 | } 61 | let shmem_buf = shmem.as_mut_slice(); 62 | unsafe{ 63 | EDGES_PTR = shmem_buf.as_ptr(); 64 | } 65 | ``` 66 | 67 | 同样，你可以把这个 `shmem` map 传递给你的 `Observer` 和 `Feedback` 以获得覆盖率反馈。 68 | -------------------------------------------------------------------------------- /src/advanced_features/concolic/concolic.md: -------------------------------------------------------------------------------- 1 | # Concolic Tracing和混合模糊测试 2 | 3 | LibAFL 支持基于 [SymCC](https://github.com/eurecom-s3/symcc) 插桩编译器的协程跟踪。 4 | 5 | 对于那些没有经验的人来说，下面将尝试用一个例子从头开始描述协程跟踪。 6 | 然后，我们将讨论 SymCC 和 LibAFL 协程跟踪的关系。 7 | 最后，我们将通过使用 LibAFL 构建一个基本的混合模糊器。 8 | 9 | ## Concolic Tracing的例子 10 | 11 | > Concolic Tracing 12 | > 13 | > Concolic 是单词concrete(具体)和symbolic(符号)的一个混合体 14 | 15 | 假设你想对以下程序进行模糊测试: 16 | 17 | ```rust 18 | fn target(input: &[u8]) -> i32 { 19 | match &input { 20 | // fictitious crashing input 21 | &[1, 3, 3, 7] => 1337, 22 | // standard error handling code 23 | &[] => -1, 24 | // representative of normal execution 25 | _ => 0 26 | } 27 | } 28 | ``` 29 | 30 | 一个简单的覆盖率最大化的模糊器在某种程度上随机地产生新的输入，将很难找到触发虚构的崩溃输入的一个输入。 31 | 许多技术被提出来，以使模糊处理不那么随机，而是更直接地试图改变输入，以翻转特定的分支，例如参与崩溃上述程序的分支。 32 | 33 | 并行追踪允许我们以 **分析的方式而不是** 随机的方式 (即猜测) 构建一个输入，以尝试程序中的一个新路径 (比如例子中的崩溃路径) 。 34 | 原则上，协程跟踪的工作方式是观察程序执行过程中所有依赖输入的执行指令。 35 | 为了理解这一点，我们将以上述程序为例进行说明。 36 | 37 | 首先，我们将程序简化为简单的 `if-then-else-statements`: 38 | 39 | ```rust 40 | fn target(input: &[u8]) -> i32 { 41 | if input.len() == 4 { 42 | if input[0] == 1 { 43 | if input[1] == 3 { 44 | if input[2] == 3 { 45 | if input[3] == 7 { 46 | return 1337; 47 | } else { 48 | return 0; 49 | } 50 | } else { 51 | return 0; 52 | } 53 | } else { 54 | return 0; 55 | } 56 | } else { 57 | return 0; 58 | } 59 | } else { 60 | if input.len() == 0 { 61 | return -1; 62 | } else { 63 | return 0; 64 | } 65 | } 66 | } 67 | ``` 68 | 69 | 接下来我们跟踪输入 `[]`. 70 | 71 | 跟踪会像下面这样: 72 | 73 | ```rust,ignore 74 | Branch { // if input.len() == 4 75 | condition: Equals { 76 | left: Variable { name: "input_len" }, 77 | right: Integer { value: 4 } 78 | }, 79 | taken: false // This condition turned out to be false... 80 | } 81 | Branch { // if input.len() == 0 82 | condition: Equals { 83 | left: Variable { name: "input_len" }, 84 | right: Integer { value: 0 } 85 | }, 86 | taken: true // This condition turned out to be true! 87 | } 88 | ``` 89 | 90 | 利用这个跟踪，我们可以很容易地推断出，我们可以通过一个长度为4的输入或者一个非零长度的输入来迫使程序采取不同的路径。 91 | 我们通过否定每个分支条件并分析解决所产生的 `expression` 来做到这一点。 92 | 事实上，我们可以为任何计算创建这些表达式，并把它们交给 [SMT](https://en.wikipedia.org/wiki/Satisfiability_modulo_theories)-Solver，它将生成一个满足表达式的输入 (只要这种输入存在) 。 93 | 94 | 在混合模糊计算中，我们将这种追踪+求解的方法与更传统的模糊计算技术相结合。 95 | 96 | ## LibAFL、SymCC和SymQEMU中的协程跟踪 97 | 98 | LibAFL中的协程跟踪支持是通过 SymCC 实现的。 99 | SymCC 是 clang 的一个编译器插件，可以用来替代普通的 C 或 C++ 编译器。 100 | SymCC 将对编译后的代码进行回调，使之成为一个可以由用户提供的运行时。 101 | 这些回调允许运行时构建一个类似于前面例子的跟踪。 102 | 103 | ### SymCC和它的运行时 104 | 105 | SymCC有两个运行时: 106 | 107 | * 一个 "简单的 "运行时，它试图用 [Z3](https://github.com/Z3Prover/z3/wiki) 来解决它遇到的任何分支，以及 108 | * 一个基于 [QSym](https://github.com/sslab-gatech/qsym) 的运行时，它对表达式进行了更多的过滤，也使用Z3进行求解 109 | 110 | 然而，与LibAFL的集成需要你使用 [`symcc_runtime`](https://docs.rs/symcc_runtime/0.1/symcc_runtime) crate进行 **BYORT** (_bring your own runtime_) 。 111 | 这个工具箱允许你轻松地从内置的构建模块中建立一个自定义的运行时，或者以完全的灵活性创建全新的运行时。 112 | 查看 `symcc_runtime` 文档，了解更多关于如何建立你自己的运行时的信息。 113 | 114 | ### SymQEMU 115 | 116 | [SymQEMU](https://github.com/eurecom-s3/symqemu) 是SymCC的一个兄弟项目。 117 | 它不是在编译时对目标进行检测，而是通过动态二进制翻译插入检测，建立在 [`QEMU`](https://www.qemu.org) 仿真栈之上。 118 | 这意味着使用SymQEMU，任何 (x86) 二进制文件都可以被追踪，而不需要提前建立插桩。 119 | `symcc_runtime` 工具箱支持这种使用情况，用 `symcc_runtime` 构建的运行时也可用于SymQEMU。 120 | 121 | ## LibAFL中的混合型模糊处理 122 | 123 | LibAFL资源库中包含了一个[混合模糊器实例](https://github.com/AFLplusplus/LibAFL/tree/main/fuzzers/libfuzzer_stb_image_concolic)。 124 | 125 | 使用LibAFL构建一个混合型模糊器主要有三个步骤。 126 | 1. 建立一个运行时间 127 | 2. 选择一个工具化的方法和 128 | 3. 构建模糊器 129 | 130 | 请注意，这些步骤的顺序是很重要的。 131 | 例如，在用SymCC进行插桩分析之前，我们需要先准备好运行时间。 132 | 133 | ### 建立一个运行时 134 | 135 | 使用 `symcc_runtime` 板块可以很容易地构建一个自定义运行时。 136 | 注意，自定义运行时是一个单独的共享对象文件，这意味着我们需要一个单独的crate用于我们的运行时。 137 | 请查看 [混合模糊器的运行时间示例](https://github.com/AFLplusplus/LibAFL/tree/main/fuzzers/libfuzzer_stb_image_concolic/runtime) 和 [`symcc_runtime` docs](https://docs.rs/symcc_runtime/0.1/symcc_runtime) 以获得灵感。 138 | 139 | ### 工具化 140 | 141 | 在LibAFL中，有两种主要的工具化方法来使用协程跟踪。 142 | 143 | * 使用**编译时**插桩化的目标与**SymCC** 144 | 145 | 这只有在目标的源代码可用，并且目标很容易使用SymCC编译器包装器构建的情况下才有效 146 | 147 | * 使用**SymQEMU**在**运行时动态地检测目标 148 | 149 | 这避免了一个单独的插桩化目标与协程跟踪插桩化，而且不需要源代码。 150 | 然而，应该注意的是，生成的表达式的 "质量 "可能会大大降低，而且SymQEMU通常比SymCC生成的表达式要多得多，而且明显更曲折。 151 | 因此，建议尽可能使用SymCC而不是SymQEMU。 152 | 153 | #### 使用 SymCC 154 | 155 | 在使用SymCC进行模糊测试之前，需要对目标进行检测。 156 | 具体如何做并不重要。 157 | 然而，SymCC编译器需要知道它应该检测的运行时间的位置。 158 | 这可以通过将 `SYMCC_RUNTIME_DIR` 环境变量设置为包含运行时的目录来实现 (通常是你的运行时板块的 `target/(debug|release)` 文件夹) 。 159 | 160 | 混合模糊器的例子在其 [`build.rs`构建脚本](https://github.com/AFLplusplus/LibAFL/blob/main/fuzzers/libfuzzer_stb_image_concolic/fuzzer/build.rs#L50) 中检测目标。 161 | 它通过克隆和构建SymCC的副本来实现，然后使用这个版本来检测目标。 162 | [`symcc_libafl` crate](https://docs.rs/symcc_libafl) 包含用于克隆和构建SymCC的辅助函数。 163 | 164 | 在尝试构建SymCC之前，请确保你满足SymCC的 [构建要求](https://github.com/eurecom-s3/symcc#readme)。 165 | 166 | #### 使用SymQEMU 167 | 168 | 根据 SymQEMU 的 [构建说明](https://github.com/eurecom-s3/symqemu#readme) 来构建它。 169 | 默认情况下，SymQEMU 会在一个同级目录下寻找运行时。 170 | 由于我们没有运行时，我们需要让它知道你的运行时的路径，将 `--symcc-build` 脚本的参数设置为你的运行时的路径。 171 | 172 | ### 构建模糊器 173 | 174 | 无论采用哪种方法，现在模糊器和被检测目标之间的接口应该是一致的。 175 | 使用SymCC和SymQEMU的唯一区别应该是代表目标的二进制文件。 176 | 在SymCC的情况下，它将是用插桩构建的二进制文件，而在SymQEMU的情况下，它将是模拟器的二进制文件 (例如: `x86_64-linux-user/symqemu-x86_64`)，后面是你的非插桩化的目标二进制文件和论据。 177 | 178 | 你可以使用 [`CommandExecutor`](https://docs.rs/libafl/0.6.0/libafl/executors/command/struct.CommandExecutor.html) 来执行你的目标 ([example](https://github.com/AFLplusplus/LibAFL/blob/main/fuzzers/libfuzzer_stb_image_concolic/fuzzer/src/main.rs#L244)) 。 179 | 在配置命令时，如果你的目标从文件中读取输入 (而不是标准输入)，请确保传递 `SYMCC_INPUT_FILE` 环境变量的输入文件路径。 180 | 181 | #### 序列化和解算 182 | 183 | 虽然完全可以建立一个自定义的运行时，在目标进程的背景下执行混合模糊的求解步骤，但LibAFL协程跟踪支持的预期用途是使用 [`TracingRuntime`](https://docs.rs/symcc_runtime/0.1/symcc_runtime/tracing/struct.TracingRuntime.html) 对 (过滤和预处理的) 分支条件进行序列化。 184 | 这个序列化的表述可以在模糊程序中被反序列化，以便使用 [`ConcolicObserver`](https://docs.rs/libafl/0.6.0/libafl/observers/concolic/struct.ConcolicObserver.html) 包裹在 [`ConcolicTracingStage`](https://docs.rs/libafl/0.6.0/libafl/stages/concolic/struct.ConcolicTracingStage.html) 中进行解决，它将在每个 [`TestCase`](https://docs.rs/libafl/0.6.0/libafl/corpus/testcase/struct.Testcase.html) 中附加一个 [`ConcolicMetadata`](https://docs.rs/libafl/0.6.0/libafl/observers/concolic/struct.ConcolicMetadata.html)。 185 | 186 | `ConcolicMetadata'可以用来重放协程跟踪，并使用SMT-Solver进行解决。 187 | 然而，大多数涉及协程跟踪的用例都需要围绕他们想要解决的分支定义一些策略。 188 | [`SimpleConcolicMutationalStage`](https://docs.rs/libafl/0.6.0//libafl/stages/concolic/struct.SimpleConcolicMutationalStage.html) 可用于测试目的。 189 | 它将尝试解决所有分支，就像SymCC的原始简单后端一样，使用Z3。 190 | 191 | ### 示例 192 | 193 | 这个例子说明了如何使用 [`ConcolicTracingStage`和`SimpleConcolicMutationalStage`](https://github.com/AFLplusplus/LibAFL/blob/main/fuzzers/libfuzzer_stb_image_concolic/fuzzer/src/main.rs#L203) 来建立一个基本的混合模糊器。 194 | -------------------------------------------------------------------------------- /src/baby_fuzzer.md: -------------------------------------------------------------------------------- 1 | # 一个简单的LibAFL模糊器 2 | 3 | 本章讨论了一个使用 LibAFL API 构建的极其简单的模糊器。 4 | 你将学习基本的实体，如 `State`、`Observer` 和 `Executor`。 5 | 虽然下面的章节会详细讨论 LibAFL 的组件，但在这里我们介绍基本原理。 6 | 7 | 我们将对一个简单的 Rust 函数进行模糊处理，该函数在某个条件下会出现panic。这个模糊器将是单线程的，并在崩溃后停止，就像libFuzzer通常做的那样。 8 | 9 | 你可以在 [`fuzzers/baby_fuzzer`](https://github.com/AFLplusplus/LibAFL/tree/main/fuzzers/baby_fuzzer) 中找到本教程的完整版本，作为一个模糊器的例子。 10 | 11 | > ### 警告 12 | > 13 | > 这个示例模糊器对于任何现实世界的使用来说都是太天真了。 14 | > 它的目的仅仅是为了展示库的主要组件，如果想更深入地了解如何构建一个自定义的模糊器，请直接阅读 [Tutorial chapter](./tutorial/intro.md)。 15 | 16 | ## 创建一个项目 17 | 18 | 我们使用 `cargo` 创建一个新的Rust项目，将 `LibAFL` 作为一个依赖项。 19 | 20 | ```sh 21 | $ cargo new baby_fuzzer 22 | $ cd baby_fuzzer 23 | ``` 24 | 25 | 生成的 `Cargo.toml` 看起来像下面这样: 26 | 27 | ```toml 28 | [package] 29 | name = "baby_fuzzer" 30 | version = "0.1.0" 31 | authors = ["Your Name "] 32 | edition = "2018" 33 | 34 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html 35 | 36 | [dependencies] 37 | ``` 38 | 39 | 为了使用 LibAFl，我们必须在 `[dependencies]` 下增添其依赖 `libafl = { path = "path/to/libafl/" }`。 40 | 如果你愿意，你可以使用 crates.io 的 LibAFL 版本，在这种情况下，你必须使用 `libafl = "*"` 来获取最新的版本 (或者将其设置为当前版本) 。 41 | 42 | 由于我们要对Rust代码进行模糊处理，我们希望崩溃不会简单地导致程序退出，而是引发一个 `abort`，然后可以被模糊器捕获。 43 | 为此，我们在 [profiles](https://doc.rust-lang.org/cargo/reference/profiles.html) 中指定 `panic = "abort"`。 44 | 45 | 除了这个设置之外，我们还为在发布模式下的编译添加了一些优化标志，最终的 `Cargo.toml` 应该类似于下面的样子: 46 | 47 | ```toml 48 | [package] 49 | name = "baby_fuzzer" 50 | version = "0.1.0" 51 | authors = ["Your Name "] 52 | edition = "2018" 53 | 54 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html 55 | 56 | [dependencies] 57 | libafl = { path = "path/to/libafl/" } 58 | 59 | [profile.dev] 60 | panic = "abort" 61 | 62 | [profile.release] 63 | panic = "abort" 64 | lto = true 65 | codegen-units = 1 66 | opt-level = 3 67 | debug = true 68 | ``` 69 | 70 | ## 被测试的函数 71 | 72 | 打开 `src/main.rs`，我们有一个空的 `main` 函数。 73 | 首先，我们创建一个我们想要模糊处理的闭包。它接受一个缓冲区作为输入，如果它以 `abc` 开头，就会引起崩溃: 74 | 75 | ```rust 76 | extern crate libafl; 77 | use libafl::inputs::{BytesInput, HasTargetBytes}; 78 | 79 | let mut harness = |input: &BytesInput| { 80 | let target = input.target_bytes(); 81 | let buf = target.as_slice(); 82 | if buf.len() > 0 && buf[0] == 'a' as u8 { 83 | if buf.len() > 1 && buf[1] == 'b' as u8 { 84 | if buf.len() > 2 && buf[2] == 'c' as u8 { 85 | panic!("=)"); 86 | } 87 | } 88 | } 89 | }; 90 | // To test the panic: 91 | // let input = BytesInput::new("abc".as_bytes()); 92 | // harness(&input); 93 | ``` 94 | 95 | ## 生成和运行一些测试 96 | 97 | 基于 LibAFL 的模糊测试器使用的主要组件之一是状态，这是一个在模糊测试过程中演变的数据容器。 98 | 包括所有的状态，如输入的语料库，当前的rng状态，以及测试案例和运行的潜在 Metadata。 99 | 在我们的 `main` 中，我们创建了一个基本的 State 实例，如下所示。 100 | 101 | ```rust,ignore 102 | // create a State from scratch 103 | let mut state = StdState::new( 104 | // RNG 105 | StdRand::with_seed(current_nanos()), 106 | // Corpus that will be evolved, we keep it in memory for performance 107 | InMemoryCorpus::new(), 108 | // Corpus in which we store solutions (crashes in this example), 109 | // on disk so the user can get them after stopping the fuzzer 110 | OnDiskCorpus::new(PathBuf::from("./crashes")).unwrap(), 111 | (), 112 | ); 113 | ``` 114 | 115 | 它需要一个随机数发生器，这是模糊器状态的一部分，在这种情况下，我们使用默认的 `StdRand`，但你可以选择一个不同的。我们用当前的纳秒数作为种子。 116 | 117 | 作为第二个参数，它需要一个实现语料库特性的实例，本例中是 `InMemoryCorpus`。语料库是由模糊器演化出的测试案例的容器，在这种情况下，我们把它全部放在内存中。 118 | 119 | 我们将在后面讨论最后一个参数。第三个参数是另一个语料库，在这种情况下，用来存储被视为模糊器 "solutions" 的测试案例。对于我们的目的，solutions是触发崩溃的输入。在这种情况下，我们想把它存储在磁盘的 `crashes` 目录下，这样我们就可以检查它。 120 | 121 | 另一个必要的组件是 `EventManager`。它处理一些事件，如在模糊处理过程中向语料库添加测试案例。对于我们的目的，我们使用最简单的一个，它只是用一个 `Monitor` 实例向用户显示这些事件的信息。 122 | 123 | ```rust,ignore 124 | // The Monitor trait defines how the fuzzer stats are displayed to the user 125 | let mon = SimpleMonitor::new(|s| println!("{}", s)); 126 | 127 | // The event manager handle the various events generated during the fuzzing loop 128 | // such as the notification of the addition of a new item to the corpus 129 | let mut mgr = SimpleEventManager::new(mon); 130 | ``` 131 | 132 | 此外，我们还有 Fuzzer，一个包含一些改变状态的行动的实体。其中一个动作是使用 `CorpusScheduler` 为模糊器调度测试案例。 133 | 我们将其创建为 `QueueCorpusScheduler`，一个以先进先出方式向模糊器提供测试案例的调度器。 134 | 135 | ```rust,ignore 136 | // A queue policy to get testcasess from the corpus 137 | let scheduler = QueueCorpusScheduler::new(); 138 | 139 | // A fuzzer with feedbacks and a corpus scheduler 140 | let mut fuzzer = StdFuzzer::new(scheduler, (), ()); 141 | ``` 142 | 143 | 最后，我们需要一个 `Executor`，它是负责运行我们被测试程序的实体。在这个例子中，我们想在进程中运行 `harness` 函数 (例如，不 fork 出一个子程序)，因此我们使用 `InProcessExecutor`。 144 | 145 | ```rust,ignore 146 | // Create the executor for an in-process function 147 | let mut executor = InProcessExecutor::new( 148 | &mut harness, 149 | (), 150 | &mut fuzzer, 151 | &mut state, 152 | &mut mgr, 153 | ) 154 | .expect("Failed to create the Executor"); 155 | ``` 156 | 157 | 它需要一个 `harness`、`state` 和 事件管理器 的引用。我们将在后面讨论第二个参数。 158 | 由于执行器期望约束函数返回一个 `ExitKind` 对象，我们在 `harness` 函数中添加 `ExitKind::Ok`。 159 | 160 | 现在我们有4个主要的实体，可以运行我们的测试，但我们仍然不能生成测试案例。 161 | 162 | 为此，我们使用一个生成器，`RandPrintablesGenerator`，它可以生成一串可打印的字节。 163 | 164 | ```rust,ignore 165 | use libafl::generators::RandPrintablesGenerator; 166 | 167 | // Generator of printable bytearrays of max size 32 168 | let mut generator = RandPrintablesGenerator::new(32); 169 | 170 | // Generate 8 initial inputs 171 | state 172 | .generate_initial_inputs(&mut fuzzer, &mut executor, &mut generator, &mut mgr, 8) 173 | .expect("Failed to generate the initial corpus".into()); 174 | ``` 175 | 176 | 现在你可以在你的 `main.rs` 中添加必要的 `use` 指令，并编译模糊器。 177 | 178 | ```rust 179 | extern crate libafl; 180 | 181 | use std::path::PathBuf; 182 | use libafl::{ 183 | bolts::{current_nanos, rands::StdRand}, 184 | corpus::{InMemoryCorpus, OnDiskCorpus, QueueCorpusScheduler}, 185 | events::SimpleEventManager, 186 | executors::{inprocess::InProcessExecutor, ExitKind}, 187 | fuzzer::StdFuzzer, 188 | generators::RandPrintablesGenerator, 189 | inputs::{BytesInput, HasTargetBytes}, 190 | monitors::SimpleMonitor, 191 | state::StdState, 192 | }; 193 | ``` 194 | 195 | 运行时，你应该看到类似的东西: 196 | 197 | ```sh 198 | $ cargo run 199 | Finished dev [unoptimized + debuginfo] target(s) in 0.04s 200 | Running `target/debug/baby_fuzzer` 201 | [LOG Debug]: Loaded 0 over 8 initial testcases 202 | ``` 203 | 204 | ## 用反馈来进化语料库 205 | 206 | 现在你只是运行了8个随机生成的测试案例，但其中没有一个被存储在语料库中。如果你非常幸运，也许你偶然触发了崩溃，但你在 `crashes` 中没有看到任何保存的文件。 207 | 208 | 现在我们想把我们的简单模糊器变成一个基于反馈的模糊器，增加产生正确的输入来触发崩溃的机会。我们将根据达到崩溃所需的3个条件来实现一个简单的反馈。 209 | 210 | 要做到这一点，我们需要一种方法来跟踪一个条件是否被满足。为模糊器提供模糊运行属性信息的组件，即我们案例中的满足条件，是观察者。我们使用 `StdMapObserver`，这是一个默认的观察者，它使用一个 map 来跟踪覆盖的元素。在我们的模糊器中，每个条件都被映射到这种 map 的一个条目。 211 | 212 | 我们将这样的 map 表示为一个 `static mut` 变量。 213 | 由于我们不依赖于任何插桩引擎，我们必须手动跟踪 map 中被测试函数的满足条件。 214 | 215 | ```rust 216 | extern crate libafl; 217 | use libafl::{ 218 | inputs::{BytesInput, HasTargetBytes}, 219 | executors::ExitKind, 220 | }; 221 | 222 | // Coverage map with explicit assignments due to the lack of instrumentation 223 | static mut SIGNALS: [u8; 16] = [0; 16]; 224 | 225 | fn signals_set(idx: usize) { 226 | unsafe { SIGNALS[idx] = 1 }; 227 | } 228 | 229 | // The closure that we want to fuzz 230 | let mut harness = |input: &BytesInput| { 231 | let target = input.target_bytes(); 232 | let buf = target.as_slice(); 233 | signals_set(0); 234 | if buf.len() > 0 && buf[0] == 'a' as u8 { 235 | signals_set(1); 236 | if buf.len() > 1 && buf[1] == 'b' as u8 { 237 | signals_set(2); 238 | if buf.len() > 2 && buf[2] == 'c' as u8 { 239 | panic!("=)"); 240 | } 241 | } 242 | } 243 | ExitKind::Ok 244 | }; 245 | ``` 246 | 247 | 观察者可以直接从 `SIGNALS` map 中创建，方法如下: 248 | 249 | ```rust,ignore 250 | // Create an observation channel using the signals map 251 | let observer = StdMapObserver::new("signals", unsafe { &mut SIGNALS }); 252 | ``` 253 | 254 | 观察者通常被保存在相应的执行器中，因为它们所记录的信息只对一次运行有效。然后我们必须修改我们的 `InProcessExecutor` 创建，以包括观察者，如下所示: 255 | 256 | ```rust,ignore 257 | // Create the executor for an in-process function with just one observer 258 | let mut executor = InProcessExecutor::new( 259 | &mut harness, 260 | tuple_list!(observer), 261 | &mut fuzzer, 262 | &mut state, 263 | &mut mgr, 264 | ) 265 | .expect("Failed to create the Executor".into()); 266 | ``` 267 | 268 | 既然模糊器可以观察到哪个条件被满足，我们就需要一种方法，根据这种观察来评定一个输入是否有趣 (即值得添加到语料库中) 。这里有一个反馈的概念，反馈是状态的一部分，它提供了一种将输入及其相应的执行评为有趣的方式，在观察者中寻找信息。反馈可以在一个所谓的 `FeedbackState` 实例中保持到目前为止所看到的信息的累积状态，在我们的例子中，它保持了在以前的运行中满足的条件的集合。 269 | 270 | 我们使用 `MaxMapFeedback`，这个反馈在 `MapObserver` 的 map 上实现了新奇的搜索。基本上，如果观察者的 map 中有一个值大于迄今为止为同一条目记录的最大值，它就会将该输入评为有趣的输入，并更新其状态。 271 | 272 | 反馈也被用来决定一个输入是否是一个 "solutions"。做到这一点的反馈被称为目标反馈，当它将一个输入评为有趣时，它不会被保存到语料库中，而是被保存到解决方案中，在我们的例子中被写在 `crash` 文件夹中。我们使用 `CrashFeedback` 来告诉模糊器，如果一个输入导致程序崩溃，那就是我们的解决方案。 273 | 274 | 我们需要更新我们的状态创建，包括反馈状态和模糊器，包括反馈和目标。 275 | 276 | ```rust,ignore 277 | extern crate libafl; 278 | use libafl::{ 279 | bolts::{current_nanos, rands::StdRand, tuples::tuple_list}, 280 | corpus::{InMemoryCorpus, OnDiskCorpus}, 281 | feedbacks::{MapFeedbackState, MaxMapFeedback, CrashFeedback}, 282 | fuzzer::StdFuzzer, 283 | state::StdState, 284 | observers::StdMapObserver, 285 | }; 286 | 287 | // The state of the edges feedback. 288 | let feedback_state = MapFeedbackState::with_observer(&observer); 289 | 290 | // Feedback to rate the interestingness of an input 291 | let feedback = MaxMapFeedback::new(&feedback_state, &observer); 292 | 293 | // A feedback to choose if an input is a solution or not 294 | let objective = CrashFeedback::new(); 295 | 296 | // create a State from scratch 297 | let mut state = StdState::new( 298 | // RNG 299 | StdRand::with_seed(current_nanos()), 300 | // Corpus that will be evolved, we keep it in memory for performance 301 | InMemoryCorpus::new(), 302 | // Corpus in which we store solutions (crashes in this example), 303 | // on disk so the user can get them after stopping the fuzzer 304 | OnDiskCorpus::new(PathBuf::from("./crashes")).unwrap(), 305 | // States of the feedbacks. 306 | // They are the data related to the feedbacks that you want to persist in the State. 307 | tuple_list!(feedback_state), 308 | ); 309 | 310 | // ... 311 | 312 | // A fuzzer with feedbacks and a corpus scheduler 313 | let mut fuzzer = StdFuzzer::new(scheduler, feedback, objective); 314 | ``` 315 | 316 | ## 实际的模糊处理 317 | 318 | 现在，在包括正确的 `use` 之后，我们可以运行这个程序了，但结果与之前的并没有什么不同，因为随机生成器并没有考虑到我们在语料库中保存的有趣内容。要做到这一点，我们需要插入一个 `Mutator`。 319 | 320 | LibAFL 的另一个核心组件是状态，它是对来自语料库的单个输入所做的动作。例如，`MutationalStage` 对输入进行突变，并多次执行。 321 | 322 | 作为最后一步，我们创建了一个突变状态，它使用了一个受 AFL 的 havoc 突变器启发的突变器。 323 | 324 | ```rust,ignore 325 | use libafl::{ 326 | mutators::scheduled::{havoc_mutations, StdScheduledMutator}, 327 | stages::mutational::StdMutationalStage, 328 | fuzzer::Fuzzer, 329 | }; 330 | 331 | // ... 332 | 333 | // Setup a mutational stage with a basic bytes mutator 334 | let mutator = StdScheduledMutator::new(havoc_mutations()); 335 | let mut stages = tuple_list!(StdMutationalStage::new(mutator)); 336 | 337 | fuzzer 338 | .fuzz_loop(&mut stages, &mut executor, &mut state, &mut mgr) 339 | .expect("Error in the fuzzing loop"); 340 | ``` 341 | 342 | `fuzz_loop` 将使用调度器为每个迭代向模糊器请求一个测试案例，然后它将调用状态。 343 | 344 | 加入这段代码后，我们就有了一个合适的模糊器，它可以在一秒钟内找到让函数崩溃的输入。 345 | 346 | ```text 347 | $ cargo run 348 | Compiling baby_fuzzer v0.1.0 (/home/andrea/Desktop/baby_fuzzer) 349 | Finished dev [unoptimized + debuginfo] target(s) in 1.56s 350 | Running `target/debug/baby_fuzzer` 351 | [New Testcase] clients: 1, corpus: 2, objectives: 0, executions: 1, exec/sec: 0 352 | [LOG Debug]: Loaded 1 over 8 initial testcases 353 | [New Testcase] clients: 1, corpus: 3, objectives: 0, executions: 804, exec/sec: 0 354 | [New Testcase] clients: 1, corpus: 4, objectives: 0, executions: 1408, exec/sec: 0 355 | thread 'main' panicked at '=)', src/main.rs:35:21 356 | note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace 357 | Crashed with SIGABRT 358 | Child crashed! 359 | [Objective] clients: 1, corpus: 4, objectives: 1, executions: 1408, exec/sec: 0 360 | Waiting for broker... 361 | Bye! 362 | ``` 363 | 364 | 正如你所看到的，在崩溃信息之后，日志的 `objectives` 计数增加 1，你会在 `crashes/` 中找到崩溃的输入。 365 | --------------------------------------------------------------------------------