secator 0.25.7
The pentester's swiss knife.
Requires Python: >=3.8
Keywords: automation, cybersecurity, pentest, recon, vulnerability

<h1 align="center">
    <img src="https://github.com/freelabz/secator/assets/9629314/ee203af4-e853-439a-af01-edeabfc4bf07/" width="400">
</h1>

<h4 align="center">The pentester's swiss knife.</h4>

<p align="center">
<!-- <a href="https://goreportcard.com/report/github.com/freelabz/secator"><img src="https://goreportcard.com/badge/github.com/freelabz/secator"></a> -->
<img src="https://img.shields.io/badge/python-3.6-blue.svg">
<a href="https://github.com/freelabz/secator/releases"><img src="https://img.shields.io/github/release/freelabz/secator"></a>
<a href="https://github.com/freelabz/secator/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-BSL%201.1-brightgreen.svg"></a>
<a href="https://pypi.org/project/secator/"><img src="https://img.shields.io/pypi/dm/secator"></a>
<a href="https://twitter.com/freelabz"><img src="https://img.shields.io/twitter/follow/freelabz.svg?logo=twitter"></a>
<a href="https://youtube.com/@FreeLabz"><img src="https://img.shields.io/youtube/channel/subscribers/UCu-F6SpU0h2NP18zBBP04cw?style=social&label=Subscribe%20%40FreeLabz"></a>
<a href="https://discord.gg/nyHjC2aTrq"><img src="https://img.shields.io/discord/695645237418131507.svg?logo=discord"></a>
</p>


<p align="center">
  <a href="#features">Features</a> •
  <a href="#supported-commands">Supported commands</a> •
  <a href="#install-secator">Installation</a> •
  <a href="#usage">Usage</a> •
  <a href="https://docs.freelabz.com">Documentation</a>  •
  <a href="https://discord.gg/nyHjC2aTrq">Join us on Discord !</a>
</p>

`secator` is a task and workflow runner used for security assessments. It supports dozens of well-known security tools
and it is designed to improve productivity for pentesters and security researchers.

# Features

![](images/demo.gif)

* **Curated list of commands**

* **Unified input options**

* **Unified output schema**

* **CLI and library usage**

* **Distributed options with Celery**

* **Complexity from simple tasks to complex workflows**

* **Customizable**


## Supported tools

`secator` integrates the following tools:

