aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAndrea Fioraldi <andreafioraldi@gmail.com>2019-08-30 12:13:51 +0200
committerAndrea Fioraldi <andreafioraldi@gmail.com>2019-08-30 12:13:51 +0200
commit5036cb54ccc3f4dcc261e124e9cf0146a06592c2 (patch)
tree42ca0eefcb907b606da00046367fc1e665a2c44f /docs
parent2eeb07d164cb7874a64a48bd9c1bf4112636ac43 (diff)
parenteadd378f6c54a7e021985bca041d9642fff41034 (diff)
downloadafl++-5036cb54ccc3f4dcc261e124e9cf0146a06592c2.tar.gz
update with changes from master
Diffstat (limited to 'docs')
-rw-r--r--docs/ChangeLog6
-rw-r--r--docs/env_variables.txt19
-rw-r--r--docs/unicorn_mode.txt109
3 files changed, 19 insertions, 115 deletions
diff --git a/docs/ChangeLog b/docs/ChangeLog
index ed8e0022..782320d6 100644
--- a/docs/ChangeLog
+++ b/docs/ChangeLog
@@ -18,6 +18,7 @@ Version ++2.53d (dev):
----------------------
- llvm 9 is now supported (still needs testing)
+ - Android is now supported (thank to JoeyJiao!) - still need to modify the Makefile though
- fix building qemu on some Ubuntus (thanks to floyd!)
- custom mutator by a loaded library is now supported (thanks to kyakdan!)
- more support for *BSD (thanks to devnexen!)
@@ -27,6 +28,11 @@ Version ++2.53d (dev):
afl never did), plus shows tuple content summary information now
- the forkserver is now in its own C file to be easily integratable
- small docu updates
+ - NeverZero counters for QEMU
+ - NeverZero counters for Unicorn
+ - CompareCoverage Unicorn
+ - Immediates-only instrumentation for CompareCoverage
+ - ... your patch? :)
--------------------------
diff --git a/docs/env_variables.txt b/docs/env_variables.txt
index 93066dbc..821463ae 100644
--- a/docs/env_variables.txt
+++ b/docs/env_variables.txt
@@ -245,9 +245,19 @@ The QEMU wrapper used to instrument binary-only code supports several settings:
- Setting AFL_INST_LIBS causes the translator to also instrument the code
inside any dynamically linked libraries (notably including glibc).
+ - Setting AFL_COMPCOV_LEVEL enables the CompareCoverage tracing of all cmp
+ and sub in x86 and x86_64 and memory comparions functions (e.g. strcmp,
+ memcmp, ...) when libcompcov is preloaded using AFL_PRELOAD.
+ More info at qemu_mode/libcompcov/README.compcov.
+ There are two levels at the moment, AFL_COMPCOV_LEVEL=1 that instruments
+ only comparisons with immediate values / read-only memory and
+ AFL_COMPCOV_LEVEL=2 that instruments all the comparions. Level 2 is more
+ accurate but may need a larger shared memory.
+
- Setting AFL_QEMU_COMPCOV enables the CompareCoverage tracing of all
- cmp and sub in x86 and x86_64. Support for other architectures and
- comparison functions (mem/strcmp et al.) is planned.
+ cmp and sub in x86 and x86_64.
+ This is an alias of AFL_COMPCOV_LEVEL=1 when AFL_COMPCOV_LEVEL is
+ not specified.
- The underlying QEMU binary will recognize any standard "user space
emulation" variables (e.g., QEMU_STACK_SIZE), but there should be no
@@ -260,10 +270,7 @@ The QEMU wrapper used to instrument binary-only code supports several settings:
- AFL_ENTRYPOINT allows you to specify a specific entrypoint into the
binary (this can be very good for the performance!).
The entrypoint is specified as hex address, e.g. 0x4004110
-
- - AFL_QEMU_COMPCOV is for a sub-project in qemu_mode called ./libcompcov
- which implements laf-intel for qemu. It also needs AFL_PRELOAD and
- you can find more information in qemu_mode/libcompcov/README.compcov
+ Note that the address must be the address of a basic block.
5) Settings for afl-cmin
------------------------
diff --git a/docs/unicorn_mode.txt b/docs/unicorn_mode.txt
deleted file mode 100644
index b691fff8..00000000
--- a/docs/unicorn_mode.txt
+++ /dev/null
@@ -1,109 +0,0 @@
-=========================================================
-Unicorn-based binary-only instrumentation for afl-fuzz
-=========================================================
-
-1) Introduction
----------------
-
-The code in ./unicorn_mode allows you to build a standalone feature that
-leverages the Unicorn Engine and allows callers to obtain instrumentation
-output for black-box, closed-source binary code snippets. This mechanism
-can be then used by afl-fuzz to stress-test targets that couldn't be built
-with afl-gcc or used in QEMU mode, or with other extensions such as
-TriforceAFL.
-
-There is a significant performance penalty compared to native AFL,
-but at least we're able to use AFL on these binaries, right?
-
-The idea and much of the implementation comes from Nathan Voss <njvoss299@gmail.com>.
-
-2) How to use
--------------
-
-Requirements: you need an installed python2 environment.
-
-*** Building AFL's Unicorn Mode ***
-
-First, make afl as usual.
-Once that completes successfully you need to build and add in the Unicorn Mode
-features:
-
- $ cd unicorn_mode
- $ ./build_unicorn_support.sh
-
-NOTE: This script downloads a recent Unicorn Engine commit that has been tested
-and is stable-ish from the Unicorn github page. If you are offline, you'll need
-to hack up this script a little bit and supply your own copy of Unicorn's latest
-stable release. It's not very hard, just check out the beginning of the
-build_unicorn_support.sh script and adjust as necessary.
-
-Building Unicorn will take a little bit (~5-10 minutes). Once it completes
-it automatically compiles a sample application and verify that it works.
-
-*** Fuzzing with Unicorn Mode ***
-
-To really use unicorn-mode effectively you need to prepare the following:
-
- * Relevant binary code to be fuzzed
- * Knowledge of the memory map and good starting state
- * Folder containing sample inputs to start fuzzing with
- - Same ideas as any other AFL inputs
- - Quality/speed of results will depend greatly on quality of starting
- samples
- - See AFL's guidance on how to create a sample corpus
- * Unicorn-based test harness which:
- - Adds memory map regions
- - Loads binary code into memory
- - Emulates at least one instruction*
- - Yeah, this is lame. See 'Gotchas' section below for more info
- - Loads and verifies data to fuzz from a command-line specified file
- - AFL will provide mutated inputs by changing the file passed to
- the test harness
- - Presumably the data to be fuzzed is at a fixed buffer address
- - If input constraints (size, invalid bytes, etc.) are known they
- should be checked after the file is loaded. If a constraint
- fails, just exit the test harness. AFL will treat the input as
- 'uninteresting' and move on.
- - Sets up registers and memory state for beginning of test
- - Emulates the interested code from beginning to end
- - If a crash is detected, the test harness must 'crash' by
- throwing a signal (SIGSEGV, SIGKILL, SIGABORT, etc.)
-
-Once you have all those things ready to go you just need to run afl-fuzz in
-'unicorn-mode' by passing in the '-U' flag:
-
- $ afl-fuzz -U -m none -i /path/to/inputs -o /path/to/results -- ./test_harness @@
-
-The normal afl-fuzz command line format applies to everything here. Refer to
-AFL's main documentation for more info about how to use afl-fuzz effectively.
-
-For a much clearer vision of what all of this looks like, please refer to the
-sample provided in the 'unicorn_mode/samples' directory. There is also a blog
-post that goes over the basics at:
-
-https://medium.com/@njvoss299/afl-unicorn-fuzzing-arbitrary-binary-code-563ca28936bf
-
-The 'helper_scripts' directory also contains several helper scripts that allow you
-to dump context from a running process, load it, and hook heap allocations. For details
-on how to use this check out the follow-up blog post to the one linked above.
-
-A example use of AFL-Unicorn mode is discussed in the Paper Unicorefuzz:
-https://www.usenix.org/conference/woot19/presentation/maier
-
-3) Gotchas, feedback, bugs
---------------------------
-
-To make sure that AFL's fork server starts up correctly the Unicorn test
-harness script must emulate at least one instruction before loading the
-data that will be fuzzed from the input file. It doesn't matter what the
-instruction is, nor if it is valid. This is an artifact of how the fork-server
-is started and could likely be fixed with some clever re-arranging of the
-patches applied to Unicorn.
-
-Running the build script builds Unicorn and its python bindings and installs
-them on your system. This installation will supersede any existing Unicorn
-installation with the patched afl-unicorn version.
-
-Refer to the unicorn_mode/samples/arm_example/arm_tester.c for an example
-of how to do this properly! If you don't get this right, AFL will not
-load any mutated inputs and your fuzzing will be useless!