Class: Msf::Ui::Console::CommandDispatcher::Modules

Inherits:
Object
  • Object
show all
Includes:
Msf::Ui::Console::CommandDispatcher, Common, Rex::Text::Color
Defined in:
lib/msf/ui/console/command_dispatcher/modules.rb

Overview

Msf::Ui::Console::CommandDispatcher for commands related to background jobs in Metasploit Framework.

Constant Summary collapse

@@search_opts = 
Rex::Parser::Arguments.new(
  '-h' => [false, 'Help banner'],
  '-I' => [false, 'Ignore the command if the only match has the same name as the search'],
  '-o' => [true,  'Send output to a file in csv format'],
  '-S' => [true,  'Regex pattern used to filter search results'],
  '-u' => [false, 'Use module if there is one result']
)

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 Common

#arg_host_range, #arg_port_range, #index_from_list, #set_rhosts_from_addrs, #show_options, #trim_path

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

#active_module, #active_module=, #active_session, #active_session=, #build_range_array, #docs_dir, #framework, #log_error, #remove_lines

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

#cmd_help, #cmd_help_help, #cmd_help_tabs, #deprecated_cmd, #deprecated_commands, #deprecated_help, #docs_dir, #help_to_s, #print, #print_error, #print_good, #print_line, #print_status, #print_warning, #tab_complete_directory, #tab_complete_filenames, #tab_complete_generic, #tab_complete_source_address, #update_prompt

Constructor Details

#initialize(driver) ⇒ Modules

Initializes the datastore cache


54
55
56
57
58
59
60
61
62
63
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 54

def initialize(driver)
  super

  @dscache = {}
  @previous_module = nil
  @module_name_stack = []
  @module_search_results = []
  @@payload_show_results = []
  @dangerzone_map = nil
end

Instance Method Details

#cmd_advanced(*args) ⇒ Object 


80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 80

def cmd_advanced(*args)
  if args.empty?
    if (active_module)
      show_advanced_options(active_module)
      return true
    else
      print_error('No module active')
      return false
    end
  end

  args.each { |name|
    mod = framework.modules.create(name)

    if (mod == nil)
      print_error("Invalid module: #{name}")
    else
      show_advanced_options(mod)
    end
  }
end

#cmd_advanced_help ⇒ Object 


72
73
74
75
76
77
78
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 72

def cmd_advanced_help
  print_line 'Usage: advanced [mod1 mod2 ...]'
  print_line
  print_line 'Queries the supplied module or modules for advanced options. If no module is given,'
  print_line 'show advanced options for the currently active module.'
  print_line
end

#cmd_advanced_tabs(str, words) ⇒ Object

Tab completion for the advanced command (same as use)

Parameters:

  • str (String) —

    the string currently being typed before tab was hit

  • words (Array<String>) —

    the previously completed words on the command line. words is always


212
213
214
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 212

def cmd_advanced_tabs(str, words)
  cmd_use_tabs(str, words)
end

#cmd_back(*args) ⇒ Object

Pop the current dispatcher stack context, assuming it isn't pointed at the core or database backend stack context.


943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 943

def cmd_back(*args)
  if (driver.dispatcher_stack.size > 1 and
    driver.current_dispatcher.name != 'Core' and
    driver.current_dispatcher.name != 'Database Backend')
    # Reset the active module if we have one
    if (active_module)

      # Do NOT reset the UI anymore
      # active_module.reset_ui

      # Save the module's datastore so that we can load it later
      # if the module is used again
      @dscache[active_module.fullname] = active_module.datastore.dup

      self.active_module = nil
    end

    # Destack the current dispatcher
    driver.destack_dispatcher
  end
end

#cmd_back_help ⇒ Object 


932
933
934
935
936
937
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 932

def cmd_back_help
  print_line "Usage: back"
  print_line
  print_line "Return to the global dispatcher context"
  print_line
end

#cmd_clearm(*_args) ⇒ Object 


868
869
870
871
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 868

def cmd_clearm(*_args)
  print_status('Clearing the module stack')
  @module_name_stack.clear
end

#cmd_clearm_help ⇒ Object 


861
862
863
864
865
866
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 861

def cmd_clearm_help
  print_line 'Usage: clearm'
  print_line
  print_line 'Clear the module stack'
  print_line
end

#cmd_info(*args) ⇒ Object

Displays information about one or more module.


116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 116

def cmd_info(*args)
  dump_json = false
  show_doc = false

  if args.include?('-j')
    args.delete('-j')
    dump_json = true
  end

  if args.include?('-d')
    args.delete('-d')
    show_doc = true
  end

  if (args.length == 0)
    if (active_module)
      if dump_json
        print(Serializer::Json.dump_module(active_module) + "\n")
      elsif show_doc
        f = Tempfile.new(["#{active_module.shortname}_doc", '.html'])
        begin
          print_status("Generating documentation for #{active_module.shortname}, then opening #{f.path} in a browser...")
          Msf::Util::DocumentGenerator.spawn_module_document(active_module, f)
        ensure
          f.close if f
        end
      else
        print(Serializer::ReadableText.dump_module(active_module))
      end
      return true
    else
      cmd_info_help
      return false
    end
  elsif args.include? "-h"
    cmd_info_help
    return false
  end

  args.each { |name|
    mod = framework.modules.create(name)

    if (mod == nil)
      print_error("Invalid module: #{name}")
    elsif dump_json
      print(Serializer::Json.dump_module(mod) + "\n")
    elsif show_doc
      f = Tempfile.new(["#{mod.shortname}_doc", '.html'])
      begin
        print_status("Generating documentation for #{mod.shortname}, then opening #{f.path} in a browser...")
        Msf::Util::DocumentGenerator.spawn_module_document(mod, f)
      ensure
        f.close if f
      end
    else
      print(Serializer::ReadableText.dump_module(mod))
    end
  }
