commit	171d2695bf1acc33ffc465f0d70a8c3f381218a8	[log] [tgz]
author	Android Build Coastguard Worker <[email protected]>	Fri Jul 07 04:49:49 2023 +0000
committer	Android Build Coastguard Worker <[email protected]>	Fri Jul 07 04:49:49 2023 +0000
tree	fb5f91a0b6ecc9dc0229fad0f71e4c8fdf97d5a9
parent	23dfcbb528442aa65c9e554f8cd57ad3d49d64da [diff]
parent	246d740ca4f773cbb896c83aa38ef2012e3b6fbf [diff]

tree: fb5f91a0b6ecc9dc0229fad0f71e4c8fdf97d5a9

README.md

The `libfuzzer-sys` Crate

Barebones wrapper around LLVM's libFuzzer runtime library.

The CPP parts are extracted from compiler-rt git repository with git filter-branch.

libFuzzer relies on LLVM sanitizer support. The Rust compiler has built-in support for LLVM sanitizer support, for now, it's limited to Linux. As a result, libfuzzer-sys only works on Linux.

Usage

Use `cargo fuzz`!

Manual Usage

This crate can also be used manually as following:

First create a new cargo project:

$ cargo new --bin fuzzed
$ cd fuzzed

Then add a dependency on the fuzzer-sys crate and your own crate:

[dependencies]
libfuzzer-sys = "0.4.0"
your_crate = { path = "../path/to/your/crate" }

Change the fuzzed/src/main.rs to fuzz your code:

#![no_main]

use libfuzzer_sys::fuzz_target;

fuzz_target!(|data: &[u8]| {
    // code to fuzz goes here
});

Build by running the following command:

$ cargo rustc -- \
    -C passes='sancov' \
    -C llvm-args='-sanitizer-coverage-level=3' \
    -C llvm-args='-sanitizer-coverage-inline-8bit-counters' \
    -Z sanitizer=address

And finally, run the fuzzer:

$ ./target/debug/fuzzed

Updating libfuzzer from upstream

./update-libfuzzer.sh <github.com/llvm-mirror/llvm-project SHA1>

License

All files in libfuzzer directory are licensed NCSA.

Everything else is dual-licensed Apache 2.0 and MIT.

The libfuzzer-sys Crate