Nmap is an agent responsible for network discovery and security auditing (wraps around the Nmap tool).
This repository is an implementation of OXO Agent for Nmap (the Network Mapper).
To perform your first scan, simply run the following command.
oxo 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 OXO Documentation
Agent Nmap can be installed directly from the oxo 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.os
(--os
): Enable OS detection
oxo agent install agent/ostorlab/nmap
You can then run the agent with the following command:
oxo scan run --agent agent/ostorlab/nmap ip 8.8.8.8
- To build the nmap agent you need to have oxo installed in your machine. If you have already installed oxo, you can skip this step.
pip3 install ostorlab
- Clone this repository.
git clone https://github.com/Ostorlab/agent_nmap.git && cd agent_nmap
- Build the agent image using oxo cli.
oxo agent build --file=ostorlab.yaml
You can pass the optional flag --organization
to specify your organisation. The organization is empty by default.
- Run the agent using on of the following commands:
- If you did not specify an organization when building the image:
oxo scan run --agent agent//nmap ip 8.8.8.8
- If you specified an organization when building the image:
oxo scan run --agent agent/[ORGANIZATION]/nmap ip 8.8.8.8