souleyez 2.43.29__py3-none-any.whl → 3.0.0__py3-none-any.whl

souleyez/core/templates.py

@@ -12,6 +12,7 @@ from typing import List, Dict, Any, Optional
 @dataclass
 class ScanPhase:
     """A phase in the recommended scan sequence."""
+
     name: str
     description: str
     tools: List[str]
@@ -21,6 +22,7 @@ class ScanPhase:
 @dataclass
 class EngagementTemplate:
     """Workflow preset for a specific type of penetration test."""
+
     id: str
     name: str
     description: str
@@ -58,170 +60,200 @@ TEMPLATES: Dict[str, EngagementTemplate] = {
         description="Test web applications for OWASP Top 10 and common web vulnerabilities",
         icon="[W]",
         recommended_tools=[
-            "nmap", "nikto", "gobuster", "feroxbuster", "sqlmap",
-            "whatweb", "wpscan", "nuclei", "ffuf", "httpx"
+            "nmap",
+            "nikto",
+            "gobuster",
+            "feroxbuster",
+            "sqlmap",
+            "whatweb",
+            "wpscan",
+            "nuclei",
+            "ffuf",
+            "httpx",
         ],
         scan_phases=[
             ScanPhase(
                 name="Reconnaissance",
                 description="Discover services, technologies, and entry points",
-                tools=["nmap", "whatweb", "httpx"]
+                tools=["nmap", "whatweb", "httpx"],
             ),
             ScanPhase(
                 name="Content Discovery",
                 description="Find hidden directories, files, and endpoints",
-                tools=["gobuster", "feroxbuster", "ffuf"]
+                tools=["gobuster", "feroxbuster", "ffuf"],
             ),
             ScanPhase(
                 name="Vulnerability Scanning",
                 description="Identify known vulnerabilities and misconfigurations",
-                tools=["nikto", "nuclei", "wpscan"]
+                tools=["nikto", "nuclei", "wpscan"],
             ),
             ScanPhase(
                 name="Exploitation Testing",
                 description="Test for injectable parameters and weaknesses",
-                tools=["sqlmap"]
-            )
+                tools=["sqlmap"],
+            ),
         ],
         wordlists={
             "directories": "directory-list-2.3-medium.txt",
             "files": "raft-large-files.txt",
-            "subdomains": "subdomains-top1million-5000.txt"
+            "subdomains": "subdomains-top1million-5000.txt",
         },
         common_findings=[
-            "SQL Injection", "Cross-Site Scripting (XSS)", "CSRF",
-            "Insecure Direct Object Reference", "Security Misconfiguration",
-            "Sensitive Data Exposure", "Broken Authentication",
-            "Directory Listing Enabled", "Information Disclosure"
+            "SQL Injection",
+            "Cross-Site Scripting (XSS)",
+            "CSRF",
+            "Insecure Direct Object Reference",
+            "Security Misconfiguration",
+            "Sensitive Data Exposure",
+            "Broken Authentication",
+            "Directory Listing Enabled",
+            "Information Disclosure",
         ],
         tips=[
             "Start with nmap to identify web ports (80, 443, 8080, 8443)",
             "Use whatweb to fingerprint technologies before deeper scanning",
             "Check robots.txt and sitemap.xml for hidden paths",
             "Test both authenticated and unauthenticated access",
-            "Look for API endpoints (/api/, /v1/, /graphql)"
-        ],
-        scope_examples=[
-            "https://example.com",
-            "app.example.com",
-            "192.168.1.100:8080"
+            "Look for API endpoints (/api/, /v1/, /graphql)",
         ],
+        scope_examples=["https://example.com", "app.example.com", "192.168.1.100:8080"],
         initial_scan_tool="nmap",
         initial_scan_args="-sV -sC -p 80,443,8080,8443",
-        initial_scan_description="Service scan on common web ports"
+        initial_scan_description="Service scan on common web ports",
     ),
