Class Msf::ModuleSet
In: lib/msf/core/module_manager.rb
Parent: Hash

A module set contains zero or more named module classes of an arbitrary type.

Methods

[]   add_module   create   demand_load_modules   each_module   each_module_filter   each_module_list   each_module_ranked   force_load_set   get_hash_val   invalidate_sorted_cache   new   on_module_reload   rank_modules   recalculate   valid?  

Included Modules

Framework::Offspring

Attributes

mod_ambiguous  [RW] 
mod_arch_hash  [RW] 
mod_extensions  [RW] 
mod_platform_hash  [RW] 
mod_ranked  [RW] 
mod_sorted  [RW] 
module_type  [W] 
module_type  [R] 
postpone_recalc  [RW]  Whether or not recalculations should be postponed. This is used from the context of the each_module_list handler in order to prevent the demand loader from calling recalc for each module if it‘s possible that more than one module may be loaded. This field is not initialized until used.

Public Class methods

new(type = nil)

Initializes a module set that will contain modules of a specific type and expose the mechanism necessary to create instances of them.

Public Instance methods

[](name)

Wrapper that detects if a symbolic module is in use. If it is, it creates an instance to demand load the module and then returns the now-loaded class afterwords.

create(name)

Create an instance of the supplied module by its name

each_module(opts = {}, &block)

Enumerates each module class in the set.

each_module_filter(opts, name, entry)

Custom each_module filtering if an advanced set supports doing extended filtering. Returns true if the entry should be filtered.

each_module_ranked(opts = {}, &block)

Enumerates each module class in the set based on their relative ranking to one another. Modules that are ranked higher are shown first.

force_load_set()

Forces all modules in this set to be loaded.

get_hash_val(name)

Returns the hash value associated with the supplied module name without throwing an exception.

on_module_reload(mod)

Gives the module set an opportunity to handle a module reload event

recalculate()

Dummy placeholder to relcalculate aliases and other fun things.

valid?(name)

Checks to see if the supplied module name is valid.

Protected Instance methods

add_module(module_class, name, modinfo = nil)

Adds a module with a the supplied name.

demand_load_modules()

Load all modules that are marked as being symbolic.

each_module_list(ary, opts, &block)

Enumerates the modules in the supplied array with possible limiting factors.

invalidate_sorted_cache()

Invalidates the sorted and ranked module caches.

rank_modules()

Ranks modules based on their constant rank value, if they have one.

[Validate]