end

#cmd_info_help ⇒ Object 


102
103
104
105
106
107
108
109
110
111
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 102

def cmd_info_help
  print_line "Usage: info <module name> [mod2 mod3 ...]"
  print_line
  print_line "Options:"
  print_line "* The flag '-j' will print the data in json format"
  print_line "* The flag '-d' will show the markdown version with a browser. More info, but could be slow."
  print_line "Queries the supplied module or modules for information. If no module is given,"
  print_line "show info for the currently active module."
  print_line
end

#cmd_info_tabs(str, words) ⇒ Object

Tab completion for the advanced command (same as use)

Parameters:

  • str (String) —

    the string currently being typed before tab was hit

  • words (Array<String>) —

    the previously completed words on the command line. words is always


222
223
224
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 222

def cmd_info_tabs(str, words)
  cmd_use_tabs(str, words)
end

#cmd_listm(*_args) ⇒ Object 


848
849
850
851
852
853
854
855
856
857
858
859
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 848

def cmd_listm(*_args)
  if @module_name_stack.empty?
    print_error('The module stack is empty')
    return
  end

  print_status("Module stack:\n")

  @module_name_stack.to_enum.with_index.reverse_each do |name, idx|
    print_line("[#{idx}]\t#{name}")
  end
end

#cmd_listm_help ⇒ Object 


841
842
843
844
845
846
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 841

def cmd_listm_help
  print_line 'Usage: listm'
  print_line
  print_line 'List the module stack'
  print_line
end

#cmd_loadpath(*args) ⇒ Object

Adds one or more search paths.


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 247

def cmd_loadpath(*args)
  if (args.length == 0 or args.include? "-h")
    cmd_loadpath_help
    return true
  end

  totals    = {}
  overall   = 0
  curr_path = nil

  begin
    # Walk the list of supplied search paths attempting to add each one
    # along the way
    args.each { |path|
      curr_path = path

      # Load modules, but do not consult the cache
      if (counts = framework.modules.add_module_path(path))
        counts.each_pair { |type, count|
          totals[type] = (totals[type]) ? (totals[type] + count) : count

          overall += count
        }
      end
    }
  rescue NameError, RuntimeError
    log_error("Failed to add search path #{curr_path}: #{$!}")
    return true
  end

  added = "Loaded #{overall} modules:\n"

  totals.each_pair { |type, count|
    added << "    #{count} #{type} modules\n"
  }

  print(added)
end

#cmd_loadpath_help ⇒ Object 


236
237
238
239
240
241
242
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 236

def cmd_loadpath_help
  print_line "Usage: loadpath </path/to/modules>"
  print_line
  print_line "Loads modules from the given directory which should contain subdirectories for"
  print_line "module types, e.g. /path/to/modules/exploits"
  print_line
end

#cmd_loadpath_tabs(str, words) ⇒ Object

Tab completion for the loadpath command

at least 1 when tab completion has reached this stage since the command itself has been completed

Parameters:

  • str (String) —

    the string currently being typed before tab was hit

  • words (Array<String>) —

    the previously completed words on the command line. words is always


293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 293

def cmd_loadpath_tabs(str, words)
  return [] if words.length > 1

  # This custom completion might better than Readline's... We'll leave it for now.
  #tab_complete_filenames(str,words)

  paths = []
  if (File.directory?(str))
    paths = Dir.entries(str)
    paths = paths.map { |f|
      if File.directory? File.join(str,f)
        File.join(str,f)
      end
    }
    paths.delete_if { |f| f.nil? or File.basename(f) == '.' or File.basename(f) == '..' }
  else
    d = Dir.glob(str + "*").map { |f| f if File.directory?(f) }
    d.delete_if { |f| f.nil? or f == '.' or f == '..' }
    # If there's only one possibility, descend to the next level
    if (1 == d.length)
      paths = Dir.entries(d[0])
      paths = paths.map { |f|
        if File.directory? File.join(d[0],f)
          File.join(d[0],f)
        end
      }
      paths.delete_if { |f| f.nil? or File.basename(f) == '.' or File.basename(f) == '..' }
    else
      paths = d
    end
  end
  paths.sort!
  return paths
end

#cmd_options(*args) ⇒ Object 


184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 184

def cmd_options(*args)
  if args.empty?
    if (active_module)
      show_options(active_module)
      return true
    else
      show_global_options
      return true
    end
  end

  args.each do |name|
    mod = framework.modules.create(name)

    if (mod == nil)
      print_error("Invalid module: #{name}")
    else
      show_options(mod)
    end
  end
end

#cmd_options_help ⇒ Object 


176
177
178
179
180
181
182
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 176

def cmd_options_help
  print_line 'Usage: options [mod1 mod2 ...]'
  print_line
  print_line 'Queries the supplied module or modules for options. If no module is given,'
  print_line 'show options for the currently active module.'
  print_line
end

#cmd_options_tabs(str, words) ⇒ Object

Tab completion for the advanced command (same as use)

Parameters:

  • str (String) —

    the string currently being typed before tab was hit

  • words (Array<String>) —

    the previously completed words on the command line. words is always


