Land rapid7#3752 - add "show missing"

Author: wchen-r7

lib/msf/base/serializer/readable_text.rb

@@ -311,8 +311,9 @@ def self.dump_generic_module(mod, indent = '')
   #
   # @param mod [Msf::Module] the module.
   # @param indent [String] the indentation to use.
+  # @param missing [Boolean] dump only empty required options.
   # @return [String] the string form of the information.
-  def self.dump_options(mod, indent = '')
+  def self.dump_options(mod, indent = '', missing = false)
     tbl = Rex::Ui::Text::Table.new(
       'Indent'  => indent.length,
       'Columns' =>
@@ -325,13 +326,13 @@ def self.dump_options(mod, indent = '')
 
     mod.options.sorted.each { |entry|
       name, opt = entry
+      val = mod.datastore[name] || opt.default
 
       next if (opt.advanced?)
       next if (opt.evasion?)
+      next if (missing && opt.valid?(val))
 
-      val_display = opt.display_value(mod.datastore[name] || opt.default)
-
-      tbl << [ name, val_display, opt.required? ? "yes" : "no", opt.desc ]
+      tbl << [ name, opt.display_value(val), opt.required? ? "yes" : "no", opt.desc ]
     }
 
     return tbl.to_s

lib/msf/ui/console/command_dispatcher/core.rb

@@ -2070,7 +2070,7 @@ def cmd_show_help
     global_opts = %w{all encoders nops exploits payloads auxiliary plugins options}
     print_status("Valid parameters for the \"show\" command are: #{global_opts.join(", ")}")
 
-    module_opts = %w{ advanced evasion targets actions }
+    module_opts = %w{ missing advanced evasion targets actions }
     print_status("Additional module-specific parameters are: #{module_opts.join(", ")}")
   end
 
@@ -2113,6 +2113,12 @@ def cmd_show(*args)
           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)
@@ -2167,7 +2173,7 @@ def cmd_show_tabs(str, words)
 
     res = %w{all encoders nops exploits payloads auxiliary post plugins options}
     if (active_module)
-      res.concat(%w{ advanced evasion targets actions })
+      res.concat(%w{ missing advanced evasion targets actions })
       if (active_module.respond_to? :compatible_sessions)
         res << "sessions"
       end
@@ -3144,6 +3150,29 @@ def show_options(mod) # :nodoc:
     #print("\nTarget: #{mod.target.name}\n\n")
   end
 
+  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
+
   def show_global_options
     columns = [ 'Option', 'Current Setting', 'Description' ]
     tbl = Table.new(

msfcli

@@ -44,6 +44,7 @@ class Msfcli
     tbl << ['(H)elp',        "You're looking at it baby!"]
     tbl << ['(S)ummary',     'Show information about this module']
     tbl << ['(O)ptions',     'Show available options for this module']
+    tbl << ['(M)issing',     'Show empty required options for this module']
     tbl << ['(A)dvanced',    'Show available advanced options for this module']
     tbl << ['(I)DS Evasion', 'Show available ids evasion options for this module']
     tbl << ['(P)ayloads',    'Show available payloads for this module']
@@ -385,6 +386,15 @@ class Msfcli
   end
 
 
+  def show_missing(m)
+    readable = Msf::Serializer::ReadableText
+    $stdout.puts("\n" + readable.dump_options(m[:module], @indent, true))
+    $stdout.puts("\nPayload:\n\n" + readable.dump_options(m[:payload], @indent, true)) if m[:payload]
+    $stdout.puts("\nEncoder:\n\n" + readable.dump_options(m[:encoder], @indent, true)) if m[:encoder]
+    $stdout.puts("\nNOP\n\n" + readable.dump_options(m[:nop], @indent, true))          if m[:nop]
+  end
+
+
   def show_advanced(m)
     readable = Msf::Serializer::ReadableText
     $stdout.puts("\n" + readable.dump_advanced_options(m[:module], @indent))
@@ -483,6 +493,8 @@ class Msfcli
       show_summary(modules)
     when "o"
       show_options(modules)
+    when "m"
+      show_missing(modules)
     when "a"
       show_advanced(modules)
     when "i"