diff --git a/README.md b/README.md index 9dc8e1730..4c4c2fe4b 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,27 @@ -# afl.rs +

+ afl.rs logo +
+ afl.rs +

-Fuzzing [Rust][] code with [american fuzzy lop (AFL)][american-fuzzy-lop] - -Screen recording of afl - -Screen recording of AFL running on Rust code. The code under test is [`examples/hello.rs`][example] in this repository. +

Fuzzing Rust code with american fuzzy lop (AFL)

## What is it? [Fuzz testing][] is a software testing technique used to find security and stability issues by providing pseudo-random data as input to the software. [American fuzzy lop][american-fuzzy-lop] is a popular, effective, and modern fuzz testing tool. This library, afl.rs, allows one to run AFL on code written in [the Rust programming language][rust]. +## What does it look like? + +Screen recording of afl + +Screen recording of AFL running on Rust code. The code under test is [`examples/hello.rs`][example] in this repository. + ## Book Documentation for afl.rs can be found here: [The afl.rs Book](https://frewsxcv.github.io/afl.rs/) -## Upcoming changes - -- [ ] [✨ Logo ✨](https://github.com/frewsxcv/afl.rs/issues/66) -- [ ] Don't require users to have AFL installed (utilize afl-sys crate) - ## Trophy case * brotli-rs: [#2](https://github.com/ende76/brotli-rs/issues/2), [#3](https://github.com/ende76/brotli-rs/issues/3), [#4](https://github.com/ende76/brotli-rs/issues/4), [#5](https://github.com/ende76/brotli-rs/issues/5), [#6](https://github.com/ende76/brotli-rs/issues/6), [#7](https://github.com/ende76/brotli-rs/issues/7), [#8](https://github.com/ende76/brotli-rs/issues/8), [#9](https://github.com/ende76/brotli-rs/issues/9), [#10](https://github.com/ende76/brotli-rs/issues/10), [#11](https://github.com/ende76/brotli-rs/issues/11), [#12](https://github.com/ende76/brotli-rs/issues/12) @@ -48,7 +49,6 @@ interesting bugs, whether they're logic errors or memory-safety problems arising from `unsafe` code. Pull requests are welcome! [conditional compilation]: https://doc.rust-lang.org/reference.html#conditional-compilation -[american-fuzzy-lop]: http://lcamtuf.coredump.cx/afl/ [Cargo feature]: http://doc.crates.io/manifest.html#the-[features]-section [example-defer]: https://github.com/frewsxcv/afl.rs/blob/master/examples/deferred-init.rs [LLVM pass]: https://github.com/frewsxcv/afl.rs/blob/master/plugin/src/afl-llvm-pass.o.cc @@ -56,5 +56,4 @@ arising from `unsafe` code. Pull requests are welcome! [Cargo]: http://doc.crates.io/ [unresolved issue]: https://github.com/frewsxcv/afl.rs/issues/11 [fuzz testing]: https://en.wikipedia.org/wiki/Fuzz_testing -[Rust]: https://www.rust-lang.org [rustup]: https://rustup.rs/ diff --git a/etc/logo.gif b/etc/logo.gif new file mode 100644 index 000000000..bb49ce31b Binary files /dev/null and b/etc/logo.gif differ diff --git a/etc/screencap.gif b/etc/screencap.gif new file mode 100644 index 000000000..6230b2e71 Binary files /dev/null and b/etc/screencap.gif differ