From 9e739d7cfed50304c94a30d2525a1f89c789a2e5 Mon Sep 17 00:00:00 2001 From: Wei Liu Date: Fri, 20 Jan 2017 11:21:40 +0000 Subject: [PATCH] tools/fuzz: add README.afl And rename README to README.oss-fuzz. Signed-off-by: Wei Liu Acked-by: Ian Jackson --- tools/fuzz/README.afl | 31 ++++++++++++++++++++++++++ tools/fuzz/{README => README.oss-fuzz} | 0 2 files changed, 31 insertions(+) create mode 100644 tools/fuzz/README.afl rename tools/fuzz/{README => README.oss-fuzz} (100%) diff --git a/tools/fuzz/README.afl b/tools/fuzz/README.afl new file mode 100644 index 0000000000..431b4a8cbf --- /dev/null +++ b/tools/fuzz/README.afl @@ -0,0 +1,31 @@ +# OVERVIEW + +Some fuzzing targets have American Fuzzy Lop (AFL) support. + +See also http://lcamtuf.coredump.cx/afl/ + +# HOW IT WORKS + +AFL provides a customised toolchain to build an executable, which in +turn is launched by the fuzzer. + +# HOW TO USE IT + +Use the x86 instruction emulator fuzzer as an example. + +1. download and compile AFL in $AFLPATH. + +2. run the following commands to build: + $ cd tools/fuzz/x86_instruction_emulator + $ make distclean + $ make CC=$AFLPATH/afl-gcc afl # produces afl-x86-insn-emulator-fuzzer + +3. provide initial test case: + $ mkdir testcase_dir + $ echo -n -e '\xc3' > testcase_dir/ret.bin + +4. run the fuzzer with AFL: + $ $AFLPATH/afl-fuzz -m none -t 1000 -i testcase_dir -o findings_dir -- \ + ./afl-x86-insn-emulator-fuzzer @@ + +Please see AFL documentation for more information. diff --git a/tools/fuzz/README b/tools/fuzz/README.oss-fuzz similarity index 100% rename from tools/fuzz/README rename to tools/fuzz/README.oss-fuzz -- 2.30.2