Skip to main content

Web Source Discovery Tool

Project description

penterepTools

PTWEBDISCOVER - Web Source Discovery Tool

Installation

pip install ptwebdiscover

Adding to PATH

If you're unable to invoke the script from your terminal, it's likely because it's not included in your PATH. You can resolve this issue by executing the following commands, depending on the shell you're using:

For Bash Users

echo "export PATH=\"`python3 -m site --user-base`/bin:\$PATH\"" >> ~/.bashrc
source ~/.bashrc

For ZSH Users

echo "export PATH=\"`python3 -m site --user-base`/bin:\$PATH\"" >> ~/.zshrc
source ~/.zshrc

Usage examples

ptwebdiscover -u https://www.example.com -src robots.txt sitemap.xml -scy 200
ptwebdiscover -u https://www.example.com -bf -ch lowercase,numbers,123abcdEFG*
ptwebdiscover -u https://www.example.com -bf -lx 4
ptwebdiscover -u https://www.example.com -w
ptwebdiscover -u https://www.example.com -w wordlist.txt
ptwebdiscover -u https://www.example.com -w wordlist.txt --begin_with admin
ptwebdiscover -u https://*.example.com -w wordlist.txt
ptwebdiscover -u https://www.example.com -Po -tr
ptwebdiscover -u https://www.example.com/exam*.txt
ptwebdiscover -u https://www.example.com -bf -e "" bak old php~ php.bak
ptwebdiscover -u https://www.example.com -w wordlist.txt-E extensions.txt"
ptwebdiscover -u https://www.example.com -w wordlist.txt -sn "Page Not Found"
ptwebdiscover -u https://www.example.com -arch checked
ptwebdiscover -u https://www.example.com -ba
ptwebdiscover -u https://www.example.com -sm

Options

-bf      --bruteforce                              Enable brute force mode
-u       --url                    <url>            URL for test (usage of a star character as anchor)
-ch      --charsets               <charsets>       Specify charset for brute force (example: lowercase,uppercase,numbers,[custom_chars])
                                                   Modify wordlist (lowercase,uppercase,capitalize)
