Make the fuzzers more reproducible
[openssl.git] / fuzz / README.md
1 # I Can Haz Fuzz?
2
3 LibFuzzer
4 =========
5
6 Or, how to fuzz OpenSSL with [libfuzzer](http://llvm.org/docs/LibFuzzer.html).
7
8 Starting from a vanilla+OpenSSH server Ubuntu install.
9
10 Use Chrome's handy recent build of clang. Older versions may also work.
11
12     $ sudo apt-get install git
13     $ mkdir git-work
14     $ git clone https://chromium.googlesource.com/chromium/src/tools/clang
15     $ clang/scripts/update.py
16
17 You may want to git pull and re-run the update from time to time.
18
19 Update your path:
20
21     $ PATH=~/third_party/llvm-build/Release+Asserts/bin/:$PATH
22
23 Get and build libFuzzer (there is a git mirror at
24 https://github.com/llvm-mirror/llvm/tree/master/lib/Fuzzer if you prefer):
25
26     $ cd
27     $ sudo apt-get install subversion
28     $ mkdir svn-work
29     $ cd svn-work
30     $ svn co http://llvm.org/svn/llvm-project/llvm/trunk/lib/Fuzzer
31     $ cd Fuzzer
32     $ clang++ -c -g -O2 -std=c++11 *.cpp
33     $ ar r libFuzzer.a *.o
34     $ ranlib libFuzzer.a
35
36 Configure for fuzzing:
37
38     $ CC=clang ./config enable-fuzz-libfuzzer \
39             --with-fuzzer-include=../../svn-work/Fuzzer \
40             --with-fuzzer-lib=../../svn-work/Fuzzer/libFuzzer \
41             -DPEDANTIC enable-asan enable-ubsan no-shared \
42             -DFUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION \
43             -fsanitize-coverage=edge,indirect-calls,8bit-counters
44     $ sudo apt-get install make
45     $ LDCMD=clang++ make -j
46     $ fuzz/helper.py $FUZZER
47
48 Where $FUZZER is one of the executables in `fuzz/`.
49
50 If you get a crash, you should find a corresponding input file in
51 `fuzz/corpora/$FUZZER-crash/`. You can reproduce the crash with
52
53     $ fuzz/$FUZZER <crashfile>
54
55 AFL
56 ===
57
58 Configure for fuzzing:
59
60     $ sudo apt-get install afl-clang
61     $ CC=afl-clang-fast ./config enable-fuzz-afl no-shared
62     $ make
63
64 Run one of the fuzzers:
65
66     $ afl-fuzz -i fuzz/corpora/$FUZZER -o fuzz/corpora/$FUZZER/out fuzz/$FUZZER
67
68 Where $FUZZER is one of the executables in `fuzz/`.