Class Msf::Plugin
In: lib/msf/core/plugin.rb
Parent: Object

This module represents an abstract plugin that can be loaded into the context of a framework instance. Plugins are meant to provide an easy way to augment the feature set of the framework by being able to load and unload them during the course of a framework‘s lifetime. For instance, a plugin could be loaded to alter the default behavior of new sessions, such as by scripting meterpreter sessions that are created. The possiblities are endless!

All plugins must exist under the Msf::Plugin namespace. Plugins are reference counted to allow them to be loaded more than once if they‘re a singleton.

Methods

add_console_dispatcher   cleanup   create   desc   flush   input   name   new   output   print   print_error   print_good   print_line   print_status   remove_console_dispatcher  

Included Modules

Framework::Offspring Rex::Ref

Public Class methods

create(framework, opts = {})

Create an instance of the plugin using the supplied framework instance. We use create instead of new directly so that singleton plugins can just return their singleton instance.

new(framework, opts = {})

Initializes the plugin instance with the supplied framework instance. The opts parameter is a hash of custom arguments that may be useful for a plugin. Some of the pre-defined arguments are:

LocalInput 

     The local input handle that implements the Rex::Ui::Text::Input
     interface.

LocalOutput 

     The local output handle that implements the Rex::Ui::Output interface.

Public Instance methods

cleanup()

Allows the plugin to clean up as it is being unloaded.

desc()

A short description of the plugin.

flush()

Flushes any buffered output.

input()

Returns the local input handle if one was passed into the constructor.

name()

Returns the name of the plugin.

output()

Returns the local output handle if one was passed into the constructor.

print(msg='')

Prints a message with no decoration.

print_error(msg='')

Prints an error message.

print_good(msg='')

Prints a ‘good’ message.

print_line(msg='')

Prints an undecorated line of information.

print_status(msg='')

Prints a status line.

Protected Instance methods

add_console_dispatcher(disp)

Adds the console dispatcher.

remove_console_dispatcher(name)

Removes the console dispatcher.

[Validate]