<!-- START_TOOLS_TABLE -->
| Name                                                            | Description                                                                      | Category          |
|-----------------------------------------------------------------|----------------------------------------------------------------------------------|-------------------|
| [arjun](https://github.com/s0md3v/Arjun)                                                           | HTTP Parameter Discovery Suite.                                                  | `url/fuzz/params` |
| arp                                                             | Display the system ARP cache.                                                    | `ip/recon`        |
| [arpscan](https://github.com/royhills/arp-scan)                                                         | Scan a CIDR range for alive hosts using ARP.                                     | `ip/recon`        |
| [bbot](https://github.com/blacklanternsecurity/bbot)                                                            | Multipurpose scanner.                                                            | `vuln/scan`       |
| [bup](https://github.com/laluka/bypass-url-parser)                                                             | 40X bypasser.                                                                    | `url/bypass`      |
| [cariddi](https://github.com/edoardottt/cariddi)                                                         | Crawl endpoints, secrets, api keys, extensions, tokens...                        | `url/crawl`       |
| [dalfox](https://github.com/hahwul/dalfox)                                                          | Powerful open source XSS scanning tool.                                          | `url/fuzz`        |
| [dirsearch](https://github.com/maurosoria/dirsearch)                                                       | Advanced web path brute-forcer.                                                  | `url/fuzz`        |
| [dnsx](https://github.com/projectdiscovery/dnsx)                                                            | dnsx is a fast and multi-purpose DNS toolkit designed for running various retryabledns library. | `dns/fuzz`        |
| [feroxbuster](https://github.com/epi052/feroxbuster)                                                     | Simple, fast, recursive content discovery tool written in Rust                   | `url/fuzz`        |
| [ffuf](https://github.com/ffuf/ffuf)                                                            | Fast web fuzzer written in Go.                                                   | `url/fuzz`        |
| [fping](https://github.com/schweikert/fping)                                                           | Send ICMP echo probes to network hosts, similar to ping, but much better.        | `ip/recon`        |
| [gau](https://github.com/lc/gau)                                                             | Fetch known URLs from AlienVault's Open Threat Exchange, the Wayback Machine, Common Crawl, and URLScan. | `pattern/scan`    |
| [getasn](https://github.com/Vulnpire/getasn)                                                          | Get ASN information from IP address.                                             | `ip/probe`        |
| [gf](https://github.com/tomnomnom/gf)                                                              | Wrapper around grep, to help you grep for things.                                | `pattern/scan`    |
| [gitleaks](https://github.com/gitleaks/gitleaks)                                                        | Tool for detecting secrets like passwords, API keys, and tokens in git repos, files, and stdin. | `secret/scan`     |
| [gospider](https://github.com/jaeles-project/gospider)                                                        | Fast web spider written in Go.                                                   | `url/crawl`       |
| [grype](https://github.com/anchore/grype)                                                           | Vulnerability scanner for container images and filesystems.                      | `vuln/scan`       |
| [h8mail](https://github.com/khast3x/h8mail)                                                          | Email information and password lookup tool.                                      | `user/recon/email` |
| [httpx](https://github.com/projectdiscovery/httpx)                                                           | Fast and multi-purpose HTTP toolkit.                                             | `url/probe`       |
| [jswhois](https://github.com/jschauma/jswhois)                                                         | WHOIS in JSON format                                                             | `domain/info`     |
| [katana](https://github.com/projectdiscovery/katana)                                                          | Next-generation crawling and spidering framework.                                | `url/crawl`       |
| [maigret](https://github.com/soxoj/maigret)                                                         | Collect a dossier on a person by username.                                       | `user/recon/username` |
| [mapcidr](https://github.com/projectdiscovery/mapcidr)                                                         | Utility program to perform multiple operations for a given subnet/cidr ranges.   | `ip/recon`        |
| [msfconsole](https://docs.rapid7.com/metasploit/msf-overview/)                                                      | CLI to access and work with the Metasploit Framework.                            | `exploit/attack`  |
| [naabu](https://github.com/projectdiscovery/naabu)                                                           | Port scanning tool written in Go.                                                | `port/scan`       |
| [nmap](https://github.com/nmap/nmap)                                                            | Network Mapper is a free and open source utility for network discovery and security auditing. | `port/scan`       |
| [nuclei](https://github.com/projectdiscovery/nuclei)                                                          | Fast and customisable vulnerability scanner based on simple YAML based DSL.      | `vuln/scan`       |
| [search_vulns](https://github.com/ra1nb0rn/search_vulns)                                                    | Search for known vulnerabilities in software by product name or CPE.             | `vuln/recon`      |
| [searchsploit](https://gitlab.com/exploit-database/exploitdb)                                                    | Exploit searcher based on ExploitDB.                                             | `exploit/recon`   |
| [sshaudit](https://github.com/jtesta/ssh-audit)                                                        | SSH server & client security auditing (banner, key exchange, encryption, mac, compression, etc). | `ssh/audit/security` |
| [subfinder](https://github.com/projectdiscovery/subfinder)                                                       | Fast passive subdomain enumeration tool.                                         | `dns/recon`       |
| [testssl](https://github.com/testssl/testssl.sh)                                                         | SSL/TLS security scanner, including ciphers, protocols and cryptographic flaws.  | `dns/recon/tls`   |
| [trivy](https://github.com/aquasecurity/trivy)                                                           | Comprehensive and versatile security scanner.                                    | `vuln/scan`       |
| [trufflehog](https://github.com/trufflesecurity/trufflehog)                                                      | Tool for finding secrets in git repositories and filesystems using TruffleHog.   | `secret/scan`     |
| [urlfinder](https://github.com/projectdiscovery/urlfinder)                                                       | Find URLs in text.                                                               | `pattern/scan`    |
| [wafw00f](https://github.com/EnableSecurity/wafw00f)                                                         | Web Application Firewall Fingerprinting tool.                                    | `waf/scan`        |
| [whois](https://github.com/mboot-github/WhoisDomain)                                                           | The whois tool retrieves registration information about domain names and IP addresses. |                   |
| [wpprobe](https://github.com/Chocapikk/wpprobe)                                                         | Fast wordpress plugin enumeration tool.                                          | `vuln/scan/wordpress` |
| [wpscan](https://github.com/wpscanteam/wpscan)                                                          | Wordpress security scanner.                                                      | `vuln/scan/wordpress` |
| [x8](https://github.com/Sh1Yo/x8)                                                              | Hidden parameters discovery suite written in Rust.                               | `url/fuzz/params` |
| [xurlfind3r](https://github.com/hueristiq/xurlfind3r)                                                      | Discover URLs for a given domain in a simple, passive and efficient way          | `url/recon`       |
<!-- END_TOOLS_TABLE -->

Feel free to request new tools to be added by opening an issue, but please 
check that the tool 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)).

## Installing secator

<details>
  <summary>Bash</summary>

```sh
bash -c "$(curl -fsSL https://raw.githubusercontent.com/freelabz/secator/main/scripts/install_universal.sh)"
```
</details>

<details>
    <summary>Pipx</summary>

```sh
pipx install secator
```
***Note:** Make sure to have [pipx](https://pipx.pypa.io/stable/installation/) installed.*

</details>

<details>
    <summary>Pip</summary>

```sh
pip install secator
```

</details>

<details>
    <summary>Docker</summary>

```sh
docker run -it --rm --net=host -v ~/.secator:/root/.secator freelabz/secator --help
```

The volume mount -v is necessary to save all secator reports to your host machine, and--net=host is recommended to grant full access to the host network.

You can alias this command to run it easier:
```sh
alias secator="docker run -it --rm --net=host -v ~/.secator:/root/.secator freelabz/secator"
```

Now you can run secator like if it was installed on baremetal:
```
secator --help
```

</details>

<details>
    <summary>Docker Compose</summary>

```sh
git clone https://github.com/freelabz/secator
cd secator
docker-compose up -d
docker-compose exec secator-client secator --help
```

</details>

***Note:*** If you chose the Docker or Docker Compose installation methods, you can skip the next sections and go straight to [Usage](#usage).


## Usage
```sh
secator --help
```
![](images/help.png)


### Usage examples

To get a complete cheatsheet of what you can do with `secator`, please read the output of:
```sh
secator cheatsheet
```

Run a fuzzing task (`ffuf`):

```sh
secator x ffuf http://testphp.vulnweb.com/FUZZ
```

Run a url crawl workflow:

```sh
secator w url_crawl http://testphp.vulnweb.com
```

Run a host scan:

```sh
secator s host mydomain.com
```

To list all tasks / workflows / scans that you can use:
```sh
secator x --help
secator w --help
secator s --help
```

To figure out which languages or tools are installed on your system (along with their version):
```sh
secator health
```

### Shell completion

`secator` supports shell completion for bash, zsh, and fish. This provides auto-completion for:
- Task names (e.g., `nmap`, `httpx`, `nuclei`)
- Workflow names (e.g., `url_crawl`, `subdomain_recon`)
- Scan names (e.g., `host`, `domain`, `network`)
- CLI options like `--profiles`, `--workspace`, `--driver`, `--output`

To install shell completion:

**Bash:**
```sh
secator util completion --shell bash --install
source ~/.bashrc
```

**Zsh:**
```sh
secator util completion --shell zsh --install
source ~/.zshrc
```

**Fish:**
```sh
secator util completion --shell fish --install
```

After installation, you can use tab completion:
```sh
secator task n<TAB>     # completes to nmap, naabu, nuclei, etc.
secator w url_<TAB>     # completes to url_crawl, url_fuzz, url_dirsearch, etc.
secator x nmap --profiles ag<TAB>  # completes to aggressive
```

## Installing tools

`secator` auto-installs tools when you first use them.
You can prevent this behavior by setting `security.autoinstall_commands` to `false` using either `secator config set security.autoinstall_commands false` or `SECATOR_SECURITY_AUTOINSTALL_COMMANDS=0`.

To install all tools, you can still run:
```sh
secator install tools
```

## Installing addons
Addons are available for `secator`, please check [our docs](https://docs.freelabz.com/getting-started/installation#installing-addons-optional) for details.

For instance, using the `mongodb` addon allows you to send runner results to MongoDB.

## Learn more

To go deeper with `secator`, check out:
* Our complete [documentation](https://docs.freelabz.com)
* Our getting started [tutorial video](https://youtu.be/-JmUTNWQDTQ?si=qpAClDWMXo2zwUK7)
* Our [Medium post](https://medium.com/p/09333f3d3682)
* Follow us on social media: [@freelabz](https://twitter.com/freelabz) on Twitter and [@FreeLabz](https://youtube.com/@FreeLabz) on YouTube

## Stats

<a href="https://star-history.com/#freelabz/secator&Date">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=freelabz/secator&type=Date&theme=dark" />
    <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=freelabz/secator&type=Date" />
    <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=freelabz/secator&type=Date" />
  </picture>
</a>