Skip to content

Adding modules

Riqky edited this page Jan 7, 2020 · 3 revisions

Adding modules

Spitzer makes use of 'modules' to test systems. Every modules is called reflectively, this makes it very easy to add a module to spitzer..

Creating the module

First you'll need to create the module to run. Create a python-script with and place it in the install directory of spitzer, or place it in the cloned project and run setup.sh when you're done. The script will need a method called exploit and a list of strings called category.

Category

Thee category property defines the intensity of the modules. Maybe this system will get more categories, but for now there are three categories:

  • intrusive Generates lots of noise and might even be able to damage the server, or get a lock-out because of dos'ing.
  • heavy Just generates a lot of noise.
  • safe Can always be ran.

The category should be like this in the script:

category = ['safe']

or

category = ['heavy']

Method

The second part of your module is the method that is called in order to start the module:

def exploit(host, nmap, port):

With the parameters being:

  • host The ip-address of the target
  • nmap A dictionary with the nmap-result for that specific port.
  • port The port number to exploit

It is important that these parameters are in this order, else they won't work.

Within the exploit method you can run any tool to scan your target.For classes within spitzer you can use, see the classes page

Clone this wiki locally