115 lines
3.9 KiB
Python
115 lines
3.9 KiB
Python
|
from lib.common import helpers
|
||
|
|
|
||
|
|
class Module:
|
||
|
|
|
||
|
|
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-Something',
|
||
|
|
|
||
|
|
# list of one or more authors for the module
|
||
|
|
'Author': ['@yourname'],
|
||
|
|
|
||
|
|
# more verbose multi-line description of the module
|
||
|
|
'Description': ('description line 1'
|
||
|
|
'description line 2'),
|
||
|
|
|
||
|
|
# True if the module needs to run in the background
|
||
|
|
'Background' : False,
|
||
|
|
|
||
|
|
# True if we're saving the output as a file
|
||
|
|
'SaveOutput' : True,
|
||
|
|
|
||
|
|
# True if the module needs admin rights to run
|
||
|
|
'NeedsAdmin' : False,
|
||
|
|
|
||
|
|
# True if the method doesn't touch disk/is reasonably opsec safe
|
||
|
|
'OpsecSafe' : True,
|
||
|
|
|
||
|
|
# The minimum PowerShell version needed for the module to run
|
||
|
|
'MinPSVersion' : '2',
|
||
|
|
|
||
|
|
# list of any references/other comments
|
||
|
|
'Comments': [
|
||
|
|
'comment',
|
||
|
|
'http://link/'
|
||
|
|
]
|
||
|
|
}
|
||
|
|
|
||
|
|
# 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 grab a screenshot from.',
|
||
|
|
'Required' : True,
|
||
|
|
'Value' : ''
|
||
|
|
},
|
||
|
|
'Command' : {
|
||
|
|
'Description' : 'Command to execute',
|
||
|
|
'Required' : True,
|
||
|
|
'Value' : 'test'
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
# 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):
|
||
|
|
|
||
|
|
# the PowerShell script itself, with the command to invoke
|
||
|
|
# for execution appended to the end. Scripts should output
|
||
|
|
# everything to the pipeline for proper parsing.
|
||
|
|
#
|
||
|
|
# the script should be stripped of comments, with a link to any
|
||
|
|
# original reference script included in the comments.
|
||
|
|
script = """
|
||
|
|
function Invoke-Something {
|
||
|
|
|
||
|
|
}
|
||
|
|
Invoke-Something"""
|
||
|
|
|
||
|
|
|
||
|
|
# 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/..."
|
||
|
|
try:
|
||
|
|
f = open(moduleSource, 'r')
|
||
|
|
except:
|
||
|
|
print helpers.color("[!] Could not read module source path at: " + str(moduleSource))
|
||
|
|
return ""
|
||
|
|
|
||
|
|
moduleCode = f.read()
|
||
|
|
f.close()
|
||
|
|
|
||
|
|
script = moduleCode
|
||
|
|
|
||
|
|
|
||
|
|
# add any arguments to the end execution of the script
|
||
|
|
for option,values in self.options.iteritems():
|
||
|
|
if option.lower() != "agent":
|
||
|
|
if values['Value'] and values['Value'] != '':
|
||
|
|
if values['Value'].lower() == "true":
|
||
|
|
# if we're just adding a switch
|
||
|
|
script += " -" + str(option)
|
||
|
|
else:
|
||
|
|
script += " -" + str(option) + " " + str(values['Value'])
|
||
|
|
|
||
|
|
return script
|