secator 0.0.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of secator might be problematic. Click here for more details.

Files changed (120) hide show
  1. secator-0.0.1/LICENSE +60 -0
  2. secator-0.0.1/MANIFEST.in +3 -0
  3. secator-0.0.1/PKG-INFO +199 -0
  4. secator-0.0.1/README.md +149 -0
  5. secator-0.0.1/secator/__init__.py +0 -0
  6. secator-0.0.1/secator/celery.py +482 -0
  7. secator-0.0.1/secator/cli.py +617 -0
  8. secator-0.0.1/secator/config.py +137 -0
  9. secator-0.0.1/secator/configs/__init__.py +0 -0
  10. secator-0.0.1/secator/configs/profiles/__init__.py +0 -0
  11. secator-0.0.1/secator/configs/profiles/aggressive.yaml +7 -0
  12. secator-0.0.1/secator/configs/profiles/default.yaml +9 -0
  13. secator-0.0.1/secator/configs/profiles/stealth.yaml +7 -0
  14. secator-0.0.1/secator/configs/scans/__init__.py +0 -0
  15. secator-0.0.1/secator/configs/scans/domain.yaml +18 -0
  16. secator-0.0.1/secator/configs/scans/host.yaml +14 -0
  17. secator-0.0.1/secator/configs/scans/network.yaml +17 -0
  18. secator-0.0.1/secator/configs/scans/subdomain.yaml +8 -0
  19. secator-0.0.1/secator/configs/scans/url.yaml +12 -0
  20. secator-0.0.1/secator/configs/workflows/__init__.py +0 -0
  21. secator-0.0.1/secator/configs/workflows/cidr_recon.yaml +28 -0
  22. secator-0.0.1/secator/configs/workflows/code_scan.yaml +11 -0
  23. secator-0.0.1/secator/configs/workflows/host_recon.yaml +41 -0
  24. secator-0.0.1/secator/configs/workflows/port_scan.yaml +34 -0
  25. secator-0.0.1/secator/configs/workflows/subdomain_recon.yaml +33 -0
  26. secator-0.0.1/secator/configs/workflows/url_crawl.yaml +29 -0
  27. secator-0.0.1/secator/configs/workflows/url_dirsearch.yaml +29 -0
  28. secator-0.0.1/secator/configs/workflows/url_fuzz.yaml +35 -0
  29. secator-0.0.1/secator/configs/workflows/url_nuclei.yaml +11 -0
  30. secator-0.0.1/secator/configs/workflows/url_vuln.yaml +55 -0
  31. secator-0.0.1/secator/configs/workflows/user_hunt.yaml +10 -0
  32. secator-0.0.1/secator/configs/workflows/wordpress.yaml +14 -0
  33. secator-0.0.1/secator/decorators.py +309 -0
  34. secator-0.0.1/secator/definitions.py +165 -0
  35. secator-0.0.1/secator/exporters/__init__.py +12 -0
  36. secator-0.0.1/secator/exporters/_base.py +3 -0
  37. secator-0.0.1/secator/exporters/csv.py +30 -0
  38. secator-0.0.1/secator/exporters/gdrive.py +118 -0
  39. secator-0.0.1/secator/exporters/json.py +15 -0
  40. secator-0.0.1/secator/exporters/table.py +7 -0
  41. secator-0.0.1/secator/exporters/txt.py +25 -0
  42. secator-0.0.1/secator/hooks/__init__.py +0 -0
  43. secator-0.0.1/secator/hooks/mongodb.py +212 -0
  44. secator-0.0.1/secator/output_types/__init__.py +24 -0
  45. secator-0.0.1/secator/output_types/_base.py +95 -0
  46. secator-0.0.1/secator/output_types/exploit.py +50 -0
  47. secator-0.0.1/secator/output_types/ip.py +33 -0
  48. secator-0.0.1/secator/output_types/port.py +45 -0
  49. secator-0.0.1/secator/output_types/progress.py +35 -0
  50. secator-0.0.1/secator/output_types/record.py +34 -0
  51. secator-0.0.1/secator/output_types/subdomain.py +42 -0
  52. secator-0.0.1/secator/output_types/tag.py +46 -0
  53. secator-0.0.1/secator/output_types/target.py +30 -0
  54. secator-0.0.1/secator/output_types/url.py +76 -0
  55. secator-0.0.1/secator/output_types/user_account.py +41 -0
  56. secator-0.0.1/secator/output_types/vulnerability.py +97 -0
  57. secator-0.0.1/secator/report.py +107 -0
  58. secator-0.0.1/secator/rich.py +124 -0
  59. secator-0.0.1/secator/runners/__init__.py +12 -0
  60. secator-0.0.1/secator/runners/_base.py +833 -0
  61. secator-0.0.1/secator/runners/_helpers.py +153 -0
  62. secator-0.0.1/secator/runners/command.py +638 -0
  63. secator-0.0.1/secator/runners/scan.py +65 -0
  64. secator-0.0.1/secator/runners/task.py +106 -0
  65. secator-0.0.1/secator/runners/workflow.py +135 -0
  66. secator-0.0.1/secator/serializers/__init__.py +8 -0
  67. secator-0.0.1/secator/serializers/dataclass.py +33 -0
  68. secator-0.0.1/secator/serializers/json.py +15 -0
  69. secator-0.0.1/secator/serializers/regex.py +17 -0
  70. secator-0.0.1/secator/tasks/__init__.py +10 -0
  71. secator-0.0.1/secator/tasks/_categories.py +304 -0
  72. secator-0.0.1/secator/tasks/cariddi.py +102 -0
  73. secator-0.0.1/secator/tasks/dalfox.py +65 -0
  74. secator-0.0.1/secator/tasks/dirsearch.py +90 -0
  75. secator-0.0.1/secator/tasks/dnsx.py +56 -0
  76. secator-0.0.1/secator/tasks/dnsxbrute.py +34 -0
  77. secator-0.0.1/secator/tasks/feroxbuster.py +91 -0
  78. secator-0.0.1/secator/tasks/ffuf.py +86 -0
  79. secator-0.0.1/secator/tasks/fping.py +44 -0
  80. secator-0.0.1/secator/tasks/gau.py +47 -0
  81. secator-0.0.1/secator/tasks/gf.py +33 -0
  82. secator-0.0.1/secator/tasks/gospider.py +71 -0
  83. secator-0.0.1/secator/tasks/grype.py +79 -0
  84. secator-0.0.1/secator/tasks/h8mail.py +81 -0
  85. secator-0.0.1/secator/tasks/httpx.py +99 -0
  86. secator-0.0.1/secator/tasks/katana.py +133 -0
  87. secator-0.0.1/secator/tasks/maigret.py +78 -0
  88. secator-0.0.1/secator/tasks/mapcidr.py +32 -0
  89. secator-0.0.1/secator/tasks/msfconsole.py +174 -0
  90. secator-0.0.1/secator/tasks/naabu.py +52 -0
  91. secator-0.0.1/secator/tasks/nmap.py +344 -0
  92. secator-0.0.1/secator/tasks/nuclei.py +97 -0
  93. secator-0.0.1/secator/tasks/searchsploit.py +52 -0
  94. secator-0.0.1/secator/tasks/subfinder.py +40 -0
  95. secator-0.0.1/secator/tasks/wpscan.py +179 -0
  96. secator-0.0.1/secator/utils.py +445 -0
  97. secator-0.0.1/secator/utils_test.py +183 -0
  98. secator-0.0.1/secator.egg-info/PKG-INFO +199 -0
  99. secator-0.0.1/secator.egg-info/SOURCES.txt +118 -0
  100. secator-0.0.1/secator.egg-info/dependency_links.txt +1 -0
  101. secator-0.0.1/secator.egg-info/entry_points.txt +2 -0
  102. secator-0.0.1/secator.egg-info/requires.txt +37 -0
  103. secator-0.0.1/secator.egg-info/top_level.txt +2 -0
  104. secator-0.0.1/setup.cfg +4 -0
  105. secator-0.0.1/setup.py +69 -0
  106. secator-0.0.1/tests/__init__.py +0 -0
  107. secator-0.0.1/tests/integration/__init__.py +0 -0
  108. secator-0.0.1/tests/integration/inputs.py +42 -0
  109. secator-0.0.1/tests/integration/outputs.py +392 -0
  110. secator-0.0.1/tests/integration/test_scans.py +82 -0
  111. secator-0.0.1/tests/integration/test_tasks.py +103 -0
  112. secator-0.0.1/tests/integration/test_workflows.py +163 -0
  113. secator-0.0.1/tests/performance/__init__.py +0 -0
  114. secator-0.0.1/tests/performance/loadtester.py +56 -0
  115. secator-0.0.1/tests/unit/__init__.py +0 -0
  116. secator-0.0.1/tests/unit/test_celery.py +39 -0
  117. secator-0.0.1/tests/unit/test_scans.py +0 -0
  118. secator-0.0.1/tests/unit/test_serializers.py +51 -0
  119. secator-0.0.1/tests/unit/test_tasks.py +348 -0
  120. secator-0.0.1/tests/unit/test_workflows.py +96 -0
