ostorlab.yaml

kind: Agent
name: amass
version: 0.3.1
image: images/cover.png
description: |
  _Amass performs network mapping of attack surfaces and external asset discovery using open source information gathering and active reconnaissance techniques.._
  This repository is an implementation of [OXO Agent](https://pypi.org/project/ostorlab/) for [amass](https://github.com/OWASP/Amass) by OWASP.
  
  ## Getting Started
  The Amass 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 responsible for scanning those records.
  To perform your first scan, simply run the following command:
  ```shell
  oxo scan run --install --agent agent/ostorlab/amass --agent agent/ostorlab/subfinder domain-name your-domain.com
  ```
  This command will download and install agents  `agent/ostorlab/amass` & `agent/ostorlab/subfinder` and target the domain  `your-domain`.
  Subfinder Agent will scan for <your-domain>, and sends all identified subdomains, then Amass 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 Amass 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/amass
  ```
  ### Build directly from the repository
  1. To build the Amass 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_amass.git && cd agent_amass
  ```
  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//amass --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]/amass  domain-name your-domain.com

  ## License

  License: [Apache-2.0](./LICENSE)
license: Apache-2.0
source: https://github.com/Ostorlab/agent_amass
in_selectors:
  - v3.asset.domain_name
out_selectors:
  - v3.asset.domain_name
supported_architectures:
  - linux/arm64/v8
  - linux/x86_64
docker_file_path : Dockerfile
docker_build_root : .
args:
  - name: "reverse_whois"
    type: "boolean"
    description: "Enable reverse Whois collection."
    value: false
  - name: "subdomain_enumeration"
    type: "boolean"
    description: "Enable subdomain collection."
    value: true