Class: Msf::OptionContainer

Inherits:
Hash
  • Object
show all
Defined in:
lib/msf/core/option_container.rb

Overview

The options purpose in life is to associate named options with arbitrary values at the most simplistic level. Each Module contains an 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.

The core supported option types are:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}) ⇒ OptionContainer

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



52
53
54
55
56
 
# File 'lib/msf/core/option_container.rb', line 52

def initialize(opts = {})
  self.groups = {}

  add_options(opts)
end

Instance Attribute Details

#groups ⇒ Hash<String, Msf::OptionGroup>

Returns:



333
334
335
 
# File 'lib/msf/core/option_container.rb', line 333

def groups
  @groups
end

Instance Method Details

#[](name) ⇒ Object

Return the value associated with the supplied name.



68
69
70
 
# File 'lib/msf/core/option_container.rb', line 68

def [](name)
  return get(name)
end

#add_advanced_options(opts, owner = nil) ⇒ Object

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



180
181
182
183
184
 
# File 'lib/msf/core/option_container.rb', line 180

def add_advanced_options(opts, owner = nil)
  return false if (opts == nil)

  add_options(opts, owner, true)
end

#add_evasion_options(opts, owner = nil) ⇒ Object

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



189
190
191
192
193
 
# File 'lib/msf/core/option_container.rb', line 189

def add_evasion_options(opts, owner = nil)
  return false if (opts == nil)

  add_options(opts, owner, false, true)
end

#add_group(option_group) ⇒ Object

Adds an option group to the container

Parameters:



321
322
323
 
# File 'lib/msf/core/option_container.rb', line 321

def add_group(option_group)
  groups[option_group.name] = option_group
end

#add_option(option, name = nil, owner = nil, advanced = false, evasion = false) ⇒ Object

Adds an option.



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/msf/core/option_container.rb', line 161

def add_option(option, name = nil, owner = nil, advanced = false, evasion = false)
  if option.kind_of?(Array)
    option = option.shift.new(name, option)
  elsif !option.kind_of?(OptBase)
    raise ArgumentError,
      "The option named #{name} did not come in a compatible format.",
      caller
  end

  option.advanced = advanced
  option.evasion  = evasion
  option.owner    = owner

  self.store(option.name, option)
end

#add_options(opts, owner = nil, advanced = false, evasion = false) ⇒ Object

Adds one or more options.



130
131
132
133
134
135
136
137
138
 
# File 'lib/msf/core/option_container.rb', line 130

def add_options(opts, owner = nil, advanced = false, evasion = false)
  return false if (opts == nil)

  if opts.kind_of?(Array)
    add_options_array(opts, owner, advanced, evasion)
  else
    add_options_hash(opts, owner, advanced, evasion)
  end
end

#add_options_array(opts, owner = nil, advanced = false, evasion = false) ⇒ Object

Add options from an array of option instances or arrays.



152
153
154
155
156
 
# File 'lib/msf/core/option_container.rb', line 152

def add_options_array(opts, owner = nil, advanced = false, evasion = false)
  opts.each { |opt|
    add_option(opt, nil, owner, advanced, evasion)
  }
end

#add_options_hash(opts, owner = nil, advanced = false, evasion = false) ⇒ Object

Add options from a hash of names.



143
144
145
146
147
 
# File 'lib/msf/core/option_container.rb', line 143

def add_options_hash(opts, owner = nil, advanced = false, evasion = false)
  opts.each_pair { |name, opt|
    add_option(opt, name, owner, advanced, evasion)
  }
end

#each(&block) ⇒ Object

Overrides the builtin ‘each’ operator to avoid the following exception on Ruby 1.9.2+

"can't add a new key into hash during iteration"



294
295
296
297
298
299
300
 
# File 'lib/msf/core/option_container.rb', line 294

def each(&block)
  list = []
  self.keys.sort.each do |sidx|
    list << [sidx, self[sidx]]
  end
  list.each(&block)
end

#each_option(&block) ⇒ Object

Enumerates each option name



286
287
288
 
# File 'lib/msf/core/option_container.rb', line 286

def each_option(&block)
  each_pair(&block)
end

#get(name) ⇒ Object

Return the option associated with the supplied name.



75
76
77
78
79
80
 
# File 'lib/msf/core/option_container.rb', line 75

def get(name)
  begin
    return fetch(name)
  rescue
  end
end

#has_advanced_options? ⇒ Boolean

Returns whether or not the container has any advanced options.

Returns:

  • (Boolean) 


99
100
101
102
103
104
105
 