232
233
234
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 232

def cmd_options_tabs(str, words)
  cmd_use_tabs(str, words)
end

#cmd_popm(*args) ⇒ Object

Command to dequeque a module from the module stack


808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 808

def cmd_popm(*args)
  if (args.count > 1 or not args[0].respond_to?("to_i"))
    return self.cmd_popm_help
  elsif args.count == 1
    # then pop 'n' items off the stack, but don't change the active module
    if args[0].to_i >= @module_name_stack.count
      # in case they pass in a number >= the length of @module_name_stack
      @module_name_stack = []
      print_status("The module stack is empty")
    else
      @module_name_stack.pop(args[0].to_i)
    end
  else #then just pop the array and make that the active module
    pop = @module_name_stack.pop
    if pop
      return self.cmd_use(pop)
    else
      print_error("There isn't anything to pop, the module stack is empty")
    end
  end
end

#cmd_popm_help ⇒ Object

Help for the 'popm' command


833
834
835
836
837
838
839
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 833

def cmd_popm_help
  print_line "Usage: popm [n]"
  print_line
  print_line "pop the latest module off of the module stack and make it the active module"
  print_line "or pop n modules off the stack, but don't change the active module"
  print_line
end

#cmd_previous(*args) ⇒ Object

Command to take to the previously active module


743
744
745
746
747
748
749
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 743

def cmd_previous(*args)
  if @previous_module
    self.cmd_use(@previous_module.fullname)
  else
    print_error("There isn't a previous module at the moment")
  end
end

#cmd_previous_help ⇒ Object

Help for the 'previous' command


754
755
756
757
758
759
760
761
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 754

def cmd_previous_help
  print_line "Usage: previous"
  print_line
  print_line "Set the previously loaded module as the current module"
  print_line
  print_line "Previous module: #{@previous_module ? @previous_module.fullname : 'none'}"
  print_line
end

#cmd_pushm(*args) ⇒ Object

Command to enqueque a module on the module stack


766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 766

def cmd_pushm(*args)
  # could check if each argument is a valid module, but for now let them hang themselves
  if args.count > 0
    args.each do |arg|
      @module_name_stack.push(arg)
      # Note new modules are appended to the array and are only module (full)names
    end
  else #then just push the active module
    if active_module
      #print_status "Pushing the active module"
      @module_name_stack.push(active_module.fullname)
    else
      print_error("There isn't an active module and you didn't specify a module to push")
      return self.cmd_pushm_help
    end
  end
end

#cmd_pushm_help ⇒ Object

Help for the 'pushm' command


798
799
800
801
802
803
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 798

def cmd_pushm_help
  print_line "Usage: pushm [module1 [,module2, module3...]]"
  print_line
  print_line "push current active module or specified modules onto the module stack"
  print_line
end

#cmd_pushm_tabs(str, words) ⇒ Object

Tab completion for the pushm command

at least 1 when tab completion has reached this stage since the command itself has been completed

Parameters:

  • str (String) —

    the string currently being typed before tab was hit

  • words (Array<String>) —

    the previously completed words on the command line. words is always


791
792
793
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 791

def cmd_pushm_tabs(str, words)
  tab_complete_module(str, words)
end

#cmd_reload_all(*args) ⇒ Object

Reload all module paths that we are aware of


897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 897

def cmd_reload_all(*args)
  if args.length > 0
    cmd_reload_all_help
    return
  end

  print_status("Reloading modules from all module paths...")
  framework.modules.reload_modules

  log_msg = "Please see #{File.join(Msf::Config.log_directory, 'framework.log')} for details."

  # Check for modules that failed to load
  if framework.modules.module_load_error_by_path.length > 0
    print_error("WARNING! The following modules could not be loaded!")

    framework.modules.module_load_error_by_path.each do |path, _error|
      print_error("\t#{path}")
    end

    print_error(log_msg)
  end

  if framework.modules.module_load_warnings.length > 0
    print_warning("The following modules were loaded with warnings:")

    framework.modules.module_load_warnings.each do |path, _error|
      print_warning("\t#{path}")
    end

    print_warning(log_msg)
  end

  self.driver.run_single("banner")
end

#cmd_reload_all_help ⇒ Object 


886
887
888
889
890
891
892
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 886

def cmd_reload_all_help
  print_line "Usage: reload_all"
  print_line
  print_line "Reload all modules from all configured module paths.  This may take awhile."
  print_line "See also: loadpath"
  print_line
end

#cmd_search(*args) ⇒ Object

Searches modules for specific keywords


375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 375