-
     "network": EngagementTemplate(
         id="network",
         name="Network Infrastructure",
         description="Test network devices, services, and infrastructure security",
         icon="[N]",
         recommended_tools=[
-            "nmap", "masscan", "enum4linux-ng", "smbclient", "snmpwalk",
-            "nbtscan", "onesixtyone", "hydra", "crackmapexec", "rpcclient"
+            "nmap",
+            "masscan",
+            "enum4linux-ng",
+            "smbclient",
+            "snmpwalk",
+            "nbtscan",
+            "onesixtyone",
+            "hydra",
+            "crackmapexec",
+            "rpcclient",
         ],
         scan_phases=[
             ScanPhase(
                 name="Host Discovery",
                 description="Identify live hosts on the network",
-                tools=["nmap", "masscan", "nbtscan"]
+                tools=["nmap", "masscan", "nbtscan"],
             ),
             ScanPhase(
                 name="Port Scanning",
                 description="Enumerate open ports and services",
-                tools=["nmap", "masscan"]
+                tools=["nmap", "masscan"],
             ),
             ScanPhase(
                 name="Service Enumeration",
                 description="Gather detailed information about services",
-                tools=["nmap", "enum4linux-ng", "snmpwalk", "onesixtyone"]
+                tools=["nmap", "enum4linux-ng", "snmpwalk", "onesixtyone"],
             ),
             ScanPhase(
                 name="Vulnerability Assessment",
                 description="Identify vulnerabilities in network services",
-                tools=["nmap"]  # NSE scripts
+                tools=["nmap"],  # NSE scripts
             ),
             ScanPhase(
                 name="Credential Testing",
                 description="Test for weak or default credentials",
-                tools=["hydra", "crackmapexec"]
-            )
+                tools=["hydra", "crackmapexec"],
+            ),
         ],
         wordlists={
-            "passwords": "rockyou.txt",
-            "usernames": "names.txt",
-            "snmp": "snmp-strings.txt"
+            "passwords": "passwords_brute.txt",
+            "usernames": "usernames_common.txt",
+            "snmp": "snmp-strings.txt",
         },
         common_findings=[
-            "Default Credentials", "Weak Passwords", "SMB Signing Disabled",
-            "Anonymous FTP Access", "SNMP Community Strings",
-            "Unpatched Services", "Telnet Enabled", "Clear-text Protocols",
-            "Unnecessary Services", "Network Segmentation Issues"
+            "Default Credentials",
+            "Weak Passwords",
+            "SMB Signing Disabled",
+            "Anonymous FTP Access",
+            "SNMP Community Strings",
+            "Unpatched Services",
+            "Telnet Enabled",
+            "Clear-text Protocols",
+            "Unnecessary Services",
+            "Network Segmentation Issues",
         ],
         tips=[
             "Use masscan for fast initial discovery, nmap for detailed scans",
             "Check for SMB null sessions and anonymous access",
             "Look for SNMP with default community strings (public/private)",
             "Test SSH, FTP, and Telnet for weak/default credentials",
-            "Document the network topology as you discover it"
-        ],
-        scope_examples=[
-            "192.168.1.0/24",
-            "10.0.0.0/8",
-            "172.16.0.1-172.16.0.254"
+            "Document the network topology as you discover it",
         ],
+        scope_examples=["192.168.1.0/24", "10.0.0.0/8", "172.16.0.1-172.16.0.254"],
         initial_scan_tool="nmap",
         initial_scan_args="-sn",
-        initial_scan_description="Host discovery ping sweep"
+        initial_scan_description="Host discovery ping sweep",
     ),
