Active recon

Scanning

With Nmap, Masscan or Zgrab2

You can use directly Nmap, Masscan, Zgrab2, ZDNS or Nuclei to run the scans. IVRE can use XML output files for Nmap and Masscan, and JSON output files for Zgrab2, ZDNS and Nuclei.

Then, provide the output files produced to the command line tool ivre scan2db. You can (and should!) insert scan results from different tools, then use ivre db2view nmap and you’re ready to explore your results with the the Web User Interface, the ivre view command line tool or the Python API.

With IVRE

Masscan does not provide results as complete as Nmap, when using the “interesting” options (for example, -vv -A) or scripts. That being said, Nmap (with such “interesting” options) cannot run efficiently against huge networks.

The ivre runscans tool can run one Nmap process per target (option --output=XMLFork). This should be less efficient in theory, because Nmap supposedly knows better how to handle the host and network resources, but in practice it is much more efficient. You can adjust how many Nmap processes you want to run in parallel using the --processes N option.

Another advantage of using ivre runscans --output=XMLFork over using Nmap directly is that ivre runscans produces output files as soon as each host has been scanned (in the scans/*/up directory).

Here is a simple example:

$ sudo ivre runscans --routable --limit 1000 --output=XMLFork

This will run a standard scan against 1000 random hosts on the Internet by running 30 nmap processes in parallel. See the output of ivre help runscans if you want to do something else.

When it’s over, to import the results in the database and create a view from them, run (ROUTABLE-001 is the category name, and MySource is the source name, usually referencing the machine used to run the scan):

$ ivre scan2db -c ROUTABLE-001 -s MySource -r scans/ROUTABLE/up
$ ivre db2view nmap

Enjoying the results

You have several options, depending on what you want to do:

  • Command line interfaces: the ivre scancli tool.
  • Python API: use the db.nmap object of the ivre.db module.
  • Web API: /cgi/scans.

If you want to combine several tools, for example Masscan and Nuclei results, you need to use a view: run ivre db2view nmap to create or update a view from the scan data, that can then be accessed by the view purpose (see Purposes), which includes the Web User Interface.

CLI

To get all the hosts with the port 22 open:

$ ivre scancli --port 22

See the output of ivre help scancli.

Python module

To use the Python module, run for example:

$ python
>>> from ivre.db import db
>>> db.nmap.get(db.nmap.flt_empty)[0]

For more, run help(db.nmap) from the Python shell.