Files
metasploit-gs/modules/auxiliary/example.rb
T
2021-11-13 04:33:24 -05:00

55 lines
1.7 KiB
Ruby

##
# This module requires Metasploit: https://metasploit.com/download
# Current source: https://github.com/rapid7/metasploit-framework
##
###
#
# This sample auxiliary module simply displays the selected action and
# registers a custom command that will show up when the module is used.
#
###
class MetasploitModule < Msf::Auxiliary
def initialize(info = {})
super(
update_info(
info,
'Name' => 'Sample Auxiliary Module',
# The description can be multiple lines, but does not preserve formatting.
'Description' => 'Sample Auxiliary Module',
'Author' => ['Joe Module <joem@example.com>'],
'License' => MSF_LICENSE,
'Actions' => [
[ 'Default Action', { 'Description' => 'This does something' } ],
[ 'Another Action', { 'Description' => 'This does a different thing' } ]
],
# The action(s) that will run as background job
'PassiveActions' => [
'Another Action'
],
# https://github.com/rapid7/metasploit-framework/wiki/Definition-of-Module-Reliability,-Side-Effects,-and-Stability
'Notes' => {
'Stability' => [],
'Reliability' => [],
'SideEffects' => []
},
'DefaultAction' => 'Default Action'
)
)
end
def run
print_status("Running the simple auxiliary module with action #{action.name}")
end
# auxiliary modules can register new commands, they all call cmd_* to
# dispatch them
def auxiliary_commands
{ 'aux_extra_command' => 'Run this auxiliary test commmand' }
end
def cmd_aux_extra_command(*args)
print_status("Running inside aux_extra_command(#{args.join(' ')})")
end
end