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.


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

def initialize(opts = {})
  self.sorted = []

  add_options(opts)
end

Instance Attribute Details

#sortedObject

The sorted array of options.


279
280
281
# File 'lib/msf/core/option_container.rb', line 279

def sorted
  @sorted
end

Instance Method Details

#[](name) ⇒ Object

Return the value associated with the supplied name.


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

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

#add_advanced_options(opts, owner = nil) ⇒ Object

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


178
179
180
181
182
# File 'lib/msf/core/option_container.rb', line 178

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.


187
188
189
190
191
# File 'lib/msf/core/option_container.rb', line 187

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

  add_options(opts, owner, false, true)
end

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

Adds an option.


156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/msf/core/option_container.rb', line 156

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)

  # Re-calculate the sorted list
  self.sorted = self.sort
end

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

Adds one or more options.


125
126
127
128
129
130
131
132
133
# File 'lib/msf/core/option_container.rb', line 125

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.


147
148
149
150
151
# File 'lib/msf/core/option_container.rb', line 147

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.


138
139
140
141
142
# File 'lib/msf/core/option_container.rb', line 138

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"

252
253
254
255
256
257
258
# File 'lib/msf/core/option_container.rb', line 252

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


244
245
246
# File 'lib/msf/core/option_container.rb', line 244

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

#get(name) ⇒ Object

Return the option associated with the supplied name.


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

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)

91
92
93
94
95
96
97
# File 'lib/msf/core/option_container.rb', line 91

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)

103
104
105
106
107
108
109
# File 'lib/msf/core/option_container.rb', line 103

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)

78
79
80
81
82
83
84
85
# File 'lib/msf/core/option_container.rb', line 78

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.


264
265
266
267
268
269
270
271
272
273
274
# File 'lib/msf/core/option_container.rb', line 264

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.


228
229
230
231
232
233
234
235
236
237
238
239
# File 'lib/msf/core/option_container.rb', line 228

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_option(name) ⇒ Object

Removes an option.


114
115
116
117
118
119
120
# File 'lib/msf/core/option_container.rb', line 114

def remove_option(name)
  delete(name)
  sorted.each_with_index { |e, idx|
    sorted[idx] = nil if (e[0] == name)
  }
  sorted.delete(nil)
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.


197
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
# File 'lib/msf/core/option_container.rb', line 197

def validate(datastore)
  errors = []

  each_pair { |name, option|
    if (!option.valid?(datastore[name]))
      errors << name
      # If the option is valid, normalize its format to the correct type.
    elsif ((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
  }

  if (errors.empty? == false)
    raise OptionValidateError.new(errors),
      "One or more options failed to validate: #{errors.join(', ')}.", caller
  end

  return true
end