Class Msf::OptionContainer
In: lib/msf/core/option_container.rb
Parent: Hash

The options purpose in life is to associate named options with arbitrary values at the most simplistic level. Each module contains a OptionContainer that is used to hold the various options that the module depends on. Example of options that are stored in the OptionContainer are rhost and rport for payloads or exploits that need to connect to a host and port, for instance.

Methods

[]   add_advanced_options   add_evasion_options   add_option   add_options   add_options_array   add_options_hash   each_option   get   has_advanced_options?   has_evasion_options?   has_options?   merge_sort   new   options_used_to_s   remove_option   validate  

Attributes

sorted  [R]  The sorted array of options.

Public Class methods

new(opts = {})

Merges in the supplied options and converts them to a OptBase as necessary.

Public Instance methods

[](name)

Return the value associated with the supplied name.

add_advanced_options(opts, owner = nil)

Alias to add advanced options that sets the proper state flag.

add_evasion_options(opts, owner = nil)

Alias to add evasion options that sets the proper state flag.

add_options_array(opts, owner = nil, advanced = false, evasion = false)

Add options from an array of option instances or arrays.

each_option(&block)

Enumerates each option name

get(name)

Return the option associated with the supplied name.

has_advanced_options?()

Returns whether or not the container has any advanced options.

has_evasion_options?()

Returns whether or not the container has any evasion options.

has_options?()

Returns whether or not the container has any options, excluding advanced (and evasions).

merge_sort(other_container)

Merges the options in this container with another option container and returns the sorted results.

options_used_to_s(datastore)

Creates string of options that were used from the datastore in VAR=VAL format separated by commas.

remove_option(name)

Removes an option.

validate(datastore)

Make sures that each of the options has a value of a compatible format and that all the required options are set.

[Validate]