generated from Ostorlab/template_agent
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathostorlab.yaml
115 lines (94 loc) · 3.43 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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
kind: Agent
name: nuclei
version: 1.0.11
image: images/logo.png
description: |
This repository is an implementation of [Ostorlab Agent](https://pypi.org/project/ostorlab/) for the [Nuclei Scanner](https://github.com/projectdiscovery/nuclei) by Project Discovery.
## Getting Started
To perform your first scan, simply run the following command:
```shell
ostorlab scan run --install --agent agent/ostorlab/nuclei ip 8.8.8.8
```
This command will download and install `agent/ostorlab/nuclei` and target the ip `8.8.8.8`.
For more information, please refer to the [Ostorlab Documentation](https://github.com/Ostorlab/ostorlab/blob/main/README.md)
## Usage
Agent Nuclei can be installed directly from the ostorlab agent store or built from this repository.
### Install directly from ostorlab agent store
```shell
ostorlab agent install agent/ostorlab/nuclei
```
You can then run the agent with the following command:
```shell
ostorlab scan run --agent agent/ostorlab/nuclei ip 8.8.8.8
```
### Build directly from the repository
1. To build the nuclei agent you need to have [ostorlab](https://pypi.org/project/ostorlab/) installed in your machine. if you have already installed ostorlab, you can skip this step.
```shell
pip3 install ostorlab
```
2. Clone this repository.
```shell
git clone https://github.com/Ostorlab/agent_nuclei.git && cd agent_nuclei
```
3. Build the agent image using ostorlab cli.
```shell
ostortab 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
ostorlab scan run --agent agent//nuclei ip 8.8.8.8
```
* If you specified an organization when building the image:
```shell
ostorlab scan run --agent agent/[ORGANIZATION]/nuclei ip 8.8.8.8
```
## License
[Apache](./LICENSE)
license: Apache-2.0
source: https://github.com/Ostorlab/agent_nuclei
in_selectors:
- v3.asset.ip.v4
- v3.asset.ip.v6
- v3.asset.domain_name
- v3.asset.link
out_selectors:
- v3.report.vulnerability
docker_file_path : Dockerfile
docker_build_root : .
supported_architectures:
- linux/arm64/v8
- linux/x86_64
args:
- name: "template_urls"
type: "array"
description: "List of template urls to run. These will be fetched by the agent and passed to Nuclei."
- name: "use_default_templates"
type: "boolean"
description: "use nuclei's default templates to scan."
value: true
- name: "https"
type: "boolean"
description: "Target that doesn't specify protocol will use this argument to set the protocol to either http
or https."
value: true
- name: "port"
type: "number"
description: "Target that doesn't specify port will use this argument to set the target port."
value: 443
- name: "scope_urls_regex"
type: "string"
description: "to define scanning scope."
- name: "vpn_config"
type: "string"
description: "Content of the VPN:wg0.conf configuration file."
- name: "dns_config"
type: "string"
description: "Content of the /etc/resolv.conf file."
- name: "basic_credentials"
type: "array"
description: "Credentials for basic authentication."
- name: "proxy"
type: "string"
description: "Proxy to use for the scan with nuclei."