About OSPD-NMAP
---------------

This is a OSP server implementation to allow OpenVAS to remotely control
the nmap port scanner.

Once running, you need to configure the Scanner for OpenVAS Manager,
for example via the web interface Greenbone Security Assistant.
Then you can create scan tasks to use this scanner.

OSPD-NMAP is licensed under GNU General Public License Version 2 or
any later version.  Please see file COPYING for details.

All parts of OSP-NMAP are Copyright (C) by Greenbone Networks GmbH
(see http://www.greenbone.net).


How to start OSPD-NMAP
----------------------

All OSPD servers share a set of command-line options such as
--help, --bind-address, --port, --key-file, --timeout etc.

For example to see the command line options you can run

$ ospd-nmap --help


To run a test instance of ospd-nmap on local port 1234:

$ ospd-nmap -b 127.0.0.1 -p 1234 &

Add "--log-level=DEBUG" to enable maximum debugging output.

Parameter for --log-level can be one of debug, info, warnings, error, or
critical (in order of priority).


Controlling a OSP daemon
------------------------

You can use command "omp" of the OpenVAS "omp-cli" module to send to and
receive information from the scanners.

Get a description of the interface:

$ omp --use-certs -p 1234 -i --xml="<help/>"


Starting a scan (scanner parameters can be added according to the description
printed upon the command "<help/>":

omp --use-certs --xml="<start_scan target='www.example.com'></start_scan>" -p 1234 -i


Show the list of scans, their status and results:

$ omp --use-certs --xml="<get_scans/>" -p 1234 -i
