How owasp/nettacker works
Project type and purpose
• OWASP Nettacker is a Python-based, multi-threaded/multi-process automated penetration-testing scanner.
• It provides:
• A CLI entrypoint (nettacker.py/main.py)
• A REST API service
• A WebUI (static HTML/JS/CSS)
• A plugin/module system for scans (scan, brute, vuln)
• Pluggable DB backends (SQLite/MySQL/PostgreSQL)
• Docker/docker-compose deployment
File structure
• Top-level artifacts:
• Dockerfile + docker-compose.yml + Makefile → container orchestration
• nettacker.py & main.py → CLI bootstrap
• pyproject.toml → Python packaging/deps
• .data/ → persistent volume (sqlite, results)
• README, docs/, mkdocs.yml → docs site
• tests/ → unit tests
• Package “nettacker/”:
• api/ → REST endpoints and engine
• core/ → argument parsing, engine loop, plugin loader, fuzzer, graph
• database/ → ORM and SQL backends
• lib/ → helper libs (graphing, reporting, HTML logs, ICMP, payloads)
• modules/ → YAML-driven scan, brute, vuln plugins
• web/ → static WebUI files
• config.py, logger.py → global config & logging
• Patterns: layered (presentation/API → core engine → data), plugin architecture for modules
README insights
• Describes features (scanning, brute forcing, reporting)
• Mentions API & WebUI, Docker deployment, persistent storage under .data
Detail
• Essential architectural elements: UI, API, core engine modules, plugin system, data persistence, external targets, deployment