Skip to content

Ostorlab/agent_whois_domain

Repository files navigation

Agent Whois

Agent responsible for retrieving WHOIS information of a domain such as it's name servers, contact information, registrar, and address.


agent-whois-domain

This repository is an implementation of OXO Agent for python-whois.

Getting Started

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

oxo scan run --install --agent agent/ostorlab/whois_domain domain-name tesla.com

This command will download and install agent/ostorlab/whois_domain. For more information, please refer to the OXO Documentation

Usage

Agent Whois can be installed directly from the ostorlab agent store or built from this repository.

Install directly from oxo agent store

oxo agent install agent/ostorlab/whois_domain

You can then run the agent with the following command:

oxo scan run --agent agent/ostorlab/whois_domain domain-name tesla.com

Build directly from the repository

  1. To build the whois_domain agent you need to have oxo installed in your machine. if you have already installed oxo, you can skip this step.
pip3 install ostorlab
  1. Clone this repository.
git clone https://github.com/Ostorlab/agent_whois_domain.git && cd agent_whois_domain
  1. Build the agent image using oxo cli.
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:
    oxo scan run --agent agent//whois_domain domain-name tesla.com
    • If you specified an organization when building the image:
    oxo scan run --agent agent/[ORGANIZATION]/whois_domain domain-name tesla.com

License

Apache-2