-scy     --status-code-yes        <status codes>   Include only sources returned with provided status codes
-scn     --status-code-no         <status codes>   Not include sources returned with provided status codes
-src     --source                 <sources>        Check for presence of only specified <source> (eg. -src robots.txt)
-fp      --forbidden-paths        <paths>          Paths that should not be tested
-lm      --length-min             <length-min>     Minimal length of brute-force tested string (default 1)
-lx      --length-max             <length-max>     Maximal length of brute-force tested string (default 6 bf / 99 wl)
-w       --wordlist               <filename>       Use specified wordlist(s)
-pf      --prefix                 <string>         Use prefix before tested string
-sf      --suffix                 <string>         Use suffix after tested string
-bw      --begin-with             <string>         Use only words from wordlist that begin with the specified string
-ci      --case-insensitive                        Case insensitive items from wordlist
-e       --extensions             <extensions>     Add extensions behind a tested string (\"\" for empty extension)
-E       --extension-file         <filename>       Add extensions from default or specified file behind a tested string.
-ew      --extensions-whitelist   <extensions>     Check for extensions whitelisting on the server (default are common backup and config extensions)
-eo      --extensions-output      <extensions>     Include only sources with specified extensions in output
-r       --recurse                                 Recursive browsing of found directories
-md      --max_depth              <integer>        Maximum depth during recursive browsing (default: 20)
-b       --backups                                 Search for backups of disclosed files
-ba      --backup-all                              Search for backups of the website or db
-P       --parse                                   Parse HTML response for URLs discovery
-Po      --parse-only                              Brute force method is disabled, crawling started on specified url
-D       --directory                               Add a slash at the ends of the strings too
-nd      --not-directories        <directories>    Not include listed directories when recursive browse run
-sy      --string-in-response     <string>         Print findings only if string in response (GET method is used)
-sn      --string-not-in-response <string>         Print findings only if string not in response (GET method is used)
-d       --delay                  <miliseconds>    Delay before each request in seconds
-T       --timeout                <miliseconds>    Manually set timeout (default 10000)
-cl      --content-length         <kilobytes>      Max content length to download and parse (default: 1000KB)
-m       --method                 <method>         Use said HTTP method (default: HEAD)
-se      --scheme                 <scheme>         Use scheme when missing (default: http)
-p       --proxy                  <proxy>          Use proxy (e.g. http://127.0.0.1:8080)
-H       --headers                <headers>        Use custom headers
-a       --user-agent             <agent>          Use custom value of User-Agent header
-c       --cookie                 <cookies>        Use cookie (-c \"PHPSESSID=abc; any=123\")
-A       --auth                   <name:pass>      Use HTTP authentication
-rc      --refuse-cookies                          Do not use cookies set by application
-t       --threads                <threads>        Number of threads (default 20)
-wd      --without-domain                          Output of discovered sources without domain
-wh      --with-headers                            Output of discovered sources with headers
-ip      --include-parameters                      Include GET parameters and anchors to output
-fd      --foreign-domains                         Output of discovered sources with foreign domains
-tr      --tree                                    Output as tree
-o       --output                 <filename>       Output to file
-S       --save                   <directory>      Save content localy
-tg      --target                 <ip or host>     Use this target when * is in domain
-nr      --not-redirect                            Do not follow redirects
-s       --silent                                  Do not show statistics in realtime
-C       --cache                                   Cache each request response to temp file
-ne      --non-exist                               Check, if non existing pages return status code 200
-vy      --vuln-yes               <vuln_code>      Add provided VULN to JSON if source is found
-vn      --vuln-no                <vuln_code>      Add provided VULN to JSON if source is not found
-er      --errors                                  Show all errors
-v       --version                                 Show script version
-h       --help                                    Show this help message
-j       --json                                    Output in JSON format
-gl      --google                                  Use Google Custom Search API for URL discovery
-gak     --google-api             <api_key>        Google Custom Search API key
-gcx     --google-cx              <cx_key>         Google Custom Search CX key
-sm      --sitemap                                 Parse sitemap.xml for URL discovery
-arch    --archive                [checked]        Passive scan via webarchive, accepts optional arguments: (checked)

Dependencies

ptlibs
bs4
treelib

License

Copyright (c) 2025 Penterep Security s.r.o.

ptwebdiscover is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

ptwebdiscover is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with ptwebdiscover. If not, see https://www.gnu.org/licenses/.

Warning

You are only allowed to run the tool against the websites which you have been given permission to pentest. We do not accept any responsibility for any damage/harm that this application causes to your computer, or your network. Penterep is not responsible for any illegal or malicious use of this code. Be Ethical!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ptwebdiscover-1.1.5.tar.gz (50.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ptwebdiscover-1.1.5-py3-none-any.whl (54.2 kB view details)

Uploaded Python 3

File details

Details for the file ptwebdiscover-1.1.5.tar.gz.

File metadata

  • Download URL: ptwebdiscover-1.1.5.tar.gz
  • Upload date:
  • Size: 50.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for ptwebdiscover-1.1.5.tar.gz
Algorithm Hash digest
SHA256 a70c81f7f5f160528812f96f9d3b4883677f64b0d03d9625b436f742e3a20759
MD5 5e24ce1ba1ccc4c7a529d9b5ad9b8a8c
BLAKE2b-256 a41500ddf70164751a5accea87edb05e46c30afd742e4ddac5d9d3e51a4da367

See more details on using hashes here.

File details

Details for the file ptwebdiscover-1.1.5-py3-none-any.whl.

File metadata

  • Download URL: ptwebdiscover-1.1.5-py3-none-any.whl
  • Upload date:
  • Size: 54.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for ptwebdiscover-1.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 87e58c1e17f02fcc6ea18d58b303422e3349a6e4b3fdf7ef616148be9b449d1b
MD5 46ad227422c18ecb2911fc3698055d45
BLAKE2b-256 4cfba95bf864f7e37c3c6985083c3554e880561b071cc18ee038610d03f32307

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page