souleyez 3.0.0__tar.gz → 3.0.11__tar.gz

souleyez-3.0.11/PKG-INFO

@@ -0,0 +1,269 @@
+Metadata-Version: 2.4
+Name: souleyez
+Version: 3.0.11
+Summary: AI-Powered Penetration Testing Platform with 40+ integrated tools
+Author-email: CyberSoul Security <contact@cybersoulsecurity.com>
+Maintainer-email: CyberSoul Security <contact@cybersoulsecurity.com>
+License: MIT
+Project-URL: Homepage, https://github.com/cyber-soul-security/SoulEyez
+Project-URL: Documentation, https://github.com/cyber-soul-security/SoulEyez#readme
+Project-URL: Repository, https://github.com/cyber-soul-security/SoulEyez.git
+Project-URL: Issues, https://github.com/cyber-soul-security/SoulEyez/issues
+Keywords: pentesting,security,hacking,penetration-testing,cybersecurity,nmap,metasploit
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Environment :: Console :: Curses
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Security
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: anthropic>=0.40.0
+Requires-Dist: click>=8.0.0
+Requires-Dist: cryptography>=3.4.0
+Requires-Dist: defusedxml>=0.7.0
+Requires-Dist: impacket>=0.11.0
+Requires-Dist: markdown>=3.4.0
+Requires-Dist: msgpack>=1.0.0
+Requires-Dist: ollama>=0.1.0
+Requires-Dist: psycopg2-binary>=2.9.0
+Requires-Dist: psutil>=5.9.0
+Requires-Dist: python-json-logger>=2.0.0
+Requires-Dist: requests>=2.28.0
+Requires-Dist: rich>=10.0.0
+Requires-Dist: wcwidth>=0.2.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Dynamic: license-file
+
+# SoulEyez — AI-Powered Penetration Testing Platform
+
+[![CI](https://github.com/cyber-soul-security/souleyez/actions/workflows/python-ci.yml/badge.svg)](https://github.com/cyber-soul-security/souleyez/actions/workflows/python-ci.yml)
+[![codecov](https://codecov.io/gh/cyber-soul-security/souleyez/branch/main/graph/badge.svg)](https://codecov.io/gh/cyber-soul-security/souleyez)
+[![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
+
+---
+
+## What is SoulEyez?
+
+**SoulEyez is your penetration testing command center.** Instead of juggling dozens of terminal windows and text files, SoulEyez gives you one organized place to:
+
+- **Run security scans** — Execute tools like Nmap, Gobuster, SQLMap with simple commands
+- **Auto-discover next steps** — When one scan finds something interesting, SoulEyez automatically suggests (or runs) the next logical tool
+- **Stay organized** — Keep all your targets, findings, and credentials in one searchable database
+- **Generate reports** — Export professional reports when you're done
+
+---
+
+## Who is this for?
+
+- **Security professionals** conducting authorized penetration tests
+- **CTF players** who want better organization during competitions
+- **Students** learning penetration testing methodology
+
+> **Important:** Only use SoulEyez on systems you have explicit authorization to test. Unauthorized scanning or exploitation is illegal.
+
+---
+
+## Features
+
+### Core Capabilities
+
+- 🎯 **Interactive Dashboard** — Real-time engagement monitoring with live updates
+- 🔗 **Smart Tool Chaining** — Automatic follow-up scans based on discoveries
+- 📊 **Findings Management** — Track and categorize vulnerabilities by severity
+- 🔑 **Credential Vault** — Encrypted storage for discovered credentials
+- 🌐 **Network Mapping** — Host discovery and service enumeration
+- 📈 **Progress Tracking** — Monitor scan completion and tool execution
+- 💾 **SQLite Storage** — Local database for all engagement data
+- 🔄 **Background Jobs** — Queue-based tool execution with status monitoring
+
+### Integrated Tools (40+)
+
+- **Reconnaissance**: nmap, masscan, theHarvester, whois, dnsrecon
+- **Web Testing**: nikto, gobuster, ffuf, sqlmap, nuclei, wpscan
+- **Enumeration**: enum4linux-ng, smbmap, crackmapexec, snmpwalk
+- **Exploitation**: Metasploit integration, searchsploit
+- **Password Attacks**: hydra, hashcat, john
+- **Post-Exploitation**: impacket suite, bloodhound
+
+### Pentest Workflow & Intelligence
+
+- 📁 **Evidence Vault** — Unified artifact collection organized by PTES phases
+- 🎯 **Attack Surface Dashboard** — Track what's exploited vs pending with priority scoring
+- 💣 **Exploit Suggestions** — Automatic CVE/Metasploit recommendations for discovered services
+- 🔗 **Correlation Engine** — Cross-phase attack tracking and gap analysis
+- 📝 **Report Generator** — Professional reports in Markdown/HTML/PDF formats
+- ✅ **Deliverable Tracking** — Manage testing requirements and acceptance criteria
+- 📸 **Screenshot Management** — Organized visual evidence by methodology phase
+
+### SIEM Integration
+
+- 🛡️ **SIEM Connectors** — Connect to Wazuh, Splunk, and other SIEM platforms
+- ✓ **Detection Validation** — Verify if your attacks triggered SIEM alerts
+- 🔍 **Vulnerability Management** — View CVEs from SIEM vulnerability data
+- ⚖️ **Gap Analysis** — Compare passive (SIEM) vs active (scan) findings
+- 🗺️ **MITRE ATT&CK Reports** — Detection coverage heatmaps by technique
+- 📡 **Real-time Alerts** — Monitor SIEM alerts during live engagements
+
+### FREE vs PRO
+
+| Feature | FREE | PRO |
+|---------|------|-----|
+| Core features (scans, findings, credentials) | ✅ | ✅ |
+| Report generation | ✅ | ✅ |
+| AI-powered suggestions & auto-chaining | ❌ | ✅ |
+| Metasploit integration & exploit suggestions | ❌ | ✅ |
+| SIEM integration & detection validation | ❌ | ✅ |
+| MITRE ATT&CK reports | ❌ | ✅ |
+
+---
+
+## Quick Start
+
+### Step 1: Install Prerequisites
+
+```bash
+sudo apt install pipx    # Install pipx
+pipx ensurepath          # Add pipx apps to your PATH
+source ~/.bashrc         # Reload shell (Kali: use ~/.zshrc)
+```
+
+### Step 2: Install SoulEyez
+
+```bash
+pipx install souleyez
+```
+
+### Step 3: Launch SoulEyez
+
+```bash
+souleyez interactive
+```
+
+### Step 4: First-Time Setup
+
+On your first run, the setup wizard guides you through:
+
+1. **Vault Password** — Create a master password that encrypts sensitive data
+2. **First Engagement** — Set up your first project and select engagement type
+3. **Tool Check** — Detect and optionally install missing security tools
+4. **AI Setup** — Configure Ollama for AI features (optional)
+5. **Tutorial** — Option to run the interactive tutorial (recommended)
+
+### Step 5: You're Ready!
+
+Once setup completes, you'll see the main menu.
+
+---
+
+## System Requirements
+
+| Component | Minimum | Recommended |
+|-----------|---------|-------------|
+| **OS** | Ubuntu 22.04+ | Kali Linux |
+| **Python** | 3.9+ | 3.11+ |
+| **RAM** | 4GB | 8GB+ |
+| **Disk** | 10GB | 50GB+ |
+
+### Supported Operating Systems
+
+| OS | Status | Notes |
+|----|--------|-------|
+| **Kali Linux** | ✅ Recommended | All pentesting tools pre-installed |
+| **Ubuntu 22.04+** | ✅ Supported | Tools installed via `souleyez setup` |
+| **Parrot OS** | ✅ Supported | Security-focused distro |
+| **Debian 12+** | ✅ Supported | Stable base system |
+| **macOS/Windows** | ❌ Not Supported | Use Linux in a VM |
+
+---
+
+## Common Commands
+
+| Command | What it does |
+|---------|--------------|
+| `souleyez interactive` | Launch the main interface |
+| `souleyez dashboard` | Real-time monitoring view |
+| `souleyez doctor` | Check if everything is set up correctly |
+| `souleyez setup` | Install/update pentesting tools |
+| `souleyez --help` | Show all available commands |
+
+---
+
+## Security & Encryption
+
+SoulEyez encrypts all stored credentials using **Fernet (AES-128-CBC + HMAC-SHA256)** with PBKDF2 key derivation (600k iterations).
+
+- Master password is never stored (cannot be recovered if lost)
+- Credentials encrypted at rest with industry-standard cryptography
+- Sensitive data is masked in the UI until explicitly revealed
+
+See [SECURITY.md](SECURITY.md) for complete security guidelines.
+
+---
+
+## Documentation
+
+- **[Getting Started](souleyez/docs/user-guide/getting-started.md)** — Your first engagement in 10 minutes
+- **[Installation Guide](souleyez/docs/user-guide/installation.md)** — Detailed setup instructions
+- **[Workflows](souleyez/docs/user-guide/workflows.md)** — Complete pentesting workflows
+- **[Auto-Chaining](souleyez/docs/user-guide/auto-chaining.md)** — Automatic follow-up scans
+- **[Configuration](souleyez/docs/user-guide/configuration.md)** — All configuration options
+- **[Troubleshooting](souleyez/docs/user-guide/troubleshooting.md)** — Common issues and fixes
+
+---
+
+## Troubleshooting
+
+| Problem | Solution |
+|---------|----------|
+| "command not found: souleyez" | Run `pipx ensurepath` then restart terminal |
+| "Tool not found" errors | Run `souleyez setup` to install missing tools |
+| Forgot vault password | Data is encrypted — start fresh with `rm -rf ~/.souleyez` |
+| Something seems broken | Run `souleyez doctor` to diagnose |
+
+---
+
+## Glossary
+
+New to pentesting? Here are some common terms:
+
+| Term | Meaning |
+|------|---------|
+| **Engagement** | A project or assessment — contains all data for one test |
+| **Target/Host** | A computer, server, or device you're testing |
+| **Finding** | A security issue or vulnerability you discovered |
+| **Credential** | Username/password combo found during testing |
+
+---
+
+## Support & Feedback
+
+- **Issues**: https://github.com/cyber-soul-security/souleyez/issues
+- **Security Issues**: cysoul.secit@gmail.com (see [SECURITY.md](SECURITY.md))
+- **General**: cysoul.secit@gmail.com
+
+---
+
+## License
+
+See [LICENSE](LICENSE) for details.
+
+---
+
+**Version**: 2.43.21 | **Maintainer**: [CyberSoul Security](https://www.cybersoulsecurity.com)

souleyez-3.0.11/pyproject.toml

@@ -0,0 +1,95 @@
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "souleyez"
+version = "3.0.11"
+description = "AI-Powered Penetration Testing Platform with 40+ integrated tools"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [{name = "CyberSoul Security", email = "contact@cybersoulsecurity.com"}]
+maintainers = [{name = "CyberSoul Security", email = "contact@cybersoulsecurity.com"}]
+requires-python = ">=3.8"
+keywords = ["pentesting", "security", "hacking", "penetration-testing", "cybersecurity", "nmap", "metasploit"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Environment :: Console :: Curses",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Information Technology",
+    "Intended Audience :: System Administrators",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: MacOS",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Security",
+    "Topic :: System :: Networking",
+]
+
+dependencies = [
+    "anthropic>=0.40.0",
+    "click>=8.0.0",
+    "cryptography>=3.4.0",
+    "defusedxml>=0.7.0",
+    "impacket>=0.11.0",
+    "markdown>=3.4.0",
+    "msgpack>=1.0.0",
+    "ollama>=0.1.0",
+    "psycopg2-binary>=2.9.0",
+    "psutil>=5.9.0",
+    "python-json-logger>=2.0.0",
+    "requests>=2.28.0",
+    "rich>=10.0.0",
+    "wcwidth>=0.2.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/cyber-soul-security/SoulEyez"
+Documentation = "https://github.com/cyber-soul-security/SoulEyez#readme"
+Repository = "https://github.com/cyber-soul-security/SoulEyez.git"
+Issues = "https://github.com/cyber-soul-security/SoulEyez/issues"
+
+[project.optional-dependencies]
+dev = ["pytest>=7.0.0"]
+
+[project.scripts]
+souleyez = "souleyez.main:main"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["souleyez*"]
+exclude = ["tests*", "scripts*", "reports*", "venv*", "debian*"]
+
+[tool.setuptools.package-data]
+souleyez = ["docs/**/*.md", "data/wordlists/*.txt", "data/wordlists/*.md", "data/templates/*.json", "data/templates/*.md", "assets/*.png"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.coverage.run]
+omit = [
+    "souleyez/main.py",
+    "souleyez/ui/*",
+    "souleyez/reporting/generator.py",
+    "*/tests/*",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+]

souleyez-3.0.11/souleyez/__init__.py

@@ -0,0 +1 @@
+__version__ = "3.0.11"

souleyez-3.0.11/souleyez/ai/__init__.py

@@ -0,0 +1,35 @@
+"""
+souleyez.ai - AI-powered attack path recommendations and report generation
+"""
+
+from .claude_provider import (
+    ANTHROPIC_AVAILABLE,
+    ClaudeProvider,
+    clear_claude_api_key,
+    set_claude_api_key,
+)
+from .context_builder import ContextBuilder
+from .llm_factory import LLMFactory
+from .llm_provider import LLMProvider, LLMProviderType
+from .ollama_provider import OllamaProvider
+from .ollama_service import OLLAMA_AVAILABLE, OllamaService
+from .recommender import AttackRecommender
+from .report_context import ReportContextBuilder
+from .report_service import AIReportService
+
+__all__ = [
+    "OllamaService",
+    "ContextBuilder",
+    "AttackRecommender",
+    "OLLAMA_AVAILABLE",
+    "LLMProvider",
+    "LLMProviderType",
+    "OllamaProvider",
+    "ClaudeProvider",
+    "ANTHROPIC_AVAILABLE",
+    "set_claude_api_key",
+    "clear_claude_api_key",
+    "LLMFactory",
+    "ReportContextBuilder",
+    "AIReportService",
+]