secator-0.0.1/LICENSE ADDED
@@ -0,0 +1,60 @@
1
+ License text copyright (c) 2020 MariaDB Corporation Ab, All Rights Reserved.
2
+ “Business Source License” is a trademark of MariaDB Corporation Ab.
3
+
4
+ Parameters
5
+
6
+ Licensor: FreeLabz.
7
+ Licensed Work: Secator. The Licensed Work is (c) 2023 FreeLabz.
8
+ Additional Use Grant: You may make production use of the Licensed Work,
9
+ provided such use does not include offering the Licensed Work
10
+ to third parties on a hosted or embedded basis which is
11
+ competitive with FreeLabz's products.
12
+ Change Date: Four years from the date the Licensed Work is published.
13
+
14
+ For information about alternative licensing arrangements for the Licensed Work,
15
+ please contact sales@freelabz.com.
16
+
17
+ Notice
18
+
19
+ Business Source License 1.1
20
+
21
+ Terms
22
+
23
+ The Licensor hereby grants you the right to copy, modify, create derivative
24
+ works, redistribute, and make non-production use of the Licensed Work. The
25
+ Licensor may make an Additional Use Grant, above, permitting limited production use.
26
+
27
+ Effective on the Change Date, or the fourth anniversary of the first publicly
28
+ available distribution of a specific version of the Licensed Work under this
29
+ License, whichever comes first, the Licensor hereby grants you rights under
30
+ the terms of the Change License, and the rights granted in the paragraph
31
+ above terminate.
32
+
33
+ If your use of the Licensed Work does not comply with the requirements
34
+ currently in effect as described in this License, you must purchase a
35
+ commercial license from the Licensor, its affiliated entities, or authorized
36
+ resellers, or you must refrain from using the Licensed Work.
37
+
38
+ All copies of the original and modified Licensed Work, and derivative works
39
+ of the Licensed Work, are subject to this License. This License applies
40
+ separately for each version of the Licensed Work and the Change Date may vary
41
+ for each version of the Licensed Work released by Licensor.
42
+
43
+ You must conspicuously display this License on each original or modified copy
44
+ of the Licensed Work. If you receive the Licensed Work in original or
45
+ modified form from a third party, the terms and conditions set forth in this
46
+ License apply to your use of that work.
47
+
48
+ Any use of the Licensed Work in violation of this License will automatically
49
+ terminate your rights under this License for the current and all other
50
+ versions of the Licensed Work.
51
+
52
+ This License does not grant you any right in any trademark or logo of
53
+ Licensor or its affiliates (provided that you may use a trademark or logo of
54
+ Licensor as expressly required by this License).
55
+
56
+ TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
57
+ AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
58
+ EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
59
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
60
+ TITLE.
@@ -0,0 +1,3 @@
1
+ include secator/configs/workflows/*.yaml
2
+ include secator/configs/scans/*.yaml
3
+ include secator/configs/profiles/*.yaml
secator-0.0.1/PKG-INFO ADDED
@@ -0,0 +1,199 @@
1
+ Metadata-Version: 2.1
2
+ Name: secator
3
+ Version: 0.0.1
4
+ Summary: Security tools command runner
5
+ Author: FLZ Security
6
+ Author-email: ocervello@freelabz.com
7
+ License: MIT
8
+ Keywords: recon framework vulnerability pentest automation
9
+ Classifier: Development Status :: 3 - Alpha
10
+ Classifier: Intended Audience :: Developers
11
+ Classifier: Programming Language :: Python
12
+ Requires-Python: >=3.8
13
+ Description-Content-Type: text/markdown
14
+ License-File: LICENSE
15
+ Requires-Dist: bs4
16
+ Requires-Dist: celery
17
+ Requires-Dist: cpe
18
+ Requires-Dist: dotmap
19
+ Requires-Dist: eventlet
20
+ Requires-Dist: flower
21
+ Requires-Dist: free-proxy
22
+ Requires-Dist: furl
23
+ Requires-Dist: gevent
24
+ Requires-Dist: jinja2
25
+ Requires-Dist: humanize
26
+ Requires-Dist: memray
27
+ Requires-Dist: netifaces
28
+ Requires-Dist: pygments
29
+ Requires-Dist: pyinstrument
30
+ Requires-Dist: python-dotenv
31
+ Requires-Dist: pyyaml
32
+ Requires-Dist: pymongo
33
+ Requires-Dist: redis
34
+ Requires-Dist: requests
35
+ Requires-Dist: rich
36
+ Requires-Dist: rich-click<1.7
37
+ Requires-Dist: tabulate
38
+ Requires-Dist: termcolor
39
+ Requires-Dist: validators
40
+ Requires-Dist: xmltodict
41
+ Provides-Extra: dev
42
+ Requires-Dist: coverage; extra == "dev"
43
+ Requires-Dist: flake8; extra == "dev"
44
+ Requires-Dist: watchdog; extra == "dev"
45
+ Requires-Dist: asciinema-automation; extra == "dev"
46
+ Provides-Extra: google
47
+ Requires-Dist: google-api-python-client; extra == "google"
48
+ Requires-Dist: google-auth; extra == "google"
49
+ Requires-Dist: gspread; extra == "google"
50
+
51
+ <h1 align="center">
52
+ secator
53
+ <br>
54
+ </h1>
55
+
56
+ <h4 align="center">Security swiss-knife to speed up vulnerability assessments.</h4>
57
+
58
+ <p align="center">
59
+ <!-- <a href="https://goreportcard.com/report/github.com/freelabz/secator"><img src="https://goreportcard.com/badge/github.com/freelabz/secator"></a> -->
60
+ <a href="https://github.com/freelabz/secator/issues"><img src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat"></a>
61
+ <a href="https://github.com/freelabz/secator/releases"><img src="https://img.shields.io/github/release/freelabz/secator"></a>
62
+ <a href="https://www.apache.org/licenses/LICENSE-2.0"><img src="https://img.shields.io/badge/License-Apache-blue.svg"></a>
63
+ <a href="https://twitter.com/freelabz"><img src="https://img.shields.io/twitter/follow/freelabz.svg?logo=twitter"></a>
64
+ <!-- <a href="https://discord.gg/freelabz"><img src="https://img.shields.io/discord/695645237418131507.svg?logo=discord"></a> -->
65
+ </p>
66
+
67
+
68
+ <p align="center">
69
+ <a href="#features">Features</a> •
70
+ <a href="#supported-commands">Supported commands</a> •
71
+ <a href="#install-secator">Installation</a> •
72
+ <a href="#usage">Usage</a> •
73
+ <a href="https://docs.freelabz.com">Documentation</a>
74
+ </p>
75
+
76
+ `secator` is a task and workflow runner used for security assessments. It supports dozens of well-known security tools
77
+ and it is designed to improve productivity for pentesters and security researchers.
78
+
79
+ # Features
80
+
81
+ ![](images/short_demo.gif)
82
+
83
+ * **Curated list of commands**
84
+
85
+ * **Unified input options**
86
+
87
+ * **Unified output schema**
88
+
89
+ * **CLI and library usage**
90
+
91
+ * **Distributed options with Celery**
92
+
93
+ * **Complexity from simple tasks to complex workflows**
94
+
95
+ * **Customizable**
96
+
97
+ ## Supported commands
98
+
99
+ `secator` integrates the following commands:
100
+
101
+ | Name | Description | Category |
102
+ |---------------------------------------------------------------|--------------------------------------------------------------------------------|----------------|
103
+ | [httpx](https://github.com/projectdiscovery/httpx) | Fast HTTP prober. | `http` |
104
+ | [cariddi](https://github.com/edoardottt/cariddi) | Fast crawler and endpoint secrets / api keys / tokens matcher. | `http/crawler` |
105
+ | [gau](https://github.com/lc/gau) | Offline URL crawler (Alien Vault, The Wayback Machine, Common Crawl, URLScan). | `http/crawler` |
106
+ | [gospider](https://github.com/jaeles-project/gospider) | Fast web spider written in Go. | `http/crawler` |
107
+ | [katana](https://github.com/projectdiscovery/katana) | Next-generation crawling and spidering framework. | `http/crawler` |
108
+ | [dirsearch](https://github.com/maurosoria/dirsearch) | Web path discovery. | `http/fuzzer` |
109
+ | [feroxbuster](https://github.com/epi052/feroxbuster) | Simple, fast, recursive content discovery tool written in Rust. | `http/fuzzer` |
110
+ | [ffuf](https://github.com/ffuf/ffuf) | Fast web fuzzer written in Go. | `http/fuzzer` |
111
+ | [h8mail](https://github.com/khast3x/h8mail) | Email OSINT and breach hunting tool. | `osint` |
112
+ | [dnsx](https://github.com/projectdiscovery/dnsx) | Fast and multi-purpose DNS toolkit designed for running DNS queries. | `recon/dns` |
113
+ | [dnsxbrute](https://github.com/projectdiscovery/dnsx) | Fast and multi-purpose DNS toolkit designed for running DNS queries (bruteforce mode). | `recon/dns` |
114
+ | [subfinder](https://github.com/projectdiscovery/subfinder) | Fast subdomain finder. | `recon/dns` |
115
+ | [fping](https://fping.org/) | Find alive hosts on local networks. | `recon/ip` |
116
+ | [mapcidr](https://github.com/projectdiscovery/mapcidr) | Expand CIDR ranges into IPs. | `recon/ip` |
117
+ | [naabu](https://github.com/projectdiscovery/naabu) | Fast port discovery tool. | `recon/port` |
118
+ | [maigret](https://github.com/soxoj/maigret) | Hunt for user accounts across many websites. | `recon/user` |
119
+ | [gf](https://github.com/tomnomnom/gf) | A wrapper around grep to avoid typing common patterns. | `tagger` |
120
+ | [grype](https://github.com/anchore/grype) | A vulnerability scanner for container images and filesystems. | `vuln/code` |
121
+ | [dalfox](https://github.com/hahwul/dalfox) | Powerful XSS scanning tool and parameter analyzer. | `vuln/http` |
122
+ | [msfconsole](https://docs.rapid7.com/metasploit/msf-overview) | CLI to access and work with the Metasploit Framework. | `vuln/http` |
123
+ | [wpscan](https://github.com/wpscanteam/wpscan) | WordPress Security Scanner | `vuln/multi` |
124
+ | [nmap](https://github.com/nmap/nmap) | Vulnerability scanner using NSE scripts. | `vuln/multi` |
125
+ | [nuclei](https://github.com/projectdiscovery/nuclei) | Fast and customisable vulnerability scanner based on simple YAML based DSL. | `vuln/multi` |
126
+ | [searchsploit](https://gitlab.com/exploit-database/exploitdb) | Exploit searcher. | `exploit/search` |
127
+
128
+ Feel free to request new commands to be added by opening an issue, but please
129
+ check that the command complies with our selection criterias before doing so. If it doesn't but you still want to integrate it into `secator`, you can plug it in (see the [dev guide](https://docs.freelabz.com/for-developers/writing-custom-tasks)).
130
+
131
+
132
+ ## Install Secator
133
+
134
+ Secator requires **python >= 3.8** to install successfully. Run the following command to install the latest version:
135
+
136
+ ```sh
137
+ pip3 install git+https://github.com/freelabz/secator.git
138
+ ```
139
+
140
+ <details>
141
+ <summary>Bash one-liner</summary>
142
+
143
+ git clone https://github.com/freelabz/secator && sh ./scripts/install.sh
144
+
145
+ </details>
146
+
147
+ <details>
148
+ <summary>Docker</summary>
149
+
150
+ docker build -t secator
151
+
152
+ </details>
153
+
154
+ <details>
155
+ <summary>Development build</summary>
156
+
157
+ git clone https://github.com/freelabz/secator
158
+ cd secator
159
+ python3 -m virtualenv -p python3 ~/.virtualenvs/secator
160
+ source ~/.virtualenvs/secator/bin/activate
161
+ pip3 install -e .
162
+
163
+ </details>
164
+
165
+
166
+ ### Install specific tasks
167
+
168
+ ```sh
169
+ secator u install <TASK_NAME>
170
+ ```
171
+
172
+ ## Usage
173
+ ```sh
174
+ secator --help
175
+ ```
176
+ ![](images/help.png)
177
+
178
+
179
+ ### Running secator
180
+
181
+ Run a fuzzing task (`ffuf`):
182
+
183
+ ```sh
184
+ secator x ffuf http://testphp.vulnweb.com/FUZZ
185
+ ```
186
+
187
+ Run a port scan:
188
+
189
+ ```sh
190
+ secator w port_scan mydomain.com
191
+ ```
192
+
193
+ Run a full host scan:
194
+
195
+ ```sh
196
+ secator s host mydomain.com
197
+ ```
198
+
199
+ For more, read the complete [documentation](https://docs.freelabz.com).
@@ -0,0 +1,149 @@
1
+ <h1 align="center">
2
+ secator
3
+ <br>
4
+ </h1>
5
+
6
+ <h4 align="center">Security swiss-knife to speed up vulnerability assessments.</h4>
7
+
8
+ <p align="center">
9
+ <!-- <a href="https://goreportcard.com/report/github.com/freelabz/secator"><img src="https://goreportcard.com/badge/github.com/freelabz/secator"></a> -->
10
+ <a href="https://github.com/freelabz/secator/issues"><img src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat"></a>
11
+ <a href="https://github.com/freelabz/secator/releases"><img src="https://img.shields.io/github/release/freelabz/secator"></a>
12
+ <a href="https://www.apache.org/licenses/LICENSE-2.0"><img src="https://img.shields.io/badge/License-Apache-blue.svg"></a>
13
+ <a href="https://twitter.com/freelabz"><img src="https://img.shields.io/twitter/follow/freelabz.svg?logo=twitter"></a>
14
+ <!-- <a href="https://discord.gg/freelabz"><img src="https://img.shields.io/discord/695645237418131507.svg?logo=discord"></a> -->
15
+ </p>
16
+
17
+
18
+ <p align="center">
19
+ <a href="#features">Features</a> •
20
+ <a href="#supported-commands">Supported commands</a> •
21
+ <a href="#install-secator">Installation</a> •
22
+ <a href="#usage">Usage</a> •
23
+ <a href="https://docs.freelabz.com">Documentation</a>
24
+ </p>
25
+
26
+ `secator` is a task and workflow runner used for security assessments. It supports dozens of well-known security tools
27
+ and it is designed to improve productivity for pentesters and security researchers.
28
+
29
+ # Features
30
+
31
+ ![](images/short_demo.gif)
32
+
33
+ * **Curated list of commands**
34
+
35
+ * **Unified input options**
36
+
37
+ * **Unified output schema**
38
+
39
+ * **CLI and library usage**
40
+
41
+ * **Distributed options with Celery**
42
+
43
+ * **Complexity from simple tasks to complex workflows**
44
+
45
+ * **Customizable**
46
+
47
+ ## Supported commands
48
+
49
+ `secator` integrates the following commands:
50
+
51
+ | Name | Description | Category |
52
+ |---------------------------------------------------------------|--------------------------------------------------------------------------------|----------------|
53
+ | [httpx](https://github.com/projectdiscovery/httpx) | Fast HTTP prober. | `http` |
54
+ | [cariddi](https://github.com/edoardottt/cariddi) | Fast crawler and endpoint secrets / api keys / tokens matcher. | `http/crawler` |
55
+ | [gau](https://github.com/lc/gau) | Offline URL crawler (Alien Vault, The Wayback Machine, Common Crawl, URLScan). | `http/crawler` |
56
+ | [gospider](https://github.com/jaeles-project/gospider) | Fast web spider written in Go. | `http/crawler` |
57
+ | [katana](https://github.com/projectdiscovery/katana) | Next-generation crawling and spidering framework. | `http/crawler` |
58
+ | [dirsearch](https://github.com/maurosoria/dirsearch) | Web path discovery. | `http/fuzzer` |
59
+ | [feroxbuster](https://github.com/epi052/feroxbuster) | Simple, fast, recursive content discovery tool written in Rust. | `http/fuzzer` |
60
+ | [ffuf](https://github.com/ffuf/ffuf) | Fast web fuzzer written in Go. | `http/fuzzer` |
61
+ | [h8mail](https://github.com/khast3x/h8mail) | Email OSINT and breach hunting tool. | `osint` |
62
+ | [dnsx](https://github.com/projectdiscovery/dnsx) | Fast and multi-purpose DNS toolkit designed for running DNS queries. | `recon/dns` |
63
+ | [dnsxbrute](https://github.com/projectdiscovery/dnsx) | Fast and multi-purpose DNS toolkit designed for running DNS queries (bruteforce mode). | `recon/dns` |
64
+ | [subfinder](https://github.com/projectdiscovery/subfinder) | Fast subdomain finder. | `recon/dns` |
65
+ | [fping](https://fping.org/) | Find alive hosts on local networks. | `recon/ip` |
66
+ | [mapcidr](https://github.com/projectdiscovery/mapcidr) | Expand CIDR ranges into IPs. | `recon/ip` |
67
+ | [naabu](https://github.com/projectdiscovery/naabu) | Fast port discovery tool. | `recon/port` |
68
+ | [maigret](https://github.com/soxoj/maigret) | Hunt for user accounts across many websites. | `recon/user` |
69
+ | [gf](https://github.com/tomnomnom/gf) | A wrapper around grep to avoid typing common patterns. | `tagger` |
70
+ | [grype](https://github.com/anchore/grype) | A vulnerability scanner for container images and filesystems. | `vuln/code` |
71
+ | [dalfox](https://github.com/hahwul/dalfox) | Powerful XSS scanning tool and parameter analyzer. | `vuln/http` |
72
+ | [msfconsole](https://docs.rapid7.com/metasploit/msf-overview) | CLI to access and work with the Metasploit Framework. | `vuln/http` |
73
+ | [wpscan](https://github.com/wpscanteam/wpscan) | WordPress Security Scanner | `vuln/multi` |
74
+ | [nmap](https://github.com/nmap/nmap) | Vulnerability scanner using NSE scripts. | `vuln/multi` |
75
+ | [nuclei](https://github.com/projectdiscovery/nuclei) | Fast and customisable vulnerability scanner based on simple YAML based DSL. | `vuln/multi` |
76
+ | [searchsploit](https://gitlab.com/exploit-database/exploitdb) | Exploit searcher. | `exploit/search` |
77
+
78
+ Feel free to request new commands to be added by opening an issue, but please
79
+ check that the command complies with our selection criterias before doing so. If it doesn't but you still want to integrate it into `secator`, you can plug it in (see the [dev guide](https://docs.freelabz.com/for-developers/writing-custom-tasks)).
80
+
81
+
82
+ ## Install Secator
83
+
84
+ Secator requires **python >= 3.8** to install successfully. Run the following command to install the latest version:
85
+
86
+ ```sh
87
+ pip3 install git+https://github.com/freelabz/secator.git
88
+ ```
89
+
90
+ <details>
91
+ <summary>Bash one-liner</summary>
92
+
93
+ git clone https://github.com/freelabz/secator && sh ./scripts/install.sh
94
+
95
+ </details>
96
+
97
+ <details>
98
+ <summary>Docker</summary>
99
+
100
+ docker build -t secator
101
+
102
+ </details>
103
+
104
+ <details>
105
+ <summary>Development build</summary>
106
+
107
+ git clone https://github.com/freelabz/secator
108
+ cd secator
109
+ python3 -m virtualenv -p python3 ~/.virtualenvs/secator
110
+ source ~/.virtualenvs/secator/bin/activate
111
+ pip3 install -e .
112
+
113
+ </details>
114
+
115
+
116
+ ### Install specific tasks
117
+
118
+ ```sh
119
+ secator u install <TASK_NAME>
120
+ ```
121
+
122
+ ## Usage
123
+ ```sh
124
+ secator --help
125
+ ```
126
+ ![](images/help.png)
127
+
128
+
129
+ ### Running secator
130
+
131
+ Run a fuzzing task (`ffuf`):
132
+
133
+ ```sh
134
+ secator x ffuf http://testphp.vulnweb.com/FUZZ
135
+ ```
136
+
137
+ Run a port scan:
138
+
139
+ ```sh
140
+ secator w port_scan mydomain.com
141
+ ```
142
+
143
+ Run a full host scan:
144
+
145
+ ```sh
146
+ secator s host mydomain.com
147
+ ```
148
+
149
+ For more, read the complete [documentation](https://docs.freelabz.com).
File without changes