recon-pipeline/pipeline/recon/wrappers.py

import luigi
from luigi.util import inherits

from .nmap import SearchsploitScan
from .helpers import get_tool_state
from .web import AquatoneScan, GobusterScan, SubjackScan, TKOSubsScan, WaybackurlsScan, WebanalyzeScan


@inherits(SearchsploitScan, AquatoneScan, TKOSubsScan, SubjackScan, GobusterScan, WebanalyzeScan)
class FullScan(luigi.WrapperTask):
    """ Wraps multiple scan types in order to run tasks on the same hierarchical level at the same time.

    Note:
        Because FullScan is a wrapper, it requires all Parameters for any of the Scans that it wraps.

    Args:
        threads: number of threads for parallel gobuster command execution
        wordlist: wordlist used for forced browsing
        extensions: additional extensions to apply to each item in the wordlist
        recursive: whether or not to recursively gobust the target (may produce a LOT of traffic... quickly)
        proxy: protocol://ip:port proxy specification for gobuster
        exempt_list: Path to a file providing blacklisted subdomains, one per line.
        top_ports: Scan top N most popular ports
        ports: specifies the port(s) to be scanned
        interface: use the named raw network interface, such as "eth0"
        rate: desired rate for transmitting packets (packets per second)
        target_file: specifies the file on disk containing a list of ips or domains
        results_dir: specifes the directory on disk to which all Task results are written
    """

    @staticmethod
    def meets_requirements():
        """ Reports whether or not this scan's needed tool(s) are installed or not """
        needs = [
            "amass",
            "aquatone",
            "masscan",
            "tko-subs",
            "recursive-gobuster",
            "searchsploit",
            "subjack",
            "gobuster",
            "webanalyze",
            "waybackurls",
        ]
        tools = get_tool_state()

        if tools:
            return all([tools.get(x).get("installed") is True for x in needs])

    def requires(self):
        """ FullScan is a wrapper, as such it requires any Tasks that it wraps. """
        args = {
            "results_dir": self.results_dir,
            "rate": self.rate,
            "target_file": self.target_file,
            "top_ports": self.top_ports,
            "interface": self.interface,
            "ports": self.ports,
            "exempt_list": self.exempt_list,
            "threads": self.threads,
            "proxy": self.proxy,
            "wordlist": self.wordlist,
            "extensions": self.extensions,
            "recursive": self.recursive,
            "db_location": self.db_location,
        }

        yield GobusterScan(**args)

        # remove options that are gobuster specific; if left dictionary unpacking to other scans throws an exception
        for gobuster_opt in ("proxy", "wordlist", "extensions", "recursive"):
            del args[gobuster_opt]

        # add aquatone scan specific option
        args.update({"scan_timeout": self.scan_timeout})

        yield AquatoneScan(**args)

        del args["scan_timeout"]

        yield SubjackScan(**args)
        yield SearchsploitScan(**args)
        yield WebanalyzeScan(**args)

        del args["threads"]

        yield TKOSubsScan(**args)
        yield WaybackurlsScan(**args)


@inherits(SearchsploitScan, AquatoneScan, GobusterScan, WebanalyzeScan)
class HTBScan(luigi.WrapperTask):
    """ Wraps multiple scan types in order to run tasks on the same hierarchical level at the same time.

    Note:
        Because HTBScan is a wrapper, it requires all Parameters for any of the Scans that it wraps.

    Args:
        threads: number of threads for parallel gobuster command execution
        wordlist: wordlist used for forced browsing
        extensions: additional extensions to apply to each item in the wordlist
        recursive: whether or not to recursively gobust the target (may produce a LOT of traffic... quickly)
        proxy: protocol://ip:port proxy specification for gobuster
        exempt_list: Path to a file providing blacklisted subdomains, one per line.
        top_ports: Scan top N most popular ports
        ports: specifies the port(s) to be scanned
        interface: use the named raw network interface, such as "eth0"
        rate: desired rate for transmitting packets (packets per second)
        target_file: specifies the file on disk containing a list of ips or domains
        results_dir: specifes the directory on disk to which all Task results are written
    """

    @staticmethod
    def meets_requirements():
        """ Reports whether or not this scan's needed tool(s) are installed or not """
        needs = ["aquatone", "masscan", "recursive-gobuster", "searchsploit", "gobuster", "webanalyze"]
        tools = get_tool_state()

        if tools:
            return all([tools.get(x).get("installed") is True for x in needs])

    def requires(self):
        """ HTBScan is a wrapper, as such it requires any Tasks that it wraps. """
        args = {
            "results_dir": self.results_dir,
            "rate": self.rate,
            "target_file": self.target_file,
            "top_ports": self.top_ports,
            "interface": self.interface,
            "ports": self.ports,
            "exempt_list": self.exempt_list,
            "threads": self.threads,
            "proxy": self.proxy,
            "db_location": self.db_location,
            "wordlist": self.wordlist,
            "extensions": self.extensions,
            "recursive": self.recursive,
        }

        yield GobusterScan(**args)

        # remove options that are gobuster specific; if left dictionary unpacking to other scans throws an exception
        for gobuster_opt in ("proxy", "wordlist", "extensions", "recursive"):
            del args[gobuster_opt]

        # add aquatone scan specific option
        args.update({"scan_timeout": self.scan_timeout})

        yield AquatoneScan(**args)

        del args["scan_timeout"]

        yield SearchsploitScan(**args)
        yield WebanalyzeScan(**args)