aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMarcoFalke <falke.marco@gmail.com>2020-04-25 09:26:44 -0400
committerMarcoFalke <falke.marco@gmail.com>2020-04-25 09:26:52 -0400
commitbab81f7e4d3e4443f9c36354dd0e4314ad430cd3 (patch)
tree62e291dec146dbeeff28eef8672a9d1049cec591 /doc
parentfd48e7ad990c7b67a9ad3bb5ba29cefd2c16e20a (diff)
parentbb1ec36fb171816309ae5af53d549ff3e4633f67 (diff)
downloadbitcoin-bab81f7e4d3e4443f9c36354dd0e4314ad430cd3.tar.xz
Merge #18739: doc: Document how to fuzz Bitcoin Core using Honggfuzz
bb1ec36fb171816309ae5af53d549ff3e4633f67 doc: Document how to fuzz Bitcoin Core using honggfuzz (practicalswift) Pull request description: Document how to fuzz Bitcoin Core using Honggfuzz. ACKs for top commit: fanquake: ACK bb1ec36fb171816309ae5af53d549ff3e4633f67 - did a couple quick runs on a severely under powered VM. Tree-SHA512: 117944c52763a5672f988c62fecb01b85f19f3827fad5582a51464aefdaac4d9a9cd81e2118199f6ea1bb3ab0893c8459ca3d1df7f67bfcf215d5e305225f210
Diffstat (limited to 'doc')
-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.