Sublist3r README

The project's README from github.com/aboul3la/Sublist3r. As one markdown file: README.md.

About Sublist3r

Sublist3r is a python tool designed to enumerate subdomains of websites using 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 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

Sublist3r

Installation

git clone https://github.com/aboul3la/Sublist3r.git

Sublist3r currently supports Python 2 and Python 3.

Dependencies:

Sublist3r depends on the requests, dnspython and argparse python modules.

These dependencies can be installed using the requirements file:

c:\python27\python.exe -m pip install -r requirements.txt

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/)

c:\python27\python.exe -m pip install requests

sudo apt-get install python-requests

sudo yum install python-requests

sudo pip install requests

dnspython Module (http://www.dnspython.org/)

c:\python27\python.exe -m pip install dnspython

sudo apt-get install python-dnspython

sudo pip install dnspython

argparse Module

sudo apt-get install python-argparse

sudo yum install python-argparse

sudo pip install argparse

for coloring in windows install the following libraries

c:\python27\python.exe -m pip install win_unicode_console colorama

Usage

Short Form Long Form Description
-d --domain Domain name to enumerate subdomains of
-b --bruteforce Enable the subbrute bruteforce module
-p --ports Scan the found subdomains against specific tcp ports
-v --verbose Enable the verbose mode and display results in realtime
-t --threads Number of threads to use for subbrute bruteforce
-e --engines Specify a comma-separated list of search engines
-o --output Save the results to text file
-h --help show the help message and exit

Examples

python sublist3r.py -h

python sublist3r.py -d example.com

python sublist3r.py -d example.com -p 80,443

python sublist3r.py -v -d example.com

python sublist3r.py -b -d example.com

python sublist3r.py -e google,yahoo,virustotal -d example.com

Using Sublist3r as a module in your python scripts

Example

import sublist3r 
subdomains = sublist3r.main(domain, no_threads, savefile, ports, silent, verbose, enable_bruteforce, engines)

The main function will return a set of unique subdomains found by Sublist3r

Function Usage:

Example to enumerate subdomains of Yahoo.com:

import sublist3r 
subdomains = sublist3r.main('yahoo.com', 40, 'yahoo_subdomains.txt', ports= None, silent=False, verbose= False, enable_bruteforce= False, engines=None)

License

Sublist3r is licensed under the GNU GPL license. take a look at the LICENSE for more information.

Credits

Thanks

Version

Current version is 1.0

Sublist3r (aboul3la/Sublist3r)

wordlist
Searching Database…

11.1K ·GitHub
Sublist3r
What is this?Sublist3r is a Python tool that enumerates subdomains of a target website using OSINT, helping penetration testers and bug hunters gather subdomains for a domain they are targeting.
Is this just a CLI script, or can I use it in my own code too?It is mainly a command-line Python script, but you can also import its main function directly into your own Python scripts.
How do I get it running?Install the dependencies from the requirements file (pip on Windows or Linux), then run something like 'python sublist3r.py -d example.com' to enumerate subdomains of a domain.
What do I need installed before running it?It depends on the requests, dnspython and argparse Python modules, and supports Python 2.7.x or Python 3.4.x.
Any catch with how it finds subdomains?Results rely on third-party sources (Google, Yahoo, Bing, Baidu, Ask, Netcraft, Virustotal, ThreatCrowd, DNSdumpster), so coverage depends on those services staying reachable and not blocking automated queries; the project is still at version 1.0.
Does it work on Windows as well as Linux?Yes, the README gives separate dependency setup instructions for both Windows and Linux (Ubuntu/Debian/Centos), and being pure Python it also runs on macOS.
What sources does it pull subdomains from?It queries search engines like Google, Yahoo, Bing, Baidu and Ask, plus Netcraft, Virustotal, ThreatCrowd, DNSdumpster and ReverseDNS.
Can it brute-force subdomains too?Yes, the -b flag enables an integrated subbrute module with an improved wordlist for bruteforce-based subdomain discovery.
Can I check which ports are open on the subdomains it finds?Yes, the -p flag scans discovered subdomains against specific TCP ports, e.g. 80 and 443.
Can I call Sublist3r from my own Python scripts?Yes, you can import its main function with parameters like domain, savefile, ports, silent, verbose, enablebruteforce and engines, and it returns a set of unique subdomains.
What are similar projects?bbot, OneForAll, theHarvester, GhostTrack, Photon, spiderfoot, thc-hydra, maigret
Which topics is it in?wordlist, subdomain-enumeration, subdomain, bruteforce, security-testing, recon, information-gathering, reconnaissance, search-engine, osint, hacking-tool, gplv2
Creator
aboul3la
Size
1.1 MB
Stars
11.1K
Updated
CommitJul 29Release1.1Apr 06
Age
10y
Commits · 90 Days