def cmd_search(*args)
  match        = ''
  row_filter  = nil
  output_file  = nil
  cached       = false
  use          = false
  count        = -1
  search_terms = []

  ignore_use_exact_match = false

  @@search_opts.parse(args) do |opt, idx, val|
    case opt
    when '-S'
      row_filter = val
    when '-h'
      cmd_search_help
      return false
    when '-o'
      output_file = val
    when '-u'
      use = true
    when '-I'
      ignore_use_exact_match = true
    else
      match += val + ' '
    end
  end

  if args.empty?
    if @module_search_results.empty?
      cmd_search_help
      return false
    end

    cached = true
  end

  begin
    if cached
      print_status('Displaying cached results')
    else
      search_params = Msf::Modules::Metadata::Search.parse_search_string(match)
      @module_search_results = Msf::Modules::Metadata::Cache.instance.find(search_params)
    end

    if @module_search_results.empty?
      print_error('No results from search')
      return false
    end

    if ignore_use_exact_match && @module_search_results.length == 1 &&
        @module_search_results.first.fullname == match.strip
      return false
    end

    if !search_params.nil? && !search_params['text'].nil?
      search_params['text'][0].each do |t|
        search_terms << t
      end
    end

    # Generate the table used to display matches
    tbl = generate_module_table('Matching Modules', search_terms, row_filter)

    @module_search_results.each do |m|
      tbl << [
          count += 1,
          m.fullname,
          m.disclosure_date.nil? ? '' : m.disclosure_date.strftime("%Y-%m-%d"),
          m.rank,
          m.check ? 'Yes' : 'No',
          m.name,
      ]
    end

    if @module_search_results.length == 1 && use
      used_module = @module_search_results.first.fullname
      cmd_use(used_module, true)
    end
  rescue ArgumentError
    print_error("Invalid argument(s)\n")
    cmd_search_help
    return false
  end

  if output_file
    print_status("Wrote search results to #{output_file}")
    ::File.open(output_file, "wb") { |ofd|
      ofd.write(tbl.to_csv)
    }
  else
    print_line(tbl.to_s)
    print_status("Using #{used_module}") if used_module

    if @module_search_results.length > 1
      index_usage = "use #{@module_search_results.length - 1}"
      name_usage = "use #{@module_search_results.last.fullname}"

      print("Interact with a module by name or index, for example %grn#{index_usage}%clr or %grn#{name_usage}%clr\n\n")
    end
  end

  true
end

#cmd_search_help ⇒ Object 


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 328

def cmd_search_help
  print_line "Usage: search [<options>] [<keywords>:<value>]"
  print_line
  print_line "Prepending a value with '-' will exclude any matching results."
  print_line "If no options or keywords are provided, cached results are displayed."
  print_line
  print_line "OPTIONS:"
  print_line "  -h                Show this help information"
  print_line "  -o <file>         Send output to a file in csv format"
  print_line "  -S <string>       Regex pattern used to filter search results"
  print_line "  -u                Use module if there is one result"
  print_line
  print_line "Keywords:"
  {
    'aka'         => 'Modules with a matching AKA (also-known-as) name',
    'author'      => 'Modules written by this author',
    'arch'        => 'Modules affecting this architecture',
    'bid'         => 'Modules with a matching Bugtraq ID',
    'cve'         => 'Modules with a matching CVE ID',
    'edb'         => 'Modules with a matching Exploit-DB ID',
    'check'       => 'Modules that support the \'check\' method',
    'date'        => 'Modules with a matching disclosure date',
    'description' => 'Modules with a matching description',
    'fullname'    => 'Modules with a matching full name',
    'mod_time'    => 'Modules with a matching modification date',
    'name'        => 'Modules with a matching descriptive name',
    'path'        => 'Modules with a matching path',
    'platform'    => 'Modules affecting this platform',
    'port'        => 'Modules with a matching port',
    'rank'        => 'Modules with a matching rank (Can be descriptive (ex: \'good\') or numeric with comparison operators (ex: \'gte400\'))',
    'ref'         => 'Modules with a matching ref',
    'reference'   => 'Modules with a matching reference',
    'target'      => 'Modules affecting this target',
    'type'        => 'Modules of a specific type (exploit, payload, auxiliary, encoder, evasion, post, or nop)',
  }.each_pair do |keyword, description|
    print_line "  #{keyword.ljust 12}:  #{description}"
  end
  print_line
  print_line "Examples:"
  print_line "  search cve:2009 type:exploit"
  print_line "  search cve:2009 type:exploit platform:-linux"
  print_line
end

#cmd_search_tabs(str, words) ⇒ Object

Tab completion for the search command

at least 1 when tab completion has reached this stage since the command itself has been completed

Parameters:

  • str (String) —

    the string currently being typed before tab was hit

  • words (Array<String>) —

    the previously completed words on the command line. words is always


488
489
490
491
492
493
494
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 488

def cmd_search_tabs(str, words)
  if words.length == 1
    return @@search_opts.fmt.keys
  end

  []
end

#cmd_show(*args) ⇒ Object

Displays the list of modules based on their type, or all modules if no type is provided.


508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 508

def cmd_show(*args)
  if args.empty?
    print_error("Argument required\n")
    cmd_show_help
    return
  end

  mod = self.active_module

  args.each { |type|
    case type
      when '-h'
        cmd_show_help
      when 'all'
        show_encoders
        show_nops
        show_exploits
        show_payloads
        show_auxiliary
        show_post
        show_plugins
      when 'encoders'
        show_encoders
      when 'nops'
        show_nops
      when 'exploits'
        show_exploits
      when 'payloads'
        show_payloads
      when 'auxiliary'
        show_auxiliary
      when 'post'
        show_post
      when 'info'
        cmd_info(*args[1, args.length])
      when 'options'
        if (mod)
          show_options(mod)
        else
          show_global_options
        end
      when 'missing'
        if (mod)
          show_missing(mod)
        else
          print_error("No module selected.")
        end
      when 'advanced'
        if (mod)
          show_advanced_options(mod)
        else
          print_error("No module selected.")
        end
      when 'evasion'
        if (mod)
          show_evasion_options(mod)
        else
          show_evasion
        end
      when 'sessions'
        if (active_module and active_module.respond_to?(:compatible_sessions))
          sessions = active_module.compatible_sessions
        else
          sessions = framework.sessions.keys.sort
        end
        print_line
        print(Serializer::ReadableText.dump_sessions(framework, :session_ids => sessions))
        print_line
      when "plugins"
        show_plugins
      when "targets"
        if (mod and (mod.exploit? or mod.evasion?))
          show_targets(mod)
        else
          print_error("No exploit module selected.")
        end
      when "actions"
        if mod && mod.kind_of?(Msf::Module::HasActions)
          show_actions(mod)
        else
          print_error("No module with actions selected.")
        end

      else
        print_error("Invalid parameter \"#{type}\", use \"show -h\" for more information")
    end
  }
