ostorlab.yaml

kind: Agent
name: all_tlds
version: 0.3.5
image: images/logo.png
description: |
  ## Getting Started
  The all_tlds Agent works collectively with other agents. It's job; from a domain name, discover all subdomains in a fast and efficient way, 
  and pass its findings to other agents responsible for scanning the subdomains, for example the [Nuclei agent](https://github.com/Ostorlab/agent_nuclei)
  To perform your first scan, simply run the following command:
  ```shell
  oxo scan run --install --agent agent/ostorlab/all_tlds --agent agent/ostorlab/nuclei domain-name your-domain.com
  ```
  This command will download and install agents  `agent/ostorlab/all_tlds` & `agent/ostorlab/nuclei` and target the domain  `your-domain`.
  Nuclei Agent will scan for <your-domain>, and waits for all subdomains found by the all_tlds Agent to perform other scans.
  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 all_tlds 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/all_tlds
  ```
  ### Build directly from the repository
  1. To build the all_tlds 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_all_tlds.git && cd agent_all_tlds
  ```
  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//all_tlds --agent agent//nuclei domain-name your-domain.com
      ```
    * If you specified an organization when building the image:
      ```shell
      oxo scan run --agent agent/[ORGANIZATION]/all_tlds --agent agent/[ORGANIZATION]/nuclei  domain-name your-domain.com
  ## License
  [Apache](./LICENSE)license: Apache-2.0
license: Apache-2.0
source: https://github.com/Ostorlab/agent_all_tlds
in_selectors:
  - v3.asset.domain_name
out_selectors:
  - v3.asset.domain_name
docker_file_path : Dockerfile
docker_build_root : .