docs/LibFuzzer.rst

   1 ========================================================
   2 LibFuzzer -- a library for coverage-guided fuzz testing.
   3 ========================================================
   4 .. contents::
   5    :local:
   6    :depth: 4
   7
   8 Introduction
   9 ============
  10
  11 This library is intended primarily for in-process coverage-guided fuzz testing
  12 (fuzzing) of other libraries. The typical workflow looks like this:
  13
  14 * Build the Fuzzer library as a static archive (or just a set of .o files).
  15   Note that the Fuzzer contains the main() function.
  16   Preferably do *not* use sanitizers while building the Fuzzer.
  17 * Build the library you are going to test with
  18   `-fsanitize-coverage={bb,edge}[,indirect-calls]`
  19   and one of the sanitizers. We recommend to build the library in several
  20   different modes (e.g. asan, msan, lsan, ubsan, etc) and even using different
  21   optimizations options (e.g. -O0, -O1, -O2) to diversify testing.
  22 * Build a test driver using the same options as the library.
  23   The test driver is a C/C++ file containing interesting calls to the library
  24   inside a single function  ``extern "C" void LLVMFuzzerTestOneInput(const uint8_t *Data, size_t Size);``
  25 * Link the Fuzzer, the library and the driver together into an executable
  26   using the same sanitizer options as for the library.
  27 * Collect the initial corpus of inputs for the
  28   fuzzer (a directory with test inputs, one file per input).
  29   The better your inputs are the faster you will find something interesting.
  30   Also try to keep your inputs small, otherwise the Fuzzer will run too slow.
  31 * Run the fuzzer with the test corpus. As new interesting test cases are
  32   discovered they will be added to the corpus. If a bug is discovered by
  33   the sanitizer (asan, etc) it will be reported as usual and the reproducer
  34   will be written to disk.
  35   Each Fuzzer process is single-threaded (unless the library starts its own
  36   threads). You can run the Fuzzer on the same corpus in multiple processes
  37   in parallel. For run-time options run the Fuzzer binary with '-help=1'.
  38
  39
  40 The Fuzzer is similar in concept to AFL_,
  41 but uses in-process Fuzzing, which is more fragile, more restrictive, but
  42 potentially much faster as it has no overhead for process start-up.
  43 It uses LLVM's SanitizerCoverage_ instrumentation to get in-process
  44 coverage-feedback
  45
  46 The code resides in the LLVM repository, requires the fresh Clang compiler to build
  47 and is used to fuzz various parts of LLVM,
  48 but the Fuzzer itself does not (and should not) depend on any
  49 part of LLVM and can be used for other projects w/o requiring the rest of LLVM.
  50
  51 Usage examples
  52 ==============
  53
  54 Toy example
  55 -----------
  56
  57 A simple function that does something interesting if it receives the input "HI!"::
  58
  59   cat << EOF >> test_fuzzer.cc
  60   extern "C" void LLVMFuzzerTestOneInput(const unsigned char *data, unsigned long size) {
  61     if (size > 0 && data[0] == 'H')
  62       if (size > 1 && data[1] == 'I')
  63          if (size > 2 && data[2] == '!')
  64          __builtin_trap();
  65   }
  66   EOF
  67   # Get lib/Fuzzer. Assuming that you already have fresh clang in PATH.
  68   svn co http://llvm.org/svn/llvm-project/llvm/trunk/lib/Fuzzer
  69   # Build lib/Fuzzer files.
  70   clang -c -g -O2 -std=c++11 Fuzzer/*.cpp -IFuzzer
  71   # Build test_fuzzer.cc with asan and link against lib/Fuzzer.
  72   clang++ -fsanitize=address -fsanitize-coverage=edge test_fuzzer.cc Fuzzer*.o
  73   # Run the fuzzer with no corpus.
  74   ./a.out
  75
  76 You should get ``Illegal instruction (core dumped)`` pretty quickly.
  77
  78 PCRE2
  79 -----
  80
  81 Here we show how to use lib/Fuzzer on something real, yet simple: pcre2_::
  82
  83   COV_FLAGS=" -fsanitize-coverage=edge,indirect-calls,8bit-counters"
  84   # Get PCRE2
  85   svn co svn://vcs.exim.org/pcre2/code/trunk pcre
  86   # Get lib/Fuzzer. Assuming that you already have fresh clang in PATH.
  87   svn co http://llvm.org/svn/llvm-project/llvm/trunk/lib/Fuzzer
  88   # Build PCRE2 with AddressSanitizer and coverage.
  89   (cd pcre; ./autogen.sh; CC="clang -fsanitize=address $COV_FLAGS" ./configure --prefix=`pwd`/../inst && make -j && make install)
  90   # Build lib/Fuzzer files.
  91   clang -c -g -O2 -std=c++11 Fuzzer/*.cpp -IFuzzer
  92   # Build the the actual function that does something interesting with PCRE2.
  93   cat << EOF > pcre_fuzzer.cc
  94   #include <string.h>
  95   #include "pcre2posix.h"
  96   extern "C" void LLVMFuzzerTestOneInput(const unsigned char *data, size_t size) {
  97     if (size < 1) return;
  98     char *str = new char[size+1];
  99     memcpy(str, data, size);
 100     str[size] = 0;
 101     regex_t preg;
 102     if (0 == regcomp(&preg, str, 0)) {
 103       regexec(&preg, str, 0, 0, 0);
 104       regfree(&preg);
 105     }
 106     delete [] str;
 107   }
 108   EOF
 109   clang++ -g -fsanitize=address $COV_FLAGS -c -std=c++11  -I inst/include/ pcre_fuzzer.cc
 110   # Link.
 111   clang++ -g -fsanitize=address -Wl,--whole-archive inst/lib/*.a -Wl,-no-whole-archive Fuzzer*.o pcre_fuzzer.o -o pcre_fuzzer
 112
 113 This will give you a binary of the fuzzer, called ``pcre_fuzzer``.
 114 Now, create a directory that will hold the test corpus::
 115
 116   mkdir -p CORPUS
 117
 118 For simple input languages like regular expressions this is all you need.
 119 For more complicated inputs populate the directory with some input samples.
 120 Now run the fuzzer with the corpus dir as the only parameter::
 121
 122   ./pcre_fuzzer ./CORPUS
 123
 124 You will see output like this::
 125
 126   Seed: 1876794929
 127   #0      READ   cov 0 bits 0 units 1 exec/s 0
 128   #1      pulse  cov 3 bits 0 units 1 exec/s 0
 129   #1      INITED cov 3 bits 0 units 1 exec/s 0
 130   #2      pulse  cov 208 bits 0 units 1 exec/s 0
 131   #2      NEW    cov 208 bits 0 units 2 exec/s 0 L: 64
 132   #3      NEW    cov 217 bits 0 units 3 exec/s 0 L: 63
 133   #4      pulse  cov 217 bits 0 units 3 exec/s 0
 134
 135 * The ``Seed:`` line shows you the current random seed (you can change it with ``-seed=N`` flag).
 136 * The ``READ``  line shows you how many input files were read (since you passed an empty dir there were inputs, but one dummy input was synthesised).
 137 * The ``INITED`` line shows you that how many inputs will be fuzzed.
 138 * The ``NEW`` lines appear with the fuzzer finds a new interesting input, which is saved to the CORPUS dir. If multiple corpus dirs are given, the first one is used.
 139 * The ``pulse`` lines appear periodically to show the current status.
 140
 141 Now, interrupt the fuzzer and run it again the same way. You will see::
 142
 143   Seed: 1879995378
 144   #0      READ   cov 0 bits 0 units 564 exec/s 0
 145   #1      pulse  cov 502 bits 0 units 564 exec/s 0
 146   ...
 147   #512    pulse  cov 2933 bits 0 units 564 exec/s 512
 148   #564    INITED cov 2991 bits 0 units 344 exec/s 564
 149   #1024   pulse  cov 2991 bits 0 units 344 exec/s 1024
 150   #1455   NEW    cov 2995 bits 0 units 345 exec/s 1455 L: 49
 151
 152 This time you were running the fuzzer with a non-empty input corpus (564 items).
 153 As the first step, the fuzzer minimized the set to produce 344 interesting items (the ``INITED`` line)
 154
 155 You may run ``N`` independent fuzzer jobs in parallel on ``M`` CPUs::
 156
 157   N=100; M=4; ./pcre_fuzzer ./CORPUS -jobs=$N -workers=$M
 158
 159 By default (``-reload=1``) the fuzzer processes will periodically scan the CORPUS directory
 160 and reload any new tests. This way the test inputs found by one process will be picked up
 161 by all others.
 162
 163 If ``-workers=$M`` is not supplied, ``min($N,NumberOfCpuCore/2)`` will be used.
 164
 165 Heartbleed
 166 ----------
 167 Remember Heartbleed_?
 168 As it was recently `shown <https://blog.hboeck.de/archives/868-How-Heartbleed-couldve-been-found.html>`_,
 169 fuzzing with AddressSanitizer can find Heartbleed. Indeed, here are the step-by-step instructions
 170 to find Heartbleed with LibFuzzer::
 171
 172   wget https://www.openssl.org/source/openssl-1.0.1f.tar.gz
 173   tar xf openssl-1.0.1f.tar.gz
 174   COV_FLAGS="-fsanitize-coverage=edge,indirect-calls" # -fsanitize-coverage=8bit-counters
 175   (cd openssl-1.0.1f/ && ./config &&
 176     make -j 32 CC="clang -g -fsanitize=address $COV_FLAGS")
 177   # Get and build LibFuzzer
 178   svn co http://llvm.org/svn/llvm-project/llvm/trunk/lib/Fuzzer
 179   clang -c -g -O2 -std=c++11 Fuzzer/*.cpp -IFuzzer
 180   # Get examples of key/pem files.
 181   git clone   https://github.com/hannob/selftls
 182   cp selftls/server* . -v
 183   cat << EOF > handshake-fuzz.cc
 184   #include <openssl/ssl.h>
 185   #include <openssl/err.h>
 186   #include <assert.h>
 187   SSL_CTX *sctx;
 188   int Init() {
 189     SSL_library_init();
 190     SSL_load_error_strings();
 191     ERR_load_BIO_strings();
 192     OpenSSL_add_all_algorithms();
 193     assert (sctx = SSL_CTX_new(TLSv1_method()));
 194     assert (SSL_CTX_use_certificate_file(sctx, "server.pem", SSL_FILETYPE_PEM));
 195     assert (SSL_CTX_use_PrivateKey_file(sctx, "server.key", SSL_FILETYPE_PEM));
 196     return 0;
 197   }
 198   extern "C" void LLVMFuzzerTestOneInput(unsigned char *Data, size_t Size) {
 199     static int unused = Init();
 200     SSL *server = SSL_new(sctx);
 201     BIO *sinbio = BIO_new(BIO_s_mem());
 202     BIO *soutbio = BIO_new(BIO_s_mem());
 203     SSL_set_bio(server, sinbio, soutbio);
 204     SSL_set_accept_state(server);
 205     BIO_write(sinbio, Data, Size);
 206     SSL_do_handshake(server);
 207     SSL_free(server);
 208   }
 209   EOF
 210   # Build the fuzzer.
 211   clang++ -g handshake-fuzz.cc  -fsanitize=address \
 212     openssl-1.0.1f/libssl.a openssl-1.0.1f/libcrypto.a Fuzzer*.o
 213   # Run 20 independent fuzzer jobs.
 214   ./a.out  -jobs=20 -workers=20
 215
 216 Voila::
 217
 218   #1048576        pulse  cov 3424 bits 0 units 9 exec/s 24385
 219   =================================================================
 220   ==17488==ERROR: AddressSanitizer: heap-buffer-overflow on address 0x629000004748 at pc 0x00000048c979 bp 0x7fffe3e864f0 sp 0x7fffe3e85ca8
 221   READ of size 60731 at 0x629000004748 thread T0
 222       #0 0x48c978 in __asan_memcpy
 223       #1 0x4db504 in tls1_process_heartbeat openssl-1.0.1f/ssl/t1_lib.c:2586:3
 224       #2 0x580be3 in ssl3_read_bytes openssl-1.0.1f/ssl/s3_pkt.c:1092:4
 225
 226 Advanced features
 227 =================
 228
 229 Tokens
 230 ------
 231
 232 By default, the fuzzer is not aware of complexities of the input language
 233 and when fuzzing e.g. a C++ parser it will mostly stress the lexer.
 234 It is very hard for the fuzzer to come up with something like ``reinterpret_cast<int>``
 235 from a test corpus that doesn't have it.
 236 See a detailed discussion of this topic at
 237 http://lcamtuf.blogspot.com/2015/01/afl-fuzz-making-up-grammar-with.html.
 238
 239 lib/Fuzzer implements a simple technique that allows to fuzz input languages with
 240 long tokens. All you need is to prepare a text file containing up to 253 tokens, one token per line,
 241 and pass it to the fuzzer as ``-tokens=TOKENS_FILE.txt``.
 242 Three implicit tokens are added: ``" "``, ``"\t"``, and ``"\n"``.
 243 The fuzzer itself will still be mutating a string of bytes
 244 but before passing this input to the target library it will replace every byte ``b`` with the ``b``-th token.
 245 If there are less than ``b`` tokens, a space will be added instead.
 246
 247 AFL compatibility
 248 -----------------
 249 LibFuzzer can be used in parallel with AFL_ on the same test corpus.
 250 Both fuzzers expect the test corpus to reside in a directory, one file per input.
 251 You can run both fuzzers on the same corpus in parallel::
 252
 253   ./afl-fuzz -i testcase_dir -o findings_dir /path/to/program -r @@
 254   ./llvm-fuzz testcase_dir findings_dir  # Will write new tests to testcase_dir
 255
 256 Periodically restart both fuzzers so that they can use each other's findings.
 257
 258 How good is my fuzzer?
 259 ----------------------
 260
 261 Once you implement your target function ``LLVMFuzzerTestOneInput`` and fuzz it to death,
 262 you will want to know whether the function or the corpus can be improved further.
 263 One easy to use metric is, of course, code coverage.
 264 You can get the coverage for your corpus like this::
 265
 266   ASAN_OPTIONS=coverage_pcs=1 ./fuzzer CORPUS_DIR -runs=0
 267
 268 This will run all the tests in the CORPUS_DIR but will not generate any new tests
 269 and dump covered PCs to disk before exiting.
 270 Then you can subtract the set of covered PCs from the set of all instrumented PCs in the binary,
 271 see SanitizerCoverage_ for details.
 272
 273 Fuzzing components of LLVM
 274 ==========================
 275
 276 clang-format-fuzzer
 277 -------------------
 278 The inputs are random pieces of C++-like text.
 279
 280 Build (make sure to use fresh clang as the host compiler)::
 281
 282     cmake -GNinja  -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DLLVM_USE_SANITIZER=Address -DLLVM_USE_SANITIZE_COVERAGE=YES -DCMAKE_BUILD_TYPE=Release /path/to/llvm
 283     ninja clang-format-fuzzer
 284     mkdir CORPUS_DIR
 285     ./bin/clang-format-fuzzer CORPUS_DIR
 286
 287 Optionally build other kinds of binaries (asan+Debug, msan, ubsan, etc).
 288
 289 TODO: commit the pre-fuzzed corpus to svn (?).
 290
 291 Tracking bug: https://llvm.org/bugs/show_bug.cgi?id=23052
 292
 293 clang-fuzzer
 294 ------------
 295
 296 The default behavior is very similar to ``clang-format-fuzzer``.
 297 Clang can also be fuzzed with Tokens_ using ``-tokens=$LLVM/lib/Fuzzer/cxx_fuzzer_tokens.txt`` option.
 298
 299 Tracking bug: https://llvm.org/bugs/show_bug.cgi?id=23057
 300
 301 FAQ
 302 =========================
 303
 304 Q. Why Fuzzer does not use any of the LLVM support?
 305 ---------------------------------------------------
 306
 307 There are two reasons.
 308
 309 First, we want this library to be used outside of the LLVM w/o users having to
 310 build the rest of LLVM. This may sound unconvincing for many LLVM folks,
 311 but in practice the need for building the whole LLVM frightens many potential
 312 users -- and we want more users to use this code.
 313
 314 Second, there is a subtle technical reason not to rely on the rest of LLVM, or
 315 any other large body of code (maybe not even STL). When coverage instrumentation
 316 is enabled, it will also instrument the LLVM support code which will blow up the
 317 coverage set of the process (since the fuzzer is in-process). In other words, by
 318 using more external dependencies we will slow down the fuzzer while the main
 319 reason for it to exist is extreme speed.
 320
 321 Q. What about Windows then? The Fuzzer contains code that does not build on Windows.
 322 ------------------------------------------------------------------------------------
 323
 324 The sanitizer coverage support does not work on Windows either as of 01/2015.
 325 Once it's there, we'll need to re-implement OS-specific parts (I/O, signals).
 326
 327 Q. When this Fuzzer is not a good solution for a problem?
 328 ---------------------------------------------------------
 329
 330 * If the test inputs are validated by the target library and the validator
 331   asserts/crashes on invalid inputs, the in-process fuzzer is not applicable
 332   (we could use fork() w/o exec, but it comes with extra overhead).
 333 * Bugs in the target library may accumulate w/o being detected. E.g. a memory
 334   corruption that goes undetected at first and then leads to a crash while
 335   testing another input. This is why it is highly recommended to run this
 336   in-process fuzzer with all sanitizers to detect most bugs on the spot.
 337 * It is harder to protect the in-process fuzzer from excessive memory
 338   consumption and infinite loops in the target library (still possible).
 339 * The target library should not have significant global state that is not
 340   reset between the runs.
 341 * Many interesting target libs are not designed in a way that supports
 342   the in-process fuzzer interface (e.g. require a file path instead of a
 343   byte array).
 344 * If a single test run takes a considerable fraction of a second (or
 345   more) the speed benefit from the in-process fuzzer is negligible.
 346 * If the target library runs persistent threads (that outlive
 347   execution of one test) the fuzzing results will be unreliable.
 348
 349 Q. So, what exactly this Fuzzer is good for?
 350 --------------------------------------------
 351
 352 This Fuzzer might be a good choice for testing libraries that have relatively
 353 small inputs, each input takes < 1ms to run, and the library code is not expected
 354 to crash on invalid inputs.
 355 Examples: regular expression matchers, text or binary format parsers.
 356
 357 .. _pcre2: http://www.pcre.org/
 358
 359 .. _AFL: http://lcamtuf.coredump.cx/afl/
 360
 361 .. _SanitizerCoverage: http://clang.llvm.org/docs/SanitizerCoverage.html
 362
 363 .. _Heartbleed: http://en.wikipedia.org/wiki/Heartbleed