end

#cmd_show_help ⇒ Object 


496
497
498
499
500
501
502
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 496

def cmd_show_help
  global_opts = %w{all encoders nops exploits payloads auxiliary post plugins info options}
  print_status("Valid parameters for the \"show\" command are: #{global_opts.join(", ")}")

  module_opts = %w{ missing advanced evasion targets actions }
  print_status("Additional module-specific parameters are: #{module_opts.join(", ")}")
end

#cmd_show_tabs(str, words) ⇒ Object

Tab completion for the show command

at least 1 when tab completion has reached this stage since the command itself has been completed

Parameters:

  • str (String) —

    the string currently being typed before tab was hit

  • words (Array<String>) —

    the previously completed words on the command line. words is always


604
605
606
607
608
609
610
611
612
613
614
615
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 604

def cmd_show_tabs(str, words)
  return [] if words.length > 1

  res = %w{all encoders nops exploits payloads auxiliary post plugins options}
  if (active_module)
    res.concat %w{missing advanced evasion targets actions info}
    if (active_module.respond_to? :compatible_sessions)
      res << "sessions"
    end
  end
  return res
end

#cmd_use(*args) ⇒ Object

Uses a module.


638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 638

def cmd_use(*args)
  if args.length == 0 || args.first == '-h'
    cmd_use_help
    return false
  end

  # Divert logic for dangerzone mode
  args = dangerzone_codename_to_module(args)

  # Try to create an instance of the supplied module name
  mod_name = args[0]

  # Use a module by search index
  index_from_list(@module_search_results, mod_name) do |mod|
    return false unless mod && mod.respond_to?(:fullname)

    # Module cache object from @module_search_results
    mod_name = mod.fullname
  end

  # See if the supplied module name has already been resolved
  mod_resolved = args[1] == true ? true : false

  # Ensure we have a reference name and not a path
  mod_name = trim_path(mod_name, "modules")

  begin
    mod = framework.modules.create(mod_name)

    unless mod
      unless mod_resolved
        # Avoid trying to use the search result if it exactly matches
        # the module we were trying to load. The module cannot be
        # loaded and searching isn't going to change that.
        mods_found = cmd_search('-I', '-u', mod_name)
      end

      unless mods_found
        print_error("Failed to load module: #{mod_name}")
        return false
      end
    end
  rescue Rex::AmbiguousArgumentError => info
    print_error(info.to_s)
  rescue NameError => info
    log_error("The supplied module name is ambiguous: #{$!}.")
  end

  return false if (mod == nil)

  # Enstack the command dispatcher for this module type
  dispatcher = nil

  case mod.type
    when Msf::MODULE_ENCODER
      dispatcher = Msf::Ui::Console::CommandDispatcher::Encoder
    when Msf::MODULE_EXPLOIT
      dispatcher = Msf::Ui::Console::CommandDispatcher::Exploit
    when Msf::MODULE_NOP
      dispatcher = Msf::Ui::Console::CommandDispatcher::Nop
    when Msf::MODULE_PAYLOAD
      dispatcher = Msf::Ui::Console::CommandDispatcher::Payload
    when Msf::MODULE_AUX
      dispatcher = Msf::Ui::Console::CommandDispatcher::Auxiliary
    when Msf::MODULE_POST
      dispatcher = Msf::Ui::Console::CommandDispatcher::Post
    when Msf::MODULE_EVASION
      dispatcher = Msf::Ui::Console::CommandDispatcher::Evasion
    else
      print_error("Unsupported module type: #{mod.type}")
      return false
  end

  # If there's currently an active module, enqueque it and go back
  if (active_module)
    @previous_module = active_module
    cmd_back()
  end

  if (dispatcher != nil)
    driver.enstack_dispatcher(dispatcher)
  end

  # Update the active module
  self.active_module = mod

  # If a datastore cache exists for this module, then load it up
  if @dscache[active_module.fullname]
    active_module.datastore.update(@dscache[active_module.fullname])
  end

  # Choose a default payload when the module is used, not run
  if mod.datastore['PAYLOAD']
    print_status("Using configured payload #{mod.datastore['PAYLOAD']}")
  elsif dispatcher.respond_to?(:choose_payload)
    chosen_payload = dispatcher.choose_payload(mod)
    print_status("No payload configured, defaulting to #{chosen_payload}") if chosen_payload
  end

  mod.init_ui(driver.input, driver.output)
end

#cmd_use_help ⇒ Object 


617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 617

def cmd_use_help
  print_line 'Usage: use <name|term|index>'
  print_line
  print_line 'Interact with a module by name or search term/index.'
  print_line 'If a module name is not found, it will be treated as a search term.'
  print_line 'An index from the previous search results can be selected if desired.'
  print_line
  print_line 'Examples:'
  print_line '  use exploit/windows/smb/ms17_010_eternalblue'
  print_line
  print_line '  use eternalblue'
  print_line '  use <name|index>'
  print_line
  print_line '  search eternalblue'
  print_line '  use <name|index>'
  print_line
