fuddly: a fuzzing and data manipulation framework

|docs|

.. |docs| image:: https://readthedocs.org/projects/fuddly/badge/?version=develop :target: https://readthedocs.org/projects/fuddly/?badge=develop :alt: Documentation

List of features

• Graph-based data model that enables:

  • to represent complex data formats and also to mix them
  • complex data manipulations
  • to dissect/absorb existing data
  • generation & mutation fuzzing strategy

• Fuzzing automation framework:

  • target abstraction
  • monitoring means based on independant probes
  • replay & logging
  • data manipulation based on disruptors (objects that implement specific data transformation)
  • scenario infrastructure (for modeling protocol logic)
  • virtual operators

• and so on...

What's still missing

• Refer to TODO file

About documentation

• Documentation is available here_.

• In order to generate the documentation from the source, follow these steps:

  #. go to the folder docs/ #. execute make html to generate HTML documentation #. execute make latexpdf to generate PDF documentation #. generated documentation is located in docs/build/

.. _here: http://fuddly.readthedocs.io

Launch fuddly test cases

The package test include all unit & integration test cases of fuddly itself. Usage is as follows:

• To launch all the tests, issue the command::

  python -m test -a

• To launch all the tests but the longer ones, issue the command::

  python -m test

• To avoid data model specific test cases use the option --ignore-dm-specifics

• To launch a specific test category issue the following command::

  python -m test test.<test_package>.<test_module>.<Test_Class>.<test_method>

Miscellaneous

• Don't forget to populate ~/fuddly_data/imported_data/ with sample files for data models that need it

Dependencies

• Compatible with Python2 and Python3

• Mandatory:

  • six_: Python 2/3 compatibility
  • sqlite3_: SQLite3 data base

• Optional:

  • xtermcolor_: Terminal color support
  • graphviz_: For graphic visualization (e.g., scenario display)
  • paramiko_: Python implementation of the SSHv2 protocol
  • serial_: For serial port access
  • cups_: Python bindings for libcups
  • rpyc_: Remote Python Call (RPyC), a transparent and symmetric RPC library

• For testing:

  • ddt_: Used for data-driven tests
  • mock_: Used for mocking (only needed in Python2)

• For documentation generation:

  • sphinx_: sphinx >= 1.3 (with builtin napoleon extension)
  • texlive_ (optional): Needed to generate PDF documentation
  • readthedocs theme_ (optional): Privileged html theme for sphinx

.. _six: http://pythonhosted.org/six/ .. _sqlite3: https://www.sqlite.org/ .. _xtermcolor: https://github.com/broadinstitute/xtermcolor .. _graphviz: https://pypi.python.org/pypi/graphviz .. _paramiko: http://www.paramiko.org/ .. _serial: https://github.com/pyserial/pyserial .. _cups: https://pypi.python.org/pypi/pycups .. _rpyc: https://pypi.python.org/pypi/rpyc .. _ddt: https://github.com/txels/ddt .. _mock: https://pypi.python.org/pypi/mock .. _sphinx: http://sphinx-doc.org/ .. _texlive: https://www.tug.org/texlive/ .. _readthedocs theme: https://github.com/snide/sphinx_rtd_theme