# File 'lib/msf/core/option_container.rb', line 99

def has_advanced_options?
  each_option { |name, opt|
    return true if (opt.advanced? == true)
  }

  return false
end

#has_evasion_options? ⇒ Boolean

Returns whether or not the container has any evasion options.

Returns:

  • (Boolean) 


111
112
113
114
115
116
117
 
# File 'lib/msf/core/option_container.rb', line 111

def has_evasion_options?
  each_option { |name, opt|
    return true if (opt.evasion? == true)
  }

  return false
end

#has_options? ⇒ Boolean

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

Returns:

  • (Boolean) 


86
87
88
89
90
91
92
93
 
# File 'lib/msf/core/option_container.rb', line 86

def has_options?
  each_option { |name, opt|
    return true if (opt.advanced? == false)

  }

  return false
end

#merge_sort(other_container) ⇒ Object

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



306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/msf/core/option_container.rb', line 306

def merge_sort(other_container)
  result = self.dup

  other_container.each { |name, opt|
    if (result.get(name) == nil)
      result[name] = opt
    end
  }

  result.sort
end

#options_used_to_s(datastore) ⇒ Object

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



270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/msf/core/option_container.rb', line 270

def options_used_to_s(datastore)
  used = ''

  each_pair { |name, option|
    next if (datastore[name] == nil)

    used += ", " if (used.length > 0)
    used += "#{name}=#{datastore[name]}"
  }

  return used
end

#remove_group(group_name) ⇒ Object

Removes an option group from the container by name

Parameters:

  • group_name (String) 


328
329
330
 
# File 'lib/msf/core/option_container.rb', line 328

def remove_group(group_name)
  groups.delete(group_name)
end

#remove_option(name) ⇒ Object

Removes an option.

Parameters:

  • name (String) —

    the option name



123
124
125
 
# File 'lib/msf/core/option_container.rb', line 123

def remove_option(name)
  delete(name)
end

#sorted ⇒ Object

Return the sorted array of options.



61
62
63
 
# File 'lib/msf/core/option_container.rb', line 61

def sorted
  self.sort
end

#validate(datastore) ⇒ Object

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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/msf/core/option_container.rb', line 198

def validate(datastore)
  # First mutate the datastore and normalize all valid values before validating permutations of RHOST/etc.
  each_pair do |name, option|
    if option.valid?(datastore[name]) && (val = option.normalize(datastore[name])) != nil
      # This *will* result in a module that previously used the
      # global datastore to have its local datastore set, which
      # means that changing the global datastore and re-running
      # the same module will now use the newly-normalized local
      # datastore value instead. This is mostly mitigated by
      # forcing a clone through mod.replicant, but can break
      # things in corner cases.
      datastore[name] = val
    end
  end

  # Validate all permutations of rhost combinations
  if include?('RHOSTS') && !(datastore['RHOSTS'].blank? && !self['RHOSTS'].required)
    error_options = Set.new
    error_reasons = Hash.new do |hash, key|
      hash[key] = []
    end
    rhosts_walker = Msf::RhostsWalker.new(datastore['RHOSTS'], datastore)
    rhosts_count = rhosts_walker.count
    unless rhosts_walker.valid?
      errors = rhosts_walker.to_enum(:errors).to_a
      grouped = errors.group_by { |err| err.cause.nil? ? nil : (err.cause.class.const_defined?(:MESSAGE) ? err.cause.class::MESSAGE : nil) }
      error_options << 'RHOSTS'
      if grouped.any?
        grouped.each do | message, error_subset |
          invalid_values = error_subset.map(&:value).take(5)
          message = 'Unexpected values' if message.nil?
          error_reasons['RHOSTS'] << "#{message}: #{invalid_values.join(', ')}"
        end
      end
    end

    rhosts_walker.each do |datastore|
      each_pair do |name, option|
        unless option.valid?(datastore[name])
          error_options << name
          if rhosts_count > 1
            error_reasons[name] << "for rhosts value #{datastore['UNPARSED_RHOSTS']}"
          end
        end
      end
    end

    unless error_options.empty?
      raise Msf::OptionValidateError.new(error_options.to_a, reasons: error_reasons),
            "One or more options failed to validate: #{error_options.to_a.join(', ')}."
    end
  else
    error_options = []
    each_pair do |name, option|
      unless option.valid?(datastore[name])
        error_options << name
      end
    end

    unless error_options.empty?
      raise Msf::OptionValidateError.new(error_options),
            "One or more options failed to validate: #{error_options.join(', ')}."
    end
  end

  true
end