docs/ipc_fuzzer.md

   1 # IPC Fuzzer
   2
   3 A chromium IPC fuzzer is under development by aedla and tsepez. The fuzzer lives
   4 under `src/tools/ipc_fuzzer/` and is running on ClusterFuzz. A previous version
   5 of the fuzzer was a simple bitflipper, which caught around 10 bugs. A new
   6 version is doing smarter mutations and generational fuzzing. To do so, each
   7 `ParamTraits<Type>` needs a corresponding `FuzzTraits<Type>`. Feel free to
   8 contribute.
   9
  10 [TOC]
  11
  12 ## Working with the fuzzer
  13
  14 ### Build instructions
  15
  16 *   add `enable_ipc_fuzzer=1` to `GYP_DEFINES`
  17 *   build `ipc_fuzzer_all` target
  18 *   component builds are currently broken, sorry
  19 *   Debug builds are broken; only Release mode works.
  20
  21 ### Replaying ipcdumps
  22
  23 *   `tools/ipc_fuzzer/scripts/play_testcase.py path/to/testcase.ipcdump`
  24 *   more help: `tools/ipc_fuzzer/scripts/play_testcase.py -h`
  25
  26 ### Listing messages in ipcdump
  27
  28 *   `out/<Build>/ipc_message_util --dump path/to/testcase.ipcdump`
  29
  30 ### Updating fuzzers in ClusterFuzz
  31
  32 *   `tools/ipc_fuzzer/scripts/cf_package_builder.py`
  33 *   upload `ipc_fuzzer_mut.zip` and `ipc_fuzzer_gen.zip` under build directory
  34     to ClusterFuzz
  35
  36 ### Contributing FuzzTraits
  37
  38 *   add them to `tools/ipc_fuzzer/fuzzer/fuzzer.cc`
  39 *   thanks!
  40
  41 ## Components
  42
  43 ### ipcdump logger
  44
  45 *   add `enable_ipc_fuzzer=1` to `GYP_DEFINES`
  46 *   build `chrome` and `ipc_message_dump` targets
  47 *   run chrome with
  48     `--no-sandbox --ipc-dump-directory=/path/to/ipcdump/directory`
  49 *   ipcdumps will be created in this directory for each renderer using the
  50     format `_pid_.ipcdump`
  51
  52 ### ipcdump replay
  53
  54 Lives under `ipc_fuzzer/replay`. The renderer is replaced with
  55 `ipc_fuzzer_replay` using `--renderer-cmd-prefix`. This is done automatically
  56 with the `ipc_fuzzer/play_testcase.py` convenience script.
  57
  58 ### ipcdump mutator / generator
  59
  60 Lives under `ipc_fuzzer/fuzzer`. This is the code that runs on ClusterFuzz. It
  61 uses `FuzzTraits<Type>` to mutate ipcdumps or generate them out of thin air.
  62
  63 ## Problems, questions, suggestions
  64
  65 Send them to mbarbella@chromium.org.