Boofuzz requires Python 2.7 or ≥ 3.5. Recommended installation requires
To ensure forward compatibility, Python 3 is recommended. As a base
requirement, the following packages are needed:
sudo apt-get install python3-pip python3-venv build-essential
sudo zypper install python3-devel gcc
sudo yum install python3-devel gcc
It is strongly recommended to set up boofuzz in a virtual environment
(venv). However, the
module is only available for Python 3. For Python 2.7, please use the
older virtualenv package.
First, create a directory that will hold our boofuzz install:
$ mkdir boofuzz && cd boofuzz $ python3 -m venv env
This creates a new virtual environment env in the current folder. Note that the
Python version in a virtual environment is fixed and chosen at its creation.
Unlike global installs, within a virtual environment
python is aliased to
the Python version of the virtual environment.
Next, activate the virtual environment:
$ source env/bin/activate
Or, if you are on Windows:
Ensure you have the latest version of both
(env) $ pip install -U pip setuptools
Finally, install boofuzz:
(env) $ pip install boofuzz
To run and test your fuzzing scripts, make sure to always activate the virtual environment beforehand.
Like above, it is recommended to set up a virtual environment. Depending on your concrete setup, this is largely equivalent to the steps outlined above. Make sure to upgrade
Download the source code. You can either grab a zip from https://github.com/jtpereyda/boofuzz or directly clone it with git:
$ git clone https://github.com/jtpereyda/boofuzz.git
pipfrom within the boofuzz directory after activating the virtual environment:
$ pip install .
-eoption for developer mode, which allows changes to be seen automatically without reinstalling:
$ pip install -e .
To install developer tools (unit test dependencies, test runners, etc.) as well:
$ pip install -e .[dev]
Note that black needs Python ≥ 3.6.
If you’re behind a proxy:
$ set HTTPS_PROXY=http://your.proxy.com:port
If you’re planning on developing boofuzz itself, you can save a directory and create your virtual environment after you’ve cloned the source code (so
env/is within the main boofuzz directory).
process_monitor.py (Windows only)¶
Currently, the process monitor is Python 2 only due to a dependency on
pydbg. See the discussion in Issue #370
for more information regarding Python 3 support.
As always, contributions are welcome!
The process monitor is a tool for detecting crashes and restarting an application on Windows (process_monitor_unix.py is provided for Unix).
The process monitor is included with boofuzz, but requires additional libraries to run. While boofuzz typically runs on a different machine than the target, the process monitor must run on the target machine itself.
If you want to use process_monitor.py, follow these additional steps:
Download and install pydbg.
Make sure to install and run pydbg using a 32-bit Python 2 interpreter, not 64-bit!
The OpenRCE repository doesn’t have a setup.py. Use Fitblip’s fork.
C:\Users\IEUser\Downloads\pydbg>pip install .
Download and install pydasm.
C:\Users\IEUser\Downloads\libdasm\pydasm>python setup.py build_ext**
C:\Users\IEUser\Downloads\libdasm\pydasm>python setup.py install
Verify that process_monitor.py runs:
C:\Users\IEUser\Downloads\boofuzz>python process_monitor.py -h usage: procmon [-h] [--debug] [--quiet] [-f STR] [-c FILENAME] [-i PID] [-l LEVEL] [-p NAME] [-P PORT] optional arguments: -h, --help show this help message and exit --debug toggle debug output --quiet suppress all output -f STR, --foo STR the notorious foo option -c FILENAME, --crash_bin FILENAME filename to serialize crash bin class to -i PID, --ignore_pid PID PID to ignore when searching for target process -l LEVEL, --log_level LEVEL log level: default 1, increase for more verbosity -p NAME, --proc_name NAME process name to search for and attach to -P PORT, --port PORT TCP port to bind this agent to
** Building pydasm on Windows requires the Visual C++ Compiler for Python 2.7.
The network monitor was Sulley’s primary tool for recording test data, and has been replaced with boofuzz’s logging mechanisms. However, some people still prefer the PCAP approach.
The network monitor requires Pcapy, which will not be automatically installed with boofuzz. You can manually
install it with
pip install pcapy.
If you run into errors, check out the requirements on the project page.