end

#cmd_use_tabs(str, words) ⇒ Object

Tab completion for the use command

at least 1 when tab completion has reached this stage since the command itself has been completd

Parameters:

  • str (String) —

    the string currently being typed before tab was hit

  • words (Array<String>) —

    the previously completed words on the command line. words is always


880
881
882
883
884
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 880

def cmd_use_tabs(str, words)
  return [] if words.length > 1

  tab_complete_module(str, words)
end

#commands ⇒ Object 


32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 32

def commands
  {
    "back"       => "Move back from the current context",
    "advanced"   => "Displays advanced options for one or more modules",
    "info"       => "Displays information about one or more modules",
    "options"    => "Displays global options or for one or more modules",
    "loadpath"   => "Searches for and loads modules from a path",
    "popm"       => "Pops the latest module off the stack and makes it active",
    "pushm"      => "Pushes the active or list of modules onto the module stack",
    "listm"      => "List the module stack",
    "clearm"     => "Clear the module stack",
    "previous"   => "Sets the previously loaded module as the current module",
    "reload_all" => "Reloads all modules from all defined module paths",
    "search"     => "Searches module names and descriptions",
    "show"       => "Displays modules of a given type, or all modules",
    "use"        => "Interact with a module by name or search term/index",
  }
end

#dangerzone_active? ⇒ Boolean

Determine if dangerzone mode is active via date or environment variable

Returns:

  • (Boolean) 

994
995
996
997
998
999
1000
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 994

def dangerzone_active?
  active = Time.now.strftime("%m%d") == "0401" || Rex::Compat.getenv('DANGERZONE').to_i > 0
  if active && @dangerzone_map.nil?
    dangerzone_build_map
  end
  active
end

#dangerzone_build_map ⇒ Object 


1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1017

def dangerzone_build_map
  return unless @dangerzone_map.nil?

  @dangerzone_map = {}

  res = []
  %W{exploit auxiliary}.each do |mtyp|
    mset = framework.modules.module_names(mtyp)
    mset.each do |mref|
      res << mtyp + '/' + mref
    end
  end

  words_a = ::File.readlines(::File.join(
    ::Msf::Config.data_directory, "wordlists", "dangerzone_a.txt"
    )).map{|line| line.strip.upcase}

  words_b = ::File.readlines(::File.join(
    ::Msf::Config.data_directory, "wordlists", "dangerzone_b.txt"
    )).map{|line| line.strip.upcase}

  aidx = -1
  bidx = -1

  res.sort.each do |mname|
    word_a = words_a[ (aidx += 1) % words_a.length ]
    word_b = words_b[ (bidx += 1) % words_b.length ]
    cname = word_a + word_b

    while @dangerzone_map[cname]
      aidx += 1
      word_a = words_a[ (aidx += 1) % words_a.length ]
      cname = word_a + word_b
    end

    @dangerzone_map[mname] = cname
    @dangerzone_map[cname] = mname
  end
end

#dangerzone_codename_to_module(args) ⇒ Object

Convert squirrel names back to regular module names


984
985
986
987
988
989
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 984

def dangerzone_codename_to_module(args)
  return args unless dangerzone_active? && args.length > 0 && args[0].length > 0
  return args unless args[0] =~ /^[A-Z]/
  args[0] = dangerzone_codename_to_module_name(args[0])
  args
end

#dangerzone_codename_to_module_name(cname) ⇒ Object 


1009
1010
1011
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1009

def dangerzone_codename_to_module_name(cname)
  @dangerzone_map[cname] || cname
end

#dangerzone_module_name_to_codename(mname) ⇒ Object 


1013
1014
1015
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1013

def dangerzone_module_name_to_codename(mname)
  @dangerzone_map[mname] || mname
end

#dangerzone_modules_to_codenames(names) ⇒ Object

Convert module names to squirrel names


1005
1006
1007
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1005

def dangerzone_modules_to_codenames(names)
  (names + @dangerzone_map.keys.grep(/^[A-Z]+/)).sort
end

#generate_module_table(type, search_terms = [], row_filter = nil) ⇒ Object

:nodoc:


1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1282

def generate_module_table(type, search_terms = [], row_filter = nil) # :nodoc:
    Table.new(
      Table::Style::Default,
      'Header'     => type,
      'Prefix'     => "\n",
      'Postfix'    => "\n",
      'SearchTerm' => row_filter,
      'Columns' => [
        '#',
        'Name',
        'Disclosure Date',
        'Rank',
        'Check',
        'Description'
      ],
      'ColProps' => {
        'Rank' => {
          'Formatters' => [Msf::Ui::Console::TablePrint::RankFormatter.new],
          'Stylers' => [Msf::Ui::Console::TablePrint::RankStyler.new]
        },
        'Name' => {
          'Stylers' => [Msf::Ui::Console::TablePrint::HighlightSubstringStyler.new(search_terms)]
        },
        'Description' => {
          'Stylers' => [Msf::Ui::Console::TablePrint::HighlightSubstringStyler.new(search_terms)]
        }
      }
    )
end

#name ⇒ Object

Returns the name of the command dispatcher.


68
69
70
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 68

def name
  "Module"
end

#show_actions(mod) ⇒ Object

:nodoc:


1161
1162
1163
1164
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1161

