Metadata-Version: 2.4
Name: pentool
Version: 1.0.0
Summary: Modern Web Pentesting TUI - Professional security testing tool
Author-email: Pentool Team <dev@pentool.pro>
License: AGPL-3.0
Project-URL: Homepage, https://github.com/pentool/pentool
Project-URL: Documentation, https://pentool.dev/docs
Project-URL: Repository, https://github.com/pentool/pentool
Project-URL: Issues, https://github.com/pentool/pentool/issues
Project-URL: Changelog, https://github.com/pentool/pentool/blob/main/CHANGELOG.md
Keywords: pentesting,security,burp,proxy,scanner,intruder
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Topic :: Security
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: textual>=0.40.0
Requires-Dist: aiohttp>=3.9.0
Requires-Dist: aiosqlite>=0.19.0
Requires-Dist: beautifulsoup4>=4.12.0
Requires-Dist: click>=8.1.0
Requires-Dist: cryptography>=41.0.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: rich>=13.0.0
Provides-Extra: dev
Requires-Dist: pytest>=7.4.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
Requires-Dist: pytest-timeout>=2.1.0; extra == "dev"
Requires-Dist: ruff>=0.1.0; extra == "dev"
Requires-Dist: mypy>=1.5.0; extra == "dev"
Requires-Dist: pre-commit>=3.4.0; extra == "dev"
Dynamic: license-file

# 🔐 Pentool — Modern Web Pentesting TUI

[![PyPI version](https://badge.fury.io/py/pentool.svg)](https://badge.fury.io/py/pentool)
[![Python](https://img.shields.io/pypi/pyversions/pentool)](https://pypi.org/project/pentool/)
[![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL--3.0-blue.svg)](LICENSE)
[![Tests](https://github.com/docx/pentool/actions/workflows/ci.yml/badge.svg)](https://github.com/docx/pentool/actions)

**Pentool** is a fast, modular web security testing tool with a terminal UI. Built for pentesters and security researchers who prefer working in the terminal.

```bash
pip install pentool
pentool
```

---

## ✨ Features

- **🌐 Proxy** — Intercept and modify HTTP/HTTPS traffic in real time, manage scope, apply match & replace rules
- **🔄 Repeater** — Replay requests with any modifications, persist tabs between sessions
- **💥 Intruder** — Automated attacks with 4 strategies: Sniper, Battering Ram, Pitchfork, Cluster Bomb
- **🚀 Turbo Intruder** — 10× speed via HTTP Keep-Alive and connection pooling (100–200 req/sec)
- **🔍 Scanner** — Detect SQLi, XSS, SSTI, LFI, RCE, SSRF, XXE and more (active + passive modes)
- **🕷 Spider** — Crawl sites automatically, collect pages, forms and JS endpoints
- **🎯 Target / Site Map** — Build a site map and manage testing scope from the UI
- **🔐 Decoder + Comparer + Sequencer** — Encode/decode, diff requests, analyze token entropy
- **🧩 Plugin system** — Extend functionality without recompiling
- **⚡ Async core** — Fully async, optimized for high load
- **🆓 Open Source + PRO** — Free base, optional PRO license for advanced features

---

## 📦 Installation

**Requirements:** Python 3.10+, Linux / macOS / Windows

```bash
pip install pentool
```

From source:

```bash
git clone https://github.com/docx/pentool.git
cd pentool
pip install -e ".[dev]"
```

---

## 🚀 Quick Start

```bash
# Launch the TUI
pentool

# Start proxy on custom port
pentool proxy start --port 8080

# Run active scan
pentool scan active --url https://example.com
```

---

## 💰 Pricing

| Plan | Price | Features |
|------|-------|----------|
| **Free** | $0 | Proxy, Repeater, Intruder, Decoder | 
| **Lite** | $29/mo | + Scanner, Spider, Match & Replace |
| **Medium** | $99/mo | + WebSocket, Plugins, Turbo Mode |
| **Full** | $299/mo | + PRO Reports, API, Unlimited |

[Get PRO license →](https://pentool.pro)

---

## 🤝 Support the project

Pentool is developed in free time. If it helps your work, consider supporting:

- [GitHub Sponsors](https://github.com/sponsors/docx)
- [Buy PRO license](https://pentool.pro) — also supports development

---

## 📖 Documentation

- [Quick Start](docs/QUICKSTART.md)
- [User Guide](docs/user/)
- [Architecture](docs/ARCHITECTURE_AUDIT.md)
- [API Reference](docs/API_CONTRACTS.md)

---

## 🧪 Tests

```bash
pytest tests/unit/ -q
```

---

## 🤝 Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md). Report vulnerabilities to security@pentool.pro.

## 📄 License

Community Edition: [AGPL-3.0](LICENSE) · PRO Edition: Commercial
