aboutsummaryrefslogtreecommitdiff
path: root/doc/fuzzing.md
diff options
context:
space:
mode:
authorpracticalswift <practicalswift@users.noreply.github.com>2020-04-22 15:22:36 +0000
committerpracticalswift <practicalswift@users.noreply.github.com>2020-04-22 15:22:36 +0000
commitbb1ec36fb171816309ae5af53d549ff3e4633f67 (patch)
tree97fbc659d4b2cf842dc4f4fa873204bb6f8d3a7d /doc/fuzzing.md
parenta7a6f1ff417abc2452a2a2b9edcd2f12d6c14441 (diff)
downloadbitcoin-bb1ec36fb171816309ae5af53d549ff3e4633f67.tar.xz
doc: Document how to fuzz Bitcoin Core using honggfuzz
Diffstat (limited to 'doc/fuzzing.md')
-rw-r--r--doc/fuzzing.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/fuzzing.md b/doc/fuzzing.md
index 9642337821..419b1db44e 100644
--- a/doc/fuzzing.md
+++ b/doc/fuzzing.md
@@ -133,3 +133,25 @@ $ afl/afl-fuzz -i inputs/ -o outputs/ -- src/test/fuzz/bech32
```
Read the [`afl-fuzz` documentation](https://github.com/google/afl) for more information.
+
+# Fuzzing Bitcoin Core using Honggfuzz
+
+## Quickstart guide
+
+To quickly get started fuzzing Bitcoin Core using [Honggfuzz](https://github.com/google/honggfuzz):
+
+```sh
+$ git clone https://github.com/bitcoin/bitcoin
+$ cd bitcoin/
+$ ./autogen.sh
+$ git clone https://github.com/google/honggfuzz
+$ cd honggfuzz/
+$ make
+$ cd ..
+$ CC=$(pwd)/honggfuzz/hfuzz_cc/hfuzz-clang CXX=$(pwd)/honggfuzz/hfuzz_cc/hfuzz-clang++ ./configure --enable-fuzz --with-sanitizers=address,undefined
+$ make
+$ mkdir -p inputs/
+$ honggfuzz/honggfuzz -i inputs/ -- src/test/fuzz/process_message
+```
+
+Read the [Honggfuzz documentation](https://github.com/google/honggfuzz/blob/master/docs/USAGE.md) for more information.