def show_actions(mod) # :nodoc:
  mod_actions = Serializer::ReadableText.dump_module_actions(mod, '   ')
  print("\n#{mod.type.capitalize} actions:\n\n#{mod_actions}\n") if (mod_actions and mod_actions.length > 0)
end

#show_advanced_options(mod) ⇒ Object

:nodoc:


1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1166

def show_advanced_options(mod) # :nodoc:
  mod_opt = Serializer::ReadableText.dump_advanced_options(mod, '   ')
  print("\nModule advanced options (#{mod.fullname}):\n\n#{mod_opt}\n") if (mod_opt and mod_opt.length > 0)

  # If it's an exploit and a payload is defined, create it and
  # display the payload's options
  if (mod.exploit? and mod.datastore['PAYLOAD'])
    p = framework.payloads.create(mod.datastore['PAYLOAD'])

    if (!p)
      print_error("Invalid payload defined: #{mod.datastore['PAYLOAD']}\n")
      return
    end

    p.share_datastore(mod.datastore)

    if (p)
      p_opt = Serializer::ReadableText.dump_advanced_options(p, '   ')
      print("\nPayload advanced options (#{mod.datastore['PAYLOAD']}):\n\n#{p_opt}\n") if (p_opt and p_opt.length > 0)
    end
  end
end

#show_auxiliary(regex = nil, minrank = nil, opts = nil) ⇒ Object

:nodoc:


1091
1092
1093
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1091

def show_auxiliary(regex = nil, minrank = nil, opts = nil) # :nodoc:
  show_module_set("Auxiliary", framework.auxiliary, regex, minrank, opts)
end

#show_encoders(regex = nil, minrank = nil, opts = nil) ⇒ Object

Module list enumeration


1061
1062
1063
1064
1065
1066
1067
1068
1069
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1061

def show_encoders(regex = nil, minrank = nil, opts = nil) # :nodoc:
  # If an active module has been selected and it's an exploit, get the
  # list of compatible encoders and display them
  if (active_module and active_module.exploit? == true)
    show_module_set("Compatible Encoders", active_module.compatible_encoders, regex, minrank, opts)
  else
    show_module_set("Encoders", framework.encoders, regex, minrank, opts)
  end
end

#show_evasion(regex = nil, minrank = nil, opts = nil) ⇒ Object

:nodoc:


1122
1123
1124
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1122

def show_evasion(regex = nil, minrank = nil, opts = nil) # :nodoc:
  show_module_set('evasion', framework.evasion, regex, minrank, opts)
end

#show_evasion_options(mod) ⇒ Object

:nodoc:


1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1189

def show_evasion_options(mod) # :nodoc:
  mod_opt = Serializer::ReadableText.dump_evasion_options(mod, '   ')
  print("\nModule evasion options:\n\n#{mod_opt}\n") if (mod_opt and mod_opt.length > 0)

  # If it's an exploit and a payload is defined, create it and
  # display the payload's options
  if (mod.evasion? and mod.datastore['PAYLOAD'])
    p = framework.payloads.create(mod.datastore['PAYLOAD'])

    if (!p)
      print_error("Invalid payload defined: #{mod.datastore['PAYLOAD']}\n")
      return
    end

    p.share_datastore(mod.datastore)

    if (p)
      p_opt = Serializer::ReadableText.dump_evasion_options(p, '   ')
      print("\nPayload evasion options (#{mod.datastore['PAYLOAD']}):\n\n#{p_opt}\n") if (p_opt and p_opt.length > 0)
    end
  end
end

#show_exploits(regex = nil, minrank = nil, opts = nil) ⇒ Object

:nodoc:


1075
1076
1077
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1075

def show_exploits(regex = nil, minrank = nil, opts = nil) # :nodoc:
  show_module_set("Exploits", framework.exploits, regex, minrank, opts)
end

#show_global_options ⇒ Object 


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1126

def show_global_options
  columns = [ 'Option', 'Current Setting', 'Description' ]
  tbl = Table.new(
    Table::Style::Default,
    'Header'  => 'Global Options:',
    'Prefix'  => "\n",
    'Postfix' => "\n",
    'Columns' => columns
  )
  [
    [ 'ConsoleLogging', framework.datastore['ConsoleLogging'] || "false", 'Log all console input and output' ],
    [ 'LogLevel', framework.datastore['LogLevel'] || "0", 'Verbosity of logs (default 0, max 3)' ],
    [ 'MinimumRank', framework.datastore['MinimumRank'] || "0", 'The minimum rank of exploits that will run without explicit confirmation' ],
    [ 'SessionLogging', framework.datastore['SessionLogging'] || "false", 'Log all input and output for sessions' ],
    [ 'TimestampOutput', framework.datastore['TimestampOutput'] || "false", 'Prefix all console output with a timestamp' ],
    [ 'Prompt', framework.datastore['Prompt'] || Msf::Ui::Console::Driver::DefaultPrompt.to_s.gsub(/%.../,"") , "The prompt string" ],
    [ 'PromptChar', framework.datastore['PromptChar'] || Msf::Ui::Console::Driver::DefaultPromptChar.to_s.gsub(/%.../,""), "The prompt character" ],
    [ 'PromptTimeFormat', framework.datastore['PromptTimeFormat'] || Time::DATE_FORMATS[:db].to_s, 'Format for timestamp escapes in prompts' ],
    [ 'MeterpreterPrompt', framework.datastore['MeterpreterPrompt'] || '%undmeterpreter%clr', 'The meterpreter prompt string' ],
  ].each { |r| tbl << r }

  print(tbl.to_s)
