Class: Msf::FeatureManager

Inherits:
Object
  • Object
show all
Includes:
Singleton
Defined in:
lib/msf/core/feature_manager.rb

Overview

The feature manager is responsible for managing feature flags that can change characteristics of framework. Each feature will have a default value. The user can choose to override this default value if they wish.

Constant Summary collapse

CONFIG_KEY = 
'framework/features'
WRAPPED_TABLES = 
'wrapped_tables'
DATASTORE_FALLBACKS = 
'datastore_fallbacks'
FULLY_INTERACTIVE_SHELLS = 
'fully_interactive_shells'
MANAGER_COMMANDS = 
'manager_commands'
METASPLOIT_PAYLOAD_WARNINGS = 
'metasploit_payload_warnings'
DEFER_MODULE_LOADS = 
'defer_module_loads'
DNS = 
'dns'
HIERARCHICAL_SEARCH_TABLE = 
'hierarchical_search_table'
SMB_SESSION_TYPE = 
'smb_session_type'
POSTGRESQL_SESSION_TYPE = 
'postgresql_session_type'
MYSQL_SESSION_TYPE = 
'mysql_session_type'
MSSQL_SESSION_TYPE = 
'mssql_session_type'
LDAP_SESSION_TYPE = 
'ldap_session_type'
SHOW_SUCCESSFUL_LOGINS = 
'show_successful_logins'
DISPLAY_MODULE_ACTION = 
'display_module_action'
DEFAULTS = 
[
  {
    name: WRAPPED_TABLES,
    description: 'When enabled Metasploit will wordwrap all tables to fit into the available terminal width',
    default_value: true,
    developer_notes: 'This functionality is enabled by default now, and the feature flag can be removed now'
  }.freeze,
  {
    name: FULLY_INTERACTIVE_SHELLS,
    description: 'When enabled you will have the option to drop into a fully interactive shell from within meterpreter',
    default_value: false,
    developer_notes: 'Development paused as the interaction time feels clunky, especially for slow transport layers like HTTP on Mettle. Would require changes to the transport sleep/priority logic'
  }.freeze,
  {
    name: MANAGER_COMMANDS,
    description: 'When enabled you will have access to manager commands such as _servicemanager and _historymanager',
    default_value: false,
    developer_notes: 'Useful for developers, likely not to ever be useful for an average user'
  }.freeze,
  {
    name: DATASTORE_FALLBACKS,
    description: 'When enabled you can consistently set username across modules, instead of setting SMBUser/FTPUser/BIND_DN/etc',
    requires_restart: true,
    default_value: true,
    developer_notes: 'This functionality is enabled by default now, and the feature flag can be removed now'
  }.freeze,
  {
    name: METASPLOIT_PAYLOAD_WARNINGS,
    description: 'When enabled Metasploit will output warnings about missing Metasploit payloads, for instance if they were removed by antivirus etc',
    requires_restart: true,
    default_value: true,
    developer_notes: 'Enabled in Metasploit 6.4.x'
  }.freeze,
  {
    name: DEFER_MODULE_LOADS,
    description: 'When enabled will not eagerly load all modules',
    requires_restart: true,
    default_value: false,
    developer_notes: 'Needs a final round of testing. Can be enabled after 6.4.0 is released.'
  }.freeze,
  {
    name: SMB_SESSION_TYPE,
    description: 'When enabled will allow for the creation/use of smb sessions',
    requires_restart: true,
    default_value: true,
    developer_notes: 'Enabled in Metasploit 6.4.x'
  }.freeze,
  {
    name: POSTGRESQL_SESSION_TYPE,
    description: 'When enabled will allow for the creation/use of PostgreSQL sessions',
    requires_restart: true,
    default_value: true,
    developer_notes: 'Enabled in Metasploit 6.4.x'
  }.freeze,
  {
    name: MYSQL_SESSION_TYPE,
    description: 'When enabled will allow for the creation/use of MySQL sessions',
    requires_restart: true,
    default_value: true,
    developer_notes: 'Enabled in Metasploit 6.4.x'
  }.freeze,
  {
    name: MSSQL_SESSION_TYPE,
    description: 'When enabled will allow for the creation/use of mssql sessions',
    requires_restart: true,
    default_value: true,
    developer_notes: 'Enabled in Metasploit 6.4.x'
  }.freeze,
  {
    name: LDAP_SESSION_TYPE,
    description: 'When enabled will allow for the creation/use of LDAP sessions',
    requires_restart: true,
    default_value: false,
    developer_notes: 'To be enabled by default after appropriate testing'
  }.freeze,
  {
    name: SHOW_SUCCESSFUL_LOGINS,
    description: 'When enabled scanners/login modules will return a table off successful logins once the module completes',
    requires_restart: false,
    default_value: false,
    developer_notes: 'To be enabled after appropriate testing'
  }.freeze,
  {
    name: DNS,
    description: 'When enabled allows configuration of DNS resolution behaviour in Metasploit',
    requires_restart: true,
    default_value: true,
    developer_notes: 'Enabled in Metasploit 6.4.x'
  }.freeze,
  {
    name: HIERARCHICAL_SEARCH_TABLE,
    description: 'When enabled the search table is enhanced to show details on module actions and targets',
    requires_restart: false,
    default_value: true,
    developer_notes: 'Enabled in Metasploit 6.4.x'
  }.freeze,
  {
    name: DISPLAY_MODULE_ACTION,
    description: 'When enabled after using a module the current action and number of actions will be displayed',
    requires_restart: false,
    default_value: true,
    developer_notes: 'Added as a feature so users can turn it off if they wish to reduce clutter in their terminal'
  }.freeze
].freeze

