Class: Msf::Ui::Console::CommandDispatcher::Auxiliary

Inherits:
Object
  • Object
show all
Includes:
ModuleCommandDispatcher
Defined in:
lib/msf/ui/console/command_dispatcher/auxiliary.rb

Overview

Recon module command dispatcher.

Constant Summary collapse

@@auxiliary_opts =
Rex::Parser::Arguments.new(
  "-h" => [ false, "Help banner."                                                        ],
  "-j" => [ false, "Run in the context of a job."                                       ],
  "-o" => [ true,  "A comma separated list of options in VAR=VAL format."                ],
  "-a" => [ true,  "The action to use.  If none is specified, ACTION is used."           ],
  "-q" => [ false, "Run the module in quiet mode with no output"                         ]
)

Instance Attribute Summary

Attributes included from Msf::Ui::Console::CommandDispatcher

#driver

Attributes included from Rex::Ui::Text::DispatcherShell::CommandDispatcher

#shell, #tab_complete_items

Instance Method Summary collapse

Methods included from ModuleCommandDispatcher

#check_multiple, #check_progress, #check_show_progress, #check_simple, #cmd_check, #cmd_pry, #cmd_pry_help, #cmd_reload, #cmd_reload_help, #mod, #mod=, #reload

Methods included from Msf::Ui::Console::CommandDispatcher

#active_module, #active_module=, #active_session, #active_session=, #defanged?, #framework, #initialize, #log_error

Methods included from Rex::Ui::Text::DispatcherShell::CommandDispatcher

#cmd_help, #cmd_help_help, #cmd_help_tabs, #deprecated_cmd, #deprecated_commands, #deprecated_help, #help_to_s, #initialize, #print, #print_error, #print_good, #print_line, #print_status, #print_warning, #tab_complete_filenames, #update_prompt

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(meth, *args) ⇒ Object

Allow modules to define their own commands


41
42
43
44
45
46
47
48
49
50
# File 'lib/msf/ui/console/command_dispatcher/auxiliary.rb', line 41

def method_missing(meth, *args)
  if (mod and mod.respond_to?(meth.to_s))

    # Initialize user interaction
    mod.init_ui(driver.input, driver.output)

    return mod.send(meth.to_s, *args)
  end
  return
end

Instance Method Details

#cmd_rerun(*args) ⇒ Object Also known as: cmd_rexploit

Reloads an auxiliary module and executes it


63
64
65
66
67
# File 'lib/msf/ui/console/command_dispatcher/auxiliary.rb', line 63

def cmd_rerun(*args)
  if reload(true)
    cmd_run(*args)
  end
end

#cmd_run(*args) ⇒ Object Also known as: cmd_exploit

Executes an auxiliary module


74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# File 'lib/msf/ui/console/command_dispatcher/auxiliary.rb', line 74

def cmd_run(*args)
  defanged?

  opt_str = nil
  action  = mod.datastore['ACTION']
  jobify  = false
  quiet   = false

  @@auxiliary_opts.parse(args) { |opt, idx, val|
    case opt
      when '-j'
        jobify = true
      when '-o'
        opt_str = val
      when '-a'
        action = val
      when '-q'
        quiet  = true
      when '-h'
        cmd_run_help
        return false
    end
  }

  # Always run passive modules in the background
  if (mod.passive or mod.passive_action?(action))
    jobify = true
  end

  begin
    mod.run_simple(
      'Action'         => action,
      'OptionStr'      => opt_str,
      'LocalInput'     => driver.input,
      'LocalOutput'    => driver.output,
      'RunAsJob'       => jobify,
      'Quiet'          => quiet
    )
  rescue ::Timeout::Error
    print_error("Auxiliary triggered a timeout exception")
    print_error("Call stack:")
    e.backtrace.each do |line|
      break if line =~ /lib.msf.base.simple/
      print_error("  #{line}")
    end
  rescue ::Interrupt
    print_error("Auxiliary interrupted by the console user")
  rescue ::Exception => e
    print_error("Auxiliary failed: #{e.class} #{e}")
    if(e.class.to_s != 'Msf::OptionValidateError')
      print_error("Call stack:")
      e.backtrace.each do |line|
        break if line =~ /lib.msf.base.simple/
        print_error("  #{line}")
      end
    end

    return false
  end

  if (jobify)
    print_status("Auxiliary module running as background job")
  else
    print_status("Auxiliary module execution completed")
  end
end

#cmd_run_helpObject Also known as: cmd_exploit_help


143
144
145
146
147
148
# File 'lib/msf/ui/console/command_dispatcher/auxiliary.rb', line 143

def cmd_run_help
  print_line "Usage: run [options]"
  print_line
  print_line "Launches an auxiliary module."
  print @@auxiliary_opts.usage
end

#commandsObject

Returns the hash of commands specific to auxiliary modules.


28
29
30
31
32
33
34
35
36
# File 'lib/msf/ui/console/command_dispatcher/auxiliary.rb', line 28

def commands
  super.update({
    "run"   => "Launches the auxiliary module",
    "rerun" => "Reloads and launches the auxiliary module",
    "exploit" => "This is an alias for the run command",
    "rexploit" => "This is an alias for the rerun command",
    "reload"   => "Reloads the auxiliary module"
  }).merge( (mod ? mod.auxiliary_commands : {}) )
end

#nameObject

Returns the command dispatcher name.


56
57
58
# File 'lib/msf/ui/console/command_dispatcher/auxiliary.rb', line 56

def name
  "Auxiliary"
end