ostorlab.yaml

kind: Agent
name: nmap
version: 0.5.0
image: images/logo.png
description: |
  This repository is an implementation of [Ostorlab Agent](https://pypi.org/project/ostorlab/) for the [Nmap Scanner](https://github.com/projectdiscovery/nmap) by Project Discovery.
  ## Getting Started
  To perform your first scan, simply run the following command:
  ```shell
  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](https://github.com/Ostorlab/ostorlab/blob/main/README.md)
  ## Usage
  Agent nmap can be installed directly from the ostorlab agent store or built from this repository.
   ### Install directly from ostorlab agent store
   ```shell
   ostorlab agent install agent/ostorlab/nmap
   ```
  You can then run the agent with the following command:
  ```shell
  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](https://pypi.org/project/ostorlab/) installed in your machine.  if you have already installed ostorlab, you can skip this step.
  ```shell
  pip3 install ostorlab
  ```
   2. Clone this repository.
  ```shell
  git clone https://github.com/Ostorlab/agent_nmap.git && cd agent_nmap
  ```
   3. Build the agent image using ostorlab cli.
   ```shell
   ostortlab 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](./LICENSE)
license: Apache-2.0
source: https://github.com/Ostorlab/agent_nmap
in_selectors:
  - v3.asset.ip.v4
  - v3.asset.ip.v6
  - v3.asset.domain_name
  - v3.asset.link
out_selectors:
  - v3.asset.ip.v4.port.service
  - v3.asset.ip.v6.port.service
  - v3.asset.domain_name.service
  - v3.report.vulnerability
  - v3.fingerprint.ip.v4.service.library
  - v3.fingerprint.ip.v6.service.library
docker_file_path : Dockerfile
docker_build_root : .
args:
  - name: "ports"
    type: "string"
    description: "List of ports to scan."
    value: "0-65535"
  - name: "timing_template"
    type: "string"
    description: "Template of timing settings (T0, T1, ... T5)."
    value: "T4"
  - name: "scripts"
    type: "array"
    description: "list of scripts to run using Nmap"