infosecn1nja
/
Empire
mirror of https://github.com/infosecn1nja/Empire.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation, reorganization, and a touch of PEP8

mdns
leesoh 2016-10-05 13:47:17 -06:00
parent 83a9da50b7
commit a5f9b7a9b4
1 changed files with 68 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

118
lib/modules/powershell_template.py
View File

@ -1,97 +1,96 @@
from lib.common import helpers from lib.common import helpers
class Module: class Module:
def __init__(self, mainMenu, params=[]): def __init__(self, mainMenu, params=[]):
# metadata info about the module, not modified during runtime # Metadata info about the module, not modified during runtime
self.info = { self.info = {
# name for the module that will appear in module menus # Name for the module that will appear in module menus
'Name': 'Invoke-Something', 'Name': 'Invoke-Something',
# list of one or more authors for the module # List of one or more authors for the module
'Author': ['@yourname'], 'Author': ['@yourname'],
# more verbose multi-line description of the module # More verbose multi-line description of the module
'Description': ('description line 1' 'Description': ('description line 1 '
'description line 2'), 'description line 2'),
# True if the module needs to run in the background # True if the module needs to run in the background
'Background' : False, 'Background': False,
# File extension to save the file as # File extension to save the file as
'OutputExtension' : None, 'OutputExtension': None,
# True if the module needs admin rights to run # True if the module needs admin rights to run
'NeedsAdmin' : False, 'NeedsAdmin': False,
# True if the method doesn't touch disk/is reasonably opsec safe # True if the method doesn't touch disk/is reasonably opsec safe
'OpsecSafe' : True, 'OpsecSafe': True,
# the language for this module # The language for this module
'Language' : 'powershell', 'Language': 'powershell',
# The minimum PowerShell version needed for the module to run # The minimum PowerShell version needed for the module to run
'MinLanguageVersion' : '2', 'MinLanguageVersion': '2',
# list of any references/other comments # List of any references/other comments
'Comments': [ 'Comments': [
'comment', 'comment',
'http://link/' 'http://link/'
] ]
} }
# any options needed by the module, settable during runtime # Any options needed by the module, settable during runtime
self.options = { self.options = {
# format: # Format:
# value_name : {description, required, default_value} # value_name : {description, required, default_value}
'Agent' : { 'Agent': {
# The 'Agent' option is the only one that MUST be in a module # The 'Agent' option is the only one that MUST be in a module
'Description' : 'Agent to grab a screenshot from.', 'Description': 'Agent to grab a screenshot from.',
'Required' : True, 'Required' : True,
'Value' : '' 'Value' : ''
}, },
'Command' : { 'Command': {
'Description' : 'Command to execute', 'Description': 'Command to execute',
'Required' : True, 'Required' : True,
'Value' : 'test' 'Value' : 'test'
} }
} }
# save off a copy of the mainMenu object to access external functionality # Save off a copy of the mainMenu object to access external
# like listeners/agent handlers/etc. # functionality like listeners/agent handlers/etc.
self.mainMenu = mainMenu self.mainMenu = mainMenu
# During instantiation, any settable option parameters # During instantiation, any settable option parameters are passed as
# are passed as an object set to the module and the # an object set to the module and the options dictionary is
# options dictionary is automatically set. This is mostly # automatically set. This is mostly in case options are passed on
# in case options are passed on the command line # the command line.
if params: if params:
for param in params: for param in params:
# parameter format is [Name, Value] # Parameter format is [Name, Value]
option, value = param option, value = param
if option in self.options: if option in self.options:
self.options[option]['Value'] = value self.options[option]['Value'] = value
def generate(self): def generate(self):
# the PowerShell script itself, with the command to invoke # The PowerShell script itself, with the command to invoke for
# for execution appended to the end. Scripts should output # execution appended to the end. Scripts should output everything
# everything to the pipeline for proper parsing. # to the pipeline for proper parsing.
# #
# the script should be stripped of comments, with a link to any # If you're planning on storing your script in module_source as a ps1,
# original reference script included in the comments. # or if you're importing a shared module_source, use the first
script = """ # method to import it and the second to add any additional code and
function Invoke-Something { # launch it.
#
} # If you're just going to inline your script, you can delete the first
Invoke-Something""" # method entirely and just use the second. The script should be
# stripped of comments, with a link to any original reference script
# included in the comments.
# if you're reading in a large, external script that might be updates, #
# use the pattern below # First method: Read in the source script from module_source
# read in the common module source code
moduleSource = self.mainMenu.installPath + "/data/module_source/..." moduleSource = self.mainMenu.installPath + "/data/module_source/..."
try: try:
f = open(moduleSource, 'r') f = open(moduleSource, 'r')
@ -102,11 +101,30 @@ Invoke-Something"""
moduleCode = f.read() moduleCode = f.read()
f.close() f.close()
# If you'd just like to import a subset of the functions from the
# module source, use the following:
# script = helpers.generate_dynamic_powershell_script(moduleCode, ["Get-Something", "Set-Something"])
script = moduleCode script = moduleCode
# Second method: For calling your imported source, or holding your
# inlined script. If you're importing source using the first method,
# ensure that you append to the script variable rather than set.
#
# The script should be stripped of comments, with a link to any
# original reference script included in the comments.
#
# If your script is more than a few lines, it's probably best to use
# the first method to source it.
#
# script += """
script = """
function Invoke-Something {
# add any arguments to the end execution of the script }
for option,values in self.options.iteritems(): Invoke-Something"""
# Add any arguments to the end execution of the script
for option, values in self.options.iteritems():
if option.lower() != "agent": if option.lower() != "agent":
if values['Value'] and values['Value'] != '': if values['Value'] and values['Value'] != '':
if values['Value'].lower() == "true": if values['Value'].lower() == "true":