cpytraceafl-regex

A modified version of mrab-regex with added cpytraceafl instrumentation


Keywords
afl-fuzz, coverage, cpython, python, regular-expression, tracing
License
PSF-2.0
Install
pip install cpytraceafl-regex==0.2.0

Documentation

cpytraceafl-regex

This is a thinly modified version of Matthew Barnett's mrab-regex regular expression library with added instrumentation for use when fuzzing python code with cpytraceafl.

The intention is for fuzzing harnesses to be able to substitute the builtin re module library with this, highly compatible, module and thereby allow AFL to generate examples which pass regular expressions used in the target or explore their limits in interesting ways.

See the original README.mrab-regex.rst for more general information in this library's extended regex features.

Recommended usage

Early in the startup of the fuzzing harness, (though after the call to install_rewriter()):

import regex
from sys import modules
modules["re"] = regex

code later importing/referencing the re module should instead be using this instrumented regex code. Note that before evaluating any regexes, cpytraceafl.tracehook.set_map_start() will need to have been initialized with a memory region to write its intrumentation data into. Otherwise you'll get segfaults.