Skip to content

Commit b66fa69

Browse files
author
Sebastian Poeplau
committed
Document gotchas in the use of the fuzzing helper
1 parent 1a379e7 commit b66fa69

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/Fuzzing.txt

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,3 +113,19 @@ It is possible to run SymCC with only an AFL master or only a secondary AFL
113113
instance; see the AFL docs for the implications. Moreover, the number of fuzzer
114114
and SymCC instances can be increased - just make sure that each has a unique
115115
name.
116+
117+
Note that there are currently a few gotchas with the fuzzing helper:
118+
119+
1. It expects afl-showmap to be in the same directory as afl-fuzz (which is
120+
usually the case), and it finds that directory via your afl-fuzz command. If
121+
afl-fuzz is on your PATH (as we assumed in the example above), all is good
122+
and you can ignore this point. Otherwise, you need to either call afl-fuzz
123+
with an absolute path (e.g., /afl/afl-fuzz in the Docker image) or, if you
124+
use a relative path, start afl-fuzz from the same working directory as the
125+
fuzzing helper.
126+
127+
2. The helper needs to know how to call the AFL-instrumented version of the
128+
target, and it finds that information by scanning your afl-fuzz command. To
129+
this end, it _requires_ the double dash that we used in the example above to
130+
separate afl-fuzz options from the target command; if you omit it, you'll
131+
likely get errors from the helper when it tries to run afl-showmap.

0 commit comments

Comments
 (0)