Skip to content

reconFTW is a tool designed to perform automated recon on a target domain by running the best set of tools to perform scanning and finding out vulnerabilities

Update README.md

Jinay Patelff6a4acf9044
diff --git a/README.md b/README.md
index 1f4a207..8aa39b2 100644
--- a/README.md
+++ b/README.md
@@ -5,12 +5,10 @@
reconFTW
<br>
</h1>
-
-<h4 align="center">A simple bash script for full recon</h4>
-
+
<p align="center">
- <a href="https://github.com/six2dez/reconftw/releases/tag/v1.6.0">
- <img src="https://img.shields.io/badge/release-v1.6.0-green">
+ <a href="https://github.com/six2dez/reconftw/releases/tag/v1.6.0.2">
+ <img src="https://img.shields.io/badge/release-v1.6.0.2-green">
</a>
</a>
<a href="https://www.gnu.org/licenses/gpl-3.0.en.html">
@@ -32,86 +30,97 @@
<img alt="Docker Cloud Build Status" src="https://img.shields.io/docker/cloud/build/six2dez/reconftw">
</a>
</p>
-
+
+<h3 align="center">Summary</h3>
+
+**ReconFTW** automates the entire process of reconnaisance for you. It outperforms the work of subdomain enumeration along with various vulnerability checks and obtaining maximum information about your target.
+
+ReconFTW uses around 5 techniques(passive,bruteforce,permutations,certificate transparency,JS scraping) for subdomain enumeration which helps you getting the maximum and the most interesting subdomains so that you be ahead of the competition.
+
+
+It also performs various vulnerability checks like XSS, Open Redirects, SSRF, CRLF, LFI, SQLi, SSL tests, SSTI, DNS zone transfers, and much more. Along with these, it performs OSINT techniques, directory fuzzing, dorking, ports scanning, screenshots, nuclei scan on your target.
+
+So, what are you waiting for Go! Go! Go! :boom:
+
📔 Table of Contents
-----------------
-- [💿 Installation:](#-installation)
+- [💿 Installation](#-installation)
- [a) In your PC/VPS/VM](#a-in-your-pcvpsvm)
- [b) Docker container 🐳 (2 options)](#b-docker-container--2-options)
- [1) From DockerHub](#1-from-dockerhub)
- [2) From repository](#2-from-repository)
-- [⚙️ Config file:](#️-config-file)
-- [Usage:](#usage)
-- [Example Usage:](#example-usage)
-- [Axiom Support: :cloud:](#axiom-support-cloud)
-- [Sample video:](#sample-video)
+- [⚙️ Config file](#️-config-file)
+- [Usage](#usage)
+ - [Example Usage](#example-usage)
+- [Axiom Support :cloud:](#axiom-support-cloud)
+- [Sample video](#sample-video)
- [:fire: Features :fire:](#fire-features-fire)
- [Mindmap/Workflow](#mindmapworkflow)
- [Data Keep](#data-keep)
- - [Main commands:](#main-commands)
- - [How to contribute:](#how-to-contribute)
- - [Need help?](#need-help)
- - [You can support this work buying me a coffee:](#you-can-support-this-work-buying-me-a-coffee)
+ - [Main commands](#main-commands)
+ - [How to contribute](#how-to-contribute)
+- [Need help?](#need-help)
+- [Support this project](#you-can-support-this-work-buying-me-a-coffee)
- [Thanks :pray:](#thanks-pray)
-
+
---
-
+
# 💿 Installation:
-
+
## a) In your PC/VPS/VM
-
+
> You can check out our wiki for the installation guide [Installation Guide](https://github.com/six2dez/reconftw/wiki/0.-Installation-Guide) :book:
-
+
- Requires [Golang](https://golang.org/dl/) > **1.15.0+** installed and paths correctly set (**$GOPATH**, **$GOROOT**)
-
+
```bash
▶ git clone https://github.com/six2dez/reconftw
▶ cd reconftw/
▶ ./install.sh
▶ ./reconftw.sh -d target.com -r
```
-
+
## b) Docker container 🐳 (2 options)
-
+
### 1) From [DockerHub](https://hub.docker.com/r/six2dez/reconftw)
-
+
```bash
▶ docker pull six2dez/reconftw:main
▶ docker run -it six2dez/reconftw:main /bin/bash
-
+
# Exit the container and run these commands additionally if you want to gain persistence:
-
+
▶ docker start $(docker ps -a|grep six2dez/reconftw:main|cut -d' ' -f1)
▶ docker exec -it $(docker ps -a|grep six2dez/reconftw:main|cut -d' ' -f1) /bin/bash
-
+
# Now you can exit the container and run again this command without files loss:
▶ docker exec -it $(docker ps -a|grep six2dez/reconftw:main|cut -d' ' -f1) /bin/bash
```
-
+
### 2) From repository
-
+
```bash
▶ git clone https://github.com/six2dez/reconftw
▶ cd reconftw/Docker
▶ docker build -t reconftw .
▶ docker run -it reconftw /bin/bash
```
-
+
# ⚙️ Config file:
> A detailed explaintion of config file can be found here [Configuration file](https://github.com/six2dez/reconftw/wiki/3.-Configuration-file) :book:
-
+
- Through ```reconftw.cfg``` file the whole execution of the tool can be controlled.
- Hunters can set various scanning modes, execution preferences, tools, config files, APIs/TOKENS, personalized wordlists and much more.
-
+
<details>
<br><br>
<summary> :point_right: Click here to view default config file :point_left: </summary>
-
+
```yaml
#################################################################
-# reconFTW config file #
+# reconFTW config file #
#################################################################
-
+
# TERM COLORS
bred='\033[1;31m'
bblue='\033[1;34m'
@@ -121,7 +130,7 @@ red='\033[0;31m'
blue='\033[0;34m'
green='\033[0;32m'
reset='\033[0m'
-
+
# General values
tools=~/Tools
SCRIPTPATH="$( cd "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )"
@@ -130,31 +139,33 @@ reconftw_version=$(git branch --show-current)-$(git describe --tags)
update_resolvers=true
proxy_url="http://127.0.0.1:8080/"
#dir_output=/custom/output/path
-
+
# Golang Vars (Comment or change on your own)
export GOROOT=/usr/local/go
export GOPATH=$HOME/go
export PATH=$GOPATH/bin:$GOROOT/bin:$HOME/.local/bin:$PATH
-
+
# Tools config files
#NOTIFY_CONFIG=~/.config/notify/notify.conf # No need to define
#SUBFINDER_CONFIG=~/.config/subfinder/config.yaml # No need to define
AMASS_CONFIG=~/.config/amass/config.ini
GITHUB_TOKENS=${tools}/.github_tokens
-
+
# APIs/TOKENS - Uncomment the lines you set removing the '#' at the beginning of the line
-#SHODAN_API_KEY=XXXXXXXXXXXXX
-#XSS_SERVER=six2dez.xss.ht
-#COLLAB_SERVER=XXXXXXXXXXXXXXXXX
-#findomain_virustotal_token=XXXXXXXXXXXXXXXXX
-#findomain_spyse_token=XXXXXXXXXXXXXXXXX
-#findomain_securitytrails_token=XXXXXXXXXXXXXXXXX
-#findomain_fb_token=XXXXXXXXXXXXXXXXX
-
+#SHODAN_API_KEY="XXXXXXXXXXXXX"
+#XSS_SERVER="XXXXXXXXXXXXXXXXX"
+#COLLAB_SERVER="XXXXXXXXXXXXXXXXX"
+#findomain_virustotal_token="XXXXXXXXXXXXXXXXX"
+#findomain_spyse_token="XXXXXXXXXXXXXXXXX"
+#findomain_securitytrails_token="XXXXXXXXXXXXXXXXX"
+#findomain_fb_token="XXXXXXXXXXXXXXXXX"
+slack_channel="XXXXXXXX"
+slack_auth="xoXX-XXX-XXX-XXX"
+
# File descriptors
DEBUG_STD="&>/dev/null"
DEBUG_ERROR="2>/dev/null"
-
+
# Osint
OSINT=true
GOOGLE_DORKS=true
@@ -162,7 +173,7 @@ GITHUB_DORKS=true
METADATA=true
EMAILS=true
DOMAIN_INFO=true
-
+
# Subdomains
SUBCRT=true
SUBBRUTE=true
@@ -172,20 +183,23 @@ SUBTAKEOVER=true
SUBRECURSIVE=true
ZONETRANSFER=true
S3BUCKETS=true
-
+
# Web detection
WEBPROBESIMPLE=true
WEBPROBEFULL=true
WEBSCREENSHOT=true
UNCOMMON_PORTS_WEB="81,300,591,593,832,981,1010,1311,1099,2082,2095,2096,2480,3000,3128,3333,4243,4567,4711,4712,4993,5000,5104,5108,5280,5281,5601,5800,6543,7000,7001,7396,7474,8000,8001,8008,8014,8042,8060,8069,8080,8081,8083,8088,8090,8091,8095,8118,8123,8172,8181,8222,8243,8280,8281,8333,8337,8443,8500,8834,8880,8888,8983,9000,9001,9043,9060,9080,9090,9091,9200,9443,9502,9800,9981,10000,10250,11371,12443,15672,16080,17778,18091,18092,20720,32000,55440,55672"
-
+# You can change to aquatone if gowitness fails, comment the one you don't want
+AXIOM_SCREENSHOT_MODULE=gowitness
+#AXIOM_SCREENSHOT_MODULE=aquatone
+
# Host
FAVICON=true
PORTSCANNER=true
PORTSCAN_PASSIVE=true
PORTSCAN_ACTIVE=true
CLOUD_IP=true
-
+
# Web analysis
WAF_DETECTION=true
NUCLEICHECK=true
@@ -197,7 +211,7 @@ PARAMS=true
FUZZ=true
CMS_SCANNER=true
WORDLIST=true
-
+
# Vulns
XSS=true
CORS=true
@@ -211,17 +225,18 @@ SQLI=true
BROKENLINKS=true
SPRAY=true
BYPASSER4XX=true
-
+
# Extra features
NOTIFICATION=false
DEEP=false
DIFF=false
REMOVETMP=false
PROXY=false
-
+SENDZIPNOTIFY=false
+
# HTTP options
HEADER="User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:72.0) Gecko/20100101 Firefox/72.0"
-
+
# Threads
FFUF_THREADS=40
HTTPX_THREADS=50
@@ -233,8 +248,16 @@ BRUTESPRAY_CONCURRENCE=10
ARJUN_THREADS=20
GAUPLUS_THREADS=10
DALFOX_THREADS=200
+PUREDNS_PUBLIC_LIMIT=0 # Set between 2000 - 10000 if your router blows up, 0 is unlimited
PUREDNS_TRUSTED_LIMIT=400
-
+DIRDAR_THREADS=200
+
+# Timeouts
+CMSSCAN_TIMEOUT=3600
+FFUF_MAXTIME=900 # Seconds
+HTTPX_TIMEOUT=15 # Seconds
+HTTPX_UNCOMMONPORTS_TIMEOUT=10 # Seconds
+
# lists
fuzz_wordlist=${tools}/fuzz_wordlist.txt
lfi_wordlist=${tools}/lfi_wordlist.txt
@@ -242,95 +265,109 @@ subs_wordlist=${tools}/subdomains.txt
subs_wordlist_big=${tools}/subdomains_big.txt
resolvers=${tools}/resolvers.txt
resolvers_trusted=${tools}/resolvers_trusted.txt
+
+# Axiom Fleet
+# Will not start a new fleet if one exist w/ same name and size (or larger)
+AXIOM_FLEET_LAUNCH=true
+AXIOM_FLEET_NAME="reconFTW"
+AXIOM_FLEET_COUNT=5
+AXIOM_FLEET_REGIONS=""
+AXIOM_FLEET_SHUTDOWN=true
+# This is a script on your reconftw host that might prep things your way...
+#AXIOM_POST_START="$HOME/bin/yourScript"
+
```
</details>
-
+
# Usage:
-
+
> Check out the wiki section to know which flag performs what all steps/attacks [Usage Guide](https://github.com/six2dez/reconftw/wiki/2.-Usage-Guide) :book:
-
+
**TARGET OPTIONS**
-
+
| Flag | Description |
|------|-------------|
-| -d | Target domain *(example.com)* |
+| -d | Single Target domain *(example.com)* |
+| -l | List of targets *(one per line)* |
| -m | Multiple domain target *(companyName)* |
-| -l | Target list *(one per line)* |
| -x | Exclude subdomains list *(Out Of Scope)* |
-
+
**MODE OPTIONS**
-
+
| Flag | Description |
|------|-------------|
| -r | Recon - Full recon process (without attacks like sqli,ssrf,xss,ssti,lfi etc.) |
| -s | Subdomains - Perform only subdomain enumeration, web probing, subdomain takeovers |
| -p | Passive - Perform only passive steps |
| -a | All - Perform whole recon and all active attacks |
-| -w | Web - Just web checks on the list provided |
-| -v | Verbose - Prints everything including errors, for debug purposes |
+| -w | Web - Perform only vulnerability checks/attacks on particular target |
+| -n | OSINT - Performs an OSINT scan (no subdomain enumeration and attacks) |
| -h | Help - Show this help menu |
-
+
**GENERAL OPTIONS**
-
+
| Flag | Description |
|------|-------------|
| --deep | Deep scan (Enable some slow options for deeper scan, _vps intended mode_) |
| -o | Output directory |
-
+
# Example Usage:
-
+
**To perform a full recon on single target**
-
+
```bash
▶ ./reconftw.sh -d target.com -r
```
-
+
**To perform a full recon on a list of targets**
-
+
```bash
▶ ./reconftw.sh -l sites.txt -r -o /output/directory/
```
-
+
**Perform all steps (whole recon + all attacks)**
-
+
```bash
▶ ./reconftw.sh -d target.com -a
```
-
+
**Perform full recon with more time intense tasks** *(VPS intended only)*
-
+
```bash
▶ ./reconftw.sh -d target.com -r --deep -o /output/directory/
```
-
+
**Perform recon in a multi domain target**
-
+
```bash
▶ ./reconftw.sh -m company -l domains_list.txt -r
```
-
+
**Show help section**
-
+
```bash
▶ ./reconftw.sh -h
```
-
+
# Axiom Support: :cloud:
![](https://i.ibb.co/Jzrgkqt/axiom-readme.png)
> Check out the wiki section for more info [Axiom Support](https://github.com/six2dez/reconftw/wiki/5.-Axiom-version)
-* Using ```reconftw_axiom.sh``` script you can take advantage of running **reconFTW** with [Axiom](https://github.com/pry0cc/axiom).
* As reconFTW actively hits the target with a lot of web traffic, hence there was a need to move to Axiom distributing the work load among various instances leading to reduction of execution time.
-* Currently except the ```-a``` flag, all flags are supported when running with Axiom.
+* During the configuartion of axiom you need to select `reconftw` as provisoner.
+* Using ```reconftw_axiom.sh``` script you can take advantage of running **reconFTW** with [Axiom](https://github.com/pry0cc/axiom).
+* Its also necessary that you need to create your fleet prior.
+
```bash
+▶ axiom-fleet testy -i=10 # Initialize a fleet named 'testy'
▶ ./reconftw_axiom.sh -d target.com -r
```
-
+
# Sample video:
-
+
![Video](images/reconFTW.gif)
-
+
# :fire: Features :fire:
-
+
- Domain information parser ([domainbigdata](https://domainbigdata.com/))
- Emails addresses and users ([theHarvester](https://github.com/laramies/theHarvester))
- Password leaks ([pwndb](https://github.com/davidtavarez/pwndb) and [H8mail](https://github.com/khast3x/h8mail))
@@ -345,7 +382,7 @@ resolvers_trusted=${tools}/resolvers_trusted.txt
- JS files & Source Code Scraping ([gospider](https://github.com/jaeles-project/gospider))
- CNAME Records ([dnsx](https://github.com/projectdiscovery/dnsx))
- Nuclei Sub TKO templates ([nuclei](https://github.com/projectdiscovery/nuclei))
-- Web Prober ([httpx](https://github.com/projectdiscovery/httpx))
+- Web Prober ([httpx](https://github.com/projectdiscovery/httpx) and [naabu](https://github.com/projectdiscovery/naabu))
- Web screenshot ([gowitness](https://github.com/sensepost/gowitness))
- Web templates scanner ([nuclei](https://github.com/projectdiscovery/nuclei))
- IP and subdomains WAF checker ([cf-check](https://github.com/dwisiswant0/cf-check) and [wafw00f](https://github.com/EnableSecurity/wafw00f))
@@ -353,7 +390,7 @@ resolvers_trusted=${tools}/resolvers_trusted.txt
- Url extraction ([waybackurls](https://github.com/tomnomnom/waybackurls), [gauplus](https://github.com/bp0lr/gauplus), [gospider](https://github.com/jaeles-project/gospider), [github-endpoints](https://gist.github.com/six2dez/d1d516b606557526e9a78d7dd49cacd3))
- Pattern Search ([gf](https://github.com/tomnomnom/gf) and [gf-patterns](https://github.com/1ndianl33t/Gf-Patterns))
- Param discovery ([paramspider](https://github.com/devanshbatham/ParamSpider) and [arjun](https://github.com/s0md3v/Arjun))
-- XSS ([XSStrike](https://github.com/s0md3v/XSStrike))
+- XSS ([dalfox](https://github.com/hahwul/dalfox))
- Open redirect ([Openredirex](https://github.com/devanshbatham/OpenRedireX))
- SSRF (headers [asyncio_ssrf.py](https://gist.github.com/h4ms1k/adcc340495d418fcd72ec727a116fea2) and param values with [ffuf](https://github.com/ffuf/ffuf))
- CRLF ([crlfuzz](https://github.com/dwisiswant0/crlfuzz))
@@ -376,23 +413,24 @@ resolvers_trusted=${tools}/resolvers_trusted.txt
- Docker container included and [DockerHub](https://hub.docker.com/r/six2dez/reconftw) integration
- Cloud providers check ([ip2provider](https://github.com/oldrho/ip2provider))
- Resume the scan from last performed step
-- Custom output folder
+- Custom output folder option
- All in one installer/updater script compatible with most distros
- Diff support for continuous running (cron mode)
- Support for targets with multiple domains
- RaspberryPi/ARM support
-- 5 modes (recon, passive, subdomains, web and all)
+- Send scan results zipped over Slack, Discord and Telegram
+- 6 modes (recon, passive, subdomains, web, osint and all)
- Out of Scope Support
- Notification support for Slack, Discord and Telegram ([notify](https://github.com/projectdiscovery/notify))
-
+
# Mindmap/Workflow
-
+
![Mindmap](images/mindmap_0321.png)
-
+
## Data Keep
-
+
Follow these simple steps to end up having a private repository with your `API Keys` and `/Recon` data.
-
+
* Create a private __blank__ repository on `Git(Hub|Lab)` (Take into account size limits regarding Recon data upload)
* Clone your project: `git clone https://gitlab.com/example/reconftw-data`
* Get inside the cloned repository: `cd reconftw-data`
@@ -400,30 +438,37 @@ Follow these simple steps to end up having a private repository with your `API K
* Add official repo as a new remote: `git remote add upstream https://github.com/six2dez/reconftw` (`upstream` is an example)
* Update upstream's repo: `git fetch upstream`
* Rebase current branch with the official one: `git rebase upstream/main master`
-
+
### Main commands:
-
+
* Upload changes to your personal repo: `git add . && git commit -m "Data upload" && git push origin master`
* Update tool anytime: `git fetch upstream && git rebase upstream/main master`
-
+
## How to contribute:
-
+
If you want to contribute to this project you can do it in multiple ways:
- Submitting an [issue](https://github.com/six2dez/reconftw/issues/new/choose) because you have found a bug or you have any suggestion or request.
- Making a Pull Request from [dev](https://github.com/six2dez/reconftw/tree/dev) branch because you want to improve the code or add something to the script.
-
-## Need help?
-
-- Take a look in the [wiki](https://github.com/six2dez/reconftw/wiki)
+
+## Need help? :information_source:
+
+- Take a look at the [wiki](https://github.com/six2dez/reconftw/wiki) section.
+- Check [FAQ](https://github.com/six2dez/reconftw/wiki/7.-FAQs) for commonly asked questions.
- Ask for help in the [Telegram group](https://t.me/joinchat/TO_R8NYFhhbmI5co)
-
+
## You can support this work buying me a coffee:
-
+
[<img src="https://cdn.buymeacoffee.com/buttons/v2/default-green.png">](https://www.buymeacoffee.com/six2dez)
-
+
+# Sponsors ❤️
+**This section shows the current financial sponsors of this project**
+
+
+[<img src="https://pbs.twimg.com/profile_images/1360304248534282240/MomOFi40_400x400.jpg" width="100" height=auto>](https://github.com/0xtavian)
+
# Thanks :pray:
* Thank you for lending a helping hand towards the development of the project!
-
+
- [Spyse](https://spyse.com/)
- [Networksdb](https://networksdb.io/)
- [Intelx](https://intelx.io/)