commit	ad7e3a3f7e043ce90a2b204b0456c115bf594cc0	[log] [tgz]
author	Android Build Coastguard Worker <[email protected]>	Sat Feb 03 02:12:43 2024 +0000
committer	Android Build Coastguard Worker <[email protected]>	Sat Feb 03 02:12:43 2024 +0000
tree	daedb7646b5c58b3c20cc03e341e7478900eb0a8
parent	545a4722101e1fe324ba9a566bec70575ebe4047 [diff]
parent	f46d740fceb95eedb2ac7d25bf18a695f3c6719b [diff]

tree: daedb7646b5c58b3c20cc03e341e7478900eb0a8

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

Linking to a local libfuzzer

When using libfuzzer-sys, you can provide your own libfuzzer runtime in two ways.

If you are developing a fuzzer, you can set the CUSTOM_LIBFUZZER_PATH environment variable to the path of your local libfuzzer runtime, which will then be linked instead of building libfuzzer as part of the build stage of libfuzzer-sys. For an example, to link to a prebuilt LLVM 16 libfuzzer, you could use:

$ export CUSTOM_LIBFUZZER_PATH=/usr/lib64/clang/16/lib/libclang_rt.fuzzer-x86_64.a
$ cargo fuzz run ...

Alternatively, you may also disable the default link_libfuzzer feature:

In Cargo.toml:

[dependencies]
libfuzzer-sys = { path = "../../libfuzzer", default-features = false }

Then link to your own runtime in your build.rs.

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