libprotobuf-mutator bindings for Python using Atheris.
Project description
Libprotobuf-mutator: Python bindings for Atheris
Structure-aware Fuzzing with Protocol Buffers
Atheris supports custom mutators (as offered by LibFuzzer) to produce grammar-aware inputs.
Protocol buffers are an example of structured types that are hard to fuzz with generic mutation-based fuzzers. Libprotobuf-mutator bindings for Atheris allow to generate protocol buffer inputs for your fuzzing targets using custom mutators.
Apart from fuzzing targets that take protocol buffers as input, it's also possible to use protocol buffers as an intermediate representation for fuzzing complex input types. See the docs on using Protocol Buffers As Intermediate Format for fuzzing.
Getting Started
Prerequisite
Install Atheris
pip3 install atheris
Install
Installing libprotobuf-mutator for Atheris from source requires bazel
. Visit
https://docs.bazel.build/versions/master/install.html for installation
instructions.
Then run:
pip3 install .
Example usage
Using Atheris with Libprotobuf-mutator is similar to using plain Atheris. The main difference is that the function under test will receive a proto of the given format, instead of a bytes array.
You can specify the proto format using the atheris_libprotobuf_mutator.Setup()
function, which substitutes the regular atheris.Setup()
function.
import atheris
import atheris_libprotobuf_mutator
import sys
import example_proto_pb2
@atheris.instrument_func
def TestOneProtoInput(msg):
# msg will be an ExampleMessage as specified in the Setup() function below.
if msg.example_value == 13371337:
raise RuntimeError('Crash!')
if __name__ == '__main__':
atheris_libprotobuf_mutator.Setup(
sys.argv, TestOneProtoInput, proto=example_proto_pb2.ExampleMessage)
atheris.Fuzz()
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for atheris_libprotobuf_mutator-0.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e716261c859664dda4e583573d0e5a72622bb8e71721ed5c596489a218a1c86 |
|
MD5 | bbc960c7320d1251de7c7f811bb7a4b7 |
|
BLAKE2b-256 | ab13b68aceb41c9b517908bb4235a3d62320a82c8df55505af6665d0eed20322 |