From 48baad462d4d940207b9a9d20d3759dacdae7b9e Mon Sep 17 00:00:00 2001 From: Ahmed Aboul-Ela Date: Fri, 24 Mar 2017 09:52:30 +0400 Subject: [PATCH] Update README.md --- README.md | 50 ++++++++++++++++++++++---------------------------- 1 file changed, 22 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 9e5d2bd..e6820a8 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,28 @@ -##About Sublist3r +## About Sublist3r -Sublist3r is python tool that is designed to enumerate subdomains of websites through various OSINT sources. It helps penetration testers and bug hunters collect and gather subdomains for the domain they are targeting. Sublist3r currenly supports many search engines such as Google, Yahoo, Bing, Baidu, and Ask. More search engines may be added in the future. Sublist3r also gathers subdomains using Netcraft, Virustotal, ThreatCrowd, DNSdumpster and PassiveDNS. +Sublist3r is python tool that is designed to enumerate subdomains of websites through OSINT. It helps penetration testers and bug hunters collect and gather subdomains for the domain they are targeting. Sublist3r enumerates subdomains using many search engines such as Google, Yahoo, Bing, Baidu, and Ask. Sublist3r also enumerates subdomains using Netcraft, Virustotal, ThreatCrowd, DNSdumpster and ReverseDNS. [subbrute](https://github.com/TheRook/subbrute) was integrated with Sublist3r to increase the possibility of finding more subdomains using bruteforce with an improved wordlist. The credit goes to TheRook who is the author of subbrute. -##Screenshots +## Screenshots ![Sublist3r](http://www.secgeek.net/images/Sublist3r.png "Sublist3r in action") -##Installation +## Installation ``` git clone https://github.com/aboul3la/Sublist3r.git ``` -##Recommended Python Version: +## Recommended Python Version: Sublist3r currently supports **Python 2** and **Python 3**. * The recommended version for Python 2 is **2.7.x** * The recommened version for Python 3 is **3.4.x** -##Dependencies: +## Dependencies: Sublist3r depends on the `requests`, `dnspython` and `argparse` python modules. @@ -30,7 +30,7 @@ These dependencies can be installed using the requirements file: - Installation on Windows: ``` -python -m pip install -r requirements.txt +c:\python27\python.exe -m pip install -r requirements.txt ``` - Installation on Linux ``` @@ -39,11 +39,11 @@ sudo pip install -r requirements.txt Alternatively, each module can be installed independently as shown below. -####Requests Module (http://docs.python-requests.org/en/latest/) +#### Requests Module (http://docs.python-requests.org/en/latest/) - Install for Windows: ``` -python -m pip install requests +c:\python27\python.exe -m pip install requests ``` - Install for Ubuntu/Debian: @@ -61,11 +61,11 @@ sudo yum install python-requests sudo pip install requests ``` -####dnspython Module (http://www.dnspython.org/) +#### dnspython Module (http://www.dnspython.org/) - Install for Windows: ``` -python -m pip install dnspython +c:\python27\python.exe -m pip install dnspython ``` - Install for Ubuntu/Debian: @@ -78,7 +78,7 @@ sudo apt-get install python-dnspython sudo pip install dnspython ``` -####argparse Module +#### argparse Module - Install for Ubuntu/Debian: ``` @@ -95,18 +95,12 @@ sudo yum install python-argparse sudo pip install argparse ``` -**And for coloring in windows install the following libraries** +**for coloring in windows install the following libraries** ``` -python -m pip install win_unicode_console colorama +c:\python27\python.exe -m pip install win_unicode_console colorama ``` -*Note:To get the path of python.exe for the windows installation process use :* -``` -import sys -sys.executable -``` - -##Usage +## Usage Short Form | Long Form | Description ------------- | ------------- |------------- @@ -119,7 +113,7 @@ Short Form | Long Form | Description -o | --output | Save the results to text file -h | --help | show the help message and exit -###Examples +### Examples * To list all the basic options and switches use -h switch: @@ -129,15 +123,15 @@ Short Form | Long Form | Description ``python sublist3r.py -d example.com`` -* To enumerate subdomains of specific domain and show only subdomains with open ports 80 and 443 : +* To enumerate subdomains of specific domain and show only subdomains which have open ports 80 and 443 : ``python sublist3r.py -d example.com -p 80,443`` -* To enumerate subdomains of specific domain and show results in realtime: +* To enumerate subdomains of specific domain and show the results in realtime: ``python sublist3r.py -v -d example.com`` -* To enumerate subdomains and use the subbrute bruteforce module: +* To enumerate subdomains and enable the bruteforce module: ``python sublist3r.py -b -d example.com`` @@ -176,14 +170,14 @@ subdomains = sublist3r.main('yahoo.com', 40, 'yahoo_subdomains.txt', ports= None Sublist3r is licensed under the GNU GPL license. take a look at the [LICENSE](https://github.com/aboul3la/Sublist3r/blob/master/LICENSE) for more information. -##Credits +## Credits * [TheRook](https://github.com/TheRook) - The bruteforce module was based on his script **subbrute**. * [Bitquark](https://github.com/bitquark) - The Subbrute's wordlist was based on his research **dnspop**. -##Thanks +## Thanks * Special Thanks to [Ibrahim Mosaad](https://twitter.com/ibrahim_mosaad) for his great contributions that helped in improving the tool. -##Version +## Version **Current version is 1.0**