Current Release: v0.4.0 (2020.9.27)
Dirsearch is a mature command-line tool designed to brute force directories and files in webservers.
With 6 years of growing, dirsearch now has become the top web content scanner. As a feature-rich tool, dirsearch allows the user to perform a complex web content discovering, with many vectors for the wordlist, high accuracy, impressive performance, advanced connection/request settings, modern brute-force techniques and nice output.
Although there are now many awesome fuzzers like wfuzz, gobuster or ffuf, dirsearch is still showing it's own unique in features and detections when doing web content brute-force. Instead of supporting parameters fuzzing like in ffuf or wfuzz, dirsearch still keeps it as a traditional web path brute forcer. This allows dirsearch to much more focus on the accuracy of the output and support more features for its purpose.
git clone https://github.com/maurosoria/dirsearch.git
cd dirsearch
python3 dirsearch.py -u <URL> -e <EXTENSIONS>
If you are using Windows and don't have git, you can install the ZIP file here, then extract and run. Dirsearch also supports Docker
Dirsearch requires python 3 or greater
Note: For the best performance, you should use CPython
Usage: dirsearch.py [-u|--url] target [-e|--extensions] extensions [options]
Options:
--version show program's version number and exit
-h, --help show this help message and exit
Mandatory:
-u URL, --url=URL Target URL
-l FILE, --url-list=FILE
URL list file
--cidr=CIDR Target CIDR
-e EXTENSIONS, --extensions=EXTENSIONS
Extension list separated by commas (Example: php,asp)
-X EXTENSIONS, --exclude-extensions=EXTENSIONS
Exclude extension list separated by commas (Example:
asp,jsp)
Dictionary Settings:
-w WORDLIST, --wordlist=WORDLIST
Customize wordlist (separated by commas)
--prefixes=PREFIXES
Add custom prefixes to all entries (separated by
commas)
--suffixes=SUFFIXES
Add custom suffixes to all entries, ignores
directories (separated by commas)
-f, --force-extensions
Force extensions for every wordlist entry
--only-selected Only entries with selected extensions or no extension
+ directories
--remove-extensions
Remove extensions in all wordlist entries (Example:
admin.php -> admin)
--no-dot-extensions
Remove the "." character before extensions
-U, --uppercase Uppercase wordlist
-L, --lowercase Lowercase wordlist
-C, --capital Capital wordlist
General Settings:
-r, --recursive Bruteforce recursively
-R DEPTH, --recursion-depth=DEPTH
Max recursion depth (subdirs) (Default: 0 [infinity])
-t THREADS, --threads=THREADS
Number of threads
-d DATA, --data=DATA
HTTP request data
--minimal=LENGTH Minimal response length
--maximal=LENGTH Maximal response length
--scan-subdirs=SUBDIRS
Scan subdirectories of the given URL (separated by
commas)
--exclude-subdirs=SUBDIRS
Exclude the following subdirectories during recursive
scan (separated by commas)
-i STATUS, --include-status=STATUS
Show only included status codes, separated by commas
(Example: 301,500)
-x STATUS, --exclude-status=STATUS
Do not show excluded status codes, separated by commas
(Example: 301,500)
--exclude-sizes=SIZES
Exclude responses by sizes, separated by commas
(Example: 123B,4KB)
--exclude-texts=TEXTS
Exclude responses by texts, separated by commas
(Example: "Not found", "Error")
--exclude-regexps=REGEXPS
Exclude responses by regexps, separated by commas
(Example: "Not foun[a-z]{1}", "^Error$")
-H HEADERS, --header=HEADERS
HTTP request header, support multiple flags (Example:
-H "Referer: example.com" -H "Accept: */*")
--header-list=FILE File contains HTTP request headers
--random-user-agent
Choose a random User-Agent for each request
-F, --follow-redirects
Follow HTTP redirects
--full-url Print full URLs in the output
--user-agent=USERAGENT
--cookie=COOKIE
-q, --quiet-mode
Connection Settings:
--timeout=TIMEOUT Connection timeout
--ip=IP Server IP address
-s DELAY, --delay=DELAY
Delay between requests (support float number)
--proxy=PROXY Proxy URL, support HTTP and SOCKS proxy (Example:
localhost:8080, socks5://localhost:8088)
--proxy-list=FILE File contains proxy servers
-m METHOD, --http-method=METHOD
HTTP method (default: GET)
--max-retries=RETRIES
-b, --request-by-hostname
By default dirsearch requests by IP for speed. This
will force requests by hostname
--exit-on-error Exit whenever an error occurs
--debug
Reports:
--simple-report=OUTPUTFILE
--plain-text-report=OUTPUTFILE
--json-report=OUTPUTFILE
--xml-report=OUTPUTFILE
--markdown-report=OUTPUTFILE
NOTE: You can change the dirsearch default configurations (default extensions, timeout, wordlist location, ...) by editing the "default.conf" file.
- Windows XP/7/8/10
- GNU/Linux
- MacOSX
- Fast
- Easy and simple to use
- Multithreading
- Wildcard responses filtering (invalid webpages)
- Keep alive connections
- Support for multiple extensions
- Support for every HTTP method
- Support for HTTP request data
- Extensions excluding
- Reporting (Plain text, JSON, XML)
- Recursive brute forcing
- Target enumuration from an IP range
- Sub-directories brute forcing
- Force extensions
- HTTP and SOCKS proxy support
- HTTP cookies and headers support
- HTTP headers from file
- User agent randomization
- Proxy host randomization
- Batch processing
- Request delaying
- Multiple wordlist formats (lowercase, uppercase, capitalization)
- Default configuration from file
- Quiet mode
- Debug mode
- Option to force requests by hostname
- Option to add custom suffixes and prefixes
- Option to whitelist response codes (-i 200,500)
- Option to blacklist response codes (-x 404,403)
- Option to exclude responses by sizes
- Option to exclude responses by texts
- Option to exclude responses by regexps (example: "Not foun[a-z]{1}")
- Options to display only items with response length from range
- Option to remove all extensions from every wordlist entry
- Option to remove the dot before extensions
- ...
- Wordlist must be a text file. Each line will be processed as such, except when the special keyword %EXT% is used, it will generate one entry for each extension (-e | --extensions) passed as an argument.
Example:
root/
index.%EXT%
Passing the extensions "asp" and "aspx" (-e asp,aspx
) will generate the following dictionary:
root/
index
index.asp
index.aspx
- For wordlists without %EXT% (like SecLists), you need to use the -f | --force-extensions switch to append extensions to every word in the wordlists, as well as the "/". And for entries in the wordlist that you do not want to force, you can add %NOFORCE% at the end of them so dirsearch won't append any extension.
Example:
admin
home.%EXT%
api%NOFORCE%
Passing extensions "php" and "html" with the -f
/--force-extensions
flag (-f -e php,html
) will generate the following dictionary:
admin
admin.php
admin.html
admin/
home
home.php
home.html
api
- To use multiple wordlists, you can seperate your wordlists with commas. Example: -w wordlist1.txt,wordlist2.txt
Some examples for how to use dirsearch - those are the most common arguments. If you need all, just use the "-h" argument.
python3 dirsearch.py -u https://target
python3 dirsearch.py -e php,html,js -u https://target
python3 dirsearch.py -e php,html,js -u https://target -w /path/to/wordlist
By adding "-r | --recursive" argument, dirsearch will automatically brute-force the after of directories that it found.
python3 dirsearch.py -e php,html,js -u https://target -r
You can set the max recursion depth with "-R" or "--recursion-depth"
python3 dirsearch.py -e php,html,js -u https://target -r -R 3
The threads number (-t | --threads) reflects the number of separate brute force processes, that each process will perform path brute-forcing against the target. And so the bigger the threads number is, the more fast dirsearch runs. By default, the number of threads is 20, but you can increase it if you want to speed up the progress.
In spite of that, the speed is actually still uncontrollable since it depends a lot on the response time of the server. And as a warning, we advise you to keep the threads number not too big because of the impact from too much automation requests, this should be adjusted to fit the power of the system that you're scanning against.
python3 dirsearch.py -e php,htm,js,bak,zip,tgz,txt -u https://target -t 30
Sometimes your wordlist may contains many extensions, for many cases like .asp
, .aspx
, .php
, .jsp
, ... But if you found the core application behind it, many of those endpoints will be useless right? Don't worry, try "-X " and all endpoints have given extensions will be removed.
python3 dirsearch.py -e asp,aspx,html,htm,js -u https://target -X php,jsp,jspx
- "--prefixes": Adding custom prefixes to all entries
python3 dirsearch.py -e php -u https://target --prefixes .,admin,_,~
Base wordlist:
tools
Generated with prefixes:
.tools
admintools
_tools
~tools
- "--suffixes": Adding custom suffixes to all entries
python3 dirsearch.py -e php -u https://target --suffixes ~,/
Base wordlist:
index.php
internal
Generated with suffixes:
index.php~
index.php/
internal~
internal/
Supported wordlist formats: uppercase, lowercase, capitalization
python3 dirsearch.py -e html -u https://target --lowercase
admin
index.html
test
python3 dirsearch.py -e html -u https://target --uppercase
ADMIN
INDEX.HTML
TEST
python3 dirsearch.py -e html -u https://target --capitalization
Admin
Index.html
Test
Use "-i | --include-status" and "-x | --exclude-status" to select allowed and not allowed response status codes
python3 dirsearch.py -e php,html,js -u https://target -i 200,204,400,403 -x 500,502,429
"--exclude-sizes", "--exclude-texts" and "--exclude-regexps" are also supported for a more advanced filter
python3 dirsearch.py -e php,html,js -u https://target --exclude-sizes 1B,243KB
python3 dirsearch.py -e php,html,js -u https://target --exclude-texts "403 Forbidden"
python3 dirsearch.py -e php,html,js -u https://target --exclude-regexps "^Error$"
From an URL, you can scan sub-dirsearctories with "--scan-subdirs".
python3 dirsearch.py -e php,html,js -u https://target --scan-subdirs admin/,folder/,/
A reverse version of this feature is "--exclude-subdir | --exclude-subdirs", which to prevent dirsearch from brute-forcing directories that should not be brute-forced when doing a recursive scan.
python3 dirsearch.py -e php,html,js -u https://target --recursive -R 2 --exclude-subdirs "server-status/,%3f/"
Dirsearch supports SOCKS and HTTP proxy, with two options: a proxy server or a list of proxy servers.
python3 dirsearch.py -e php,html,js -u https://target --proxy 127.0.0.1:8080
python3 dirsearch.py -e php,html,js -u https://target --proxy socks5://10.10.0.1:8080
python3 dirsearch.py -e php,html,js -u https://target --proxylist proxyservers.txt
Dirsearch allows the user to save the output into a file. It supports several output formats like text or json, and we are keep updating for new formats
python3 dirsearch.py -e php -l URLs.txt --plain-text-report report.txt
python3 dirsearch.py -e php -u https://target --json-report target.json
python3 dirsearch.py -e php -u https://target --simple-report target.txt
python3 dirsearch.py -e php,txt,zip -u https://target -w db/dicc.txt -H "X-Forwarded-Host: 127.0.0.1" -f
python3 dirsearch.py -e php,txt,zip -u https://target -w db/dicc.txt -t 100 -m POST --data "username=admin"
python3 dirsearch.py -e php,txt,zip -u https://target -w db/dicc.txt --random-agent --cookie "PHPSESSID=el4ukv0kqbvoirg7nkp4dncpk3"
python3 dirsearch.py -e php,txt,zip -u https://target -w db/dicc.txt --json-report=target.json
python3 dirsearch.py -e php,txt,zip -u https://target -w db/dicc.txt --minimal 1
python3 dirsearch.py -e php,txt,zip -u https://target -w db/dicc.txt --header-list rate-limit-bypasses.txt
python3 dirsearch.py -e php,txt,zip -u https://target -w db/dicc.txt -q --stop-on-error
python3 dirsearch.py -e php,txt,zip -u https://target -w db/dicc.txt --full-url
python3 dirsearch.py -u https://target -w db/dicc.txt --no-extension
There are more features and you will need to discover it by your self
- To run dirsearch with a rate of requests per second, try
-t <rate> -s 1
- Want to findout config files or backups? Try out
--suffixes ~
and--prefixes .
- For some endpoints that you do not want to force extensions, add
%NOFORCE%
at the end of them - Want to find only folders/directories? Combine
--no-extension
and--suffixes /
! - The combination of
--cidr
,-F
and-q
will reduce most of the noise + false negatives when brute-forcing with a CIDR
Keep updating ...
- Don't use
-e *
, it won't replace*
with all extensions as what you are thinking
Install Docker
curl -fsSL https://get.docker.com | bash
To use docker you need superuser power
To create image
docker build -t "dirsearch:v0.4.0" .
dirsearch this is name the image and v0.4.0 is version
For using
docker run -it --rm "dirsearch:v0.4.0" -u target -e php,html,js,zip
target is the site or IP
Copyright (C) Mauro Soria ([email protected])
License: GNU General Public License, version 2
Main: @maurosoria and @shelld3v
Special thanks for these people:
- @V-Rico
- @random-robbie
- @mzfr
- @DustinTheGreat
- @jsfan
- @liamosaur
- @Anon-Exploiter
- @tkisason
- @ricardojba
- @Sjord
- @danritter
- @shahril96
- @drego85
- @Bo0oM
- @exploide
- @redshark180
- @zrquan
- @SUHAR1K
- @eur0pa
- @FireFart
- @telnet22
- @sysevil
- @mazen160
- @k2l8m11n2
- @vlohacks
- @russtone
- @jsav0
- @serhattsnmz
- @ColdFusionX
- @gdattacker
- @chowmean