Agent Nmap

Nmap is an agent responsible for network discovery and security auditing (wraps around the Nmap tool).

---

This repository is an implementation of Ostorlab Agent for Nmap (the Network Mapper).

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.

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:

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

   • If you specified an organization when building the image:

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

License

Apache