Empire/lib/modules/python_jobs_template.py

80 lines
2.5 KiB
Python

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': 'Background Example',
# list of one or more authors for the module
'Author': ['@Killswitch-GUI'],
# more verbose multi-line description of the module
'Description': ('A quick example how to feed your data to a background job.'),
# True if the module needs to run in the background
'Background' : True,
# File extension to save the file as
'OutputExtension' : '',
# if the module needs administrative privileges
'NeedsAdmin' : False,
# True if the method doesn't touch disk/is reasonably opsec safe
'OpsecSafe' : False,
# the module language
'Language' : 'python',
# the minimum language version needed
'MinLanguageVersion' : '2.6',
# list of any references/other comments
'Comments': [ ]
}
# 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 execute module on.',
'Required' : True,
'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):
script = """
x = 0
while True:
import time
try:
time.sleep(2)
msg = 'NOW inside buffer at message: ' + str(x) + '\\n'
job_message_buffer(msg)
x += 1
except Exception as e:
print e
"""
return script