Features • Supported commands • Installation • Usage • Documentation
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.
-
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
secator integrates the following tools:
| Name | Description | Category |
|---|---|---|
| httpx | Fast HTTP prober. | http |
| cariddi | Fast crawler and endpoint secrets / api keys / tokens matcher. | http/crawler |
| gau | Offline URL crawler (Alien Vault, The Wayback Machine, Common Crawl, URLScan). | http/crawler |
| gospider | Fast web spider written in Go. | http/crawler |
| katana | Next-generation crawling and spidering framework. | http/crawler |
| dirsearch | Web path discovery. | http/fuzzer |
| feroxbuster | Simple, fast, recursive content discovery tool written in Rust. | http/fuzzer |
| ffuf | Fast web fuzzer written in Go. | http/fuzzer |
| h8mail | Email OSINT and breach hunting tool. | osint |
| dnsx | Fast and multi-purpose DNS toolkit designed for running DNS queries. | recon/dns |
| dnsxbrute | Fast and multi-purpose DNS toolkit designed for running DNS queries (bruteforce mode). | recon/dns |
| subfinder | Fast subdomain finder. | recon/dns |
| fping | Find alive hosts on local networks. | recon/ip |
| mapcidr | Expand CIDR ranges into IPs. | recon/ip |
| naabu | Fast port discovery tool. | recon/port |
| maigret | Hunt for user accounts across many websites. | recon/user |
| gf | A wrapper around grep to avoid typing common patterns. | tagger |
| grype | A vulnerability scanner for container images and filesystems. | vuln/code |
| dalfox | Powerful XSS scanning tool and parameter analyzer. | vuln/http |
| msfconsole | CLI to access and work with the Metasploit Framework. | vuln/http |
| wpscan | WordPress Security Scanner | vuln/multi |
| nmap | Vulnerability scanner using NSE scripts. | vuln/multi |
| nuclei | Fast and customisable vulnerability scanner based on simple YAML based DSL. | vuln/multi |
| searchsploit | Exploit searcher. | exploit/search |
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).
Pipx
pipx install secatorPip
pip install secatorBash
wget -O - https://raw.githubusercontent.com/freelabz/secator/main/scripts/install.sh | shDocker
docker run -it --rm --net=host -v ~/.secator:/root/.secator freelabz/secator --helpThe 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:
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
Docker Compose
git clone https://github.com/freelabz/secator
cd secator
docker-compose up -d
docker-compose exec secator secator --helpNote: If you chose the Bash, Docker or Docker Compose installation methods, you can skip the next sections and go straight to Usage.
secator uses external tools, so you might need to install languages used by those tools assuming they are not already installed on your system.
We provide utilities to install required languages if you don't manage them externally:
Go
secator install langs goRuby
secator install langs rubysecator does not install any of the external tools it supports by default.
We provide utilities to install or update each supported tool which should work on all systems supporting apt:
All tools
secator install toolsSpecific tools
secator install tools <TOOL_NAME>For instance, to install httpx, use:
secator install tools httpxPlease make sure you are using the latest available versions for each tool before you run secator or you might run into parsing / formatting issues.
secator comes installed with the minimum amount of dependencies.
There are several addons available for secator:
worker
Add support for Celery workers (see Distributed runs with Celery).
secator install addons workerAdd support for Google Drive exporter (-o gdrive).
secator install addons googlemongodb
Add support for MongoDB driver (-driver mongodb).
secator install addons mongodbredis
Add support for Redis backend (Celery).
secator install addons redisdev
Add development tools like coverage and flake8 required for running tests.
secator install addons devtrace
Add tracing tools like memray and pyinstrument required for tracing functions.
secator install addons tracebuild
Add hatch for building and publishing the PyPI package.
secator install addons buildsecator makes remote API calls to https://cve.circl.lu/ to get in-depth information about the CVEs it encounters.
We provide a subcommand to download all known CVEs locally so that future lookups are made from disk instead:
secator install cvesTo figure out which languages or tools are installed on your system (along with their version):
secator healthsecator --help
Run a fuzzing task (ffuf):
secator x ffuf http://testphp.vulnweb.com/FUZZRun a url crawl workflow:
secator w url_crawl http://testphp.vulnweb.comRun a host scan:
secator s host mydomain.comand more... to list all tasks / workflows / scans that you can use:
secator x --help
secator w --help
secator s --helpTo go deeper with secator, check out:
- Our complete documentation
- Our getting started tutorial video
- Our Medium post
- Follow us on social media: @freelabz on Twitter and @FreeLabz on YouTube
