Class: Msf::Ui::Console::CommandDispatcher::Modules
- Inherits:
-
Object
- Object
- Msf::Ui::Console::CommandDispatcher::Modules
- 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', '--help'] => [false, 'Help banner'], ['-I', '--ignore'] => [false, 'Ignore the command if the only match has the same name as the search'], ['-o', '--output'] => [true, 'Send output to a file in csv format', '<filename>'], ['-S', '--filter'] => [true, 'Regex pattern used to filter search results', '<filter>'], ['-u', '--use'] => [false, 'Use module if there is one result'], ['-s', '--sort-ascending'] => [true, 'Sort search results by the specified column in ascending order', '<column>'], ['-r', '--sort-descending'] => [true, 'Reverse the order of search results to descending order', '<column>'] )
- @@favorite_opts =
Rex::Parser::Arguments.new( '-h' => [false, 'Help banner'], '-c' => [false, 'Clear the contents of the favorite modules file'], '-d' => [false, 'Delete module(s) or the current active module from the favorite modules file'], '-l' => [false, 'Print the list of favorite modules (alias for `show favorites`)'] )
- @@favorites_opts =
Rex::Parser::Arguments.new( '-h' => [false, 'Help banner'] )
Instance Attribute Summary
Attributes included from Msf::Ui::Console::CommandDispatcher
Attributes included from Rex::Ui::Text::DispatcherShell::CommandDispatcher
Instance Method Summary collapse
-
#add_record(mod, count, compatible_mod) ⇒ Object
`show` command is run.
- #cmd_advanced(*args) ⇒ Object
- #cmd_advanced_help ⇒ Object
-
#cmd_advanced_tabs(str, words) ⇒ Object
Tab completion for the advanced command (same as use).
-
#cmd_back(*args) ⇒ Object
Pop the current dispatcher stack context, assuming it isn't pointed at the core or database backend stack context.
- #cmd_back_help ⇒ Object
- #cmd_clearm(*_args) ⇒ Object
- #cmd_clearm_help ⇒ Object
-
#cmd_favorite(*args) ⇒ Object
Add modules to or delete modules from the fav_modules file.
- #cmd_favorite_help ⇒ Object
-
#cmd_favorites(*args) ⇒ Object
Print the list of favorite modules from the fav_modules file (alias for `show favorites`).
- #cmd_favorites_help ⇒ Object
-
#cmd_info(*args) ⇒ Object
Displays information about one or more module.
- #cmd_info_help ⇒ Object
-
#cmd_info_tabs(str, words) ⇒ Object
Tab completion for the advanced command (same as use).
- #cmd_listm(*_args) ⇒ Object
- #cmd_listm_help ⇒ Object
-
#cmd_loadpath(*args) ⇒ Object
Adds one or more search paths.
- #cmd_loadpath_help ⇒ Object
-
#cmd_loadpath_tabs(str, words) ⇒ Object
Tab completion for the loadpath command.
- #cmd_options(*args) ⇒ Object
- #cmd_options_help ⇒ Object
-
#cmd_options_tabs(str, words) ⇒ Object
Tab completion for the advanced command (same as use).
-
#cmd_popm(*args) ⇒ Object
Command to dequeque a module from the module stack.
-
#cmd_popm_help ⇒ Object
Help for the 'popm' command.
-
#cmd_previous(*args) ⇒ Object
Command to take to the previously active module.
-
#cmd_previous_help ⇒ Object
Help for the 'previous' command.
-
#cmd_pushm(*args) ⇒ Object
Command to enqueque a module on the module stack.
-
#cmd_pushm_help ⇒ Object
Help for the 'pushm' command.
-
#cmd_pushm_tabs(str, words) ⇒ Object
Tab completion for the pushm command.
-
#cmd_reload_all(*args) ⇒ Object
Reload all module paths that we are aware of.
- #cmd_reload_all_help ⇒ Object
-
#cmd_search(*args) ⇒ Object
Searches modules for specific keywords.
- #cmd_search_help ⇒ Object
-
#cmd_search_tabs(str, words) ⇒ Object
Tab completion for the search command.
-
#cmd_show(*args) ⇒ Object
Displays the list of modules based on their type, or all modules if no type is provided.
- #cmd_show_help ⇒ Object
-
#cmd_show_tabs(str, words) ⇒ Object
Tab completion for the show command.
-
#cmd_use(*args) ⇒ Object
Uses a module.
- #cmd_use_help ⇒ Object
-
#cmd_use_tabs(str, words) ⇒ Object
Tab completion for the use command.
- #commands ⇒ Object
-
#dangerzone_active? ⇒ Boolean
Determine if dangerzone mode is active via date or environment variable.
- #dangerzone_build_map ⇒ Object
-
#dangerzone_codename_to_module(args) ⇒ Object
Convert squirrel names back to regular module names.
- #dangerzone_codename_to_module_name(cname) ⇒ Object
- #dangerzone_module_name_to_codename(mname) ⇒ Object
-
#dangerzone_modules_to_codenames(names) ⇒ Object
Convert module names to squirrel names.
-
#favorite_add(modules, favs_file) ⇒ Object
Helper method for cmd_favorite that writes modules to the fav_modules_file.
-
#favorite_check_fav_modules(favs_file) ⇒ Object
Helper method for cmd_favorite that checks if the fav_modules file exists and is readable / writable.
-
#favorite_del(modules, delete_all, favs_file) ⇒ Object
Helper method for cmd_favorite that deletes modules from the fav_modules_file.
-
#generate_module_table(type, search_terms = [], row_filter = nil) ⇒ Object
:nodoc:.
-
#initialize(driver) ⇒ Modules
constructor
Initializes the datastore cache.
-
#name ⇒ Object
Returns the name of the command dispatcher.
- #print_april_fools_module_use ⇒ Object
- #print_module_info(mod, dump_json: false, show_doc: false) ⇒ Object
-
#print_module_search_results_usage ⇒ Object
Handles the index selection formatting.
-
#show_actions(mod) ⇒ Object
:nodoc:.
-
#show_advanced_options(mod) ⇒ Object
:nodoc:.
-
#show_auxiliary ⇒ Object
:nodoc:.
-
#show_encoders ⇒ Object
Module list enumeration.
-
#show_evasion ⇒ Object
:nodoc:.
-
#show_evasion_options(mod) ⇒ Object
:nodoc:.
-
#show_exploits ⇒ Object
:nodoc:.
-
#show_favorites ⇒ Object
:nodoc:.
- #show_global_options ⇒ Object
-
#show_missing(mod) ⇒ Object
:nodoc:.
-
#show_module_metadata(table_name, module_filter) ⇒ Object
or a Hash(show favorites) containing fullname `show` command is run.
-
#show_nops ⇒ Object
:nodoc:.
-
#show_payloads ⇒ Object
:nodoc:.
-
#show_plugins ⇒ Object
:nodoc:.
-
#show_post ⇒ Object
:nodoc:.
-
#show_targets(mod) ⇒ Object
:nodoc:.
-
#tab_complete_module(str, words) ⇒ Object
Tab complete module names.
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, #load_config, #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, included, #print, #print_error, #print_good, #print_line, #print_status, #print_warning, #tab_complete_directory, #tab_complete_filenames, #tab_complete_generic, #tab_complete_source_address, #unknown_command, #update_prompt
Constructor Details
#initialize(driver) ⇒ Modules
Initializes the datastore cache
64 65 66 67 68 69 70 71 72 73 74 75 76 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 64 def initialize(driver) super @dscache = {} @previous_module = nil @module_name_stack = [] # Array of individual modules that have been searched for @module_search_results = [] # Module search results, with additional metadata on what to do if the module is interacted with @module_search_results_with_usage_metadata = [] @@payload_show_results = [] @dangerzone_map = nil end |
Instance Method Details
#add_record(mod, count, compatible_mod) ⇒ Object
`show` command is run
Adds a record for a table, also handle logic for whether the module is currently handling compatible payloads/encoders
1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1757 def add_record(mod, count, compatible_mod) if compatible_mod check = mod.has_check? ? 'Yes' : 'No' else check = mod.check ? 'Yes' : 'No' end [ count, mod.fullname, mod.disclosure_date.nil? ? '' : mod.disclosure_date.strftime('%Y-%m-%d'), mod.rank, check, mod.name ] end |
#cmd_advanced(*args) ⇒ Object
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 93 def cmd_advanced(*args) if args.empty? if (active_module) (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 (mod) end } end |
#cmd_advanced_help ⇒ Object
85 86 87 88 89 90 91 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 85 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)
257 258 259 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 257 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.
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1115 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
1104 1105 1106 1107 1108 1109 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1104 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
1039 1040 1041 1042 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1039 def cmd_clearm(*_args) print_status('Clearing the module stack') @module_name_stack.clear end |
#cmd_clearm_help ⇒ Object
1032 1033 1034 1035 1036 1037 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1032 def cmd_clearm_help print_line 'Usage: clearm' print_line print_line 'Clear the module stack' print_line end |
#cmd_favorite(*args) ⇒ Object
Add modules to or delete modules from the fav_modules file
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 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1286 def cmd_favorite(*args) valid_custom_args = ['-c', '-d', '-l'] favs_file = Msf::Config.fav_modules_file # always display the help banner if -h is provided or if multiple options are provided if args.include?('-h') || args.select{ |arg| arg if valid_custom_args.include?(arg) }.length > 1 cmd_favorite_help return end # if no arguments were provided, check if there is an active module to add if args.empty? unless active_module print_error('No module has been provided to favorite.') cmd_favorite_help return end args = [active_module.fullname] favorite_add(args, favs_file) return end case args[0] when '-c' args.delete('-c') unless args.empty? print_error('Option `-c` does not support arguments.') cmd_favorite_help return end favorite_del(args, true, favs_file) when '-d' args.delete('-d') if args.empty? unless active_module print_error('No module has been provided to delete.') cmd_favorite_help return end args = [active_module.fullname] end favorite_del(args, false, favs_file) when '-l' args.delete('-l') unless args.empty? print_error('Option `-l` does not support arguments.') cmd_favorite_help return end cmd_show('favorites') else # no valid options, but there are arguments if args[0].start_with?('-') print_error('Invalid option provided') cmd_favorite_help return end favorite_add(args, favs_file) end end |
#cmd_favorite_help ⇒ Object
1137 1138 1139 1140 1141 1142 1143 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1137 def cmd_favorite_help print_line 'Usage: favorite [mod1 mod2 ...]' print_line print_line "Add one or multiple modules to the list of favorite modules stored in #{Msf::Config.fav_modules_file}" print_line 'If no module name is specified, the command will add the active module if there is one' print @@favorite_opts.usage end |
#cmd_favorites(*args) ⇒ Object
Print the list of favorite modules from the fav_modules file (alias for `show favorites`)
1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1362 def cmd_favorites(*args) if args.empty? cmd_show('favorites') return end # always display the help banner if the command is called with arguments unless args.include?('-h') print_error('Invalid option(s) provided') end cmd_favorites_help end |
#cmd_favorites_help ⇒ Object
1351 1352 1353 1354 1355 1356 1357 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1351 def cmd_favorites_help print_line 'Usage: favorites' print_line print_line 'Print the list of favorite modules (alias for `show favorites`)' print_line 'You can use the %grnfavorite%clr command to add the current module to your favorites list' print @@favorites_opts.usage end |
#cmd_info(*args) ⇒ Object
Displays information about one or more module.
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 162 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 print_module_info(active_module, dump_json: dump_json, show_doc: show_doc) return true else cmd_info_help return false end elsif args.include? '-h' cmd_info_help return false end args.each do |arg| mod_name = arg additional_datastore_values = nil # Use a module by search index index_from_list(@module_search_results_with_usage_metadata, mod_name) do |result| mod = result&.[](:mod) next unless mod && mod.respond_to?(:fullname) # Module cache object mod_name = mod.fullname additional_datastore_values = result[:datastore] end # Ensure we have a reference name and not a path name = trim_path(mod_name, 'modules') # Creates an instance of the module mod = framework.modules.create(name) # If any additional datastore values were provided, set these values mod.datastore.update(additional_datastore_values) unless additional_datastore_values.nil? if mod.nil? print_error("Invalid module: #{name}") else print_module_info(mod, dump_json: dump_json, show_doc: show_doc) end end end |
#cmd_info_help ⇒ Object
115 116 117 118 119 120 121 122 123 124 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 115 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)
267 268 269 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 267 def cmd_info_tabs(str, words) cmd_use_tabs(str, words) end |
#cmd_listm(*_args) ⇒ Object
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1019 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
1012 1013 1014 1015 1016 1017 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1012 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.
292 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 327 328 329 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 292 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.sort_by { |type, _count| type }.each { |type, count| added << " #{count} #{type} modules\n" } print(added) end |
#cmd_loadpath_help ⇒ Object
281 282 283 284 285 286 287 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 281 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
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 371 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 338 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
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 229 def (*args) if args.empty? if (active_module) (active_module) return true else return true end end args.each do |name| mod = framework.modules.create(name) if (mod == nil) print_error("Invalid module: #{name}") else (mod) end end end |
#cmd_options_help ⇒ Object
221 222 223 224 225 226 227 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 221 def 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)
277 278 279 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 277 def (str, words) cmd_use_tabs(str, words) end |
#cmd_popm(*args) ⇒ Object
Command to dequeque a module from the module stack
979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 979 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
1004 1005 1006 1007 1008 1009 1010 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1004 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
914 915 916 917 918 919 920 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 914 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
925 926 927 928 929 930 931 932 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 925 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
937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 937 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
969 970 971 972 973 974 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 969 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
962 963 964 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 962 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
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1068 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 wlog("WARNING! The following modules could not be loaded!") framework.modules.module_load_error_by_path.each do |path, _error| wlog("\t#{path}") end wlog(log_msg) end if framework.modules.module_load_warnings.length > 0 wlog("The following modules were loaded with warnings:") framework.modules.module_load_warnings.each do |path, _error| wlog("\t#{path}") end wlog(log_msg) end self.driver.run_single('reload') self.driver.run_single("banner") end |
#cmd_reload_all_help ⇒ Object
1057 1058 1059 1060 1061 1062 1063 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1057 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
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 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 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 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 436 def cmd_search(*args) match = '' row_filter = nil output_file = nil cached = false use = false count = -1 search_terms = [] sort_attribute = 'name' valid_sort_attributes = ['action', 'rank','disclosure_date','name','date','type','check'] reverse_sort = false 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 when '-s' sort_attribute = val when '-r' reverse_sort = true else match += val + ' ' end end if args.empty? if @module_search_results_with_usage_metadata.empty? cmd_search_help return false end cached = true end if sort_attribute && !valid_sort_attributes.include?(sort_attribute) print_error("Supported options for the -s flag are: #{valid_sort_attributes}") return false 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) @module_search_results.sort_by! do || if sort_attribute == 'action' .actions&.any? ? 0 : 1 elsif sort_attribute == 'check' .check ? 0 : 1 elsif sort_attribute == 'disclosure_date' || sort_attribute == 'date' # Not all modules have disclosure_date, i.e. multi/handler .disclosure_date || Time.utc(0) else .send(sort_attribute) end end if reverse_sort @module_search_results.reverse! end 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_with_usage_metadata = [] @module_search_results.each do |m| @module_search_results_with_usage_metadata << { mod: m } count += 1 tbl << [ count, "#{m.fullname}", m.disclosure_date.nil? ? '' : m.disclosure_date.strftime("%Y-%m-%d"), m.rank, m.check ? 'Yes' : 'No', m.name, ] if framework.features.enabled?(Msf::FeatureManager::HIERARCHICAL_SEARCH_TABLE) total_children_rows = (m.actions&.length || 0) + (m.targets&.length || 0) + (m.notes&.[]('AKA')&.length || 0) show_child_items = total_children_rows > 1 next unless show_child_items indent = " \\_ " # Note: We still use visual indicators for blank values as it's easier to read # We can't always use a generic formatter/styler, as it would be applied to the 'parent' rows too blank_value = '.' if (m.actions&.length || 0) > 1 m.actions.each do |action| @module_search_results_with_usage_metadata << { mod: m, datastore: { 'ACTION' => action['name'] } } count += 1 tbl << [ count, "#{indent}action: #{action['name']}", blank_value, blank_value, blank_value, action['description'], ] end end if (m.targets&.length || 0) > 1 m.targets.each do |target| @module_search_results_with_usage_metadata << { mod: m, datastore: { 'TARGET' => target } } count += 1 tbl << [ count, "#{indent}target: #{target}", blank_value, blank_value, blank_value, blank_value ] end end if (m.notes&.[]('AKA')&.length || 0) > 1 m.notes['AKA'].each do |aka| @module_search_results_with_usage_metadata << { mod: m } count += 1 tbl << [ count, "#{indent}AKA: #{aka}", blank_value, blank_value, blank_value, blank_value ] end end end 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) } return true end print_line(tbl.to_s) print_module_search_results_usage if @module_search_results.length == 1 && use used_module = @module_search_results_with_usage_metadata.first[:mod].fullname print_status("Using #{used_module}") if used_module cmd_use(used_module, true) end true end |
#cmd_search_help ⇒ Object
373 374 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 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 373 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 @@search_opts.usage print_line print_line "Keywords:" { 'adapter' => 'Modules with a matching adater reference name', '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', 'session_type' => 'Modules with a matching session type (SMB, MySQL, Meterpreter, etc)', 'stage' => 'Modules with a matching stage reference name', 'stager' => 'Modules with a matching stager reference name', 'target' => 'Modules affecting this target', 'type' => 'Modules of a specific type (exploit, payload, auxiliary, encoder, evasion, post, or nop)', 'action' => 'Modules with a matching action name or description', }.each_pair do |keyword, description| print_line " #{keyword.ljust 17}: #{description}" end print_line print_line "Supported search columns:" { 'rank' => 'Sort modules by their exploitability rank', 'date' => 'Sort modules by their disclosure date. Alias for disclosure_date', 'disclosure_date' => 'Sort modules by their disclosure date', 'name' => 'Sort modules by their name', 'type' => 'Sort modules by their type', 'check' => 'Sort modules by whether or not they have a check method', 'action' => 'Sort modules by whether or not they have actions', }.each_pair do |keyword, description| print_line " #{keyword.ljust 17}: #{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 " search cve:2009 -s name" print_line " search type:exploit -s type -r" 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
630 631 632 633 634 635 636 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 630 def cmd_search_tabs(str, words) if words.length == 1 return @@search_opts.option_keys end [] end |
#cmd_show(*args) ⇒ Object
Displays the list of modules based on their type, or all modules if no type is provided.
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 739 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 650 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 'favorites' show_favorites when 'info' cmd_info(*args[1, args.length]) when 'options' if (mod) (mod) else end when 'missing' if (mod) show_missing(mod) else print_error("No module selected.") end when 'advanced' if (mod) (mod) else print_error("No module selected.") end when 'evasion' if (mod) (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
638 639 640 641 642 643 644 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 638 def cmd_show_help global_opts = %w{all encoders nops exploits payloads auxiliary post plugins info options favorites} 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
748 749 750 751 752 753 754 755 756 757 758 759 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 748 def cmd_show_tabs(str, words) return [] if words.length > 1 res = %w{all encoders nops exploits payloads auxiliary post plugins options favorites} 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.
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 783 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] additional_datastore_values = nil # Use a module by search index index_from_list(@module_search_results_with_usage_metadata, mod_name) do |result| mod = result&.[](:mod) unless mod && mod.respond_to?(:fullname) print_error("Invalid module index: #{mod_name}") return false end # Module cache object from @module_search_results_with_usage_metadata mod_name = mod.fullname additional_datastore_values = result[:datastore] 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 # Checks to see if we have any load_errors for the current module. # and if so, returns them to the user. load_error = framework.modules.load_error_by_name(mod_name) if load_error print_error("Failed to load module: #{load_error}") return false end unless mod_resolved elog("Module #{mod_name} not found, and no loading errors found. If you're using a custom module" \ ' refer to our wiki: https://docs.metasploit.com/docs/using-metasploit/intermediate/running-private-modules.html') # 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', *args) 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 # If any additional datastore values were provided, set these values unless additional_datastore_values.nil? || additional_datastore_values.empty? mod.datastore.update(additional_datastore_values) print_status("Additionally setting #{additional_datastore_values.map { |k,v| "#{k} => #{v}" }.join(", ")}") if additional_datastore_values['TARGET'] && (mod.exploit? || mod.evasion?) mod.import_target_defaults end 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
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 761 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 print_april_fools_module_use 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 completed
1051 1052 1053 1054 1055 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1051 def cmd_use_tabs(str, words) return [] if words.length > 1 tab_complete_module(str, words) end |
#commands ⇒ Object
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 40 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", "favorite" => "Add module(s) to the list of favorite modules", "favorites" => "Print the list of favorite modules (alias for `show favorites`)" } end |
#dangerzone_active? ⇒ Boolean
Determine if dangerzone mode is active via date or environment variable
1416 1417 1418 1419 1420 1421 1422 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1416 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
1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1439 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
1406 1407 1408 1409 1410 1411 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1406 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
1431 1432 1433 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1431 def dangerzone_codename_to_module_name(cname) @dangerzone_map[cname] || cname end |
#dangerzone_module_name_to_codename(mname) ⇒ Object
1435 1436 1437 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1435 def dangerzone_module_name_to_codename(mname) @dangerzone_map[mname] || mname end |
#dangerzone_modules_to_codenames(names) ⇒ Object
Convert module names to squirrel names
1427 1428 1429 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1427 def dangerzone_modules_to_codenames(names) (names + @dangerzone_map.keys.grep(/^[A-Z]+/)).sort end |
#favorite_add(modules, favs_file) ⇒ Object
Helper method for cmd_favorite that writes modules to the fav_modules_file
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1148 def favorite_add(modules, favs_file) fav_limit = 50 # obtain useful info about the fav_modules file exists, writable, readable, contents = favorite_check_fav_modules(favs_file) # if the fav_modules file exists, check the file permissions if exists case when !writable print_error("Unable to save module(s) to the favorite modules file because it is not writable") return when !readable print_error("Unable to save module(s) to the favorite modules file because it is not readable") return end end fav_count = 0 if contents fav_count = contents.split.size end modules = modules.uniq # prevent modules from being added more than once modules.each do |name| mod = framework.modules.create(name) if (mod == nil) print_error("Invalid module: #{name}") next end if contents && contents.include?(mod.fullname) print_warning("Module #{mod.fullname} has already been favorited and will not be added to the favorite modules file") next end if fav_count >= fav_limit print_error("Favorite module limit (#{fav_limit}) exceeded. No more modules will be added.") return end File.open(favs_file, 'a+') { |file| file.puts(mod.fullname) } print_good("Added #{mod.fullname} to the favorite modules file") fav_count += 1 end return end |
#favorite_check_fav_modules(favs_file) ⇒ Object
Helper method for cmd_favorite that checks if the fav_modules file exists and is readable / writable
1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1261 def favorite_check_fav_modules(favs_file) exists = false writable = false readable = false contents = '' if File.exist?(favs_file) exists = true end if File.writable?(favs_file) writable = true end if File.readable?(favs_file) readable = true contents = File.read(favs_file) end return exists, writable, readable, contents end |
#favorite_del(modules, delete_all, favs_file) ⇒ Object
Helper method for cmd_favorite that deletes modules from the fav_modules_file
1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 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 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1198 def favorite_del(modules, delete_all, favs_file) # obtain useful info about the fav_modules file exists, writable, readable, contents = favorite_check_fav_modules(favs_file) if delete_all = 'clear the contents of' else = 'delete module(s) from' end case # error handling based on the existence / permissions of the fav_modules file when !exists print_warning("Unable to #{} the favorite modules file because it does not exist") return when !writable print_error("Unable to #{} the favorite modules file because it is not writable") return when !readable unless delete_all print_error("Unable to #{} the favorite modules file because it is not readable") return end when contents.empty? print_warning("Unable to #{} the favorite modules file because it is already empty") return end if delete_all File.write(favs_file, '') print_good("Favorite modules file cleared") return end modules = modules.uniq # prevent modules from being deleted more than once contents = contents.split modules.each do |name| mod = framework.modules.create(name) if (mod == nil) print_error("Invalid module: #{name}") next end unless contents.include?(mod.fullname) print_warning("Module #{mod.fullname} cannot be deleted because it is not in the favorite modules file") next end contents.delete(mod.fullname) print_status("Removing #{mod.fullname} from the favorite modules file") end # clear the contents of the fav_modules file if removing the module(s) makes it empty if contents.length == 0 File.write(favs_file, '') return end File.open(favs_file, 'w') { |file| file.puts(contents.join("\n")) } end |
#generate_module_table(type, search_terms = [], row_filter = nil) ⇒ Object
:nodoc:
1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1773 def generate_module_table(type, search_terms = [], row_filter = nil) # :nodoc: table_hierarchy_formatters = framework.features.enabled?(Msf::FeatureManager::HIERARCHICAL_SEARCH_TABLE) ? [Msf::Ui::Console::TablePrint::BlankFormatter.new] : [] Table.new( Table::Style::Default, 'Header' => type, 'Prefix' => "\n", 'Postfix' => "\n", 'SearchTerm' => row_filter, 'SortIndex' => -1, # For now, don't perform any word wrapping on the search table as it breaks the workflow of # copying module names in conjunction with the `use <paste-buffer>` command 'WordWrap' => false, 'Columns' => [ '#', 'Name', 'Disclosure Date', 'Rank', 'Check', 'Description' ], 'ColProps' => { 'Rank' => { 'Formatters' => [ *table_hierarchy_formatters, Msf::Ui::Console::TablePrint::RankFormatter.new ], 'Stylers' => [ Msf::Ui::Console::TablePrint::RankStyler.new ] }, 'Name' => { 'Strip' => false, 'Stylers' => [Msf::Ui::Console::TablePrint::HighlightSubstringStyler.new(search_terms)] }, 'Check' => { 'Formatters' => [ *table_hierarchy_formatters, ] }, 'Disclosure Date' => { 'Formatters' => [ *table_hierarchy_formatters, ] }, 'Description' => { 'Stylers' => [ Msf::Ui::Console::TablePrint::HighlightSubstringStyler.new(search_terms) ] } } ) end |
#name ⇒ Object
Returns the name of the command dispatcher.
81 82 83 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 81 def name "Module" end |
#print_april_fools_module_use ⇒ Object
1396 1397 1398 1399 1400 1401 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1396 def print_april_fools_module_use return unless ENV['APRILFOOLSMODULEUSE'] || Time.now.strftime("%m%d") == "0401" = Msf::Ui::Banner.readfile('help-using-a-module.txt') print_line("%grn#{}%clr") end |
#print_module_info(mod, dump_json: false, show_doc: false) ⇒ Object
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 126 def print_module_info(mod, dump_json: false, show_doc: false) if 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)) print("\nView the full module info with the #{Msf::Ui::Tip.highlight('info -d')} command.\n\n") end end |
#print_module_search_results_usage ⇒ Object
Handles the index selection formatting
144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 144 def print_module_search_results_usage = @module_search_results_with_usage_metadata.last index_usage = "use #{@module_search_results_with_usage_metadata.length - 1}" index_info = "info #{@module_search_results_with_usage_metadata.length - 1}" name_usage = "use #{[:mod].fullname}" = "" additional_usage_example = ([:datastore] || {}).first if framework.features.enabled?(Msf::FeatureManager::HIERARCHICAL_SEARCH_TABLE) && additional_usage_example key, value = additional_usage_example = "\nAfter interacting with a module you can manually set a #{key} with %grnset #{key} '#{value}'%clr" end print("Interact with a module by name or index. For example %grn#{index_info}%clr, %grn#{index_usage}%clr or %grn#{name_usage}%clr#{}\n\n") end |
#show_actions(mod) ⇒ Object
:nodoc:
1642 1643 1644 1645 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1642 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:
1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1647 def (mod) # :nodoc: mod_opt = Serializer::ReadableText.(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.(p, ' ') print("\nPayload advanced options (#{mod.datastore['PAYLOAD']}):\n\n#{p_opt}\n") if (p_opt and p_opt.length > 0) end end print("\nView the full module info with the #{Msf::Ui::Tip.highlight('info')}, or #{Msf::Ui::Tip.highlight('info -d')} command.\n\n") end |
#show_auxiliary ⇒ Object
:nodoc:
1514 1515 1516 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1514 def show_auxiliary # :nodoc: ('Auxiliary','auxiliary') end |
#show_encoders ⇒ Object
Module list enumeration
1483 1484 1485 1486 1487 1488 1489 1490 1491 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1483 def show_encoders # :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) ('Compatible Encoders', active_module.compatible_encoders) else ('Encoders', 'encoder') end end |
#show_evasion ⇒ Object
:nodoc:
1522 1523 1524 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1522 def show_evasion # :nodoc: ('Evasion','evasion') end |
#show_evasion_options(mod) ⇒ Object
:nodoc:
1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1671 def (mod) # :nodoc: mod_opt = Serializer::ReadableText.(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.(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 ⇒ Object
:nodoc:
1497 1498 1499 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1497 def show_exploits # :nodoc: ('Exploits', 'exploit') end |
#show_favorites ⇒ Object
:nodoc:
1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1526 def show_favorites # :nodoc: favs_file = Msf::Config.fav_modules_file unless File.exist?(favs_file) print_error("The favorite modules file does not exist") return end if File.zero?(favs_file) print_warning("The favorite modules file is empty") return end unless File.readable?(favs_file) print_error("Unable to read from #{favs_file}") return end # create module set using the saved modules fav_modules = {} # get the full module names from the favorites file and use then to search the MetaData Cache for matching modules saved_favs = File.readlines(favs_file).map(&:strip) saved_favs.each do |mod| # populate hash with module fullname and module object fav_modules[mod] = framework.modules[mod] end fav_modules.each do |fullname, mod_obj| if mod_obj.nil? print_warning("#{favs_file} contains a module that can not be found - #{fullname}.") end end # find cache module instance and add it to @module_search_results @module_search_results = Msf::Modules::Metadata::Cache.instance.find('fullname' => [saved_favs, []]) # This scenario is for when a module fullname is a substring of other module fullnames # Example, searching for the payload/windows/meterpreter/reverse_tcp module can result in matches for: # - windows/meterpreter/reverse_tcp_allports # - windows/meterpreter/reverse_tcp_dns # So if @module_search_results is greater than the amount of fav_modules, we need to filter the results to be more accurate if fav_modules.length < @module_search_results.length filtered_results = [] fav_modules.each do |fullname, _mod_obj| filtered_results << @module_search_results.select do |search_result| search_result.fullname == fullname end end @module_search_results = filtered_results.flatten.sort_by(&:fullname) end @module_search_results_with_usage_metadata = @module_search_results.map { |mod| { mod: mod, datastore: {} } } ('Favorites', fav_modules) print_module_search_results_usage end |
#show_global_options ⇒ Object
1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1606 def 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' ], [ 'SessionTlvLogging', framework.datastore['SessionTlvLogging'] || "false", 'Log all incoming and outgoing TLV packets' ], [ '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:
1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1583 def show_missing(mod) # :nodoc: mod_opt = Serializer::ReadableText.(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.(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_metadata(table_name, module_filter) ⇒ Object
or a Hash(show favorites) containing fullname `show` command is run
Handles the filtering of modules that will be generated into a table
1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1720 def (table_name, module_filter) count = -1 tbl = generate_module_table(table_name) if module_filter.is_a?(Array) || module_filter.is_a?(Hash) module_filter.sort.each do |_mod_fullname, mod_obj| mod = nil begin mod = mod_obj.new rescue ::Exception end next unless mod count += 1 tbl << add_record(mod, count, true) end else results = Msf::Modules::Metadata::Cache.instance.find( 'type' => [[module_filter], []] ) # Loop over each module and gather data results.each do |mod, _value| count += 1 tbl << add_record(mod, count, false) end end print(tbl.to_s) end |
#show_nops ⇒ Object
:nodoc:
1493 1494 1495 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1493 def show_nops # :nodoc: ('NOP Generators', 'nop') end |
#show_payloads ⇒ Object
:nodoc:
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1501 def show_payloads # :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 ('Compatible Payloads', @@payload_show_results) else # show_module_set(‘Payloads’, framework.payloads, regex, minrank, opts) ('Payloads', 'payload') end end |
#show_plugins ⇒ Object
:nodoc:
1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1694 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 ⇒ Object
:nodoc:
1518 1519 1520 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1518 def show_post # :nodoc: ('Post','post') end |
#show_targets(mod) ⇒ Object
:nodoc:
1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1631 def show_targets(mod) # :nodoc: case mod when Msf::Exploit mod_targs = Serializer::ReadableText.dump_exploit_targets(mod, '', "\nExploit targets:") print("#{mod_targs}\n") if (mod_targs and mod_targs.length > 0) when Msf::Evasion mod_targs = Serializer::ReadableText.dump_evasion_targets(mod, '', "\nEvasion targets:") print("#{mod_targs}\n") if (mod_targs and mod_targs.length > 0) end end |
#tab_complete_module(str, words) ⇒ Object
Tab complete module names
1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 |
# File 'lib/msf/ui/console/command_dispatcher/modules.rb', line 1379 def tab_complete_module(str, words) res = [] = Msf::Modules::Metadata::Cache.instance. .each do |m| res << "#{m.type}/#{m.ref_name}" end 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.uniq.sort end |