Skip to main content

Console web directory and subdomain scanner for security research and asset discovery

Project description

OWASP WEB Directory Scanner Twitter

OpenDoor OWASP

Python Linux macOS Windows
3.12 CI Linux Python 3.12 CI macOS Python 3.12 CI Windows Python 3.12
3.13 CI Linux Python 3.13 CI macOS Python 3.13 CI Windows Python 3.13
3.14 CI Linux Python 3.14 CI macOS Python 3.14 CI Windows Python 3.14

OpenDoor OWASP is a multifunctional console website scanner.
This application finds possible login entry points, Index of/ directories, web shells, restricted access points, subdomains, hidden data, and large backup files.
Scanning is performed using both the built-in dictionary and external dictionaries.
Anonymity and speed are provided through the use of proxy servers.
The software is written for informational purposes and is released as an open-source product under the GPL license.
The project is part of BlackArch Linux and is maintained and supported by the community.

Maintainer Contributors PyPI version Python 3.12+ codecov

Documentation Status Codacy Security Scan Dependency Review CodeQL

Read The Docs

  • Current 5.1.0 (20.04.2026)
    • Directories: 110977
    • Subdomains: 255359

Changelog (last changes)

v5.1.0 (20.04.2026)

  • (feature)#35 Added response size to exported txt, html, and json reports.
  • (feature)#39 Feature Request: Output response codes
  • (feature) Populated directories by adding new unique +27965 actual paths
  • (bugfix) Report plugins now create nested target directories correctly, e.g. reports/example.com instead of reportsexample.com.
  • (bugfix)Fixed BOM decoding behavior in helper utilities and aligned tests with the corrected implementation.
  • (optimization) Refactored FileSystem.readline() to batch-load lines with much lower peak memory usage.
  • (optimization) Optimized Reader.get_lines() hot path by precomputing handler params and reducing repeated string formatting work.
  • (optimization) Optimized ThreadPool.add() submit-side accounting using submitted task tracking.
  • (optimization) Kept Reader extension filters on the fast in-memory path after benchmark validation.
  • (optimization) Updated benchmark workflow documentation and project maintenance flow.
  • (optimization) Fixed benchmark callback accounting for batched readline() processing.
  • (optimization) Improved compatibility of terminal, color, logger exception, and rainbow logger behavior under tests.
  • (tests) Test suite expanded to 400+ tests.
  • (tests) Added regression tests and edge case coverage for report size propagation.
  • (tests) Added broad unit test coverage across core, HTTP, reporter, browser, proxy, socket, logger, terminal, color, and filesystem modules.

Main features

  • ✅ directories scanner
  • ✅ subdomains scanner
  • ✅ multithreading control
  • ✅ scan's reports
  • ✅ HTTP(S) (PORT) support
  • ✅ Keep-alive long pooling
  • ✅ Invalid certificates scan
  • ✅ HTTP(S)/SOCKS proxies
  • ✅ dynamic request header
  • ✅ custom wordlists prefixes
  • ✅ custom wordlists, proxies, ignore lists
  • ✅ debug levels (1-3)
  • ✅ extensions filter
  • ✅ custom reports directory
  • ✅ custom config wizard (use random techniques)
  • ✅ analyze techniques:
    • detect redirects
    • detect index of/ Apache
    • detect large files
    • skip 200 OK redirects
    • skip empty pages
    • heuristic detect invalid pages
    • blank success page filter
    • certificate required pages
  • ✅ randomization techniques:
    • random user-agent per request
    • random proxy per request
    • wordlists shuffling
    • wordlists filters

Install PIP

python3 -m ensurepip --upgrade
python3 -m pip install --upgrade pip

Global installation from PyPI

Use this if you want the package available as a normal Python CLI tool.

Linux / macOS
python3 -m pip install --upgrade opendoor
opendoor --host http://www.example.com
Windows (PowerShell)
winget install Python.Python.3.14
py -m pip install --upgrade pip
py -m pip install --upgrade opendoor