-
     "activedirectory": EngagementTemplate(
         id="activedirectory",
         name="Active Directory",
         description="Test Windows Active Directory environments for privilege escalation paths",
         icon="[AD]",
         recommended_tools=[
-            "nmap", "enum4linux-ng", "crackmapexec", "smbclient", "rpcclient",
-            "impacket", "bloodhound", "ldapsearch", "kerbrute", "responder"
+            "nmap",
+            "enum4linux-ng",
+            "crackmapexec",
+            "smbclient",
+            "rpcclient",
+            "impacket",
+            "bloodhound",
+            "ldapsearch",
+            "kerbrute",
+            "responder",
         ],
         scan_phases=[
             ScanPhase(
                 name="Domain Enumeration",
                 description="Identify domain controllers and domain info",
-                tools=["nmap", "crackmapexec"]
+                tools=["nmap", "crackmapexec"],
             ),
             ScanPhase(
                 name="User Enumeration",
                 description="Enumerate domain users, groups, and computers",
-                tools=["enum4linux-ng", "crackmapexec", "rpcclient"]
+                tools=["enum4linux-ng", "crackmapexec", "rpcclient"],
             ),
             ScanPhase(
                 name="Kerberos Attacks",
                 description="Test for Kerberoasting and AS-REP roasting",
-                tools=["impacket", "kerbrute"]
+                tools=["impacket", "kerbrute"],
             ),
             ScanPhase(
                 name="SMB/LDAP Enumeration",
                 description="Enumerate shares, GPOs, and LDAP objects",
-                tools=["smbclient", "crackmapexec", "ldapsearch"]
+                tools=["smbclient", "crackmapexec", "ldapsearch"],
             ),
             ScanPhase(
                 name="Attack Path Analysis",
                 description="Identify paths to domain admin",
-                tools=["bloodhound"]
-            )
+                tools=["bloodhound"],
+            ),
         ],
         wordlists={
-            "passwords": "rockyou.txt",
-            "usernames": "xato-net-10-million-usernames.txt",
-            "ad-users": "statistically-likely-usernames.txt"
+            "passwords": "passwords_brute.txt",
+            "usernames": "usernames_common.txt",
+            "ad-users": "ad_users.txt",
         },
         common_findings=[
-            "Kerberoastable Accounts", "AS-REP Roastable Accounts",
-            "Weak Domain Passwords", "LLMNR/NBT-NS Poisoning",
-            "Unconstrained Delegation", "Password in Description",
-            "Service Account Misconfiguration", "GPP Passwords",
-            "SMB Signing Disabled", "Path to Domain Admin"
+            "Kerberoastable Accounts",
+            "AS-REP Roastable Accounts",
+            "Weak Domain Passwords",
+            "LLMNR/NBT-NS Poisoning",
+            "Unconstrained Delegation",
+            "Password in Description",
+            "Service Account Misconfiguration",
+            "GPP Passwords",
+            "SMB Signing Disabled",
+            "Path to Domain Admin",
         ],
         tips=[
             "Start by identifying all Domain Controllers",
@@ -229,18 +261,17 @@ TEMPLATES: Dict[str, EngagementTemplate] = {
             "Look for service accounts with SPNs (Kerberoasting)",
             "Use BloodHound to visualize attack paths",
             "Check GPO for stored credentials (GPP)",
-            "Test password spray attacks carefully (lockout policies!)"
+            "Test password spray attacks carefully (lockout policies!)",
         ],
         scope_examples=[
             "CORP.EXAMPLE.COM",
             "10.10.10.0/24 (DC subnet)",
-            "dc01.corp.local"
+            "dc01.corp.local",
         ],
         initial_scan_tool="nmap",
         initial_scan_args="-sV -p 53,88,135,139,389,445,464,636,3268,3269",
-        initial_scan_description="AD/DC service discovery"
+        initial_scan_description="AD/DC service discovery",
     ),
-
     "custom": EngagementTemplate(
         id="custom",
         name="Custom / Blank",
@@ -254,59 +285,69 @@ TEMPLATES: Dict[str, EngagementTemplate] = {
             "Define your scope clearly before starting",
             "Enable only the tools you need",
             "Use 'souleyez run <tool>' to queue scans",
-            "Check 'souleyez dashboard' to monitor progress"
+            "Check 'souleyez dashboard' to monitor progress",
         ],
-        scope_examples=[
-            "any target or range"
-        ]
+        scope_examples=["any target or range"],
     ),
