Skip to content

Ostorlab/agent_ip2geo

Repository files navigation

Agent Ip2Geo

image image image

Ip2Geo agent is part of the auto-discovery agents, responsible for detecting the geolocation details of an IP address.

image

This repository is an implementation of OXO Agent.

Getting Started

The Ip2Geo Agent works collectively with other agents. Its job; Find all geolocation details of an IP address and emit back these findings.

To use the agent in a scan, simply run the following command:

oxo scan run --install --agent agent/ostorlab/ip2geo \
			    --agent agent/ostorlab/subfinder \
			    --agent agent/ostorlab/autodiscovery_persist_graph \
			    ip 8.8.8.8

This command will download and install the agents :ip2geo, subfinder and autodiscovery_persist_graph and target the IP address 8.8.8.8.

For more information, please refer to the OXO Documentation

Usage

Agent Ip2Geo can be installed directly from the oxo agent store or built from this repository.

Install directly from oxo agent store

oxo agent install agent/ostorlab/ip2geo

Build directly from the repository

  1. To build the Ip2Geo 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_ip2geo.git && cd agent_ip2geo
  1. Build the agent image using oxo cli.
oxo agent build --file=ostorlab.yaml

You can pass the optional flag --organization to specify your organization. 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//ip2geo --agent agent//autodiscovery_persist_graph ip 8.8.8.8
    • If you specified an organization when building the image:
    oxo scan run --agent agent/[ORGANIZATION]/ip2geo --agent agent/[ORGANIZATION]/autodiscovery_persist_graph ip 8.8.8.8

License

Apache