opendoor --host http://www.example.com

Global installation with pipx (recommended for end users)

macOS / Homebrew
brew install pipx
pipx ensurepath
pipx install opendoor

opendoor --host http://www.example.com
Linux / generic environments

Install pipx with your system package manager or preferred Python tooling, then:

pipx ensurepath
pipx install opendoor

opendoor --host http://www.example.com
Windows (PowerShell)
winget install Python.Python.3.14
py -m pip install --user pipx
py -m pipx ensurepath

# Reopen PowerShell after ensurepath
pipx install opendoor

opendoor --host http://www.example.com

pipx is the preferred option when you want an isolated CLI installation without managing a project virtual environment manually.

Local installation and run

Use this mode if you want to run OpenDoor directly from the repository without installing it globally.

Linux / macOS
git clone https://github.com/stanislav-web/OpenDoor.git
cd OpenDoor/
python3 -m pip install -r requirements.txt
chmod +x opendoor.py

python3 opendoor.py --host http://www.example.com
Windows (PowerShell)
git clone https://github.com/stanislav-web/OpenDoor.git
cd OpenDoor
py -m pip install -r requirements.txt

py opendoor.py --host http://www.example.com

Local development installation

Use this mode if you are developing, testing, or changing the project locally.

Linux / macOS
git clone https://github.com/stanislav-web/OpenDoor.git
cd OpenDoor/
python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip setuptools wheel
python -m pip install -r requirements-dev.txt
python -m pip install -e .

opendoor --host http://www.example.com
Windows (PowerShell)
git clone https://github.com/stanislav-web/OpenDoor.git
cd OpenDoor
py -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install --upgrade pip setuptools wheel
python -m pip install -r requirements-dev.txt
python -m pip install -e .

opendoor --host http://www.example.com

Installation from source for OS distributions / maintainers

This flow is intended for Linux distributions, package maintainers, and release pipelines.

Linux / macOS
git clone https://github.com/stanislav-web/OpenDoor.git
cd OpenDoor/
python3 -m pip install --upgrade build
python3 -m build
Windows (PowerShell)
git clone https://github.com/stanislav-web/OpenDoor.git
cd OpenDoor
py -m pip install --upgrade build
py -m build

Generated artifacts:

dist/opendoor-5.0.1.tar.gz
dist/opendoor-5.0.1-py3-none-any.whl

This flow is preferable for Linux distributions and package maintainers because:

  • source package and wheel are generated through the standard Python build backend
  • installation can be managed by the distribution package manager
  • updates can be delivered together with OS package updates
  • no legacy setup.py install flow is required

The package is already present in BlackArch Linux, and this build layout is intended to make packaging for other Linux distributions easier as well.

Manual installation from built wheel

Linux / macOS
python3 -m pip install dist/opendoor-5.0.1-py3-none-any.whl
opendoor --host http://www.example.com
Windows (PowerShell)
py -m pip install dist/opendoor-5.0.1-py3-none-any.whl
opendoor --host http://www.example.com

Updates

PyPI installation

Linux / macOS:

python3 -m pip install --upgrade opendoor

Windows:

py -m pip install --upgrade opendoor
pipx installation
pipx upgrade opendoor
Source checkout

Linux / macOS:

git pull
python3 -m pip install -e .

Windows:

git pull
py -m pip install -e .

Help

usage: opendoor [-h] [--host HOST] [-p PORT] [-m METHOD] [-t THREADS]
                [-d DELAY] [--timeout TIMEOUT] [-r RETRIES]
                [--keep-alive] [--accept-cookies] [--debug DEBUG] [--tor]
                [--torlist TORLIST] [--proxy PROXY] [-s SCAN] [-w WORDLIST]
                [--reports REPORTS] [--reports-dir REPORTS_DIR]
                [--random-agent] [--random-list] [--prefix PREFIX]
                [-e EXTENSIONS] [-i IGNORE_EXTENSIONS] [--sniff SNIFF]
                [--update] [--version] [--examples] [--docs]
                [--wizard [WIZARD]]

