souleyez 2.40.0__py3-none-any.whl → 2.43.1__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.

Potentially problematic release.


This version of souleyez might be problematic. Click here for more details.

souleyez/__init__.py CHANGED
@@ -1,2 +1,2 @@
1
- __version__ = '2.40.0'
1
+ __version__ = '2.43.1'
2
2
 
@@ -93,7 +93,7 @@ def status():
93
93
  click.echo(click.style(" No active license", fg='yellow'))
94
94
  click.echo()
95
95
  click.echo(" You are using the FREE tier.")
96
- click.echo(" Upgrade to Pro: https://souleyez.com/pricing")
96
+ click.echo(" Upgrade to Pro: https://www.cybersoulsecurity.com/souleyez")
97
97
  click.echo()
98
98
  click.echo(" Activate with: souleyez license activate <key>")
99
99
  click.echo()
souleyez/docs/README.md CHANGED
@@ -1,7 +1,7 @@
1
1
  # SoulEyez Documentation
2
2
 
3
- **Version:** 2.40.0
4
- **Last Updated:** January 9, 2026
3
+ **Version:** 2.43.1
4
+ **Last Updated:** January 11, 2026
5
5
  **Organization:** CyberSoul Security
6
6
 
7
7
  Welcome to the SoulEyez documentation! This documentation covers architecture, development, user guides, and operational information for the SoulEyez penetration testing platform.
@@ -240,8 +240,8 @@ Legal and compliance documentation.
240
240
 
241
241
  - **Issues**: https://github.com/cybersoul-security/souleyez/issues
242
242
  - **Discussions**: https://github.com/cybersoul-security/souleyez/discussions
243
- - **Security**: security@cybersoul.io
244
- - **General**: support@cybersoul.io
243
+ - **Security**: cysoul.secit@gmail.com
244
+ - **General**: cysoul.secit@gmail.com
245
245
 
246
246
  ---
247
247
 
@@ -167,7 +167,7 @@ SoulEyez's tagline: *"See through the soul's eyes — perceive what others canno
167
167
  **Messaging Opportunity**:
168
168
  > "SoulEyez AI never sends your data to the cloud. Your engagement stays between you and your client — always."
169
169
 
170
- This positions CyberSoul as **security-first, privacy-respecting** — aligned with Soul Hackers brand values.
170
+ This positions CyberSoul as **security-first, privacy-respecting** — aligned with SoulEyez brand values.
171
171
 
172
172
  ---
173
173
 
@@ -283,7 +283,7 @@ Sanitized: "[USER]:[PASS] on [IP] port 3306 MySQL"
283
283
  - ✅ Predictable performance
284
284
 
285
285
  4. **Brand**
286
- - ✅ Reinforces "Soul Hackers" identity (ethical, privacy-respecting)
286
+ - ✅ Reinforces "SoulEyez" identity (ethical, privacy-respecting)
287
287
  - ✅ Differentiation in crowded market
288
288
  - ✅ Thought leadership opportunity (blog: "Why We Built Privacy-First AI")
289
289
 
@@ -30,7 +30,7 @@ souleyez needs a **credential encryption strategy** that balances security with
30
30
  3. **Encryption**: Fernet (AES-128 in CBC mode + HMAC authentication)
31
31
  4. **Scope**: Encrypts `credentials.username` and `credentials.password` fields only
32
32
  5. **Unlock**: Session-based (key lives in memory, cleared on exit)
33
- 6. **Optional**: Encryption is opt-in via migration script
33
+ 6. **Mandatory**: Encryption is configured during setup wizard
34
34
 
35
35
  ---
36
36
 
