generated from Ostorlab/template_agent
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathostorlab.yaml
87 lines (64 loc) · 2.88 KB
/
ostorlab.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
kind: Agent
name: ip2geo
version: 0.2.10
image: images/logo.png
description: |
# Agent Ip2Geo
_Ip2Geo agent is part of the auto-discovery agents, responsible for detecting the geolocation details of an IP address._
This repository is an implementation of [OXO Agent](https://pypi.org/project/ostorlab/).
## 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:
```shell
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](https://oxo.ostorlab.co/docs)
## Usage
Agent Ip2Geo 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/ip2geo
```
### Build directly from the repository
1. To build the Ip2Geo 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_ip2geo.git && cd agent_ip2geo
```
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 organization. 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//ip2geo --agent agent//autodiscovery_persist_graph ip 8.8.8.8
```
* If you specified an organization when building the image:
```shell
oxo scan run --agent agent/[ORGANIZATION]/ip2geo --agent agent/[ORGANIZATION]/autodiscovery_persist_graph ip 8.8.8.8
```
## License
[Apache](./LICENSE)
license: Apache-2.0
source: https://github.com/Ostorlab/agent_ip2geo
in_selectors:
- v3.asset.ip.v4
- v3.asset.ip.v6
out_selectors:
- v3.asset.ip.v4.geolocation
- v3.asset.ip.v6.geolocation
docker_file_path : Dockerfile
docker_build_root : .