-
     "ctf": EngagementTemplate(
         id="ctf",
         name="CTF / HackTheBox",
         description="Optimized for CTF challenges and platforms like HackTheBox/TryHackMe",
         icon="[CTF]",
         recommended_tools=[
-            "nmap", "gobuster", "nikto", "ffuf", "enum4linux-ng",
-            "linpeas", "winpeas", "pspy", "hydra", "john", "hashcat"
+            "nmap",
+            "gobuster",
+            "nikto",
+            "ffuf",
+            "enum4linux-ng",
+            "linpeas",
+            "winpeas",
+            "pspy",
+            "hydra",
+            "john",
+            "hashcat",
         ],
         scan_phases=[
             ScanPhase(
                 name="Full Port Scan",
                 description="Scan all 65535 ports - CTF boxes often have unusual ports",
-                tools=["nmap"]
+                tools=["nmap"],
             ),
             ScanPhase(
                 name="Service Enumeration",
                 description="Deep dive into each discovered service",
-                tools=["nmap", "enum4linux-ng"]
+                tools=["nmap", "enum4linux-ng"],
             ),
             ScanPhase(
                 name="Web Enumeration",
                 description="If web ports found, enumerate thoroughly",
-                tools=["gobuster", "ffuf", "nikto"]
+                tools=["gobuster", "ffuf", "nikto"],
             ),
             ScanPhase(
                 name="Exploitation",
                 description="Exploit vulnerabilities for initial access",
-                tools=[]  # Manual + searchsploit
+                tools=[],  # Manual + searchsploit
             ),
             ScanPhase(
                 name="Privilege Escalation",
                 description="Escalate to root/admin",
-                tools=["linpeas", "winpeas"]
-            )
+                tools=["linpeas", "winpeas"],
+            ),
         ],
         wordlists={
-            "directories": "directory-list-2.3-medium.txt",
-            "passwords": "rockyou.txt",
-            "extensions": "web-extensions.txt"
+            "directories": "web_dirs_large.txt",
+            "passwords": "passwords_brute.txt",
+            "extensions": "web_extensions.txt",
         },
         common_findings=[
-            "Hidden Web Directory", "Default Credentials",
-            "Outdated Software Version", "SUID Binary",
-            "Writable Script in Cron", "SSH Key Exposure",
-            "Database Credentials in Config", "Kernel Exploit"
+            "Hidden Web Directory",
+            "Default Credentials",
+            "Outdated Software Version",
+            "SUID Binary",
+            "Writable Script in Cron",
+            "SSH Key Exposure",
+            "Database Credentials in Config",
+            "Kernel Exploit",
         ],
         tips=[
             "Always do a full port scan (-p-) - CTF boxes hide services",
@@ -314,17 +355,13 @@ TEMPLATES: Dict[str, EngagementTemplate] = {
             "Look for version numbers to searchsploit",
             "After initial access, stabilize your shell first",
             "Run linPEAS/winPEAS immediately after access",
-            "Check sudo -l, SUID binaries, and cron jobs"
-        ],
-        scope_examples=[
-            "10.10.10.X (HTB)",
-            "10.10.X.X (THM)",
-            "ctf.example.com"
+            "Check sudo -l, SUID binaries, and cron jobs",
         ],
+        scope_examples=["10.10.10.X (HTB)", "10.10.X.X (THM)", "ctf.example.com"],
         initial_scan_tool="nmap",
         initial_scan_args="-sV -sC -p-",
-        initial_scan_description="Full port scan (all 65535 ports)"
-    )
+        initial_scan_description="Full port scan (all 65535 ports)",
+    ),
 }
 
 
