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
Shell bug-bountybugbountybugbounty-tooldnshackingnucleiosintpenetration-testingpentestpentest-toolpentestingreconreconnaissancescannersecuritysecurity-toolssubdomainsubdomain-enumerationvulnerabilities
Update README.md
six2dez1335ff6cb87b
diff --git a/README.md b/README.mdindex 3ab144b..7faf55f 100644--- a/README.md+++ b/README.md@@ -5,9 +5,9 @@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.4.2"><img src="https://img.shields.io/badge/release-v1.4.2-green">@@ -32,9 +32,12 @@<img alt="Docker Cloud Build Status" src="https://img.shields.io/docker/cloud/build/six2dez/reconftw"></a></p>-++📔 Table of Contents+------------------ [Summary](#summary)-- [Install](#install)+- [Installation](#-installation)+- [Config file](#-config-file)- [Usage](#usage)- [Running reconFTW](#running-reconftw)- [Sample Video](#sample-video)@@ -44,65 +47,68 @@- [Need help?](#need-help)- [Contribute](#how-to-contribute)- [Thanks](#thanks)-+# Summary-+reconFTW is a tool designed to perform automated recon on a target domain by running the best set of tools to perform enumeration and finding out vulnerabilities.--# Install-++---++# 💿 Installation+## a) In your PC/VPS/VM--- [Installation Guide](https://github.com/six2dez/reconftw/wiki) :book:-- Requires [Golang](https://golang.org/dl/) > 1.14 installed and paths correctly set (**$GOPATH**, **$GOROOT**)-++> You can check out our wiki for installtion 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)--### From [DockerHub](https://hub.docker.com/r/six2dez/reconftw)-++## 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 this 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```--### From repository-++### 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-- Through ```reconftw.config``` 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-+++# ⚙️ 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>Click here to view default config file</summary>+ <summary> :point_right: Click here to view default config file :point_left: </summary>```yaml#################################################################-# reconFTW config file #+# reconFTW config file ##################################################################--# TERM COLOURS++# TERM COLORSbred='\033[1;31m'bblue='\033[1;34m'bgreen='\033[1;32m'@@ -111,76 +117,82 @@ red='\033[0;31m'blue='\033[0;34m'green='\033[0;32m'reset='\033[0m'-+# General valuestools=~/Tools-NPROC=$(nproc || echo -n 1)SCRIPTPATH="$( cd "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )"profile_shell=".$(basename $(echo $SHELL))rc"+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/goexport GOPATH=$HOME/goexport 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 defineAMASS_CONFIG=~/.config/amass/config.iniGITHUB_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=i0m1y4j3fu.canarytokens.com-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+# File descriptorsDEBUG_STD="&>/dev/null"DEBUG_ERROR="2>/dev/null"-+# Osint+OSINT=trueGOOGLE_DORKS=true-GITHUB_DORKS=false+GITHUB_DORKS=trueMETADATA=trueEMAILS=trueDOMAIN_INFO=true-+# SubdomainsSUBCRT=trueSUBBRUTE=trueSUBSCRAPING=trueSUBPERMUTE=trueSUBTAKEOVER=true+SUBRECURSIVE=trueZONETRANSFER=trueS3BUCKETS=true-+# Web detectionWEBPROBESIMPLE=trueWEBPROBEFULL=trueWEBSCREENSHOT=true-+# HostFAVICON=truePORTSCANNER=truePORTSCAN_PASSIVE=truePORTSCAN_ACTIVE=true-+CLOUD_IP=true+# Web analysisWAF_DETECTION=trueNUCLEICHECK=trueURL_CHECK=trueURL_GF=true+URL_EXT=trueJSCHECKS=truePARAMS=trueFUZZ=trueCMS_SCANNER=trueWORDLIST=true-+# VulnsXSS=trueCORS=true@@ -194,112 +206,115 @@ SQLI=trueBROKENLINKS=trueSPRAY=trueBYPASSER4XX=true-+# Extra features-NOTIFICATION=true+NOTIFICATION=falseDEEP=falseDIFF=falseREMOVETMP=false-+PROXY=false+# HTTP options-COOKIE=""HEADER="User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:72.0) Gecko/20100101 Firefox/72.0"-+# ThreadsFFUF_THREADS=40HTTPX_THREADS=50-HTTPX_UNCOMMONPORTS_THREADS=150-SHUFFLEDNS_THREADS=5000+HTTPX_UNCOMMONPORTS_THREADS=100GOSPIDER_THREADS=50GITDORKER_THREADS=5-XSSTRIKE_THREADS=30BRUTESPRAY_THREADS=20BRUTESPRAY_CONCURRENCE=10ARJUN_THREADS=20-+GAUPLUS_THREADS=10+DALFOX_THREADS=200+PUREDNS_TRUSTED_LIMIT=400+# listsfuzz_wordlist=${tools}/fuzz_wordlist.txtlfi_wordlist=${tools}/lfi_wordlist.txtsubs_wordlist=${tools}/subdomains.txtsubs_wordlist_big=${tools}/subdomains_big.txtresolvers=${tools}/resolvers.txt+resolvers_trusted=${tools}/resolvers_trusted.txt```</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)* || -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 (only recon without attacks) |-| -s | Subdomains - Search subdomains, check tko and web probe |-| -p | Passive - Performs only passive steps |-| -a | All - Perform all checks and exploitations |-| -w | Web - Just web checks from list provided |+| -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 |-| -h | Help - Show this help |-+| -h | Help - Show this help menu |+**GENERAL OPTIONS**-+| Flag | Description ||------|-------------|-| --deep | Deep scan (Enable some slow options for deeper scan) |+| --deep | Deep scan (Enable some slow options for deeper scan, _vps intented mode_) || -o | Output directory |-+## Running ReconFTW--**To perform a full recon on single target** *(may take a significant time)*-++**To perform a full recon on single target**+```bash▶ ./reconftw.sh -d example.com -r```-+**To perfrom a full recon on a list of targets**-+```bash▶ ./reconftw.sh -l sites.txt -r -o /output/directory/```--**Perform all steps (recon + attacks)**-++**Perform all steps (whole recon + all attacks)**+```bash▶ ./reconftw.sh -d example.com -a```--**Perform full recon with more intense tasks** *(VPS intended)*-++**Perform full recon with more time intense tasks** *(VPS intended only)*+```bash▶ ./reconftw.sh -d example.com -r --deep -o /output/directory/```-+**Perform recon in a multi domain target**-+```bash▶ ./reconftw.sh -m company -l domainsList.txt -r```-+**Show help section**-+```bash▶ ./reconftw.sh -h```-+## Sample video-+-+## :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))@@ -311,7 +326,7 @@ resolvers=${tools}/resolvers.txt- Certificate transparency ([ctfr](https://github.com/UnaPibaGeek/ctfr), [tls.bufferover](tls.bufferover.run) and [dns.bufferover](dns.bufferover.run)))- Bruteforce ([puredns](https://github.com/d3mondev/puredns))- Permutations ([DNScewl](https://github.com/codingo/DNSCewl))- - Source Code Scraping ([gospider](https://github.com/jaeles-project/gospider))+ - 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))@@ -343,25 +358,25 @@ resolvers=${tools}/resolvers.txt- Custom resolvers generated list ([dnsvalidator](https://github.com/vortexau/dnsvalidator))- DNS Zone Transfer ([dnsrecon](https://github.com/darkoperator/dnsrecon))- Docker container included and [DockerHub](https://hub.docker.com/r/six2dez/reconftw) integration-- Cloud providers check [ip2provider](https://github.com/oldrho/ip2provider)+- Cloud providers check ([ip2provider](https://github.com/oldrho/ip2provider))+- Resume the scan from last performed step- Custom output folder-- Auto installer/updater compatible with most distros+- All in one installer/updater script compatible with most distros- Diff support for continuous running (cron mode)-- Support for targets with multiple domains-- Update tools script+- Support for targets with multiple domains- RaspberryPi/ARM support- 5 modes (recon, passive, subdomains, web and all)- Out of Scope Support- Notification support for Slack, Discord and Telegram ([notify](https://github.com/projectdiscovery/notify))-+## Mindmap/Workflow-+-+## 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`@@ -369,31 +384,31 @@ 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)- 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)-+## Thanks-+For their great feedback, support, help or for nothing special but well deserved:-+- [@detonXX](https://twitter.com/detonXX)- [@Bileltechno](https://twitter.com/BilelEljaamii)- [@cyph3r_asr](https://twitter.com/cyph3r_asr)