souleyez 2.37.0__py3-none-any.whl → 2.38.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- souleyez/__init__.py +1 -1
- souleyez/docs/README.md +1 -1
- souleyez/main.py +1 -1
- souleyez-2.38.0.dist-info/METADATA +265 -0
- {souleyez-2.37.0.dist-info → souleyez-2.38.0.dist-info}/RECORD +9 -9
- souleyez-2.37.0.dist-info/METADATA +0 -319
- {souleyez-2.37.0.dist-info → souleyez-2.38.0.dist-info}/WHEEL +0 -0
- {souleyez-2.37.0.dist-info → souleyez-2.38.0.dist-info}/entry_points.txt +0 -0
- {souleyez-2.37.0.dist-info → souleyez-2.38.0.dist-info}/licenses/LICENSE +0 -0
- {souleyez-2.37.0.dist-info → souleyez-2.38.0.dist-info}/top_level.txt +0 -0
souleyez/__init__.py
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
__version__ = '2.
|
|
1
|
+
__version__ = '2.38.0'
|
|
2
2
|
|
souleyez/docs/README.md
CHANGED
souleyez/main.py
CHANGED
|
@@ -173,7 +173,7 @@ def _check_privileged_tools():
|
|
|
173
173
|
|
|
174
174
|
|
|
175
175
|
@click.group()
|
|
176
|
-
@click.version_option(version='2.
|
|
176
|
+
@click.version_option(version='2.38.0')
|
|
177
177
|
def cli():
|
|
178
178
|
"""SoulEyez - AI-Powered Pentesting Platform by CyberSoul Security"""
|
|
179
179
|
from souleyez.log_config import init_logging
|
|
@@ -0,0 +1,265 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: souleyez
|
|
3
|
+
Version: 2.38.0
|
|
4
|
+
Summary: AI-Powered Penetration Testing Platform with 40+ integrated tools
|
|
5
|
+
Author-email: CyberSoul Security <contact@cybersoulsecurity.com>
|
|
6
|
+
Maintainer-email: CyberSoul Security <contact@cybersoulsecurity.com>
|
|
7
|
+
License: MIT
|
|
8
|
+
Project-URL: Homepage, https://github.com/cyber-soul-security/SoulEyez
|
|
9
|
+
Project-URL: Documentation, https://github.com/cyber-soul-security/SoulEyez#readme
|
|
10
|
+
Project-URL: Repository, https://github.com/cyber-soul-security/SoulEyez.git
|
|
11
|
+
Project-URL: Issues, https://github.com/cyber-soul-security/SoulEyez/issues
|
|
12
|
+
Keywords: pentesting,security,hacking,penetration-testing,cybersecurity,nmap,metasploit
|
|
13
|
+
Classifier: Development Status :: 4 - Beta
|
|
14
|
+
Classifier: Environment :: Console
|
|
15
|
+
Classifier: Environment :: Console :: Curses
|
|
16
|
+
Classifier: Intended Audience :: Developers
|
|
17
|
+
Classifier: Intended Audience :: Information Technology
|
|
18
|
+
Classifier: Intended Audience :: System Administrators
|
|
19
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
20
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
21
|
+
Classifier: Operating System :: MacOS
|
|
22
|
+
Classifier: Programming Language :: Python :: 3
|
|
23
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
24
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
25
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
26
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
27
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
28
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
29
|
+
Classifier: Topic :: Security
|
|
30
|
+
Classifier: Topic :: System :: Networking
|
|
31
|
+
Requires-Python: >=3.8
|
|
32
|
+
Description-Content-Type: text/markdown
|
|
33
|
+
License-File: LICENSE
|
|
34
|
+
Requires-Dist: anthropic>=0.40.0
|
|
35
|
+
Requires-Dist: click>=8.0.0
|
|
36
|
+
Requires-Dist: cryptography>=3.4.0
|
|
37
|
+
Requires-Dist: defusedxml>=0.7.0
|
|
38
|
+
Requires-Dist: impacket>=0.11.0
|
|
39
|
+
Requires-Dist: markdown>=3.4.0
|
|
40
|
+
Requires-Dist: msgpack>=1.0.0
|
|
41
|
+
Requires-Dist: ollama>=0.1.0
|
|
42
|
+
Requires-Dist: psycopg2-binary>=2.9.0
|
|
43
|
+
Requires-Dist: psutil>=5.9.0
|
|
44
|
+
Requires-Dist: python-json-logger>=2.0.0
|
|
45
|
+
Requires-Dist: requests>=2.28.0
|
|
46
|
+
Requires-Dist: rich>=10.0.0
|
|
47
|
+
Requires-Dist: wcwidth>=0.2.0
|
|
48
|
+
Provides-Extra: dev
|
|
49
|
+
Requires-Dist: pytest>=7.0.0; extra == "dev"
|
|
50
|
+
Dynamic: license-file
|
|
51
|
+
|
|
52
|
+
# SoulEyez — AI-Powered Penetration Testing Platform
|
|
53
|
+
|
|
54
|
+
[](https://github.com/cyber-soul-security/souleyez/actions/workflows/python-ci.yml)
|
|
55
|
+
[](https://codecov.io/gh/cyber-soul-security/souleyez)
|
|
56
|
+
[](https://www.python.org/downloads/)
|
|
57
|
+
[](https://github.com/psf/black)
|
|
58
|
+
[](https://github.com/PyCQA/bandit)
|
|
59
|
+
|
|
60
|
+
**LEGAL NOTICE — Use Responsibly**
|
|
61
|
+
Only use SoulEyez on systems you own or have explicit written permission to test.
|
|
62
|
+
Unauthorized scanning or exploitation is illegal. The authors are not responsible for misuse.
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## Features
|
|
67
|
+
|
|
68
|
+
### Core Capabilities
|
|
69
|
+
- 🎯 **Interactive Dashboard** - Real-time engagement monitoring with live updates
|
|
70
|
+
- 🔗 **Smart Tool Chaining** - Automatic follow-up scans based on discoveries
|
|
71
|
+
- 📊 **Findings Management** - Track and categorize vulnerabilities by severity
|
|
72
|
+
- 🔑 **Credential Vault** - Encrypted storage for discovered credentials
|
|
73
|
+
- 🌐 **Network Mapping** - Host discovery and service enumeration
|
|
74
|
+
- 📈 **Progress Tracking** - Monitor scan completion and tool execution
|
|
75
|
+
- 💾 **SQLite Storage** - Local database for all engagement data
|
|
76
|
+
- 🔄 **Background Jobs** - Queue-based tool execution with status monitoring
|
|
77
|
+
|
|
78
|
+
### Integrated Tools (40+)
|
|
79
|
+
- **Reconnaissance**: nmap, masscan, theHarvester, whois, dnsrecon
|
|
80
|
+
- **Web Testing**: nikto, gobuster, ffuf, sqlmap, nuclei, wpscan
|
|
81
|
+
- **Enumeration**: enum4linux-ng, smbmap, crackmapexec, snmpwalk
|
|
82
|
+
- **Exploitation**: Metasploit integration, searchsploit
|
|
83
|
+
- **Password Attacks**: hydra, hashcat, john
|
|
84
|
+
- **Post-Exploitation**: impacket suite, bloodhound
|
|
85
|
+
|
|
86
|
+
### Pentest Workflow & Intelligence
|
|
87
|
+
- 📁 **Evidence Vault** - Unified artifact collection organized by PTES phases
|
|
88
|
+
- 🎯 **Attack Surface Dashboard** - Track what's exploited vs pending with priority scoring
|
|
89
|
+
- 💣 **Exploit Suggestions** - Automatic CVE/Metasploit recommendations for discovered services
|
|
90
|
+
- 🔗 **Correlation Engine** - Cross-phase attack tracking and gap analysis
|
|
91
|
+
- 📝 **Report Generator** - Professional reports in Markdown/HTML/PDF formats
|
|
92
|
+
- ✅ **Deliverable Tracking** - Manage testing requirements and acceptance criteria
|
|
93
|
+
- 📸 **Screenshot Management** - Organized visual evidence by methodology phase
|
|
94
|
+
|
|
95
|
+
### Purple Team / SIEM Integration
|
|
96
|
+
- 🛡️ **Wazuh Integration** - Connect to Wazuh Manager for detection validation
|
|
97
|
+
- 📊 **Splunk Integration** - Query Splunk for alerts and vulnerability data
|
|
98
|
+
- ✓ **Detection Validation** - Verify if your attacks triggered SIEM alerts
|
|
99
|
+
- 🔍 **Vulnerability Management** - View CVEs from Wazuh agents synced to Splunk
|
|
100
|
+
- ⚖️ **Gap Analysis** - Compare passive (SIEM) vs active (scan) findings
|
|
101
|
+
- 🗺️ **MITRE ATT&CK Reports** - Detection coverage heatmaps by technique
|
|
102
|
+
- 📡 **Real-time Alerts** - Monitor SIEM alerts during live engagements
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
## 🔐 Security & Data Protection
|
|
107
|
+
|
|
108
|
+
### Credential Encryption
|
|
109
|
+
|
|
110
|
+
SoulEyez encrypts all stored credentials using Fernet (AES-128-CBC + HMAC-SHA256) with PBKDF2 key derivation (600k iterations).
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
# Enable encryption with master password
|
|
114
|
+
souleyez db encrypt
|
|
115
|
+
|
|
116
|
+
# Add credentials (automatically encrypted)
|
|
117
|
+
souleyez creds add --username admin --password secret123 --service ssh --host 10.0.0.82
|
|
118
|
+
|
|
119
|
+
# View credentials (requires master password)
|
|
120
|
+
souleyez creds list
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
**Key Points:**
|
|
124
|
+
- Master password is never stored (cannot be recovered if lost)
|
|
125
|
+
- Credentials encrypted at rest with industry-standard cryptography
|
|
126
|
+
- Dashboard shows masked values (••••••••) until explicitly revealed
|
|
127
|
+
- Each user should maintain their own database
|
|
128
|
+
|
|
129
|
+
### Data Masking
|
|
130
|
+
|
|
131
|
+
Sensitive data is automatically masked in the UI:
|
|
132
|
+
- Passwords: `Su***********3!`
|
|
133
|
+
- Credit card numbers: `45**************34`
|
|
134
|
+
- Access warning prompts before viewing sensitive data
|
|
135
|
+
|
|
136
|
+
See [SECURITY.md](SECURITY.md) for complete security guidelines.
|
|
137
|
+
|
|
138
|
+
---
|
|
139
|
+
|
|
140
|
+
## 📝 Configuration
|
|
141
|
+
|
|
142
|
+
SoulEyez uses a flexible configuration system:
|
|
143
|
+
|
|
144
|
+
1. **Environment Variables** - `SOULEYEZ_*` prefix (highest priority)
|
|
145
|
+
2. **Config File** - `~/.souleyez/config.json` (auto-created)
|
|
146
|
+
3. **Default Values** - Built-in safe defaults
|
|
147
|
+
|
|
148
|
+
```bash
|
|
149
|
+
# Edit config file
|
|
150
|
+
nano ~/.souleyez/config.json
|
|
151
|
+
|
|
152
|
+
# Or use environment variables
|
|
153
|
+
export SOULEYEZ_DATABASE_PATH=/custom/path/souleyez.db
|
|
154
|
+
export SOULEYEZ_LOGGING_LEVEL=DEBUG
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
See [docs/CONFIG.md](souleyez/docs/CONFIG.md) for complete configuration options.
|
|
158
|
+
|
|
159
|
+
---
|
|
160
|
+
|
|
161
|
+
## Supported Operating Systems
|
|
162
|
+
|
|
163
|
+
| OS | Status | Notes |
|
|
164
|
+
|----|--------|-------|
|
|
165
|
+
| **Kali Linux** | ✅ Recommended | All pentesting tools pre-installed |
|
|
166
|
+
| **Ubuntu 22.04+** | ✅ Supported | Tools installed via `souleyez setup` |
|
|
167
|
+
| **Parrot OS** | ✅ Supported | Security-focused distro |
|
|
168
|
+
| **Debian 12+** | ✅ Supported | Stable base system |
|
|
169
|
+
| **Other Linux** | ⚠️ Unofficial | Manual testing required |
|
|
170
|
+
| **macOS/Windows** | ❌ Not Supported | Use Linux in a VM |
|
|
171
|
+
|
|
172
|
+
**Architectures:** AMD64, ARM64
|
|
173
|
+
|
|
174
|
+
---
|
|
175
|
+
|
|
176
|
+
## System Requirements
|
|
177
|
+
|
|
178
|
+
| Component | Minimum | Recommended |
|
|
179
|
+
|-----------|---------|-------------|
|
|
180
|
+
| **CPU** | 2 cores | 4+ cores |
|
|
181
|
+
| **RAM** | 4GB | 8GB+ |
|
|
182
|
+
| **Disk** | 10GB | 50GB+ |
|
|
183
|
+
| **GPU** | None | Optional (for hashcat) |
|
|
184
|
+
|
|
185
|
+
---
|
|
186
|
+
|
|
187
|
+
## Installation
|
|
188
|
+
|
|
189
|
+
```bash
|
|
190
|
+
# Install pipx if needed
|
|
191
|
+
sudo apt install pipx
|
|
192
|
+
pipx ensurepath
|
|
193
|
+
source ~/.bashrc # Kali Linux: use 'source ~/.zshrc' instead
|
|
194
|
+
|
|
195
|
+
# Install SoulEyez
|
|
196
|
+
pipx install souleyez
|
|
197
|
+
|
|
198
|
+
# Install pentesting tools
|
|
199
|
+
souleyez setup
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
> **Kali Linux users:** Kali uses zsh by default. Use `source ~/.zshrc` instead of `source ~/.bashrc`
|
|
203
|
+
|
|
204
|
+
See [docs/user-guide/installation.md](souleyez/docs/user-guide/installation.md) for detailed instructions.
|
|
205
|
+
|
|
206
|
+
---
|
|
207
|
+
|
|
208
|
+
## Usage
|
|
209
|
+
|
|
210
|
+
### Interactive Mode (Recommended)
|
|
211
|
+
|
|
212
|
+
```bash
|
|
213
|
+
souleyez interactive
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
Menu-driven interface with guided workflows, tool selection by phase, and integrated help.
|
|
217
|
+
|
|
218
|
+
### Dashboard
|
|
219
|
+
|
|
220
|
+
```bash
|
|
221
|
+
souleyez dashboard
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
Real-time monitoring with hotkeys: `[h]` Help, `[a]` Auto-chain, `[m]` Menu, `[q]` Quit
|
|
225
|
+
|
|
226
|
+
### Command Line
|
|
227
|
+
|
|
228
|
+
```bash
|
|
229
|
+
# Engagement management
|
|
230
|
+
souleyez workspace create <name>
|
|
231
|
+
souleyez workspace use <name>
|
|
232
|
+
|
|
233
|
+
# Run scans
|
|
234
|
+
souleyez run nmap <target>
|
|
235
|
+
souleyez run gobuster <target>
|
|
236
|
+
|
|
237
|
+
# View results
|
|
238
|
+
souleyez findings list
|
|
239
|
+
souleyez creds list
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
---
|
|
243
|
+
|
|
244
|
+
## Documentation
|
|
245
|
+
|
|
246
|
+
- **[Installation Guide](souleyez/docs/user-guide/installation.md)** - Setup instructions
|
|
247
|
+
- **[Getting Started](souleyez/docs/user-guide/getting-started.md)** - Quick start guide
|
|
248
|
+
- **[Workflows](souleyez/docs/user-guide/workflows.md)** - Complete pentesting workflows
|
|
249
|
+
- **[Evidence Vault](souleyez/docs/user-guide/evidence-vault.md)** - Artifact collection
|
|
250
|
+
- **[Report Generation](souleyez/docs/user-guide/report-generation.md)** - Professional reports
|
|
251
|
+
- **[SECURITY.md](SECURITY.md)** - Security best practices
|
|
252
|
+
- **[AUTO_CHAINING_GUIDE.md](AUTO_CHAINING_GUIDE.md)** - Automated workflows
|
|
253
|
+
|
|
254
|
+
---
|
|
255
|
+
|
|
256
|
+
## Support
|
|
257
|
+
|
|
258
|
+
- **GitHub Issues**: https://github.com/cyber-soul-security/SoulEyez/issues
|
|
259
|
+
- **Security Issues**: Report privately (see SECURITY.md)
|
|
260
|
+
|
|
261
|
+
---
|
|
262
|
+
|
|
263
|
+
## License
|
|
264
|
+
|
|
265
|
+
See [LICENSE](LICENSE) for details.
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
souleyez/__init__.py,sha256=
|
|
1
|
+
souleyez/__init__.py,sha256=f9RVuYnnKRJ33OuCsEabLjoQDKxZuTUKB8ZkC9tixyQ,24
|
|
2
2
|
souleyez/config.py,sha256=av357I3GYRWAklv8Dto-9-5Db699Wq5znez7zo7241Q,11595
|
|
3
3
|
souleyez/devtools.py,sha256=rptmUY4a5eVvYjdEc6273MSagL-D9xibPOFgohVqUno,3508
|
|
4
4
|
souleyez/feature_flags.py,sha256=mo6YAq07lc6sR3lEFKmIwTKxXZ2JPxwa5X97uR_mu50,4642
|
|
5
5
|
souleyez/history.py,sha256=gzs5I_j-3OigIP6yfmBChdqxaFmyUIxvTpzWUPe_Q6c,2853
|
|
6
6
|
souleyez/log_config.py,sha256=MMhPAJOqgXDfuE-xm5g0RxAfWndcmbhFHvIEMm1a_Wo,5830
|
|
7
|
-
souleyez/main.py,sha256=
|
|
7
|
+
souleyez/main.py,sha256=T1mZzCtBHHLxdC8t1pU6gsL3sNuJiznnK-2DO8ixD8Y,130228
|
|
8
8
|
souleyez/scanner.py,sha256=U3IWHRrJ5aQ32dSHiVAHB60w1R_z0E0QxfM99msYNlw,3124
|
|
9
9
|
souleyez/security.py,sha256=S84m1QmnKz_6NgH2I6IBIAorMHxRPNYVFSnks5xjihQ,2479
|
|
10
10
|
souleyez/ui.py,sha256=15pfsqoDPnojAqr5S0TZHJE2ZkSHzkHpNVfVvsRj66A,34301
|
|
@@ -104,7 +104,7 @@ souleyez/detection/__init__.py,sha256=QIhvXjFdjrquQ6A0VQ7GZQkK_EXB59t8Dv9PKXhEUe
|
|
|
104
104
|
souleyez/detection/attack_signatures.py,sha256=akgWwiIkh6WYnghCuLhRV0y6FS0SQ0caGF8tZUc49oA,6965
|
|
105
105
|
souleyez/detection/mitre_mappings.py,sha256=xejE80YK-g8kKaeQoo-vBl8P3t8RTTItbfN0NaVZw6s,20558
|
|
106
106
|
souleyez/detection/validator.py,sha256=-AJ7QSJ3-6jFKLnPG_Rc34IXyF4JPyI82BFUgTA9zw0,15641
|
|
107
|
-
souleyez/docs/README.md,sha256=
|
|
107
|
+
souleyez/docs/README.md,sha256=kzKJmSAw_B9RrAlbGXkfbvtNkCoTP8MzfOABhpkbvk4,7183
|
|
108
108
|
souleyez/docs/api-reference/cli-commands.md,sha256=lTLFnILN3YRVdqCaag7WgsYXfDGglb1TuPexkxDsVdE,12917
|
|
109
109
|
souleyez/docs/api-reference/engagement-api.md,sha256=nd-EvQMtiJrobg2bzFEADp853HP1Uhb9dmgok0_-neE,11672
|
|
110
110
|
souleyez/docs/api-reference/integration-guide.md,sha256=c96uX79ukHyYotLa54wZ20Kx-EUZnrKegTeGkfLD-pw,16285
|
|
@@ -370,9 +370,9 @@ souleyez/ui/tutorial_state.py,sha256=Thf7_qCj4VKjG7UqgJqa9kjIqiFUU-7Q7kG4v-u2B4A
|
|
|
370
370
|
souleyez/ui/wazuh_vulns_view.py,sha256=3vJJEmrjgS2wD6EDB7ZV7WxgytBHTm-1WqNDjp7lVEI,21830
|
|
371
371
|
souleyez/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
372
372
|
souleyez/utils/tool_checker.py,sha256=kQcXJVY5NiO-orQAUnpHhpQvR5UOBNHJ0PaT0fBxYoQ,30782
|
|
373
|
-
souleyez-2.
|
|
374
|
-
souleyez-2.
|
|
375
|
-
souleyez-2.
|
|
376
|
-
souleyez-2.
|
|
377
|
-
souleyez-2.
|
|
378
|
-
souleyez-2.
|
|
373
|
+
souleyez-2.38.0.dist-info/licenses/LICENSE,sha256=J7vDD5QMF4w2oSDm35eBgosATE70ah1M40u9W4EpTZs,1090
|
|
374
|
+
souleyez-2.38.0.dist-info/METADATA,sha256=85YhOlEVxfPfRBF2G5ED4qXWRaQyX92NnHwedWwvVmQ,9434
|
|
375
|
+
souleyez-2.38.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
|
|
376
|
+
souleyez-2.38.0.dist-info/entry_points.txt,sha256=bN5W1dhjDZJl3TKclMjRpfQvGPmyrJLwwDuCj_X39HE,48
|
|
377
|
+
souleyez-2.38.0.dist-info/top_level.txt,sha256=afAMzS9p4lcdBNxhGo6jl3ipQE9HUvvNIPOdjtPjr_Q,9
|
|
378
|
+
souleyez-2.38.0.dist-info/RECORD,,
|
|
@@ -1,319 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.4
|
|
2
|
-
Name: souleyez
|
|
3
|
-
Version: 2.37.0
|
|
4
|
-
Summary: AI-Powered Penetration Testing Platform with 40+ integrated tools
|
|
5
|
-
Author-email: CyberSoul Security <contact@cybersoulsecurity.com>
|
|
6
|
-
Maintainer-email: CyberSoul Security <contact@cybersoulsecurity.com>
|
|
7
|
-
License: MIT
|
|
8
|
-
Project-URL: Homepage, https://github.com/cyber-soul-security/SoulEyez
|
|
9
|
-
Project-URL: Documentation, https://github.com/cyber-soul-security/SoulEyez#readme
|
|
10
|
-
Project-URL: Repository, https://github.com/cyber-soul-security/SoulEyez.git
|
|
11
|
-
Project-URL: Issues, https://github.com/cyber-soul-security/SoulEyez/issues
|
|
12
|
-
Keywords: pentesting,security,hacking,penetration-testing,cybersecurity,nmap,metasploit
|
|
13
|
-
Classifier: Development Status :: 4 - Beta
|
|
14
|
-
Classifier: Environment :: Console
|
|
15
|
-
Classifier: Environment :: Console :: Curses
|
|
16
|
-
Classifier: Intended Audience :: Developers
|
|
17
|
-
Classifier: Intended Audience :: Information Technology
|
|
18
|
-
Classifier: Intended Audience :: System Administrators
|
|
19
|
-
Classifier: License :: OSI Approved :: MIT License
|
|
20
|
-
Classifier: Operating System :: POSIX :: Linux
|
|
21
|
-
Classifier: Operating System :: MacOS
|
|
22
|
-
Classifier: Programming Language :: Python :: 3
|
|
23
|
-
Classifier: Programming Language :: Python :: 3.8
|
|
24
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
25
|
-
Classifier: Programming Language :: Python :: 3.10
|
|
26
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
27
|
-
Classifier: Programming Language :: Python :: 3.12
|
|
28
|
-
Classifier: Programming Language :: Python :: 3.13
|
|
29
|
-
Classifier: Topic :: Security
|
|
30
|
-
Classifier: Topic :: System :: Networking
|
|
31
|
-
Requires-Python: >=3.8
|
|
32
|
-
Description-Content-Type: text/markdown
|
|
33
|
-
License-File: LICENSE
|
|
34
|
-
Requires-Dist: anthropic>=0.40.0
|
|
35
|
-
Requires-Dist: click>=8.0.0
|
|
36
|
-
Requires-Dist: cryptography>=3.4.0
|
|
37
|
-
Requires-Dist: defusedxml>=0.7.0
|
|
38
|
-
Requires-Dist: impacket>=0.11.0
|
|
39
|
-
Requires-Dist: markdown>=3.4.0
|
|
40
|
-
Requires-Dist: msgpack>=1.0.0
|
|
41
|
-
Requires-Dist: ollama>=0.1.0
|
|
42
|
-
Requires-Dist: psycopg2-binary>=2.9.0
|
|
43
|
-
Requires-Dist: psutil>=5.9.0
|
|
44
|
-
Requires-Dist: python-json-logger>=2.0.0
|
|
45
|
-
Requires-Dist: requests>=2.28.0
|
|
46
|
-
Requires-Dist: rich>=10.0.0
|
|
47
|
-
Requires-Dist: wcwidth>=0.2.0
|
|
48
|
-
Provides-Extra: dev
|
|
49
|
-
Requires-Dist: pytest>=7.0.0; extra == "dev"
|
|
50
|
-
Dynamic: license-file
|
|
51
|
-
|
|
52
|
-
# SoulEyez Beta Program
|
|
53
|
-
|
|
54
|
-
[](https://github.com/cyber-soul-security/souleyez/actions/workflows/python-ci.yml)
|
|
55
|
-
[](https://codecov.io/gh/cyber-soul-security/souleyez)
|
|
56
|
-
[](https://www.python.org/downloads/)
|
|
57
|
-
[](https://github.com/psf/black)
|
|
58
|
-
[](https://github.com/PyCQA/bandit)
|
|
59
|
-
|
|
60
|
-
Welcome to the SoulEyez beta! Thank you for helping us test and improve this penetration testing management platform.
|
|
61
|
-
|
|
62
|
-
---
|
|
63
|
-
|
|
64
|
-
## What is SoulEyez?
|
|
65
|
-
|
|
66
|
-
**SoulEyez is your penetration testing command center.** Instead of juggling dozens of terminal windows and text files, SoulEyez gives you one organized place to:
|
|
67
|
-
|
|
68
|
-
- **Run security scans** - Execute tools like Nmap, Gobuster, SQLMap with simple commands
|
|
69
|
-
- **Auto-discover next steps** - When one scan finds something interesting, SoulEyez automatically suggests (or runs) the next logical tool
|
|
70
|
-
- **Stay organized** - Keep all your targets, findings, and credentials in one searchable database
|
|
71
|
-
- **Generate reports** - Export professional reports when you're done
|
|
72
|
-
|
|
73
|
-
### Who is this for?
|
|
74
|
-
|
|
75
|
-
- **Security professionals** conducting authorized penetration tests
|
|
76
|
-
- **CTF players** who want better organization during competitions
|
|
77
|
-
- **Students** learning penetration testing methodology
|
|
78
|
-
|
|
79
|
-
> ⚠️ **Important**: Only use SoulEyez on systems you have explicit authorization to test.
|
|
80
|
-
|
|
81
|
-
## Version: 2.37.0
|
|
82
|
-
|
|
83
|
-
### What's Included
|
|
84
|
-
|
|
85
|
-
| Feature | FREE Tier | PRO Tier |
|
|
86
|
-
|---------|-----------|----------|
|
|
87
|
-
| **Core Features** | | |
|
|
88
|
-
| Run security scans | ✅ | ✅ |
|
|
89
|
-
| Organize targets & findings | ✅ | ✅ |
|
|
90
|
-
| Encrypted credential storage | ✅ | ✅ |
|
|
91
|
-
| 20+ integrated tools | ✅ | ✅ |
|
|
92
|
-
| Report generation | ✅ | ✅ |
|
|
93
|
-
| **AI & Automation** | | |
|
|
94
|
-
| AI-powered suggestions | ❌ | ✅ |
|
|
95
|
-
| Automatic tool chaining | ❌ | ✅ |
|
|
96
|
-
| AI Execute (natural language commands) | ❌ | ✅ |
|
|
97
|
-
| **Exploitation** | | |
|
|
98
|
-
| Metasploit integration | ❌ | ✅ |
|
|
99
|
-
| Exploit suggestions (MSF modules) | ❌ | ✅ |
|
|
100
|
-
| Exploitation progress tracking | ❌ | ✅ |
|
|
101
|
-
| **SIEM Integration (Purple Team)** | | |
|
|
102
|
-
| Wazuh integration | ❌ | ✅ |
|
|
103
|
-
| Splunk integration | ❌ | ✅ |
|
|
104
|
-
| Detection validation | ❌ | ✅ |
|
|
105
|
-
| Vulnerability management views | ❌ | ✅ |
|
|
106
|
-
| Gap analysis (passive vs active) | ❌ | ✅ |
|
|
107
|
-
| MITRE ATT&CK detection reports | ❌ | ✅ |
|
|
108
|
-
| **Intelligence Hub** | | |
|
|
109
|
-
| Attack surface scoring | ❌ | ✅ |
|
|
110
|
-
| Exploitation gaps analysis | ❌ | ✅ |
|
|
111
|
-
| Real-time SIEM alerts | ❌ | ✅ |
|
|
112
|
-
|
|
113
|
-
### System Requirements
|
|
114
|
-
|
|
115
|
-
- **Operating System**: Kali Linux or Ubuntu 22.04+ (Windows users: use WSL)
|
|
116
|
-
- **Python**: 3.8 or newer
|
|
117
|
-
- **Storage**: ~500MB for SoulEyez + tools
|
|
118
|
-
|
|
119
|
-
> **🐉 Kali Linux Recommended**
|
|
120
|
-
>
|
|
121
|
-
> SoulEyez performs significantly better on **Kali Linux** than other distributions:
|
|
122
|
-
> - All pentesting tools pre-installed and optimized
|
|
123
|
-
> - Metasploit database and RPC already configured
|
|
124
|
-
> - Security-focused kernel and networking stack
|
|
125
|
-
> - No dependency hunting or version conflicts
|
|
126
|
-
> - Wordlists, databases, and tool configs ready to go
|
|
127
|
-
>
|
|
128
|
-
> While Ubuntu and other Debian-based distros are supported, you may experience slower setup times and occasional tool compatibility issues.
|
|
129
|
-
|
|
130
|
-
### Known Issues
|
|
131
|
-
|
|
132
|
-
- Very large scan outputs (>10MB) may slow the interface
|
|
133
|
-
- Some edge cases in tool output parsing
|
|
134
|
-
|
|
135
|
-
## Quick Start (Step-by-Step)
|
|
136
|
-
|
|
137
|
-
### Step 1: Install Prerequisites
|
|
138
|
-
|
|
139
|
-
First, we need `pipx` - a tool that safely installs Python CLI apps:
|
|
140
|
-
|
|
141
|
-
```bash
|
|
142
|
-
sudo apt install pipx # Install pipx
|
|
143
|
-
pipx ensurepath # Add pipx apps to your PATH
|
|
144
|
-
source ~/.bashrc # Reload your shell (or close and reopen terminal)
|
|
145
|
-
```
|
|
146
|
-
|
|
147
|
-
> **Kali Linux users:** Kali uses zsh by default. Use `source ~/.zshrc` instead of `source ~/.bashrc`
|
|
148
|
-
|
|
149
|
-
> 💡 **What's pipx?** It's like `apt` but for Python command-line tools. It keeps each tool isolated so they don't conflict with each other.
|
|
150
|
-
|
|
151
|
-
### Step 2: Install SoulEyez
|
|
152
|
-
|
|
153
|
-
```bash
|
|
154
|
-
pipx install souleyez
|
|
155
|
-
```
|
|
156
|
-
|
|
157
|
-
This downloads SoulEyez and all its dependencies. Takes 1-2 minutes.
|
|
158
|
-
|
|
159
|
-
### Step 3: Launch SoulEyez
|
|
160
|
-
|
|
161
|
-
```bash
|
|
162
|
-
souleyez dashboard
|
|
163
|
-
```
|
|
164
|
-
|
|
165
|
-
### Step 4: First-Time Setup Wizard
|
|
166
|
-
|
|
167
|
-
On your first run, SoulEyez guides you through setup:
|
|
168
|
-
|
|
169
|
-
1. **Tool Installation** - Detects missing security tools (nmap, sqlmap, etc.) and offers to install them
|
|
170
|
-
2. **Vault Password** - You'll create a master password that encrypts sensitive data
|
|
171
|
-
3. **Admin Account** - Create your login credentials
|
|
172
|
-
4. **First Engagement** - Set up your first project (like "Home Lab Test" or "CTF Challenge")
|
|
173
|
-
|
|
174
|
-
> 💡 **What's an engagement?** Think of it as a project folder. Everything you discover during a test (hosts, services, credentials) is stored in that engagement.
|
|
175
|
-
|
|
176
|
-
### Step 5: You're Ready!
|
|
177
|
-
|
|
178
|
-
Once setup completes, you'll see the main menu. Navigate using the numbered options.
|
|
179
|
-
|
|
180
|
-
**Recommended: Run the built-in tutorial!**
|
|
181
|
-
|
|
182
|
-
Go to: **Settings & Security** → **[t] Tutorial**
|
|
183
|
-
|
|
184
|
-
The interactive tutorial walks you through:
|
|
185
|
-
1. Creating your first engagement
|
|
186
|
-
2. Running a basic reconnaissance scan
|
|
187
|
-
3. Viewing and understanding results
|
|
188
|
-
4. Using the real-time dashboard
|
|
189
|
-
5. Next steps and tips
|
|
190
|
-
|
|
191
|
-
---
|
|
192
|
-
|
|
193
|
-
## Common Commands
|
|
194
|
-
|
|
195
|
-
Here are the commands you'll use most often:
|
|
196
|
-
|
|
197
|
-
| Command | What it does |
|
|
198
|
-
|---------|--------------|
|
|
199
|
-
| `souleyez dashboard` | Launch the main interface |
|
|
200
|
-
| `souleyez doctor` | Check if everything is set up correctly |
|
|
201
|
-
| `souleyez setup` | Install/update pentesting tools |
|
|
202
|
-
| `souleyez --help` | Show all available commands |
|
|
203
|
-
| `souleyez <command> --help` | Get help for a specific command |
|
|
204
|
-
|
|
205
|
-
### Quick Troubleshooting
|
|
206
|
-
|
|
207
|
-
| Problem | Solution |
|
|
208
|
-
|---------|----------|
|
|
209
|
-
| "command not found: souleyez" | Run `pipx ensurepath` then restart your terminal |
|
|
210
|
-
| "Tool not found" errors | Run `souleyez setup` to install missing tools |
|
|
211
|
-
| Forgot your password | Data is encrypted - you'll need to start fresh with `rm -rf ~/.souleyez` |
|
|
212
|
-
| Something seems broken | Run `souleyez doctor` to diagnose the issue |
|
|
213
|
-
|
|
214
|
-
---
|
|
215
|
-
|
|
216
|
-
## Reporting Issues & Feedback
|
|
217
|
-
|
|
218
|
-
### Email (Preferred for Beta)
|
|
219
|
-
**cysoul.secit@gmail.com**
|
|
220
|
-
|
|
221
|
-
When reporting issues, please include:
|
|
222
|
-
- SoulEyez version (`souleyez --version`)
|
|
223
|
-
- Operating system and version
|
|
224
|
-
- Steps to reproduce
|
|
225
|
-
- Error messages (screenshots or copy/paste)
|
|
226
|
-
- Expected vs actual behavior
|
|
227
|
-
|
|
228
|
-
### Bug Report Template
|
|
229
|
-
```
|
|
230
|
-
**Description:**
|
|
231
|
-
[Brief description of the issue]
|
|
232
|
-
|
|
233
|
-
**Steps to Reproduce:**
|
|
234
|
-
1.
|
|
235
|
-
2.
|
|
236
|
-
3.
|
|
237
|
-
|
|
238
|
-
**Expected Behavior:**
|
|
239
|
-
[What should happen]
|
|
240
|
-
|
|
241
|
-
**Actual Behavior:**
|
|
242
|
-
[What actually happens]
|
|
243
|
-
|
|
244
|
-
**Environment:**
|
|
245
|
-
- OS:
|
|
246
|
-
- Python:
|
|
247
|
-
- SoulEyez version:
|
|
248
|
-
|
|
249
|
-
**Screenshots/Logs:**
|
|
250
|
-
[If applicable]
|
|
251
|
-
```
|
|
252
|
-
|
|
253
|
-
### Feature Requests
|
|
254
|
-
We welcome feature suggestions! Please prefix your issue title with `[Feature Request]`.
|
|
255
|
-
|
|
256
|
-
## Security Vulnerabilities
|
|
257
|
-
|
|
258
|
-
For security-related issues, please do NOT open a public GitHub issue.
|
|
259
|
-
|
|
260
|
-
Contact: cysoul.secit@gmail.com
|
|
261
|
-
|
|
262
|
-
Or see [SECURITY.md](SECURITY.md) for our security policy.
|
|
263
|
-
|
|
264
|
-
## Beta Feedback Survey
|
|
265
|
-
|
|
266
|
-
Help us improve SoulEyez by completing our quick feedback survey:
|
|
267
|
-
|
|
268
|
-
**[Take the Beta Feedback Survey](https://docs.google.com/forms/d/e/1FAIpQLSfylyvCor681VLeP7qGgFRDHCyzRDCFhiyjE6IqLbQDUB6-Jg/viewform?usp=send_form)**
|
|
269
|
-
|
|
270
|
-
## Beta Testing Guidelines
|
|
271
|
-
|
|
272
|
-
### What We Need Tested
|
|
273
|
-
- [ ] Full workflow: Create engagement → Add hosts → Run scans → Record findings → Generate report
|
|
274
|
-
- [ ] Credential encryption/decryption cycle
|
|
275
|
-
- [ ] Multi-user collaboration features
|
|
276
|
-
- [ ] Tool parsers (especially edge cases)
|
|
277
|
-
- [ ] Auto-chaining behavior
|
|
278
|
-
- [ ] Report generation quality
|
|
279
|
-
- [ ] UI responsiveness and navigation
|
|
280
|
-
|
|
281
|
-
### What to Avoid
|
|
282
|
-
- Don't test on production networks without authorization
|
|
283
|
-
- Don't store real client data in the beta (use test data)
|
|
284
|
-
- Don't share your vault password
|
|
285
|
-
|
|
286
|
-
## Support
|
|
287
|
-
|
|
288
|
-
- **Email**: cysoul.secit@gmail.com
|
|
289
|
-
- **Built-in Help**: Run `souleyez --help` or `souleyez <command> --help`
|
|
290
|
-
- **Diagnostics**: Run `souleyez doctor` to check your setup
|
|
291
|
-
|
|
292
|
-
---
|
|
293
|
-
|
|
294
|
-
## Glossary (New to Pentesting?)
|
|
295
|
-
|
|
296
|
-
| Term | Meaning |
|
|
297
|
-
|------|---------|
|
|
298
|
-
| **Engagement** | A project or assessment - contains all data for one test |
|
|
299
|
-
| **Target/Host** | A computer, server, or device you're testing |
|
|
300
|
-
| **Service** | A program running on a port (like a web server on port 80) |
|
|
301
|
-
| **Finding** | A security issue or vulnerability you discovered |
|
|
302
|
-
| **Credential** | Username/password combo found during testing |
|
|
303
|
-
| **Port** | A numbered "door" on a computer where services listen (e.g., 22=SSH, 80=HTTP) |
|
|
304
|
-
| **Nmap** | Network scanner - finds open ports and services |
|
|
305
|
-
| **Gobuster** | Directory scanner - finds hidden web pages |
|
|
306
|
-
| **SQLMap** | Automatically tests for SQL injection vulnerabilities |
|
|
307
|
-
| **Metasploit** | Framework for running exploits (PRO feature) |
|
|
308
|
-
|
|
309
|
-
---
|
|
310
|
-
|
|
311
|
-
## Thank You!
|
|
312
|
-
|
|
313
|
-
Your feedback is invaluable in making SoulEyez better. Every bug report, feature suggestion, and piece of feedback helps us build a tool that truly serves the security community.
|
|
314
|
-
|
|
315
|
-
Happy hacking! 🛡️
|
|
316
|
-
|
|
317
|
-
---
|
|
318
|
-
|
|
319
|
-
**Version**: 2.37.0 | **Release Date**: January 2026 | **Maintainer**: CyberSoul Security
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|