ostorlab.yaml

kind: Agent
name: dnsx # Agent name, must be unique by organisation to be published on the store.
version: 0.2.11
image: images/cover.png
description: |
  This repository is an implementation of [OXO Agent](https://pypi.org/project/ostorlab/) for [dnsx](https://github.com/projectdiscovery/dnsx) DNS toolkitby by ProjectDiscovery.
  ## Getting Started
  The Dnsx Agent works collectively with other agents. It's job is to reverse a subdomain name and send all the identified records to the other agents reponsible for scanning those records.
  To perform your first scan, simply run the following command:
  ```shell
  oxo scan run --install --agent agent/ostorlab/dnsx --agent agent/ostorlab/subfinder domain-name your-domain.com
  ```
  This command will download and install agents  `agent/ostorlab/dnsx` & `agent/ostorlab/subfinder` and target the domain  `your-domain`.
  Subfinder Agent will scan for <your-domain>, and sends all identified subdomains, then Dnsx will reverse those subdomains and send the records.
  You can use any Agent expecting <v3.asset.domain_name> as an in-selector, like Nmap, OpenVas, etc.
  For more information, please refer to the [OXO Documentation](https://oxo.ostorlab.co/docs)
  ## Usage
  Agent Dnsx can be installed directly from the oxo agent store or built from this repository.
  ### Install directly from oxo agent store
  ```shell
  oxo agent install agent/ostorlab/dnsx
  ```
  ### Build directly from the repository
  1. To build the Dnsx agent you need to have [oxo](https://pypi.org/project/ostorlab/) installed in your machine. If you have already installed oxo, you can skip this step.
  ```shell
  pip3 install ostorlab
  ```
  2. Clone this repository.
  ```shell
  git clone https://github.com/Ostorlab/agent_dnsx.git && cd agent_dnsx
  ```
  3. Build the agent image using oxo cli.
  ```shell
  oxo 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
      oxo scan run --agent agent//dnsx --agent agent//subfinder domain-name your-domain.com
      ```
    * If you specified an organization when building the image:
      ```shell
      oxo scan run --agent agent/[ORGANIZATION]/subfinder --agent agent/[ORGANIZATION]/dnsx  domain-name your-domain.com
  ## License
  [Apache](./LICENSE)license: Apache-2.0
license: Apache-2.0
in_selectors:
  - v3.asset.domain_name
out_selectors:
  - v3.asset.domain_name.dns_record
docker_file_path : Dockerfile
docker_build_root : .
args:
  - name: "wordlist"
    type: "string"
    description: "Path to wordlist to brute force DNS, the agent ships with a 100, 2M and 9M subdomains list at /app/agent/wordlists/[2m,10k,100]_list.txt"
  - name: "max_subdomains"
    type: "number"
    description: "Maximum number of subdomains to return"
  - name: "scope_domain_regex"
    type: "string"
    description: "Regular expression to define domain scanning scope."