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
.. figure:: docs/source/images/fuddly_tui.png :align: center
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 operators (objects that implement specific data transformation) - scenario infrastructure (for modeling protocol logic) - ...
Basic Installation Instructions -------------------------------
Installation with pipenv::
$ cd
Refer to the documentation for more information
Launch fuddly shell -------------------
- If
fuddlyis installed either through pip/pipenv or a package from your distribution::
- If
fuddlyis not installed::
Note: the --tui flag enables the launching of the fuddly TUI
About the Documentation
-----------------------
+ The 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. From the src/ directory, usage is as follows:
- To launch all the tests, issue the command::
- To launch all the tests but the longer ones, issue the command::
- To avoid data model specific test cases use the option
--ignore-dm-specifics`
- To launch a specific test category issue the following command::