ostorlab.yaml

kind: Agent
name: whois_ip
version: 0.4.2
image: images/cover.png
description: |
  This repository is an implementation of [Ostorlab Agent](https://pypi.org/project/ostorlab/)
  for [ipwhois](https://pypi.org/project/ipwhois/).

  ## Getting Started

  To perform your first scan, simply run the following command.

  ```shell
  oxo scan run --install --agent agent/ostorlab/whois_ip ip 8.8.8.8
  ```

  This command will download and install `agent/ostorlab/whois_ip`.
  For more information, please refer to
  the [OXO Documentation](https://oxo.ostorlab.co/docs)

  ## Usage

  Agent Whois 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/whois_ip
   ```

  You can then run the agent with the following command:

  ```shell
  oxo scan run --agent agent/ostorlab/whois_ip domain-name tesla.com
  ```

  ### Build directly from the repository

  1. To build the whois_ip 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_whois_ip.git && cd agent_whois_ip
  ```

  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.

  1. 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//whois_ip domain-name tesla.com
       ```
      * If you specified an organization when building the image:
       ```shell
       oxo scan run --agent agent/[ORGANIZATION]/whois_ip ip 8.8.8.8
       ```

  ## License

  [Apache-2](./LICENSE)
in_selectors:
  - v3.asset.ip.v4
  - v3.asset.ip.v6
  - v3.asset.domain_name.dns_record
out_selectors:
  - v3.asset.ip.v4.whois
  - v3.asset.ip.v6.whois
docker_file_path : Dockerfile
docker_build_root : .
args:
  - name: "scope_domain_regex"
    type: "string"
    description: "Regular expression to define domain scanning scope."