Development

You can create new plugins by following the instructions below. A template is provided in the plugins/template directory.

$ cd plugins
$ mkdir newplugin
$ cd newplugin
$ touch __init__.py
$ touch newplugin.py

Instructions within that file should give you all the information you need to add a new plugin.

Plugin Args

If your plugin requirements plugin-specific arguments, you can implement a validate function in the __init__.py file of your plugin directory that will be passed a dictionary of all optional arguments. An example of plugin argument validation can be found in any of the plugins provided.

All validate functions must return a pluginargs ['url'] value to be used for the API creation, which cannot include the URI. FireProx will not work properly if the URI is provided. The HTTPBrute plugin is a good example if you need clarification. Everything else will be passed to the authentication function to be used.

Feel free to reach out if you have any questions