This repository is an implementation of Ostorlab Agent for the Nmap Scanner by Project Discovery.

Getting Started

To perform your first scan, simply run the following command:

ostorlab scan run --install --agent agent/ostorlab/nmap ip 8.8.8.8

This command will download and install agent/ostorlab/nmap and target the ip 8.8.8.8. For more information, please refer to the Ostorlab Documentation

Usage

Agent Nmap can be installed directly from the ostorlab agent store or built from this repository.

Supported agent flags:

• fast_mode (-F): Fast mode scans fewer ports than the default mode.
• ports (-p): List of ports to scan.
• top_ports (--top-ports): Top ports to scan.
• no_ping (-Pn): Treat all hosts as online, skip host discovery.
• version_info (-sV): Probe open ports to determine service/version info.
• timing_template (-Tx): Template of timing settings (T0, T1, ... T5)..
• script_default (-sC): Script scan, equivalent to --script=default.
• scripts (--script): List of scripts to run using Nmap.

Install directly from ostorlab agent store

ostorlab agent install agent/ostorlab/nmap

You can then run the agent with the following command:

ostorlab scan run --agent agent/ostorlab/nmap ip 8.8.8.8

Build directly from the repository

1. To build the nmap agent you need to have ostorlab installed in your machine. if you have already installed ostorlab, you can skip this step.

pip3 install ostorlab

2. Clone this repository.

git clone https://github.com/Ostorlab/agent_nmap.git && cd agent_nmap

3. Build the agent image using ostorlab cli.

ostorlab agent build --file=ostorlab.yaml

You can pass the optional flag --organization to specify your organisation. The organization is empty by default. 4. Run the agent using on of the following commands:

• If you did not specify an organization when building the image:

```shell
ostorlab scan run --agent agent//nmap ip 8.8.8.8
```

• If you specified an organization when building the image:

```shell
ostorlab scan run --agent agent/[ORGANIZATION]/nmap ip 8.8.8.8
```

License

Apache-2.0