Instance Method Summary collapse

Constructor Details

#initialize ⇒ FeatureManager

Initializes the feature manager.



141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/msf/core/feature_manager.rb', line 141

def initialize
  @flag_lookup = DEFAULTS.each_with_object({}) do |feature, acc|
    if feature[:name] == WRAPPED_TABLES
      if feature[:default_value] == true
        Rex::Text::Table.wrap_tables!
      else
        Rex::Text::Table.unwrap_tables!
      end
    end

    key = feature[:name]
    acc[key] = feature.dup
  end
end

Instance Method Details

#all ⇒ Object 



156
157
158
159
160
 
# File 'lib/msf/core/feature_manager.rb', line 156

def all
  @flag_lookup.values.map do |feature|
    feature.slice(:name, :description).merge(enabled: enabled?(feature[:name]))
  end
end

#enabled?(name) ⇒ TrueClass, FalseClass

Returns True if the flag is be enabled, false otherwise.

Parameters:

  • name (String) —

    The feature name

Returns:

  • (TrueClass, FalseClass) —

    True if the flag is be enabled, false otherwise



164
165
166
167
168
169
 
# File 'lib/msf/core/feature_manager.rb', line 164

def enabled?(name)
  return false unless @flag_lookup[name]

  feature = @flag_lookup[name]
  feature.key?(:user_preference) ? feature[:user_preference] : feature[:default_value]
end

#exists?(name) ⇒ Boolean

Returns:

  • (Boolean) 


179
180
181
 
# File 'lib/msf/core/feature_manager.rb', line 179

def exists?(name)
  @flag_lookup.key?(name)
end

#load_config ⇒ Object 



201
202
203
204
205
206
 
# File 'lib/msf/core/feature_manager.rb', line 201

def load_config
  conf = Msf::Config.load
  conf.fetch(CONFIG_KEY, {}).each do |name, value|
    set(name, value == 'true')
  end
end

#names ⇒ Object 



183
184
185
 
# File 'lib/msf/core/feature_manager.rb', line 183

def names
  all.map { |feature| feature[:name] }
end

#requires_restart?(name) ⇒ TrueClass, FalseClass

Returns True if the flag requires a console restart to work effectively.

Parameters:

  • name (String) —

    The feature name

Returns:

  • (TrueClass, FalseClass) —

    True if the flag requires a console restart to work effectively



173
174
175
176
177
 
# File 'lib/msf/core/feature_manager.rb', line 173

def requires_restart?(name)
  return false unless @flag_lookup[name]

  @flag_lookup[name][:requires_restart] == true
end

#save_config ⇒ Object 



208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/msf/core/feature_manager.rb', line 208

def save_config
  # Note, we intentionally omit features that have not explicitly been set by the user.
  config = Msf::Config.load
  old_config = config.fetch(CONFIG_KEY, {})
  new_config = @flag_lookup.values.each_with_object(old_config) do |feature, config|
    next unless feature.key?(:user_preference)

    config.merge!(feature[:name] => feature[:user_preference].to_s)
  end

  Msf::Config.save(CONFIG_KEY => new_config)
end

#set(name, value) ⇒ Object 



187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/msf/core/feature_manager.rb', line 187

def set(name, value)
  return false unless @flag_lookup[name]

  @flag_lookup[name][:user_preference] = value

  if name == WRAPPED_TABLES
    if value
      Rex::Text::Table.wrap_tables!
    else
      Rex::Text::Table.unwrap_tables!
    end
  end
end