Class Msf::Config
In: lib/msf/base/config.rb
Parent: Hash

This class wraps interaction with global configuration that can be used as a persistent storage point for configuration, logs, and other such fun things.

Methods

config_directory   config_directory   config_file   config_file   data_directory   data_directory   get_config_root   init   init   install_root   install_root   load   load   log_directory   log_directory   module_directory   module_directory   new   plugin_directory   plugin_directory   save   save   script_directory   script_directory   session_log_directory   session_log_directory   user_module_directory   user_module_directory   user_script_directory   user_script_directory  

Constants

InstallRoot = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..'))   The installation root directory for the distribution
FileSep = File::SEPARATOR   Default values
Defaults = { 'ConfigDirectory' => get_config_root, 'ConfigFile' => "config", 'ModuleDirectory' => "modules", 'ScriptDirectory' => "scripts", 'LogDirectory' => "logs", 'SessionLogDirectory' => "logs/sessions", 'PluginDirectory' => "plugins", 'DataDirectory' => "data"

Public Class methods

config_directory()

Calls the instance method.

config_file()

Calls the instance method.

data_directory()

Calls the instance method.

get_config_root()

Determines the base configuration directory.

init()

Calls the instance method.

install_root()

Returns the framework installation root.

load(path = nil)

Calls the instance method.

log_directory()

Calls the instance method.

module_directory()

Calls the instance method.

new()

Updates the config class’ self with the default hash.

plugin_directory()

Calls the instance method.

save(opts)

Calls the instance method.

script_directory()

Calls the instance method.

session_log_directory()

Calls the instance method.

user_module_directory()

Calls the instance method.

user_script_directory()

Calls the instance method.

Public Instance methods

config_directory()

Returns the configuration directory default.

config_file()

Returns the full path to the configuration file.

data_directory()

Returns the data directory

init()

Initializes configuration, creating directories as necessary.

install_root()

Returns the installation root directory

load(path = nil)

Loads configuration from the supplied file path, or the default one if none is specified.

log_directory()

Returns the directory that log files should be stored in.

module_directory()

Returns the global module directory.

plugin_directory()

Returns the directory that plugins are stored in.

save(opts)

Saves configuration to the path specified in the ConfigFile hash key or the default path is one isn‘t specified. The options should be group references that have named value pairs. Example:

save( 

  'ExampleGroup' =>
     {
        'Foo' => 'Cat'
     })
script_directory()

Returns the path that scripts can be loaded from.

session_log_directory()

Returns the directory in which session log files are to reside.

user_module_directory()

Returns the user-specific module base path

user_script_directory()

Returns the user-specific script base path

[Validate]