souleyez 2.0.20__tar.gz
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-2.0.20/BETA_README.md +232 -0
- souleyez-2.0.20/LICENSE +21 -0
- souleyez-2.0.20/MANIFEST.in +4 -0
- souleyez-2.0.20/PKG-INFO +284 -0
- souleyez-2.0.20/README.md +309 -0
- souleyez-2.0.20/data/wordlists/README.md +175 -0
- souleyez-2.0.20/data/wordlists/all_users.txt +11643 -0
- souleyez-2.0.20/data/wordlists/api_endpoints.txt +331 -0
- souleyez-2.0.20/data/wordlists/default_credentials.txt +33 -0
- souleyez-2.0.20/data/wordlists/soul_pass.txt +114 -0
- souleyez-2.0.20/data/wordlists/soul_users.txt +218 -0
- souleyez-2.0.20/data/wordlists/subdomains_common.txt +4997 -0
- souleyez-2.0.20/data/wordlists/top100.txt +101 -0
- souleyez-2.0.20/data/wordlists/top20_quick.txt +21 -0
- souleyez-2.0.20/data/wordlists/web_dirs_common.txt +4617 -0
- souleyez-2.0.20/data/wordlists/web_extensions.txt +25 -0
- souleyez-2.0.20/data/wordlists/web_files_common.txt +35 -0
- souleyez-2.0.20/pyproject.toml +90 -0
- souleyez-2.0.20/setup.cfg +4 -0
- souleyez-2.0.20/setup.py +49 -0
- souleyez-2.0.20/souleyez/__init__.py +1 -0
- souleyez-2.0.20/souleyez/ai/__init__.py +29 -0
- souleyez-2.0.20/souleyez/ai/action_mapper.py +403 -0
- souleyez-2.0.20/souleyez/ai/claude_provider.py +287 -0
- souleyez-2.0.20/souleyez/ai/context_builder.py +286 -0
- souleyez-2.0.20/souleyez/ai/executor.py +308 -0
- souleyez-2.0.20/souleyez/ai/feedback_handler.py +263 -0
- souleyez-2.0.20/souleyez/ai/llm_factory.py +135 -0
- souleyez-2.0.20/souleyez/ai/llm_provider.py +108 -0
- souleyez-2.0.20/souleyez/ai/ollama_provider.py +114 -0
- souleyez-2.0.20/souleyez/ai/ollama_service.py +243 -0
- souleyez-2.0.20/souleyez/ai/path_scorer.py +218 -0
- souleyez-2.0.20/souleyez/ai/recommender.py +571 -0
- souleyez-2.0.20/souleyez/ai/report_context.py +245 -0
- souleyez-2.0.20/souleyez/ai/report_prompts.py +160 -0
- souleyez-2.0.20/souleyez/ai/report_service.py +421 -0
- souleyez-2.0.20/souleyez/ai/result_parser.py +485 -0
- souleyez-2.0.20/souleyez/ai/safety.py +164 -0
- souleyez-2.0.20/souleyez/auth/__init__.py +91 -0
- souleyez-2.0.20/souleyez/auth/audit.py +327 -0
- souleyez-2.0.20/souleyez/auth/engagement_access.py +326 -0
- souleyez-2.0.20/souleyez/auth/permissions.py +235 -0
- souleyez-2.0.20/souleyez/auth/session_manager.py +345 -0
- souleyez-2.0.20/souleyez/auth/user_manager.py +570 -0
- souleyez-2.0.20/souleyez/commands/__init__.py +1 -0
- souleyez-2.0.20/souleyez/commands/audit.py +229 -0
- souleyez-2.0.20/souleyez/commands/auth.py +160 -0
- souleyez-2.0.20/souleyez/commands/deliverables.py +242 -0
- souleyez-2.0.20/souleyez/commands/engagement.py +195 -0
- souleyez-2.0.20/souleyez/commands/license.py +192 -0
- souleyez-2.0.20/souleyez/commands/screenshots.py +162 -0
- souleyez-2.0.20/souleyez/commands/user.py +367 -0
- souleyez-2.0.20/souleyez/config.py +325 -0
- souleyez-2.0.20/souleyez/core/__init__.py +4 -0
- souleyez-2.0.20/souleyez/core/credential_tester.py +308 -0
- souleyez-2.0.20/souleyez/core/cve_matcher.py +313 -0
- souleyez-2.0.20/souleyez/core/msf_auto_mapper.py +243 -0
- souleyez-2.0.20/souleyez/core/msf_chain_engine.py +515 -0
- souleyez-2.0.20/souleyez/core/msf_database.py +785 -0
- souleyez-2.0.20/souleyez/core/msf_integration.py +1746 -0
- souleyez-2.0.20/souleyez/core/msf_rpc_client.py +530 -0
- souleyez-2.0.20/souleyez/core/msf_sync_manager.py +715 -0
- souleyez-2.0.20/souleyez/core/parser_handler.py +166 -0
- souleyez-2.0.20/souleyez/core/pending_chains.py +387 -0
- souleyez-2.0.20/souleyez/core/templates.py +388 -0
- souleyez-2.0.20/souleyez/core/tool_chaining.py +4844 -0
- souleyez-2.0.20/souleyez/core/vuln_correlation.py +392 -0
- souleyez-2.0.20/souleyez/core/web_utils.py +148 -0
- souleyez-2.0.20/souleyez/detection/__init__.py +7 -0
- souleyez-2.0.20/souleyez/detection/attack_signatures.py +214 -0
- souleyez-2.0.20/souleyez/detection/validator.py +396 -0
- souleyez-2.0.20/souleyez/devtools.py +116 -0
- souleyez-2.0.20/souleyez/docs/AUTO_CHAINING.md +640 -0
- souleyez-2.0.20/souleyez/docs/CONFIG.md +749 -0
- souleyez-2.0.20/souleyez/docs/MSF_INTEGRATION.md +366 -0
- souleyez-2.0.20/souleyez/docs/MSF_INTEGRATION_WARNING.md +104 -0
- souleyez-2.0.20/souleyez/docs/README.md +243 -0
- souleyez-2.0.20/souleyez/docs/api-reference/cli-commands.md +837 -0
- souleyez-2.0.20/souleyez/docs/api-reference/engagement-api.md +579 -0
- souleyez-2.0.20/souleyez/docs/api-reference/integration-guide.md +754 -0
- souleyez-2.0.20/souleyez/docs/api-reference/parser-formats.md +746 -0
- souleyez-2.0.20/souleyez/docs/architecture/decisions/000-template.md +199 -0
- souleyez-2.0.20/souleyez/docs/architecture/decisions/001-local-llm-over-cloud.md +481 -0
- souleyez-2.0.20/souleyez/docs/architecture/decisions/002-master-password-approach.md +438 -0
- souleyez-2.0.20/souleyez/docs/architecture/decisions/003-database-schema-design.md +642 -0
- souleyez-2.0.20/souleyez/docs/architecture/overview.md +1348 -0
- souleyez-2.0.20/souleyez/docs/database/MIGRATIONS.md +476 -0
- souleyez-2.0.20/souleyez/docs/database/SCHEMA.md +279 -0
- souleyez-2.0.20/souleyez/docs/database/SCHEMA_ERD.md +209 -0
- souleyez-2.0.20/souleyez/docs/developer-guide/test_coverage_plan.md +825 -0
- souleyez-2.0.20/souleyez/docs/developer-guide/ui-design-system.md +595 -0
- souleyez-2.0.20/souleyez/docs/images/README.md +213 -0
- souleyez-2.0.20/souleyez/docs/security/best-practices.md +883 -0
- souleyez-2.0.20/souleyez/docs/security/credential-encryption.md +767 -0
- souleyez-2.0.20/souleyez/docs/security/password-protected-commands.md +182 -0
- souleyez-2.0.20/souleyez/docs/security/secure-defaults.md +771 -0
- souleyez-2.0.20/souleyez/docs/security/threat-model.md +547 -0
- souleyez-2.0.20/souleyez/docs/user-guide/ai-integration.md +326 -0
- souleyez-2.0.20/souleyez/docs/user-guide/attack-surface.md +469 -0
- souleyez-2.0.20/souleyez/docs/user-guide/deliverables-screenshots.md +616 -0
- souleyez-2.0.20/souleyez/docs/user-guide/dependencies.md +336 -0
- souleyez-2.0.20/souleyez/docs/user-guide/evidence-vault.md +379 -0
- souleyez-2.0.20/souleyez/docs/user-guide/exploit-suggestions.md +711 -0
- souleyez-2.0.20/souleyez/docs/user-guide/getting-started.md +670 -0
- souleyez-2.0.20/souleyez/docs/user-guide/installation.md +546 -0
- souleyez-2.0.20/souleyez/docs/user-guide/rbac.md +708 -0
- souleyez-2.0.20/souleyez/docs/user-guide/report-generation.md +896 -0
- souleyez-2.0.20/souleyez/docs/user-guide/tools-reference.md +735 -0
- souleyez-2.0.20/souleyez/docs/user-guide/troubleshooting.md +739 -0
- souleyez-2.0.20/souleyez/docs/user-guide/uninstall.md +225 -0
- souleyez-2.0.20/souleyez/docs/user-guide/wazuh-integration.md +511 -0
- souleyez-2.0.20/souleyez/docs/user-guide/worker-management.md +531 -0
- souleyez-2.0.20/souleyez/docs/user-guide/workflows.md +906 -0
- souleyez-2.0.20/souleyez/engine/__init__.py +4 -0
- souleyez-2.0.20/souleyez/engine/background.py +1536 -0
- souleyez-2.0.20/souleyez/engine/base.py +26 -0
- souleyez-2.0.20/souleyez/engine/job_status.py +104 -0
- souleyez-2.0.20/souleyez/engine/loader.py +94 -0
- souleyez-2.0.20/souleyez/engine/log_sanitizer.py +198 -0
- souleyez-2.0.20/souleyez/engine/manager.py +101 -0
- souleyez-2.0.20/souleyez/engine/result_handler.py +2957 -0
- souleyez-2.0.20/souleyez/engine/worker_manager.py +109 -0
- souleyez-2.0.20/souleyez/export/__init__.py +1 -0
- souleyez-2.0.20/souleyez/export/evidence_bundle.py +281 -0
- souleyez-2.0.20/souleyez/feature_flags/__init__.py +1 -0
- souleyez-2.0.20/souleyez/feature_flags/features.py +174 -0
- souleyez-2.0.20/souleyez/feature_flags.py +156 -0
- souleyez-2.0.20/souleyez/history.py +94 -0
- souleyez-2.0.20/souleyez/importers/__init__.py +3 -0
- souleyez-2.0.20/souleyez/importers/msf_importer.py +360 -0
- souleyez-2.0.20/souleyez/importers/smart_importer.py +347 -0
- souleyez-2.0.20/souleyez/integrations/__init__.py +2 -0
- souleyez-2.0.20/souleyez/integrations/wazuh/__init__.py +5 -0
- souleyez-2.0.20/souleyez/integrations/wazuh/client.py +353 -0
- souleyez-2.0.20/souleyez/integrations/wazuh/config.py +127 -0
- souleyez-2.0.20/souleyez/intelligence/__init__.py +13 -0
- souleyez-2.0.20/souleyez/intelligence/correlation_analyzer.py +599 -0
- souleyez-2.0.20/souleyez/intelligence/exploit_knowledge.py +1026 -0
- souleyez-2.0.20/souleyez/intelligence/exploit_suggestions.py +296 -0
- souleyez-2.0.20/souleyez/intelligence/gap_detector.py +358 -0
- souleyez-2.0.20/souleyez/intelligence/sensitive_tables.py +404 -0
- souleyez-2.0.20/souleyez/intelligence/service_parser.py +255 -0
- souleyez-2.0.20/souleyez/intelligence/surface_analyzer.py +515 -0
- souleyez-2.0.20/souleyez/intelligence/target_parser.py +370 -0
- souleyez-2.0.20/souleyez/licensing/__init__.py +24 -0
- souleyez-2.0.20/souleyez/licensing/validator.py +365 -0
- souleyez-2.0.20/souleyez/log_config.py +176 -0
- souleyez-2.0.20/souleyez/main.py +2855 -0
- souleyez-2.0.20/souleyez/migrations/__init__.py +4 -0
- souleyez-2.0.20/souleyez/migrations/fix_job_counter.py +79 -0
- souleyez-2.0.20/souleyez/parsers/__init__.py +0 -0
- souleyez-2.0.20/souleyez/parsers/bloodhound_parser.py +101 -0
- souleyez-2.0.20/souleyez/parsers/crackmapexec_parser.py +204 -0
- souleyez-2.0.20/souleyez/parsers/dalfox_parser.py +236 -0
- souleyez-2.0.20/souleyez/parsers/dnsrecon_parser.py +221 -0
- souleyez-2.0.20/souleyez/parsers/enum4linux_parser.py +251 -0
- souleyez-2.0.20/souleyez/parsers/ffuf_parser.py +54 -0
- souleyez-2.0.20/souleyez/parsers/gobuster_parser.py +182 -0
- souleyez-2.0.20/souleyez/parsers/hashcat_parser.py +159 -0
- souleyez-2.0.20/souleyez/parsers/hydra_parser.py +319 -0
- souleyez-2.0.20/souleyez/parsers/impacket_parser.py +300 -0
- souleyez-2.0.20/souleyez/parsers/john_parser.py +186 -0
- souleyez-2.0.20/souleyez/parsers/msf_parser.py +1008 -0
- souleyez-2.0.20/souleyez/parsers/nikto_parser.py +229 -0
- souleyez-2.0.20/souleyez/parsers/nmap_parser.py +621 -0
- souleyez-2.0.20/souleyez/parsers/nuclei_parser.py +124 -0
- souleyez-2.0.20/souleyez/parsers/responder_parser.py +115 -0
- souleyez-2.0.20/souleyez/parsers/searchsploit_parser.py +232 -0
- souleyez-2.0.20/souleyez/parsers/smbmap_parser.py +281 -0
- souleyez-2.0.20/souleyez/parsers/sqlmap_parser.py +643 -0
- souleyez-2.0.20/souleyez/parsers/theharvester_parser.py +158 -0
- souleyez-2.0.20/souleyez/parsers/whois_parser.py +283 -0
- souleyez-2.0.20/souleyez/parsers/wpscan_parser.py +377 -0
- souleyez-2.0.20/souleyez/plugins/__init__.py +4 -0
- souleyez-2.0.20/souleyez/plugins/bloodhound.py +261 -0
- souleyez-2.0.20/souleyez/plugins/crackmapexec.py +317 -0
- souleyez-2.0.20/souleyez/plugins/dalfox.py +231 -0
- souleyez-2.0.20/souleyez/plugins/dnsrecon.py +200 -0
- souleyez-2.0.20/souleyez/plugins/enum4linux.py +251 -0
- souleyez-2.0.20/souleyez/plugins/ffuf.py +288 -0
- souleyez-2.0.20/souleyez/plugins/gobuster.py +393 -0
- souleyez-2.0.20/souleyez/plugins/hashcat.py +281 -0
- souleyez-2.0.20/souleyez/plugins/hydra.py +674 -0
- souleyez-2.0.20/souleyez/plugins/impacket_getnpusers.py +219 -0
- souleyez-2.0.20/souleyez/plugins/impacket_psexec.py +227 -0
- souleyez-2.0.20/souleyez/plugins/impacket_secretsdump.py +238 -0
- souleyez-2.0.20/souleyez/plugins/impacket_smbclient.py +228 -0
- souleyez-2.0.20/souleyez/plugins/john.py +235 -0
- souleyez-2.0.20/souleyez/plugins/msf_auxiliary.py +588 -0
- souleyez-2.0.20/souleyez/plugins/msf_exploit.py +345 -0
- souleyez-2.0.20/souleyez/plugins/nikto.py +245 -0
- souleyez-2.0.20/souleyez/plugins/nmap.py +350 -0
- souleyez-2.0.20/souleyez/plugins/nuclei.py +354 -0
- souleyez-2.0.20/souleyez/plugins/plugin_base.py +179 -0
- souleyez-2.0.20/souleyez/plugins/plugin_template.py +48 -0
- souleyez-2.0.20/souleyez/plugins/responder.py +325 -0
- souleyez-2.0.20/souleyez/plugins/searchsploit.py +238 -0
- souleyez-2.0.20/souleyez/plugins/smbmap.py +245 -0
- souleyez-2.0.20/souleyez/plugins/sqlmap.py +392 -0
- souleyez-2.0.20/souleyez/plugins/theharvester.py +242 -0
- souleyez-2.0.20/souleyez/plugins/whois.py +184 -0
- souleyez-2.0.20/souleyez/plugins/wpscan.py +224 -0
- souleyez-2.0.20/souleyez/reporting/__init__.py +4 -0
- souleyez-2.0.20/souleyez/reporting/attack_chain.py +753 -0
- souleyez-2.0.20/souleyez/reporting/charts.py +522 -0
- souleyez-2.0.20/souleyez/reporting/compliance_mappings.py +265 -0
- souleyez-2.0.20/souleyez/reporting/formatters.py +3336 -0
- souleyez-2.0.20/souleyez/reporting/generator.py +751 -0
- souleyez-2.0.20/souleyez/reporting/metrics.py +152 -0
- souleyez-2.0.20/souleyez/scanner.py +89 -0
- souleyez-2.0.20/souleyez/security/__init__.py +163 -0
- souleyez-2.0.20/souleyez/security/validation.py +548 -0
- souleyez-2.0.20/souleyez/security.py +84 -0
- souleyez-2.0.20/souleyez/storage/__init__.py +0 -0
- souleyez-2.0.20/souleyez/storage/credentials.py +672 -0
- souleyez-2.0.20/souleyez/storage/crypto.py +546 -0
- souleyez-2.0.20/souleyez/storage/database.py +359 -0
- souleyez-2.0.20/souleyez/storage/db.py +222 -0
- souleyez-2.0.20/souleyez/storage/deliverable_evidence.py +299 -0
- souleyez-2.0.20/souleyez/storage/deliverable_exporter.py +391 -0
- souleyez-2.0.20/souleyez/storage/deliverable_templates.py +297 -0
- souleyez-2.0.20/souleyez/storage/deliverables.py +368 -0
- souleyez-2.0.20/souleyez/storage/engagements.py +240 -0
- souleyez-2.0.20/souleyez/storage/evidence.py +308 -0
- souleyez-2.0.20/souleyez/storage/execution_log.py +143 -0
- souleyez-2.0.20/souleyez/storage/exploit_attempts.py +363 -0
- souleyez-2.0.20/souleyez/storage/exploits.py +222 -0
- souleyez-2.0.20/souleyez/storage/findings.py +390 -0
- souleyez-2.0.20/souleyez/storage/hosts.py +531 -0
- souleyez-2.0.20/souleyez/storage/migrate_to_engagements.py +149 -0
- souleyez-2.0.20/souleyez/storage/migrations/_001_add_credential_enhancements.py +74 -0
- souleyez-2.0.20/souleyez/storage/migrations/_002_add_status_tracking.py +33 -0
- souleyez-2.0.20/souleyez/storage/migrations/_003_add_execution_log.py +61 -0
- souleyez-2.0.20/souleyez/storage/migrations/_005_screenshots.py +34 -0
- souleyez-2.0.20/souleyez/storage/migrations/_006_deliverables.py +35 -0
- souleyez-2.0.20/souleyez/storage/migrations/_007_deliverable_templates.py +36 -0
- souleyez-2.0.20/souleyez/storage/migrations/_008_add_nuclei_table.py +36 -0
- souleyez-2.0.20/souleyez/storage/migrations/_009_add_cme_tables.py +16 -0
- souleyez-2.0.20/souleyez/storage/migrations/_010_evidence_linking.py +39 -0
- souleyez-2.0.20/souleyez/storage/migrations/_011_timeline_tracking.py +60 -0
- souleyez-2.0.20/souleyez/storage/migrations/_012_team_collaboration.py +78 -0
- souleyez-2.0.20/souleyez/storage/migrations/_013_add_host_tags.py +26 -0
- souleyez-2.0.20/souleyez/storage/migrations/_014_exploit_attempts.py +58 -0
- souleyez-2.0.20/souleyez/storage/migrations/_015_add_mac_os_fields.py +31 -0
- souleyez-2.0.20/souleyez/storage/migrations/_016_add_domain_field.py +26 -0
- souleyez-2.0.20/souleyez/storage/migrations/_017_msf_sessions.py +72 -0
- souleyez-2.0.20/souleyez/storage/migrations/_018_add_osint_target.py +42 -0
- souleyez-2.0.20/souleyez/storage/migrations/_019_add_engagement_type.py +42 -0
- souleyez-2.0.20/souleyez/storage/migrations/_020_add_rbac.py +119 -0
- souleyez-2.0.20/souleyez/storage/migrations/_021_wazuh_integration.py +77 -0
- souleyez-2.0.20/souleyez/storage/migrations/_022_wazuh_indexer_columns.py +34 -0
- souleyez-2.0.20/souleyez/storage/migrations/_023_fix_detection_results_fk.py +70 -0
- souleyez-2.0.20/souleyez/storage/migrations/__init__.py +67 -0
- souleyez-2.0.20/souleyez/storage/migrations/migration_manager.py +221 -0
- souleyez-2.0.20/souleyez/storage/msf_sessions.py +340 -0
- souleyez-2.0.20/souleyez/storage/osint.py +195 -0
- souleyez-2.0.20/souleyez/storage/recommendation_engine.py +419 -0
- souleyez-2.0.20/souleyez/storage/schema.sql +542 -0
- souleyez-2.0.20/souleyez/storage/screenshots.py +183 -0
- souleyez-2.0.20/souleyez/storage/smb_shares.py +293 -0
- souleyez-2.0.20/souleyez/storage/sqlmap_data.py +390 -0
- souleyez-2.0.20/souleyez/storage/team_collaboration.py +406 -0
- souleyez-2.0.20/souleyez/storage/timeline_tracker.py +283 -0
- souleyez-2.0.20/souleyez/storage/web_paths.py +190 -0
- souleyez-2.0.20/souleyez/testing/__init__.py +3 -0
- souleyez-2.0.20/souleyez/testing/credential_tester.py +448 -0
- souleyez-2.0.20/souleyez/ui/__init__.py +8 -0
- souleyez-2.0.20/souleyez/ui/ai_quotes.py +128 -0
- souleyez-2.0.20/souleyez/ui/attack_surface.py +4517 -0
- souleyez-2.0.20/souleyez/ui/chain_rules_view.py +1426 -0
- souleyez-2.0.20/souleyez/ui/correlation_view.py +630 -0
- souleyez-2.0.20/souleyez/ui/dashboard.py +4033 -0
- souleyez-2.0.20/souleyez/ui/deliverables_view.py +224 -0
- souleyez-2.0.20/souleyez/ui/design_system.py +118 -0
- souleyez-2.0.20/souleyez/ui/errors.py +325 -0
- souleyez-2.0.20/souleyez/ui/evidence_linking_view.py +382 -0
- souleyez-2.0.20/souleyez/ui/evidence_vault.py +1012 -0
- souleyez-2.0.20/souleyez/ui/exploit_suggestions_view.py +1556 -0
- souleyez-2.0.20/souleyez/ui/export_view.py +177 -0
- souleyez-2.0.20/souleyez/ui/help_system.py +411 -0
- souleyez-2.0.20/souleyez/ui/intelligence_view.py +770 -0
- souleyez-2.0.20/souleyez/ui/interactive.py +30097 -0
- souleyez-2.0.20/souleyez/ui/interactive_selector.py +474 -0
- souleyez-2.0.20/souleyez/ui/log_formatter.py +130 -0
- souleyez-2.0.20/souleyez/ui/menu_components.py +95 -0
- souleyez-2.0.20/souleyez/ui/msf_auxiliary_menu.py +478 -0
- souleyez-2.0.20/souleyez/ui/pending_chains_view.py +738 -0
- souleyez-2.0.20/souleyez/ui/progress_indicators.py +149 -0
- souleyez-2.0.20/souleyez/ui/recommendations_view.py +265 -0
- souleyez-2.0.20/souleyez/ui/rule_builder.py +521 -0
- souleyez-2.0.20/souleyez/ui/setup_wizard.py +776 -0
- souleyez-2.0.20/souleyez/ui/shortcuts.py +327 -0
- souleyez-2.0.20/souleyez/ui/team_dashboard.py +872 -0
- souleyez-2.0.20/souleyez/ui/template_selector.py +516 -0
- souleyez-2.0.20/souleyez/ui/terminal.py +84 -0
- souleyez-2.0.20/souleyez/ui/timeline_view.py +288 -0
- souleyez-2.0.20/souleyez/ui/tool_setup.py +639 -0
- souleyez-2.0.20/souleyez/ui/tutorial.py +355 -0
- souleyez-2.0.20/souleyez/ui/tutorial_state.py +213 -0
- souleyez-2.0.20/souleyez/ui.py +924 -0
- souleyez-2.0.20/souleyez/utils/__init__.py +0 -0
- souleyez-2.0.20/souleyez/utils/tool_checker.py +382 -0
- souleyez-2.0.20/souleyez/utils.py +103 -0
- souleyez-2.0.20/souleyez/wordlists.py +483 -0
- souleyez-2.0.20/souleyez.egg-info/PKG-INFO +284 -0
- souleyez-2.0.20/souleyez.egg-info/SOURCES.txt +325 -0
- souleyez-2.0.20/souleyez.egg-info/dependency_links.txt +1 -0
- souleyez-2.0.20/souleyez.egg-info/entry_points.txt +2 -0
- souleyez-2.0.20/souleyez.egg-info/requires.txt +17 -0
- souleyez-2.0.20/souleyez.egg-info/top_level.txt +1 -0
- souleyez-2.0.20/tests/test_config.py +483 -0
- souleyez-2.0.20/tests/test_config_enhanced.py +212 -0
- souleyez-2.0.20/tests/test_crypto.py +770 -0
- souleyez-2.0.20/tests/test_database_100_final.py +332 -0
- souleyez-2.0.20/tests/test_engagements.py +393 -0
- souleyez-2.0.20/tests/test_engagements_simple.py +155 -0
- souleyez-2.0.20/tests/test_job_status_tracking.py +123 -0
- souleyez-2.0.20/tests/test_logging.py +81 -0
- souleyez-2.0.20/tests/test_ollama_service.py +577 -0
- souleyez-2.0.20/tests/test_plugin_base.py +130 -0
- souleyez-2.0.20/tests/test_recommender.py +286 -0
- souleyez-2.0.20/tests/test_result_handler_sqlmap.py +61 -0
- souleyez-2.0.20/tests/test_schema.py +342 -0
- souleyez-2.0.20/tests/test_security_hardening.py +331 -0
- souleyez-2.0.20/tests/test_security_validation.py +392 -0
- souleyez-2.0.20/tests/test_sqlmap_parser.py +102 -0
- souleyez-2.0.20/tests/test_storage.py +209 -0
|
@@ -0,0 +1,232 @@
|
|
|
1
|
+
# SoulEyez Beta Program
|
|
2
|
+
|
|
3
|
+
Welcome to the SoulEyez beta! Thank you for helping us test and improve this penetration testing management platform.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## What is SoulEyez?
|
|
8
|
+
|
|
9
|
+
**SoulEyez is your penetration testing command center.** Instead of juggling dozens of terminal windows and text files, SoulEyez gives you one organized place to:
|
|
10
|
+
|
|
11
|
+
- **Run security scans** - Execute tools like Nmap, Gobuster, SQLMap with simple commands
|
|
12
|
+
- **Auto-discover next steps** - When one scan finds something interesting, SoulEyez automatically suggests (or runs) the next logical tool
|
|
13
|
+
- **Stay organized** - Keep all your targets, findings, and credentials in one searchable database
|
|
14
|
+
- **Generate reports** - Export professional reports when you're done
|
|
15
|
+
|
|
16
|
+
### Who is this for?
|
|
17
|
+
|
|
18
|
+
- **Security professionals** conducting authorized penetration tests
|
|
19
|
+
- **CTF players** who want better organization during competitions
|
|
20
|
+
- **Students** learning penetration testing methodology
|
|
21
|
+
|
|
22
|
+
> ⚠️ **Important**: Only use SoulEyez on systems you have explicit authorization to test.
|
|
23
|
+
|
|
24
|
+
## Version: 2.0.20
|
|
25
|
+
|
|
26
|
+
### What's Included
|
|
27
|
+
|
|
28
|
+
| Feature | FREE Tier | PRO Tier |
|
|
29
|
+
|---------|-----------|----------|
|
|
30
|
+
| Run security scans | ✅ | ✅ |
|
|
31
|
+
| Organize targets & findings | ✅ | ✅ |
|
|
32
|
+
| Encrypted credential storage | ✅ | ✅ |
|
|
33
|
+
| 20+ integrated tools | ✅ | ✅ |
|
|
34
|
+
| Report generation | ✅ | ✅ |
|
|
35
|
+
| AI-powered suggestions | ❌ | ✅ |
|
|
36
|
+
| Automatic tool chaining | ❌ | ✅ |
|
|
37
|
+
| Metasploit integration | ❌ | ✅ |
|
|
38
|
+
|
|
39
|
+
### System Requirements
|
|
40
|
+
|
|
41
|
+
- **Operating System**: Kali Linux or Ubuntu 22.04+ (Windows users: use WSL)
|
|
42
|
+
- **Python**: 3.8 or newer
|
|
43
|
+
- **Storage**: ~500MB for SoulEyez + tools
|
|
44
|
+
|
|
45
|
+
### Known Issues
|
|
46
|
+
|
|
47
|
+
- Very large scan outputs (>10MB) may slow the interface
|
|
48
|
+
- Some edge cases in tool output parsing
|
|
49
|
+
|
|
50
|
+
## Quick Start (Step-by-Step)
|
|
51
|
+
|
|
52
|
+
### Step 1: Install Prerequisites
|
|
53
|
+
|
|
54
|
+
First, we need `pipx` - a tool that safely installs Python CLI apps:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
sudo apt install pipx # Install pipx
|
|
58
|
+
pipx ensurepath # Add pipx apps to your PATH
|
|
59
|
+
source ~/.bashrc # Reload your shell (or close and reopen terminal)
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
> 💡 **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.
|
|
63
|
+
|
|
64
|
+
### Step 2: Install SoulEyez
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
pipx install souleyez
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
This downloads SoulEyez and all its dependencies. Takes 1-2 minutes.
|
|
71
|
+
|
|
72
|
+
### Step 3: Launch SoulEyez
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
souleyez dashboard
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Step 4: First-Time Setup Wizard
|
|
79
|
+
|
|
80
|
+
On your first run, SoulEyez guides you through setup:
|
|
81
|
+
|
|
82
|
+
1. **Tool Installation** - Detects missing security tools (nmap, sqlmap, etc.) and offers to install them
|
|
83
|
+
2. **Vault Password** - You'll create a master password that encrypts sensitive data
|
|
84
|
+
3. **Admin Account** - Create your login credentials
|
|
85
|
+
4. **First Engagement** - Set up your first project (like "Home Lab Test" or "CTF Challenge")
|
|
86
|
+
|
|
87
|
+
> 💡 **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.
|
|
88
|
+
|
|
89
|
+
### Step 5: You're Ready!
|
|
90
|
+
|
|
91
|
+
Once setup completes, you'll see the main menu. Navigate using the numbered options.
|
|
92
|
+
|
|
93
|
+
**Recommended: Run the built-in tutorial!**
|
|
94
|
+
|
|
95
|
+
Go to: **Settings & Security** → **[t] Tutorial**
|
|
96
|
+
|
|
97
|
+
The interactive tutorial walks you through:
|
|
98
|
+
1. Creating your first engagement
|
|
99
|
+
2. Running a basic reconnaissance scan
|
|
100
|
+
3. Viewing and understanding results
|
|
101
|
+
4. Using the real-time dashboard
|
|
102
|
+
5. Next steps and tips
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
## Common Commands
|
|
107
|
+
|
|
108
|
+
Here are the commands you'll use most often:
|
|
109
|
+
|
|
110
|
+
| Command | What it does |
|
|
111
|
+
|---------|--------------|
|
|
112
|
+
| `souleyez dashboard` | Launch the main interface |
|
|
113
|
+
| `souleyez doctor` | Check if everything is set up correctly |
|
|
114
|
+
| `souleyez setup` | Install/update pentesting tools |
|
|
115
|
+
| `souleyez --help` | Show all available commands |
|
|
116
|
+
| `souleyez <command> --help` | Get help for a specific command |
|
|
117
|
+
|
|
118
|
+
### Quick Troubleshooting
|
|
119
|
+
|
|
120
|
+
| Problem | Solution |
|
|
121
|
+
|---------|----------|
|
|
122
|
+
| "command not found: souleyez" | Run `pipx ensurepath` then restart your terminal |
|
|
123
|
+
| "Tool not found" errors | Run `souleyez setup` to install missing tools |
|
|
124
|
+
| Forgot your password | Data is encrypted - you'll need to start fresh with `rm -rf ~/.souleyez` |
|
|
125
|
+
| Something seems broken | Run `souleyez doctor` to diagnose the issue |
|
|
126
|
+
|
|
127
|
+
---
|
|
128
|
+
|
|
129
|
+
## Reporting Issues & Feedback
|
|
130
|
+
|
|
131
|
+
### Email (Preferred for Beta)
|
|
132
|
+
**cysoul.secit@gmail.com**
|
|
133
|
+
|
|
134
|
+
When reporting issues, please include:
|
|
135
|
+
- SoulEyez version (`souleyez --version`)
|
|
136
|
+
- Operating system and version
|
|
137
|
+
- Steps to reproduce
|
|
138
|
+
- Error messages (screenshots or copy/paste)
|
|
139
|
+
- Expected vs actual behavior
|
|
140
|
+
|
|
141
|
+
### Bug Report Template
|
|
142
|
+
```
|
|
143
|
+
**Description:**
|
|
144
|
+
[Brief description of the issue]
|
|
145
|
+
|
|
146
|
+
**Steps to Reproduce:**
|
|
147
|
+
1.
|
|
148
|
+
2.
|
|
149
|
+
3.
|
|
150
|
+
|
|
151
|
+
**Expected Behavior:**
|
|
152
|
+
[What should happen]
|
|
153
|
+
|
|
154
|
+
**Actual Behavior:**
|
|
155
|
+
[What actually happens]
|
|
156
|
+
|
|
157
|
+
**Environment:**
|
|
158
|
+
- OS:
|
|
159
|
+
- Python:
|
|
160
|
+
- SoulEyez version:
|
|
161
|
+
|
|
162
|
+
**Screenshots/Logs:**
|
|
163
|
+
[If applicable]
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
### Feature Requests
|
|
167
|
+
We welcome feature suggestions! Please prefix your issue title with `[Feature Request]`.
|
|
168
|
+
|
|
169
|
+
## Security Vulnerabilities
|
|
170
|
+
|
|
171
|
+
For security-related issues, please do NOT open a public GitHub issue.
|
|
172
|
+
|
|
173
|
+
Contact: cysoul.secit@gmail.com
|
|
174
|
+
|
|
175
|
+
Or see [SECURITY.md](SECURITY.md) for our security policy.
|
|
176
|
+
|
|
177
|
+
## Beta Feedback Survey
|
|
178
|
+
|
|
179
|
+
Help us improve SoulEyez by completing our quick feedback survey:
|
|
180
|
+
|
|
181
|
+
**[Take the Beta Feedback Survey](https://docs.google.com/forms/d/e/1FAIpQLSfylyvCor681VLeP7qGgFRDHCyzRDCFhiyjE6IqLbQDUB6-Jg/viewform?usp=send_form)**
|
|
182
|
+
|
|
183
|
+
## Beta Testing Guidelines
|
|
184
|
+
|
|
185
|
+
### What We Need Tested
|
|
186
|
+
- [ ] Full workflow: Create engagement → Add hosts → Run scans → Record findings → Generate report
|
|
187
|
+
- [ ] Credential encryption/decryption cycle
|
|
188
|
+
- [ ] Multi-user collaboration features
|
|
189
|
+
- [ ] Tool parsers (especially edge cases)
|
|
190
|
+
- [ ] Auto-chaining behavior
|
|
191
|
+
- [ ] Report generation quality
|
|
192
|
+
- [ ] UI responsiveness and navigation
|
|
193
|
+
|
|
194
|
+
### What to Avoid
|
|
195
|
+
- Don't test on production networks without authorization
|
|
196
|
+
- Don't store real client data in the beta (use test data)
|
|
197
|
+
- Don't share your vault password
|
|
198
|
+
|
|
199
|
+
## Support
|
|
200
|
+
|
|
201
|
+
- **Email**: cysoul.secit@gmail.com
|
|
202
|
+
- **Built-in Help**: Run `souleyez --help` or `souleyez <command> --help`
|
|
203
|
+
- **Diagnostics**: Run `souleyez doctor` to check your setup
|
|
204
|
+
|
|
205
|
+
---
|
|
206
|
+
|
|
207
|
+
## Glossary (New to Pentesting?)
|
|
208
|
+
|
|
209
|
+
| Term | Meaning |
|
|
210
|
+
|------|---------|
|
|
211
|
+
| **Engagement** | A project or assessment - contains all data for one test |
|
|
212
|
+
| **Target/Host** | A computer, server, or device you're testing |
|
|
213
|
+
| **Service** | A program running on a port (like a web server on port 80) |
|
|
214
|
+
| **Finding** | A security issue or vulnerability you discovered |
|
|
215
|
+
| **Credential** | Username/password combo found during testing |
|
|
216
|
+
| **Port** | A numbered "door" on a computer where services listen (e.g., 22=SSH, 80=HTTP) |
|
|
217
|
+
| **Nmap** | Network scanner - finds open ports and services |
|
|
218
|
+
| **Gobuster** | Directory scanner - finds hidden web pages |
|
|
219
|
+
| **SQLMap** | Automatically tests for SQL injection vulnerabilities |
|
|
220
|
+
| **Metasploit** | Framework for running exploits (PRO feature) |
|
|
221
|
+
|
|
222
|
+
---
|
|
223
|
+
|
|
224
|
+
## Thank You!
|
|
225
|
+
|
|
226
|
+
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.
|
|
227
|
+
|
|
228
|
+
Happy hacking! 🛡️
|
|
229
|
+
|
|
230
|
+
---
|
|
231
|
+
|
|
232
|
+
**Version**: 2.0.20 | **Release Date**: December 2025 | **Maintainer**: CyberSoul Security
|
souleyez-2.0.20/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 y0d8 & CyberSoul SecurITy
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the “Software”), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
|
13
|
+
all copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
21
|
+
THE SOFTWARE.
|
souleyez-2.0.20/PKG-INFO
ADDED
|
@@ -0,0 +1,284 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: souleyez
|
|
3
|
+
Version: 2.0.20
|
|
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
|
+
Dynamic: requires-python
|
|
52
|
+
|
|
53
|
+
# SoulEyez Beta Program
|
|
54
|
+
|
|
55
|
+
Welcome to the SoulEyez beta! Thank you for helping us test and improve this penetration testing management platform.
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## What is SoulEyez?
|
|
60
|
+
|
|
61
|
+
**SoulEyez is your penetration testing command center.** Instead of juggling dozens of terminal windows and text files, SoulEyez gives you one organized place to:
|
|
62
|
+
|
|
63
|
+
- **Run security scans** - Execute tools like Nmap, Gobuster, SQLMap with simple commands
|
|
64
|
+
- **Auto-discover next steps** - When one scan finds something interesting, SoulEyez automatically suggests (or runs) the next logical tool
|
|
65
|
+
- **Stay organized** - Keep all your targets, findings, and credentials in one searchable database
|
|
66
|
+
- **Generate reports** - Export professional reports when you're done
|
|
67
|
+
|
|
68
|
+
### Who is this for?
|
|
69
|
+
|
|
70
|
+
- **Security professionals** conducting authorized penetration tests
|
|
71
|
+
- **CTF players** who want better organization during competitions
|
|
72
|
+
- **Students** learning penetration testing methodology
|
|
73
|
+
|
|
74
|
+
> ⚠️ **Important**: Only use SoulEyez on systems you have explicit authorization to test.
|
|
75
|
+
|
|
76
|
+
## Version: 2.0.20
|
|
77
|
+
|
|
78
|
+
### What's Included
|
|
79
|
+
|
|
80
|
+
| Feature | FREE Tier | PRO Tier |
|
|
81
|
+
|---------|-----------|----------|
|
|
82
|
+
| Run security scans | ✅ | ✅ |
|
|
83
|
+
| Organize targets & findings | ✅ | ✅ |
|
|
84
|
+
| Encrypted credential storage | ✅ | ✅ |
|
|
85
|
+
| 20+ integrated tools | ✅ | ✅ |
|
|
86
|
+
| Report generation | ✅ | ✅ |
|
|
87
|
+
| AI-powered suggestions | ❌ | ✅ |
|
|
88
|
+
| Automatic tool chaining | ❌ | ✅ |
|
|
89
|
+
| Metasploit integration | ❌ | ✅ |
|
|
90
|
+
|
|
91
|
+
### System Requirements
|
|
92
|
+
|
|
93
|
+
- **Operating System**: Kali Linux or Ubuntu 22.04+ (Windows users: use WSL)
|
|
94
|
+
- **Python**: 3.8 or newer
|
|
95
|
+
- **Storage**: ~500MB for SoulEyez + tools
|
|
96
|
+
|
|
97
|
+
### Known Issues
|
|
98
|
+
|
|
99
|
+
- Very large scan outputs (>10MB) may slow the interface
|
|
100
|
+
- Some edge cases in tool output parsing
|
|
101
|
+
|
|
102
|
+
## Quick Start (Step-by-Step)
|
|
103
|
+
|
|
104
|
+
### Step 1: Install Prerequisites
|
|
105
|
+
|
|
106
|
+
First, we need `pipx` - a tool that safely installs Python CLI apps:
|
|
107
|
+
|
|
108
|
+
```bash
|
|
109
|
+
sudo apt install pipx # Install pipx
|
|
110
|
+
pipx ensurepath # Add pipx apps to your PATH
|
|
111
|
+
source ~/.bashrc # Reload your shell (or close and reopen terminal)
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
> 💡 **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.
|
|
115
|
+
|
|
116
|
+
### Step 2: Install SoulEyez
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
pipx install souleyez
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
This downloads SoulEyez and all its dependencies. Takes 1-2 minutes.
|
|
123
|
+
|
|
124
|
+
### Step 3: Launch SoulEyez
|
|
125
|
+
|
|
126
|
+
```bash
|
|
127
|
+
souleyez dashboard
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### Step 4: First-Time Setup Wizard
|
|
131
|
+
|
|
132
|
+
On your first run, SoulEyez guides you through setup:
|
|
133
|
+
|
|
134
|
+
1. **Tool Installation** - Detects missing security tools (nmap, sqlmap, etc.) and offers to install them
|
|
135
|
+
2. **Vault Password** - You'll create a master password that encrypts sensitive data
|
|
136
|
+
3. **Admin Account** - Create your login credentials
|
|
137
|
+
4. **First Engagement** - Set up your first project (like "Home Lab Test" or "CTF Challenge")
|
|
138
|
+
|
|
139
|
+
> 💡 **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.
|
|
140
|
+
|
|
141
|
+
### Step 5: You're Ready!
|
|
142
|
+
|
|
143
|
+
Once setup completes, you'll see the main menu. Navigate using the numbered options.
|
|
144
|
+
|
|
145
|
+
**Recommended: Run the built-in tutorial!**
|
|
146
|
+
|
|
147
|
+
Go to: **Settings & Security** → **[t] Tutorial**
|
|
148
|
+
|
|
149
|
+
The interactive tutorial walks you through:
|
|
150
|
+
1. Creating your first engagement
|
|
151
|
+
2. Running a basic reconnaissance scan
|
|
152
|
+
3. Viewing and understanding results
|
|
153
|
+
4. Using the real-time dashboard
|
|
154
|
+
5. Next steps and tips
|
|
155
|
+
|
|
156
|
+
---
|
|
157
|
+
|
|
158
|
+
## Common Commands
|
|
159
|
+
|
|
160
|
+
Here are the commands you'll use most often:
|
|
161
|
+
|
|
162
|
+
| Command | What it does |
|
|
163
|
+
|---------|--------------|
|
|
164
|
+
| `souleyez dashboard` | Launch the main interface |
|
|
165
|
+
| `souleyez doctor` | Check if everything is set up correctly |
|
|
166
|
+
| `souleyez setup` | Install/update pentesting tools |
|
|
167
|
+
| `souleyez --help` | Show all available commands |
|
|
168
|
+
| `souleyez <command> --help` | Get help for a specific command |
|
|
169
|
+
|
|
170
|
+
### Quick Troubleshooting
|
|
171
|
+
|
|
172
|
+
| Problem | Solution |
|
|
173
|
+
|---------|----------|
|
|
174
|
+
| "command not found: souleyez" | Run `pipx ensurepath` then restart your terminal |
|
|
175
|
+
| "Tool not found" errors | Run `souleyez setup` to install missing tools |
|
|
176
|
+
| Forgot your password | Data is encrypted - you'll need to start fresh with `rm -rf ~/.souleyez` |
|
|
177
|
+
| Something seems broken | Run `souleyez doctor` to diagnose the issue |
|
|
178
|
+
|
|
179
|
+
---
|
|
180
|
+
|
|
181
|
+
## Reporting Issues & Feedback
|
|
182
|
+
|
|
183
|
+
### Email (Preferred for Beta)
|
|
184
|
+
**cysoul.secit@gmail.com**
|
|
185
|
+
|
|
186
|
+
When reporting issues, please include:
|
|
187
|
+
- SoulEyez version (`souleyez --version`)
|
|
188
|
+
- Operating system and version
|
|
189
|
+
- Steps to reproduce
|
|
190
|
+
- Error messages (screenshots or copy/paste)
|
|
191
|
+
- Expected vs actual behavior
|
|
192
|
+
|
|
193
|
+
### Bug Report Template
|
|
194
|
+
```
|
|
195
|
+
**Description:**
|
|
196
|
+
[Brief description of the issue]
|
|
197
|
+
|
|
198
|
+
**Steps to Reproduce:**
|
|
199
|
+
1.
|
|
200
|
+
2.
|
|
201
|
+
3.
|
|
202
|
+
|
|
203
|
+
**Expected Behavior:**
|
|
204
|
+
[What should happen]
|
|
205
|
+
|
|
206
|
+
**Actual Behavior:**
|
|
207
|
+
[What actually happens]
|
|
208
|
+
|
|
209
|
+
**Environment:**
|
|
210
|
+
- OS:
|
|
211
|
+
- Python:
|
|
212
|
+
- SoulEyez version:
|
|
213
|
+
|
|
214
|
+
**Screenshots/Logs:**
|
|
215
|
+
[If applicable]
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
### Feature Requests
|
|
219
|
+
We welcome feature suggestions! Please prefix your issue title with `[Feature Request]`.
|
|
220
|
+
|
|
221
|
+
## Security Vulnerabilities
|
|
222
|
+
|
|
223
|
+
For security-related issues, please do NOT open a public GitHub issue.
|
|
224
|
+
|
|
225
|
+
Contact: cysoul.secit@gmail.com
|
|
226
|
+
|
|
227
|
+
Or see [SECURITY.md](SECURITY.md) for our security policy.
|
|
228
|
+
|
|
229
|
+
## Beta Feedback Survey
|
|
230
|
+
|
|
231
|
+
Help us improve SoulEyez by completing our quick feedback survey:
|
|
232
|
+
|
|
233
|
+
**[Take the Beta Feedback Survey](https://docs.google.com/forms/d/e/1FAIpQLSfylyvCor681VLeP7qGgFRDHCyzRDCFhiyjE6IqLbQDUB6-Jg/viewform?usp=send_form)**
|
|
234
|
+
|
|
235
|
+
## Beta Testing Guidelines
|
|
236
|
+
|
|
237
|
+
### What We Need Tested
|
|
238
|
+
- [ ] Full workflow: Create engagement → Add hosts → Run scans → Record findings → Generate report
|
|
239
|
+
- [ ] Credential encryption/decryption cycle
|
|
240
|
+
- [ ] Multi-user collaboration features
|
|
241
|
+
- [ ] Tool parsers (especially edge cases)
|
|
242
|
+
- [ ] Auto-chaining behavior
|
|
243
|
+
- [ ] Report generation quality
|
|
244
|
+
- [ ] UI responsiveness and navigation
|
|
245
|
+
|
|
246
|
+
### What to Avoid
|
|
247
|
+
- Don't test on production networks without authorization
|
|
248
|
+
- Don't store real client data in the beta (use test data)
|
|
249
|
+
- Don't share your vault password
|
|
250
|
+
|
|
251
|
+
## Support
|
|
252
|
+
|
|
253
|
+
- **Email**: cysoul.secit@gmail.com
|
|
254
|
+
- **Built-in Help**: Run `souleyez --help` or `souleyez <command> --help`
|
|
255
|
+
- **Diagnostics**: Run `souleyez doctor` to check your setup
|
|
256
|
+
|
|
257
|
+
---
|
|
258
|
+
|
|
259
|
+
## Glossary (New to Pentesting?)
|
|
260
|
+
|
|
261
|
+
| Term | Meaning |
|
|
262
|
+
|------|---------|
|
|
263
|
+
| **Engagement** | A project or assessment - contains all data for one test |
|
|
264
|
+
| **Target/Host** | A computer, server, or device you're testing |
|
|
265
|
+
| **Service** | A program running on a port (like a web server on port 80) |
|
|
266
|
+
| **Finding** | A security issue or vulnerability you discovered |
|
|
267
|
+
| **Credential** | Username/password combo found during testing |
|
|
268
|
+
| **Port** | A numbered "door" on a computer where services listen (e.g., 22=SSH, 80=HTTP) |
|
|
269
|
+
| **Nmap** | Network scanner - finds open ports and services |
|
|
270
|
+
| **Gobuster** | Directory scanner - finds hidden web pages |
|
|
271
|
+
| **SQLMap** | Automatically tests for SQL injection vulnerabilities |
|
|
272
|
+
| **Metasploit** | Framework for running exploits (PRO feature) |
|
|
273
|
+
|
|
274
|
+
---
|
|
275
|
+
|
|
276
|
+
## Thank You!
|
|
277
|
+
|
|
278
|
+
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.
|
|
279
|
+
|
|
280
|
+
Happy hacking! 🛡️
|
|
281
|
+
|
|
282
|
+
---
|
|
283
|
+
|
|
284
|
+
**Version**: 2.0.20 | **Release Date**: December 2025 | **Maintainer**: CyberSoul Security
|