Module: Msf::Ui::Console::ModuleOptionValidation

Included in:
ModuleArgumentParsing, ModuleOptionTabCompletion
Defined in:
lib/msf/ui/console/module_option_validation.rb

Overview

Module-specific datastore option validation helpers.

Instance Method Summary collapse

Instance Method Details

#datastore_option_names(datastore) ⇒ Object 



15
16
17
18
19
20
21
22
23
 
# File 'lib/msf/ui/console/module_option_validation.rb', line 15

def datastore_option_names(datastore)
  keys = (
    Msf::DataStore::GLOBAL_KEYS +
      datastore.options.keys
  )
  keys.concat(datastore.options.values.flat_map(&:fallbacks)) if datastore.is_a?(Msf::DataStore)
  keys.uniq!(&:downcase)
  keys
end

#unknown_datastore_option_message(mod, name, valid_options: nil) ⇒ Object

Returns an “Unknown datastore option” message (including a “Did you mean” suggestion when applicable) if name is not a valid option name for mod, or nil if it is valid. Pass valid_options if the caller has already computed it, to avoid recomputing it here.



87
88
89
90
91
92
93
94
95
 
# File 'lib/msf/ui/console/module_option_validation.rb', line 87

def unknown_datastore_option_message(mod, name, valid_options: nil)
  valid_options ||= valid_datastore_option_names(mod, include_aliases: true)
  return nil if valid_options.any? { |vo| vo.casecmp?(name) }

  message = "Unknown datastore option: #{name}."
  suggestion = DidYouMean::SpellChecker.new(dictionary: valid_options).correct(name).first
  message << " Did you mean #{suggestion}?" if suggestion
  message
end

#valid_datastore_option_names(mod, include_aliases: false, active_only: false) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/msf/ui/console/module_option_validation.rb', line 25

def valid_datastore_option_names(mod, include_aliases: false, active_only: false)
  datastore = mod ? mod.datastore : framework.datastore
  res = datastore_option_names(datastore) || []

  return res unless mod

  if active_only
    hidden_option_names = datastore.options.each_with_object([]) do |(name, opt), names|
      next if Msf::OptCondition.show_option(mod, opt)

      names << name
      names.concat(opt.fallbacks)
      names.concat(opt.aliases) if include_aliases
    end
    res.delete_if { |name| hidden_option_names.any? { |hidden_name| hidden_name.casecmp?(name) } }
  end

  mod.options.each do |name, opt|
    next if active_only && !Msf::OptCondition.show_option(mod, opt)

    res << name
    # aliases that are defined for backwards compatibility are not tab completed but are still valid option names
    res += opt.aliases if include_aliases
  end

  # Exploits provide these three default options
  if mod.exploit?
    res << 'PAYLOAD'
    res << 'NOP'
    res << 'TARGET'
    res << 'ENCODER'
  elsif mod.evasion?
    res << 'PAYLOAD'
    res << 'TARGET'
    res << 'ENCODER'
  elsif mod.payload?
    res << 'ENCODER'
  end

  res << 'ACTION' if mod.is_a?(Msf::Module::HasActions)

  if ((mod.exploit? || mod.evasion?) && mod.datastore['PAYLOAD'])
    payload = framework.payloads.create(mod.datastore['PAYLOAD'])
    if payload
      payload.options.each do |name, opt|
        next if active_only && !Msf::OptCondition.show_option(mod, opt)

        res << name
        res += opt.aliases if include_aliases
      end
    end
  end

  res
end