Class Msf::Auxiliary
In: lib/msf/core/auxiliary.rb
Parent: Msf::Module

The auxiliary class acts as a base class for all modules that perform reconnaisance, retrieve data, brute force logins, or any other action that doesn‘t fit our concept of an ‘exploit’ (involving payloads and targets and whatnot).

Methods

abort_sockets   action   add_socket   autofilter   auxiliary_commands   cleanup   create   find_action   new   passive?   passive_action?   remove_socket   run   setup   type   type  

Attributes

actions  [R]  Allow access to the hash table of actions and the string containing the default action
actions  [W] 
default_action  [W] 
default_action  [R]  Allow access to the hash table of actions and the string containing the default action
passive  [R]  Allow access to the hash table of actions and the string containing the default action
passive  [W] 
passive_actions  [R]  Allow access to the hash table of actions and the string containing the default action
passive_actions  [W] 
queue  [RW] 
sockets  [RW] 

Public Class methods

create(info = {})

Creates a singleton instance of this auxiliary class

new(info = {})

Creates an instance of the auxiliary module.

type()

Returns MODULE_AUX to indicate that this is an auxiliary module.

Public Instance methods

abort_sockets()

This method is called once a new session has been created on behalf of this module instance and all socket connections created by this module should be closed.

add_socket(sock)

Adds a socket to the list of sockets opened by this exploit.

autofilter()

Performs last-minute sanity checking of auxiliary parameters. This method is called during automated exploitation attempts and allows an auxiliary module to filter bad attempts, obtain more information, and choose better parameters based on the available data. Returning anything that evaluates to "false" will cause this specific auxiliary attempt to be skipped. This method can and will change datastore values and may interact with the backend database. The default value for auxiliary modules is false, since not all auxiliary modules actually attempt to exploit a vulnerability.

cleanup()

Called after ‘run’ returns

passive?()

Returns a boolean indicating whether this module should be run passively

passive_action?(name)

Returns a boolean indicating whether this specific action should be run passively

remove_socket(sock)

Removes a socket from the list of sockets.

setup()

Called directly before ‘run‘

type()

Returns MODULE_AUX to indicate that this is an auxiliary module.

[Validate]