39 lines
1.3 KiB
Python
39 lines
1.3 KiB
Python
#!/usr/bin/env python3
|
|
# -*- coding: utf-8 -*-
|
|
|
|
class CMEModule:
|
|
'''
|
|
Example
|
|
Module by @yomama
|
|
|
|
'''
|
|
name = 'example module'
|
|
description = 'I do something'
|
|
supported_protocols = []
|
|
opsec_safe= True #Does the module touch disk?
|
|
multiple_hosts = True #Does it make sense to run this module on multiple hosts at a time?
|
|
|
|
def options(self, context, module_options):
|
|
'''Required. Module options get parsed here. Additionally, put the modules usage here as well'''
|
|
pass
|
|
|
|
def on_login(self, context, connection):
|
|
'''Concurrent. Required if on_admin_login is not present. This gets called on each authenticated connection'''
|
|
pass
|
|
|
|
def on_admin_login(self, context, connection):
|
|
'''Concurrent. Required if on_login is not present. This gets called on each authenticated connection with Administrative privileges'''
|
|
pass
|
|
|
|
def on_request(self, context, request):
|
|
'''Optional. If the payload needs to retrieve additonal files, add this function to the module'''
|
|
pass
|
|
|
|
def on_response(self, context, response):
|
|
'''Optional. If the payload sends back its output to our server, add this function to the module to handle its output'''
|
|
pass
|
|
|
|
def on_shutdown(self, context, connection):
|
|
'''Optional. Do something on shutdown'''
|
|
pass
|