@@ -233,19 +233,23 @@ CREATE TABLE credentials (
233
233
 
234
234
  **Decision**: Fernet is the **safe, simple choice** for application-level encryption.
235
235
 
236
- ### Why Optional Encryption?
236
+ ### Why Mandatory Encryption?
237
237
 
238
- Encryption is **opt-in** via migration script (`migrate_credentials.py`).
238
+ Encryption is **required** and configured during the setup wizard.
239
239
 
240
240
  **Rationale**:
241
- 1. **Lab Environments**: Operators testing against intentionally vulnerable VMs (HackTheBox, TryHackMe) don't need encryption
242
- 2. **Usability**: Master password prompts add friction for quick scans
243
- 3. **Backward Compatibility**: Existing databases work without migration
244
- 4. **Transparency**: Users consciously choose to enable encryption
245
-
246
- **Default Behavior**: Credentials stored in **plaintext** unless user enables encryption.
247
-
248
- **Security Guidance**: Documentation recommends enabling encryption for **client engagements**.
241
+ 1. **Security First**: As a security company, we cannot allow plaintext credential storage
242
+ 2. **Consistency**: All users have the same security baseline
243
+ 3. **Compliance**: Encrypted storage is expected for professional pentesting tools
244
+ 4. **Simplicity**: One-time setup during wizard, no migration scripts needed
245
+
246
+ **Default Behavior**: Credentials are **always encrypted** with the vault master password.
247
+
248
+ **Password Requirements**:
249
+ - At least 12 characters
250
+ - Mix of uppercase and lowercase
251
+ - At least one number
252
+ - At least one special character
249
253
 
250
254
  ---
251
255
 
@@ -105,7 +105,7 @@ souleyez is a penetration testing automation framework designed to:
105
105
  1. **Plugin-First Architecture**: All security tools are wrapped in plugins with standardized interfaces
106
106
  2. **Engagement-Centric**: All data is scoped to engagements (workspaces) for isolation
107
107
  3. **Parse-Store-Correlate**: Tool output → Parser → Database → Correlation → Findings
108
- 4. **Security-by-Default**: Optional credential encryption with industry-standard cryptography
108
+ 4. **Security-by-Default**: Mandatory credential encryption with industry-standard cryptography
109
109
  5. **File-Backed Job Queue**: Persistent, crash-resilient job tracking without external dependencies
110
110
  6. **Real-Time Monitoring**: Live dashboard with automatic refresh and status updates
111
111
 
@@ -176,7 +176,7 @@ souleyez is a penetration testing automation framework designed to:
176
176
 
177
177
  #### Credentials Manager (`souleyez/storage/credentials.py`)
178
178
 
179
- Stores and retrieves discovered credentials with optional encryption.
179
+ Stores and retrieves discovered credentials with mandatory encryption.
180
180
 
181
181
  **Schema**:
182
182
  ```sql
@@ -499,7 +499,7 @@ class PluginBase:
499
499
 
500
500
  ### Overview
501
501
 
502
- souleyez implements **optional at-rest encryption** for discovered credentials using **Fernet** (symmetric encryption based on AES-128-CBC + HMAC-SHA256).
502
+ souleyez implements **mandatory at-rest encryption** for discovered credentials using **Fernet** (symmetric encryption based on AES-128-CBC + HMAC-SHA256). Encryption is configured during the first-run setup wizard.
503
503
 
504
504
  **Note**: The README mentions AES-256, but the actual implementation uses **Fernet** which is AES-128 in CBC mode with HMAC authentication.
505
505
 
@@ -1264,9 +1264,8 @@ souleyez workspace create acme-pentest
1264
1264
  # Set as active
1265
1265
  souleyez workspace use acme-pentest
1266
1266
 
1267
- # Enable encryption (optional but recommended)
1268
- python3 migrate_credentials.py
1269
- # Enter master password when prompted
1267
+ # Note: Encryption is configured during the setup wizard (mandatory)
1268
+ # Credentials are automatically encrypted with your vault master password
1270
1269
  ```
1271
1270
 
1272
1271
  ### Phase 2: Discovery
@@ -10,11 +10,13 @@ This guide covers everything you need to know about managing encryption keys in
10
10
 
11
11
  | Operation | Command | Time |
12
12
  |-----------|---------|------|
13
- | Enable encryption | `python3 migrate_credentials.py` | 1 min |
13
+ | Initial setup | `souleyez interactive` (setup wizard) | 5 min |
14
14
  | View encrypted creds | `souleyez creds list` | Instant |
15
15
  | Check encryption status | Python API | Instant |
16
16
  | Backup crypto config | `cp ~/.souleyez/crypto.json backup/` | Instant |
17
- | Disable encryption | Python API (see below) | 5 min |
17
+ | Change password | `souleyez db change-password` | 1 min |
18
+
19
+ > **Note:** Encryption is mandatory and configured during the first-run setup wizard.
18
20
 
19
21
  ---
20
22
 
@@ -58,7 +60,8 @@ This guide covers everything you need to know about managing encryption keys in
58
60
  **1. Master Password**
59
61
  - Known only to user
60
62
  - Never stored anywhere
61
- - Minimum 8 characters (12+ recommended)
63
+ - Minimum 12 characters (required)
64
+ - Must include: uppercase, lowercase, number, special character
62
65
  - Used to derive encryption key
63
66
 
64
67
  **2. Salt**
@@ -83,19 +86,34 @@ This guide covers everything you need to know about managing encryption keys in
83
86
 
84
87
  ## Initial Setup
85
88
 
86
- ### Step 1: Enable Encryption
89
+ ### Encryption via Setup Wizard (Recommended)
90
+
91
+ Encryption is configured automatically during the first-run setup wizard:
92
+
93
+ ```bash
94
+ souleyez interactive
95
+ ```
96
+
97
+ **What happens:**
98
+ 1. Setup wizard prompts for vault master password
99
+ 2. Password must meet requirements (12+ chars, mixed case, number, special)
100
+ 3. Password confirmation required
101
+ 4. Generates random 32-byte salt
102
+ 5. Derives encryption key from password + salt
103
+ 6. All future credentials are automatically encrypted
104
+
105
+ ### Legacy: Migration Script
87
106
 
88
- Run the migration script:
107
+ For existing installations or manual setup:
89
108
 
90
109
  ```bash
91
- cd /path/to/souleyez_app
92
110
  python3 migrate_credentials.py
93
111
  ```
94
112
 
95
113
  **What happens:**
96
114
  1. Checks if encryption already enabled (fails if yes)
97
115
  2. Prompts for master password (twice for confirmation)
98
- 3. Validates password (minimum 8 characters)
116
+ 3. Validates password (minimum 12 characters)
99
117
  4. Generates random 32-byte salt
100
118
  5. Derives encryption key from password + salt
101
119
  6. Encrypts all existing credentials in database
@@ -287,7 +287,7 @@ souleyez jobs enqueue nmap 192.168.1.1
287
287
 
288
288
  | Data Type | Storage | Protection | Risk |
289
289
  |-----------|---------|------------|------|
290
- | Credentials | Database | Optional encryption | High |
290
+ | Credentials | Database | Mandatory encryption (Fernet/AES-128) | High |
291
291
  | Job logs | Plaintext files | File permissions | Medium |
292
292
  | Targets | Database | Plaintext | Low |
293
293
  | Findings | Database | Plaintext | Medium |
@@ -748,4 +748,4 @@ rm ~/.souleyez/config.json && souleyez --version
748
748
 
749
749
  ---
750
750
 
751
- **Last Updated:** 2026-01-09 | **Version:** 2.27.1
751
+ **Last Updated:** 2026-01-11 | **Version:** 2.43.1
@@ -66,7 +66,7 @@ Defined in `requirements.txt`:
66
66
 
67
67
  ### Cryptography Dependencies
68
68
 
69
- If using credential encryption (optional):
69
+ For credential encryption (required):
70
70
 
71
71
  #### cryptography >= 41.0.0
72
72
  - **Purpose**: Fernet symmetric encryption (AES-128)
@@ -29,88 +29,80 @@ souleyez interactive
29
29
 
30
30
  ### Step 2: First-Run Setup Wizard (First Time Only)
31
31
 
32
- **On your first launch, you'll be guided through a 7-step setup wizard:**
32
+ **On your first launch, you'll be guided through the setup wizard:**
33
33
 
34
34
  ```
35
- ███████╗ ██████╗ ██╗ ██╗██╗ ██╗ ██╗ █████╗ ██████╗██╗ ██╗███████╗██████╗ ███████╗
36
- ██╔════╝██╔═══██╗██║ ██║██║ ██║ ██║██╔══██╗██╔════╝██║ ██╔╝██╔════╝██╔══██╗██╔════╝
37
- ███████╗██║ ██║██║ ██║██║ ███████║███████║██║ █████╔╝ █████╗ ██████╔╝███████╗
38
- ╚════██║██║ ██║██║ ██║██║ ██╔══██║██╔══██║██║ ██╔═██╗ ██╔══╝ ██╔══██╗╚════██║
39
- ███████║╚██████╔╝╚██████╔╝███████╗ ██║ ██║██║ ██║╚██████╗██║ ██╗███████╗██║ ██║███████║
40
- ╚══════╝ ╚═════╝ ╚═════╝ ╚══════╝ ╚═╝ ╚═╝╚═╝ ╚═╝ ╚═════╝╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚══════╝
35
+ ███████╗ ██████╗ ██╗ ██╗██╗ ███████╗██╗ ██╗███████╗███████╗
36
+ ██╔════╝██╔═══██╗██║ ██║██║ ██╔════╝╚██╗ ██╔╝██╔════╝╚══███╔╝
37
+ ███████╗██║ ██║██║ ██║██║ █████╗ ╚████╔╝ █████╗ ███╔╝
38
+ ╚════██║██║ ██║██║ ██║██║ ██╔══╝ ╚██╔╝ ██╔══╝ ███╔╝
39
+ ███████║╚██████╔╝╚██████╔╝███████╗███████╗ ██║ ███████╗███████╗
40
+ ╚══════╝ ╚═════╝ ╚═════╝ ╚══════╝╚══════╝ ╚═╝ ╚══════╝╚══════╝
41
41
 
42
42
  Created by CyberSoul SecurITy
43
43
  ```
44
44
 
45
- #### The 7-Step Setup Wizard
45
+ #### Setup Wizard Steps
46
46
 
47
47
  | Step | Name | Description |
48
48
  |------|------|-------------|
49
49
  | 1 | **Welcome** | Introduction and overview of what to expect |
50
- | 2 | **Encryption Setup** | Configure credential encryption (recommended) |
51
- | 3 | **Create Engagement** | Set up your first engagement with name, type, and scope |
52
- | 4 | **Tool Availability** | Check which security tools are installed on your system |
53
- | 5 | **Automation Preferences** | Configure auto-chaining approval mode |
54
- | 6 | **Deliverables** | Select report templates for your engagement type |
55
- | 7 | **Summary** | Review all settings and launch into SoulEyez |
50
+ | 2 | **Encryption Setup** | Create vault master password (mandatory) |
51
+ | 3 | **Create Engagement** | Set up your first engagement with name and type |
52
+ | 4 | **Tool Availability** | Check which security tools are installed |
53
+ | 5 | **AI Features** | Configure Ollama for AI features (optional) |
54
+ | 6 | **Summary** | Review settings and option to run tutorial |
56
55
 
57
56
  #### Step 2: Encryption Setup
58
57
 
59
- **Choose your security level:**
58
+ SoulEyez encrypts all credentials with a master password. This is **mandatory** for security.
60
59
 
61
- - **Press Y** (Recommended):
62
- - Create a master password to encrypt all credentials
63
- - Best for production pentests and client data
64
- - You'll need this password to view credentials
60
+ **Password Requirements:**
61
+ - At least 12 characters
62
+ - Mix of uppercase and lowercase
63
+ - At least one number
64
+ - At least one special character (!@#$%^&*)
65
65
 
66
- - **Press N** (Not recommended):
67
- - Skip encryption for now (can enable later via Settings)
68
- - Only acceptable for isolated lab environments
66
+ > ⚠️ **If you lose this password, encrypted credentials cannot be recovered!**
69
67
 
70
68
  #### Step 3: Create Your Engagement
71
69
 
70
+ Enter your engagement name (e.g., "ACME Corp Pentest" or "HackTheBox Lab").
71
+
72
72
  Select your engagement type:
73
- - **Penetration Test** - Standard assessment with scope boundaries
74
- - **Bug Bounty** - Public program with defined rules
75
- - **CTF/Lab** - Training environment (no approval needed)
76
- - **Red Team** - Adversary simulation with stealth focus
73
+ - **Penetration Test** - Full-scope security assessment
74
+ - **Bug Bounty** - Vulnerability hunting with defined scope
75
+ - **CTF/Lab** - Practice environment, aggressive scanning OK
76
+ - **Red Team** - Adversary simulation, stealth preferred
77
77
  - **Custom** - Define your own parameters
78
78
 
79
- Enter your engagement name and target scope (domains, IPs, URLs).
79
+ > **Note:** Type affects default automation and scan aggressiveness
80
80
 
81
81
  #### Step 4: Tool Availability
82
82
 
83
83
  The wizard scans your system for installed security tools:
84
84
  - Shows which tools are available (✓) and missing (✗)
85
- - Categorized by phase: Reconnaissance, Network, Web, Exploitation, etc.
86
- - Missing tools can be installed later
87
-
88
- #### Step 5: Automation Preferences
89
-
90
- Configure how auto-chaining handles discovered targets:
91
- - **Auto-approve** - Jobs run automatically (CTF/Lab)
92
- - **Prompt** - Ask before each chain job (default)
93
- - **Queue only** - Add to queue but don't execute
85
+ - Shows version warnings for outdated tools (!)
86
+ - Option to install/upgrade missing tools
94
87
 
95
- #### Step 6: Deliverables
88
+ #### Step 5: AI Features (Optional)
96
89
 
97
- Select report templates based on your engagement type:
98
- - Executive Summary, Technical Report, Findings Matrix
99
- - Remediation Plan, Evidence Package
100
- - Templates auto-selected based on engagement type
90
+ Configure Ollama for AI-powered features:
91
+ - Checks if Ollama is installed and running
92
+ - Option to install Ollama if not present
93
+ - Option to download recommended model (llama3.1:8b)
101
94
 
102
- #### Step 7: Summary
95
+ #### Step 6: Summary & Tutorial
103
96
 
104
- Review all your settings before launching:
105
- - Engagement details and scope
97
+ Review all your settings:
106
98
  - Encryption status
99
+ - Engagement details
107
100
  - Available tools count
108
- - Automation mode
109
- - Selected deliverables
101
+ - AI features status
110
102
 
111
- Press Enter to complete setup and launch the main menu.
103
+ **Tutorial Offer:** The wizard offers to run an interactive tutorial (recommended for new users).
112
104
 
113
- > 💡 **Tip**: You can re-run the wizard anytime from **Settings → Run Setup Wizard**
105
+ > 💡 **Tip**: You can run the tutorial anytime from **Settings → [t] Tutorial**
114
106
 
115
107
  ### Step 3: Enter the Main Menu
116
108
 
@@ -118,41 +110,50 @@ After completing the wizard, you'll see the main menu:
118
110
 
119
111
  ```
120
112
  ⚡ MISSION CONTROL
121
- ══════════════════════════════════════════════════════════════════════════════
113
+ ════════════════════════════════════════════════════════════════════════════════
122
114
  Your central hub for intelligent pentesting
123
115
 
124
116
  [c ] 🧿 Command Center - Live monitoring, attack surface, next actions
125
- [i ] 🕵️ Intelligence Hub - Host analysis, exploitation coverage, gaps
126
- [x ] 🤖 AI Execute 💎 - AI-driven autonomous execution
127
- [a ] 🔗 Automation 💎 - Chain rules & settings
128
- [m ] 🔧 MSF Integration 💎 - Advanced exploitation & attack chains
129
- [r ] 📊 Reports & Export 💎 - Professional deliverables
130
-
131
- 🔍 RECONNAISSANCE
132
- ──────────────────────────────────────────────────────────────
133
- Gather intelligence on target
134
- [ 1] theHarvester - Email, subdomain & name collection
135
- [ 2] WHOIS - Domain ownership lookup
136
- [ 3] DNSRecon - DNS enumeration & zone transfer
137
-
138
- 🌐 NETWORK DISCOVERY
139
- ──────────────────────────────────────────────────────────────
140
- Map the attack surface
141
- [ 4] Nmap - Network scanning & service detection
142
-
143
- (Additional phase-organized tools...)
117
+ [i ] 🕵️ Intelligence Hub 🔒 PRO - Host analysis, exploitation coverage, gaps
118
+ [x ] 🤖 AI Execute 🔒 PRO - AI-driven autonomous execution
119
+ [a ] 🔗 Automation 🔒 PRO - Chain rules & settings
120
+ [m ] 🔧 Metasploit 🔒 PRO - Advanced exploitation & attack chains
121
+ [r ] 📊 Reports & Export 🔒 PRO - Professional deliverables
122
+
123
+ 🔍 PHASE 1: RECONNAISSANCE
124
+ ────────────────────────────────────────────────────────────
125
+ Gather information before active scanning (OSINT)
126
+
127
+ [ 7] theHarvester - Email, domain, subdomain discovery
128
+ [ 8] WHOIS - Domain registration and ownership lookup
129
+ [ 9] DNSRecon - DNS enumeration and subdomain discovery
130
+
131
+ 🔬 PHASE 2: SCANNING & ENUMERATION
132
+ ────────────────────────────────────────────────────────────
133
+ Identify hosts, ports, services, shares, and web paths
134
+
135
+ [10] Nmap - Network scanner with presets
136
+ [11] CrackMapExec - Windows/AD enumeration (SMB, WinRM, LDAP)
137
+ ...
138
+
139
+ ⚠️ PHASE 3: VULNERABILITY ANALYSIS
140
+ 💥 PHASE 4: EXPLOITATION
141
+ 🎯 PHASE 5: POST-EXPLOITATION
144
142
 
145
143
  ⚙️ OPERATIONS
146
- ──────────────────────────────────────────────────────────────
144
+ ────────────────────────────────────────────────────────────
147
145
  Monitor progress and manage engagement
148
146
 
149
- [j ] Job Queue - Manage active jobs and worker
150
- [e ] Engagements - Switch or create engagements
151
- [s ] Settings - Encryption and preferences
152
- [h ] Help Center - Documentation and guides
147
+ [j ] Job Queue - Manage active jobs and worker
148
+ [e ] Engagements - Switch or create engagements
149
+ [h ] Help Center - Documentation and guides
150
+ [g ] Scan Phases Guide - View recommended workflow
151
+ [* ] Settings - Encryption and preferences
152
+
153
+ [L ] Logout - End session
153
154
  ```
154
155
 
155
- **💎 = Premium features** (advanced automation and AI capabilities)
156
+ **🔒 PRO = Premium features** (AI, automation, Metasploit, reports)
156
157
 
157
158
  ### Step 4: Verify Your Engagement
158
159
 
@@ -175,7 +176,7 @@ If you completed the setup wizard, your first engagement is already created and
175
176
  Navigate back to the main menu and launch a scan:
176
177
 
177
178
  ```
178
- 1. From the main menu, type the number for Nmap (usually [4] under Network Discovery)
179
+ 1. From the main menu, type [10] for Nmap (under Phase 2: Scanning & Enumeration)
179
180
  2. Select a preset (e.g., [1] Quick Scan - Ping Sweep)
180
181
  3. Enter target: 192.168.1.0/24
181
182
  4. Confirm to start
@@ -297,25 +298,31 @@ From the main menu, you can access:
297
298
 
298
299
  **Mission Control (Top Section)**
299
300
  - `[c]` **Command Center** - Live monitoring dashboard with attack surface, findings
300
- - `[i]` **Intelligence Hub** - Host analysis, exploitation coverage, gaps
301
- - `[x]` **AI Execute** 💎 - AI-driven autonomous execution
302
- - `[a]` **Automation** 💎 - Chain rules and auto-scan settings
303
- - `[m]` **MSF Integration** 💎 - Metasploit resource scripts, sessions, payloads
304
- - `[r]` **Reports & Export** 💎 - Professional deliverables and reports
301
+ - `[i]` **Intelligence Hub** 🔒 PRO - Host analysis, exploitation coverage, gaps
302
+ - `[x]` **AI Execute** 🔒 PRO - AI-driven autonomous execution
303
+ - `[a]` **Automation** 🔒 PRO - Chain rules and auto-scan settings
304
+ - `[m]` **Metasploit** 🔒 PRO - Advanced exploitation and attack chains
305
+ - `[r]` **Reports & Export** 🔒 PRO - Professional deliverables and reports
305
306
 
306
307
  **Phase-Organized Tools (Numbered)**
307
- - `[1-N]` Tools organized by pentest phase (Recon, Network Discovery, Enumeration, etc.)
308
+ - **Phase 1: Reconnaissance** - theHarvester, WHOIS, DNSRecon
309
+ - **Phase 2: Scanning & Enumeration** - Nmap, CrackMapExec, SMBMap, Gobuster, ffuf
310
+ - **Phase 3: Vulnerability Analysis** - Nuclei, Nikto, WPScan, SearchSploit
311
+ - **Phase 4: Exploitation** - SQLMap, Hydra, Metasploit Auxiliary
312
+ - **Phase 5: Post-Exploitation** - Credential harvesting, lateral movement, data collection
308
313
 
309
314
  **Operations (Bottom Section)**
310
315
  - `[j]` **Job Queue** - Monitor and control background jobs
311
316
  - `[e]` **Engagements** - Create, switch, and manage engagements
312
- - `[s]` **Settings** - Encryption and preferences
313
317
  - `[h]` **Help Center** - Documentation and guides
318
+ - `[g]` **Scan Phases Guide** - View recommended workflow
319
+ - `[*]` **Settings** - Encryption and preferences
320
+ - `[L]` **Logout** - End session
314
321
  - `[q]` **Quit** - Exit the application
315
322
 
316
323
  ### Running Tools
317
324
 
318
- 1. From main menu, type a tool number (e.g., `4` for Nmap under Network Discovery)
325
+ 1. From main menu, type a tool number (e.g., `10` for Nmap under Phase 2)
319
326
  2. Choose a preset or configure custom options
320
327
  3. Enter target
321
328
  4. Job is queued and runs in background
@@ -488,7 +495,7 @@ SoulEyez can automatically trigger follow-up scans based on discoveries.
488
495
  - When MySQL is detected → Automatically suggests exploitation options
489
496
 
490
497
  **Configure auto-chaining:**
491
- From the main menu, press `[a]` for Automation (💎 premium feature) to manage chain rules and approval settings.
498
+ From the main menu, press `[a]` for Automation (🔒 PRO premium feature) to manage chain rules and approval settings.
492
499
 
493
500
  **Examples of auto-chaining:**
494
501
  1. **Web Services**: HTTP/HTTPS → Nikto, Gobuster, WhatWeb
@@ -526,7 +533,7 @@ Create custom automation rules from the Automation menu:
526
533
  After testing, generate professional reports:
527
534
 
528
535
  **From Interactive Menu:**
529
- Press `[r]` for Reports & Export (💎 premium feature) to access professional deliverables.
536
+ Press `[r]` for Reports & Export (🔒 PRO premium feature) to access professional deliverables.
530
537
 
531
538
  **From CLI:**
532
539
  ```bash
@@ -571,10 +578,12 @@ souleyez findings add "Weak Password" \
571
578
  --description "Admin account uses password 'admin123'. Confirmed via SSH login."
572
579
  ```
573
580
 
574
- ### 5. Enable Encryption for Sensitive Tests
575
- If you skipped encryption setup initially, enable it now:
581
+ ### 5. Encryption is Always Enabled
582
+ Encryption is mandatory and configured during the setup wizard. Your credentials are protected with your vault master password.
583
+
584
+ To change your vault password:
576
585
  ```bash
577
- souleyez db encrypt
586
+ souleyez db change-password
578
587
  ```
579
588
 
580
589
  ### 6. Regular Backups
@@ -642,10 +651,11 @@ Now that you're familiar with the basics:
642
651
  - SMB Enumeration (Enum4Linux, SMBMap)
643
652
  - Post-Exploitation (secretsdump, CrackMapExec)
644
653
 
645
- 2. **Premium Features** (💎):
646
- - **MSF Integration** `[m]` - Generate Metasploit resource scripts, manage sessions
654
+ 2. **PRO Features** (🔒):
655
+ - **Metasploit** `[m]` - Advanced exploitation and attack chains
647
656
  - **Automation** `[a]` - Configure auto-chaining rules and approval modes
648
657
  - **AI Execute** `[x]` - AI-driven autonomous execution
658
+ - **Intelligence Hub** `[i]` - Host analysis, exploitation coverage, gaps
649
659
  - **Reports & Export** `[r]` - Professional deliverables
650
660
 
651
661
  3. **Learn Advanced Features**:
@@ -140,43 +140,32 @@ souleyez --version
140
140
 
141
141
  ## First Run Experience
142
142
 
143
- When you launch SoulEyez for the first time, you'll see:
143
+ When you launch SoulEyez for the first time:
144
144
 
145
145
  ```bash
146
146
  souleyez interactive
147
147
  ```
148
148
 
149
- **You'll be greeted with:**
149
+ **You'll be guided through the Setup Wizard:**
150
150
 
151
- 1. **Welcome Banner** - The SOUL HACKERS ASCII art logo
152
- 2. **Security Prompt** - Encryption setup dialog
151
+ 1. **Welcome Banner** - The SoulEyez ASCII art logo and introduction
152
+ 2. **Encryption Setup** - Create a vault master password (mandatory)
153
+ 3. **Create Engagement** - Set up your first project with name and type
154
+ 4. **Tool Availability** - Check which security tools are installed
155
+ 5. **AI Features** - Configure Ollama for AI features (optional)
156
+ 6. **Summary & Tutorial** - Review settings and option to run interactive tutorial
153
157
 
154
- ```
155
- 🔐 ENCRYPTED CREDENTIALS
156
- ======================================================================
157
-
158
- ⚠️ SECURITY WARNING
159
-
160
- Encryption is NOT enabled.
161
- Credentials are currently stored in PLAINTEXT in the database.
162
-
163
- This is a security risk!
164
-
165
- Would you like to enable encryption now?
166
- • Credentials will be encrypted with a master password
167
- • Existing plaintext credentials will be migrated
168
- • You'll need this password to view credentials
169
-
170
- Enable encryption? [Y/n]:
171
- ```
158
+ **Encryption is mandatory** - you'll create a master password that encrypts all credentials.
172
159
 
173
- **Important Decision:**
174
- - **Press Y** (recommended): Set up encryption now. You'll create a master password.
175
- - **Press N**: Skip encryption. You can enable it later with `souleyez db encrypt`.
160
+ **Password Requirements:**
161
+ - At least 12 characters
162
+ - Mix of uppercase and lowercase
163
+ - At least one number
164
+ - At least one special character (!@#$%^&*)
176
165
 
177
- > ⚠️ **Security Note**: For production pentests, always enable encryption. Credentials will be stored in plaintext if you skip this step.
166
+ > ⚠️ **Important**: If you lose this password, encrypted credentials cannot be recovered!
178
167
 
179
- **After encryption setup** (or if you skip it), you'll enter the main interactive menu where you can create your first engagement and start scanning.
168
+ **After the wizard completes**, you'll enter the main interactive menu where you can start scanning.
180
169
 
181
170
  ## Security Tools Installation
182
171
 
@@ -321,10 +310,10 @@ souleyez interactive
321
310
  ```
322
311
 
323
312
  This launches the user-friendly menu interface where you can:
324
- 1. Set up encryption (on first run)
325
- 2. Create your first engagement
326
- 3. Run scans with presets
327
- 4. View results in organized tables
313
+ 1. Complete the setup wizard (on first run)
314
+ 2. Run scans with presets
315
+ 3. View results in the Command Center
316
+ 4. Manage engagements and findings
328
317
 
329
318
  See the **[Getting Started Guide](getting-started.md)** for a complete walkthrough.
330
319
 
@@ -217,7 +217,7 @@ $ souleyez whoami
217
217
  │ AI Execute requires a Pro license. │
218
218
  │ │
219
219
  │ [a] Activate license key │
220
- │ [p] Purchase at souleyez.com/pro
220
+ │ [p] Purchase at cybersoulsecurity.com
221
221
  │ [q] Return to menu │
222
222
  └─────────────────────────────────────────┘
223
223
  ```
@@ -628,7 +628,7 @@ Your role doesn't allow this action. Contact an admin for elevated access.
628
628
 
629
629
  ### "Pro license required"
630
630
 
631
- The feature requires a Pro tier license. Upgrade at souleyez.com/pro or contact your admin.
631
+ The feature requires a Pro tier license. Upgrade at cybersoulsecurity.com/souleyez or contact your admin.
632
632
 
633
633
  ### "Account is temporarily locked"
634
634
 
@@ -705,4 +705,4 @@ souleyez audit export --start X # Export (Admin)
705
705
 
706
706
  ---
707
707
 
708
- *For support, contact support@souleyez.com or visit github.com/cyber-soul-security/souleyez*
708
+ *For support, contact cysoul.secit@gmail.com or visit github.com/cyber-soul-security/souleyez*
@@ -680,4 +680,4 @@ souleyez scope log <eng> --action blocked # Filter blocked
680
680
 
681
681
  ---
682
682
 
683
- *For support, contact support@souleyez.com or visit github.com/cyber-soul-security/souleyez*
683
+ *For support, contact cysoul.secit@gmail.com or visit github.com/cyber-soul-security/souleyez*