options:
  -h, --help            show this help message and exit

required named options:
  --host HOST           Target host; example: --host http://example.com

Application tools:
  --update              Show package update instructions
  --version             Show current version
  --examples            Show usage examples
  --docs                Open documentation
  --wizard [WIZARD]     Run scanner wizard from your config

Debug tools:
  --debug DEBUG         Debug level -1 (silent), 1 - 3

Reports tools:
  --reports REPORTS     Scan reports (json,std,txt,html)
  --reports-dir REPORTS_DIR
                        Path to custom reports directory

Request tools:
  -p PORT, --port PORT  Custom port (default 80)
  -m METHOD, --method METHOD
                        Request method (HEAD by default)
  -d DELAY, --delay DELAY
                        Delay between threaded requests
  --timeout TIMEOUT     Request timeout (30 sec default)
  -r RETRIES, --retries RETRIES
                        Maximum reconnect retries (default 3)
  --keep-alive          Use keep-alive connection
  --accept-cookies      Accept and route cookies from responses
  --tor                 Use built-in proxy list
  --torlist TORLIST     Path to custom proxy list
  --proxy PROXY         Custom permanent proxy server
  --random-agent        Randomize user-agent per request

Sniff tools:
  --sniff SNIFF         Response sniff plugins
                        (indexof,collation,file,skipempty,skipsizes=NUM:NUM...)

Stream tools:
  -t THREADS, --threads THREADS
                        Allowed threads

Wordlist tools:
  -s SCAN, --scan SCAN  Scan type: directories or subdomains
  -w WORDLIST, --wordlist WORDLIST
                        Path to custom wordlist
  --random-list         Shuffle scan list
  --prefix PREFIX       Append path prefix to scan host
  -e EXTENSIONS, --extensions EXTENSIONS
                        Force selected extensions for scan session, e.g. php,json
  -i IGNORE_EXTENSIONS, --ignore-extensions IGNORE_EXTENSIONS
                        Ignore selected extensions for the scan session, e.g. aspx,jsp

Maintainers

Tests

python3 -m pip install -r requirements-dev.txt
python3 -m unittest

Build

python3 -m pip install -r requirements-dev.txt
python3 -m build

Lint

python3 -m pip install -r requirements-dev.txt
ruff check .

Contributors

If you like to contribute to the development of the project, in that case, pull requests are open for you. Also, you can suggest ideas and create a task in my track list.

Ask DeepWiki License: GPL v3

Documentation

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

opendoor-5.1.0.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

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

opendoor-5.1.0-py3-none-any.whl (1.6 MB view details)

Uploaded Python 3

File details

Details for the file opendoor-5.1.0.tar.gz.

File metadata

  • Download URL: opendoor-5.1.0.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for opendoor-5.1.0.tar.gz
Algorithm Hash digest
SHA256 e68704eee3a5ca02004cb3be2c7238676cf9a2d86975b68d056b7929858584e2
MD5 006924dda731af1ff016cc9ef24e25cb
BLAKE2b-256 97f960995a00317566cbb61f3185d324ca8379063891b675ae663ab8b7457445

See more details on using hashes here.

File details

Details for the file opendoor-5.1.0-py3-none-any.whl.

File metadata

  • Download URL: opendoor-5.1.0-py3-none-any.whl
  • Upload date:
  • Size: 1.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for opendoor-5.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2faec58b8ad948bcbf5b42cc0c2ad1c98864168f6406991fcef238974f1d9d62
MD5 2ac85157a143fe944a70791ffc8eefde
BLAKE2b-256 d88b0776e9e037b7eb923ef65415aaf958b85f0543477800d54295d53ea17006

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