@@ -355,6 +392,7 @@ def apply_template_settings(engagement_id: int, template_id: str) -> Dict[str, A
 
     # Store template metadata with engagement (for future reference)
     from souleyez.storage.engagements import EngagementManager
+
     em = EngagementManager()
 
     # Update engagement type
@@ -365,7 +403,7 @@ def apply_template_settings(engagement_id: int, template_id: str) -> Dict[str, A
         "template": template.name,
         "recommended_tools": template.recommended_tools,
         "scan_phases": [p.name for p in template.scan_phases],
-        "tips": template.tips[:3]  # First 3 tips
+        "tips": template.tips[:3],  # First 3 tips
     }
 
 
@@ -374,33 +412,33 @@ def display_template_info(template: EngagementTemplate) -> None:
     import click
 
     click.echo()
-    click.echo(click.style(f"  {template.icon} {template.name}", fg='cyan', bold=True))
-    click.echo(click.style(f"  {template.description}", fg='white'))
+    click.echo(click.style(f"  {template.icon} {template.name}", fg="cyan", bold=True))
+    click.echo(click.style(f"  {template.description}", fg="white"))
     click.echo()
 
     if template.recommended_tools:
-        click.echo(click.style("  Recommended Tools:", fg='yellow'))
+        click.echo(click.style("  Recommended Tools:", fg="yellow"))
         # Display in rows of 5
         tools = template.recommended_tools
         for i in range(0, len(tools), 5):
-            row = tools[i:i+5]
+            row = tools[i : i + 5]
             click.echo("    " + ", ".join(row))
         click.echo()
 
     if template.scan_phases:
-        click.echo(click.style("  Scan Phases:", fg='yellow'))
+        click.echo(click.style("  Scan Phases:", fg="yellow"))
         for i, phase in enumerate(template.scan_phases, 1):
             click.echo(f"    {i}. {phase.name} - {phase.description}")
         click.echo()
 
     if template.tips:
-        click.echo(click.style("  Quick Tips:", fg='yellow'))
+        click.echo(click.style("  Quick Tips:", fg="yellow"))
         for tip in template.tips[:3]:
             click.echo(f"    - {tip}")
         click.echo()
 
     if template.scope_examples:
-        click.echo(click.style("  Scope Examples:", fg='yellow'))
+        click.echo(click.style("  Scope Examples:", fg="yellow"))
         for ex in template.scope_examples:
             click.echo(f"    - {ex}")
 
@@ -413,7 +451,9 @@ def get_recommended_tools(engagement_type: str) -> set:
     return set(t.lower() for t in template.recommended_tools)
 
 
-def queue_initial_scan(template_id: str, target: str, engagement_id: int) -> Optional[int]:
+def queue_initial_scan(
+    template_id: str, target: str, engagement_id: int
+) -> Optional[int]:
     """
     Queue the initial scan for a template.
 
@@ -425,13 +465,14 @@ def queue_initial_scan(template_id: str, target: str, engagement_id: int) -> Opt
 
     try:
         from souleyez.engine.background import enqueue_job
+
         job_id = enqueue_job(
             tool=template.initial_scan_tool,
             target=target,
             args=template.initial_scan_args,
             label=f"Initial: {template.initial_scan_description}",
             engagement_id=engagement_id,
-            metadata={"auto_queued": True, "template": template_id}
+            metadata={"auto_queued": True, "template": template_id},
         )
         return job_id
     except Exception:
@@ -457,16 +498,26 @@ def display_scan_phases_guide(template_id: str, clear_screen: bool = True) -> No
     click.echo("┌" + "─" * (width - 2) + "┐")
     title = f"SCAN PHASES GUIDE: {template.name if template else 'Unknown'}"
     padding = (width - len(title) - 2) // 2
-    click.echo("│" + " " * padding + click.style(title, bold=True, fg='cyan') + " " * (width - len(title) - padding - 2) + "│")
+    click.echo(
+        "│"
+        + " " * padding
+        + click.style(title, bold=True, fg="cyan")
+        + " " * (width - len(title) - padding - 2)
+        + "│"
+    )
     click.echo("└" + "─" * (width - 2) + "┘")
     click.echo()
 
     if not template:
-        click.echo(click.style("  No template found.", fg='red'))
+        click.echo(click.style("  No template found.", fg="red"))
         return
 
     if not template.scan_phases:
-        click.echo(click.style("  No scan phases defined for this engagement type.", fg='yellow'))
+        click.echo(
+            click.style(
+                "  No scan phases defined for this engagement type.", fg="yellow"
+            )
+        )
         click.echo("  This is a custom engagement - define your own workflow!")
         return
 
@@ -475,11 +526,11 @@ def display_scan_phases_guide(template_id: str, clear_screen: bool = True) -> No
     click.echo()
 
     for i, phase in enumerate(template.scan_phases, 1):
-        click.echo(click.style(f"    Phase {i}: {phase.name}", fg='yellow', bold=True))
+        click.echo(click.style(f"    Phase {i}: {phase.name}", fg="yellow", bold=True))
         click.echo(f"    {phase.description}")
         if phase.tools:
             tools_str = ", ".join(phase.tools)
-            click.echo(click.style("    Tools: ", fg='green') + tools_str)
+            click.echo(click.style("    Tools: ", fg="green") + tools_str)
         click.echo()
 
     if template.tips:
@@ -493,6 +544,6 @@ def display_scan_phases_guide(template_id: str, clear_screen: bool = True) -> No
 
     click.echo("  " + "─" * (width - 4))
     click.echo()
-    click.echo(click.style("    [q] ← Back", fg='bright_black'))
+    click.echo(click.style("    [q] ← Back", fg="bright_black"))
     click.echo()
     click.echo("  " + "─" * (width - 4))