driftmux

User guide

  • Installation
    • Requirements
    • Install from source
    • Install Nmap
    • Install Nuclei
    • Optional: OS detection
  • Quickstart
    • Basic scan
    • Specify ports manually
    • Use a profile
    • Use NVD enrichment
    • Run Nmap scripts
    • Output
  • Scan profiles
    • Passive
    • Fast
    • Deep
    • Choosing a profile
  • Command line interface
    • Common options
    • Examples

Internals

  • Architecture
    • Pipeline overview
    • Models
    • Planner
    • Nuclei integration
    • NVD enrichment
  • API reference
    • Engine
      • DriftmuxEngine
        • DriftmuxEngine.scan_host()
        • DriftmuxEngine.scan_hosts()
      • ScanConfig
        • ScanConfig.deep_wordpress
        • ScanConfig.log_dir
        • ScanConfig.min_cvss
        • ScanConfig.nmap_script
        • ScanConfig.nuclei_profile
        • ScanConfig.nvd_api_key
        • ScanConfig.nvd_cache
        • ScanConfig.nvd_cache_ttl_hours
        • ScanConfig.output_dir
        • ScanConfig.output_format
        • ScanConfig.ports
        • ScanConfig.timeout
        • ScanConfig.vuln_backend
        • ScanConfig.web_scheme
      • guess_scheme()
      • is_web_candidate()
    • Models
      • Finding
        • Finding.confidence
        • Finding.description
        • Finding.detected_version
        • Finding.evidence
        • Finding.host
        • Finding.metadata
        • Finding.normalized_severity()
        • Finding.port
        • Finding.reference
        • Finding.scanner
        • Finding.service
        • Finding.severity
        • Finding.title
        • Finding.to_dict()
      • HostScanResult
        • HostScanResult.add_error()
        • HostScanResult.errors
        • HostScanResult.findings
        • HostScanResult.host
        • HostScanResult.max_severity()
        • HostScanResult.metadata
        • HostScanResult.services
        • HostScanResult.to_dict()
      • OpenPort
        • OpenPort.classifications
        • OpenPort.cpes
        • OpenPort.detected_version()
        • OpenPort.endpoint()
        • OpenPort.extrainfo
        • OpenPort.port
        • OpenPort.product
        • OpenPort.protocol
        • OpenPort.service
        • OpenPort.state
        • OpenPort.to_dict()
        • OpenPort.tunnel
        • OpenPort.version
      • ToolError
        • ToolError.details
        • ToolError.host
        • ToolError.message
        • ToolError.scanner
        • ToolError.to_dict()
    • Planner
      • NucleiTarget
        • NucleiTarget.host
        • NucleiTarget.reason
        • NucleiTarget.service
        • NucleiTarget.severity
        • NucleiTarget.tags
        • NucleiTarget.url
      • ScanPlan
        • ScanPlan.nuclei_targets
        • ScanPlan.passive_only
        • ScanPlan.wordpress_targets
      • build_scan_plan()
      • build_url()
      • is_web_candidate()
      • tags_for_service()
    • Nmap scanner
      • NmapScanner
        • NmapScanner.debug
        • NmapScanner.extra_args
        • NmapScanner.nmap_script
        • NmapScanner.ports
        • NmapScanner.scan()
        • NmapScanner.timeout
    • Nuclei scanner
      • NucleiScanner
        • NucleiScanner.profile
        • NucleiScanner.scan_many()
        • NucleiScanner.timeout
driftmux
  • Overview: module code

All modules for which code is available

  • driftmux.engine
  • driftmux.models
  • driftmux.planner
  • driftmux.scanners.nmap
  • driftmux.scanners.nuclei

© Copyright 2026, aidaph.

Built with Sphinx using a theme provided by Read the Docs.