end

#show_missing(mod) ⇒ Object

:nodoc:


1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1099

def show_missing(mod) # :nodoc:
  mod_opt = Serializer::ReadableText.dump_options(mod, '   ', true)
  print("\nModule options (#{mod.fullname}):\n\n#{mod_opt}\n") if (mod_opt and mod_opt.length > 0)

  # If it's an exploit and a payload is defined, create it and
  # display the payload's options
  if (mod.exploit? and mod.datastore['PAYLOAD'])
    p = framework.payloads.create(mod.datastore['PAYLOAD'])

    if (!p)
      print_error("Invalid payload defined: #{mod.datastore['PAYLOAD']}\n")
      return
    end

    p.share_datastore(mod.datastore)

    if (p)
      p_opt = Serializer::ReadableText.dump_options(p, '   ', true)
      print("\nPayload options (#{mod.datastore['PAYLOAD']}):\n\n#{p_opt}\n") if (p_opt and p_opt.length > 0)
    end
  end
end

#show_module_set(type, module_set, regex = nil, minrank = nil, opts = nil) ⇒ Object

:nodoc:


1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1231

def show_module_set(type, module_set, regex = nil, minrank = nil, opts = nil) # :nodoc:
  count = -1

  tbl = generate_module_table(type)

  module_set.sort.each { |refname, mod|
    o = nil

    begin
      o = mod.new
    rescue ::Exception
    end
    next if not o

    # handle a search string, search deep
    if (
    not regex or
      o.name.match(regex) or
      o.description.match(regex) or
      o.refname.match(regex) or
      o.references.map{|x| [x.ctx_id + '-' + x.ctx_val, x.to_s]}.join(' ').match(regex) or
      o.author.to_s.match(regex)
    )
      if (not minrank or minrank <= o.rank)
        show = true
        if opts
          mod_opt_keys = o.options.keys.map { |x| x.downcase }

          opts.each do |opt,val|
            if !mod_opt_keys.include?(opt.downcase) || (val != nil && o.datastore[opt] != val)
              show = false
            end
          end
        end
        if (opts == nil or show == true)
          tbl << [
            count += 1,
            refname,
            o.disclosure_date.nil? ? "" : o.disclosure_date.strftime("%Y-%m-%d"),
            o.rank_to_s,
            o.has_check? ? 'Yes' : 'No',
            o.name
          ]
        end
      end
    end
  }

  print(tbl.to_s)
end

#show_nops(regex = nil, minrank = nil, opts = nil) ⇒ Object

:nodoc:


1071
1072
1073
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1071

def show_nops(regex = nil, minrank = nil, opts = nil) # :nodoc:
  show_module_set("NOP Generators", framework.nops, regex, minrank, opts)
end

#show_payloads(regex = nil, minrank = nil, opts = nil) ⇒ Object

:nodoc:


1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1079

def show_payloads(regex = nil, minrank = nil, opts = nil) # :nodoc:
  # If an active module has been selected and it's an exploit, get the
  # list of compatible payloads and display them
  if active_module && (active_module.exploit? || active_module.evasion?)
    @@payload_show_results = active_module.compatible_payloads

    show_module_set('Compatible Payloads', @@payload_show_results, regex, minrank, opts)
  else
    show_module_set('Payloads', framework.payloads, regex, minrank, opts)
  end
end

#show_plugins ⇒ Object

:nodoc:


1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1212

def show_plugins # :nodoc:
  tbl = Table.new(
    Table::Style::Default,
    'Header'  => 'Loaded Plugins',
    'Prefix'  => "\n",
    'Postfix' => "\n",
    'Columns' => [ 'Name', 'Description' ]
  )

  framework.plugins.each { |plugin|
    tbl << [ plugin.name, plugin.desc ]
  }

  # create an instance of core to call the list_plugins
  core = Msf::Ui::Console::CommandDispatcher::Core.new(driver)
  core.list_plugins
  print(tbl.to_s)
end

#show_post(regex = nil, minrank = nil, opts = nil) ⇒ Object

:nodoc:


1095
1096
1097
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1095

def show_post(regex = nil, minrank = nil, opts = nil) # :nodoc:
  show_module_set("Post", framework.post, regex, minrank, opts)
end

#show_targets(mod) ⇒ Object

:nodoc:


1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1150

def show_targets(mod) # :nodoc:
  case mod
  when Msf::Exploit
    mod_targs = Serializer::ReadableText.dump_exploit_targets(mod, '   ')
    print("\nExploit targets:\n\n#{mod_targs}\n") if (mod_targs and mod_targs.length > 0)
  when Msf::Evasion
    mod_targs = Serializer::ReadableText.dump_evasion_targets(mod, '   ')
    print("\nEvasion targets:\n\n#{mod_targs}\n") if (mod_targs and mod_targs.length > 0)
  end
end

#tab_complete_module(str, words) ⇒ Object

Tab complete module names


968
969
970
971
972
973
974
975
976
977
978
979
 
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 968

def tab_complete_module(str, words)
  res = []
  framework.modules.module_types.each do |mtyp|
    mset = framework.modules.module_names(mtyp)
    mset.each do |mref|
      res << mtyp + '/' + mref
    end
  end

  return dangerzone_modules_to_codenames(res.sort) if dangerzone_active?
  return res.sort
end