honggfuzz-rs

使用 Google 开发的 Honggfuzz 模糊测试你的 Rust 代码！

文档

关于 Hongg

Honggfuzz 是一个以安全为导向的模糊测试工具，具有强大的分析选项。支持基于代码覆盖率（软件和硬件）的进化式、反馈驱动式模糊测试。

• 项目主页 honggfuzz.com
• 项目仓库 github.com/google/honggfuzz
• 此上游项目由 Google 维护，但...
• 这不是一个官方的 Google 产品

兼容性

• Rust: 稳定版、beta 版、nightly 版
• 操作系统: GNU/Linux、macOS、FreeBSD、NetBSD、Android、WSL（Windows Subsystem for Linux）
• 架构: x86_64、x86、arm64-v8a、armebi-v7a、armebi
• Sanitizer: 无、地址、线程、泄露

依赖项

Linux

• C 编译器: cc
• GNU Make: make
• GNU Binutils 开发文件用于 BFD 库: libbfd.h
• libunwind 开发文件: libunwind.h
• Blocks 运行时库（当使用 clang 编译时）
• liblzma 开发文件

例如在 Debian 及其衍生版本中

sudo apt install build-essential binutils-dev libunwind-dev libblocksruntime-dev liblzma-dev

如何使用此 crate

安装 honggfuzz 命令以构建带有仪器和模糊测试的软件

# installs hongg and honggfuzz subcommands in cargo
cargo install cargo-hongg

将其添加到依赖项中

[dependencies]
hongg = "0.5.54"

创建用于模糊测试的目标

use hongg::fuzz;

fn main() {
    // Here you can parse `std::env::args and
    // setup / initialize your project

    // You have full control over the loop but
    // you're supposed to call `fuzz` ad vitam aeternam
    loop {
        // The fuzz macro gives an arbitrary object (see `arbitrary crate`)
        // to a closure-like block of code.
        // For performance reasons, it is recommended that you use the native type
        // `&[u8]` when possible.
        // Here, this slice will contain a "random" quantity of "random" data.
        fuzz!(|data: &[u8]| {
            if data.len() != 3 {return}
            if data[0] != b'h' {return}
            if data[1] != b'e' {return}
            if data[2] != b'y' {return}
            panic!("BOOM")
        });
    }
}

为了乐趣和利益而模糊测试！

# builds with fuzzing instrumentation and then fuzz the "example" target
cargo hongg fuzz --bin example

一旦发生崩溃，您可以在调试环境中轻松回放

# builds the target in debug mode and replays automatically the crash in rust-lldb
cargo hongg debug --bin example hfuzz_workspace/*/*.fuzz

您还可以在不使用编译时软件仪器（LLVM的SanCov passes）的情况下构建和运行您的项目

这允许您尝试仅硬件反馈驱动的模糊测试

# builds without fuzzing instrumentation and then fuzz the "example" target using hardware-based feedback
HFUZZ_RUN_ARGS="--linux_perf_ipt_block --linux_perf_instr --linux_perf_branch" cargo hfuzz run-no-instr example

清洁

# a wrapper on "cargo clean" which cleans the fuzzing_target directory
cargo hongg clean

版本

cargo hongg --version

环境变量

RUSTFLAGS

您可以使用 RUSTFLAGS 将额外的参数发送到 rustc。

例如，您可以启用LLVM的 sanitizers。如果您想测试您的 unsafe rust代码，这是一个推荐选项，但它将对性能产生影响。

RUSTFLAGS="-Z sanitizer=address" cargo hongg fuzz -b example

HFUZZ_BUILD_ARGS

您可以使用 HFUZZ_BUILD_ARGS 将额外的参数发送到 cargo build。

HFUZZ_RUN_ARGS

您可以使用 HFUZZ_RUN_ARGS 将额外的参数发送到 hongg fuzz。有关这些参数的列表，请参阅 USAGE。

例如

# 1 second of timeout
# use 12 fuzzing thread
# be verbose
# stop after 1000000 fuzzing iteration
# exit upon crash
HFUZZ_RUN_ARGS="-t 1 -n 12 -v -N 1000000 --exit_upon_crash" cargo hfuzz run example

HFUZZ_DEBUGGER

默认情况下，我们使用 rust-lldb，但您也可以将其更改为 rust-gdb、gdb、/usr/bin/lldb-7 等。

CARGO_TARGET_DIR

目标编译目录，默认为 hfuzz_target，以免与 cargo build 的默认 target 目录冲突。

HFUZZ_WORKSPACE

Honggfuzz工作目录，默认为 hfuzz_workspace。

HFUZZ_INPUT

Honggfuzz输入文件（也称为“语料库”），默认为 $HFUZZ_WORKSPACE/{TARGET}/input。

#[cfg(fuzzing)]
let mut rng = rand_chacha::ChaCha8Rng::from_seed(&[0]);
#[cfg(not(fuzzing))]
let mut rng = rand::thread_rng();