Show session/rhost options separate from each other

Author: dwelch-r7

lib/msf/base/serializer/readable_text.rb

@@ -569,53 +569,19 @@ def self.dump_generic_module(mod, indent = '')
   # @param missing [Boolean] dump only empty required options.
   # @return [String] the string form of the information.
   def self.dump_options(mod, indent = '', missing = false)
-    options = mod.options.map { |_name, option| option }
-    options_grouped_by_conditions = options.group_by(&:conditions)
+    all_options = mod.options.map { |_name, option| option }
+
+    # separate mutually exclusive options from conditional options to format them differently
+    mutually_exclusive_options, conditional_options = all_options.partition { |option| option.mutual_exclusions.any? }
+    options_grouped_by_conditions = conditional_options.group_by(&:conditions)
+    options_grouped_by_mutual_exclusivity = mutually_exclusive_options.group_by(&:mutual_exclusions)
 
     options_with_conditions = ''.dup
     options_without_conditions = ''.dup
+    options_with_mutual_exclusivity = ''.dup
 
     options_grouped_by_conditions.each do |conditions, options|
-      tbl = Rex::Text::Table.new(
-        'Indent' => indent.length,
-        'Columns' =>
-          [
-            'Name',
-            'Current Setting',
-            'Required',
-            'Description'
-          ])
-
-      options.sort_by(&:name).each do |opt|
-        name = opt.name
-        if mod.datastore.is_a?(Msf::DataStoreWithFallbacks)
-          val = mod.datastore[name]
-        else
-          val = mod.datastore[name].nil? ? opt.default : mod.datastore[name]
-        end
-
-        next if (opt.advanced?)
-        next if (opt.evasion?)
-        next if (missing && opt.valid?(val))
-
-        desc = opt.desc.dup
-
-        # Hint at RPORT proto by regexing mixins
-        if name == 'RPORT' && opt.kind_of?(Msf::OptPort)
-          mod.class.included_modules.each do |m|
-            case m.name
-            when /tcp/i, /HttpClient$/
-              desc << ' (TCP)'
-              break
-            when /udp/i
-              desc << ' (UDP)'
-              break
-            end
-          end
-        end
-
-        tbl << [ name, opt.display_value(val), opt.required? ? "yes" : "no", desc ]
-      end
+      tbl = options_table(missing, mod, options, indent)
 
       next if conditions.any? && tbl.rows.empty?
 
@@ -627,10 +593,59 @@ def self.dump_options(mod, indent = '', missing = false)
       end
     end
 
-    result = "#{options_without_conditions}#{options_with_conditions}"
+    options_grouped_by_mutual_exclusivity.each do |mutual_exclusions, options|
+      tbl = options_table(missing, mod, options, indent)
+      options_with_mutual_exclusivity << "\n\n#{indent}When not using #{mutual_exclusions.join(', ')}:\n\n"
+      options_with_mutual_exclusivity << tbl.to_s
+    end
+
+    result = "#{options_without_conditions}#{options_with_conditions}#{options_with_mutual_exclusivity}"
     result
   end
 
+  def self.options_table(missing, mod, options, indent)
+    tbl = Rex::Text::Table.new(
+      'Indent' => indent.length,
+      'Columns' =>
+        [
+          'Name',
+          'Current Setting',
+          'Required',
+          'Description'
+        ])
+    options.sort_by(&:name).each do |opt|
+      # Skip over advanced or evasion options
+      next if (opt.advanced? || opt.evasion?)
+
+      name = opt.name
+      if mod.datastore.is_a?(Msf::DataStoreWithFallbacks)
+        val = mod.datastore[name]
+      else
+        val = mod.datastore[name].nil? ? opt.default : mod.datastore[name]
+      end
+      next if (missing && opt.valid?(val))
+
+      desc = opt.desc.dup
+
+      # Hint at RPORT proto by regexing mixins
+      if name == 'RPORT' && opt.kind_of?(Msf::OptPort)
+        mod.class.included_modules.each do |m|
+          case m.name
+          when /tcp/i, /HttpClient$/
+            desc << ' (TCP)'
+            break
+          when /udp/i
+            desc << ' (UDP)'
+            break
+          end
+        end
+      end
+
+      tbl << [name, opt.display_value(val), opt.required? ? "yes" : "no", desc]
+    end
+    tbl
+  end
+
   # Dumps the advanced options associated with the supplied module.
   #
   # @param mod [Msf::Module] the module.

lib/msf/core/opt.rb

@@ -44,8 +44,8 @@ def self.RHOSTS(default= nil, required=true, desc="The target host(s), see https
       Msf::OptRhosts.new('RHOSTS', [ required, desc, default ], aliases: [ 'RHOST' ])
     end
 
-    def self.RHOST(default=nil, required=true, desc="The target host(s), see https://docs.metasploit.com/docs/using-metasploit/basics/using-metasploit.html")
-      Msf::OptRhosts.new('RHOSTS', [ required, desc, default ], aliases: [ 'RHOST' ])
+    def self.RHOST(default=nil, required=true, desc="The target host(s), see https://docs.metasploit.com/docs/using-metasploit/basics/using-metasploit.html", **kwargs)
+      Msf::OptRhosts.new('RHOSTS', [ required, desc, default ], aliases: [ 'RHOST' ], **kwargs)
     end
 
     # @return [OptPort]

lib/msf/core/opt_base.rb

@@ -26,14 +26,15 @@ class OptBase
     #
     def initialize(in_name, attrs = [],
                    required: false, desc: nil, default: nil, conditions: [], enums: [], regex: nil, aliases: [], max_length: nil,
-                   fallbacks: [])
+                   fallbacks: [], mutual_exclusions: [])
       self.name     = in_name
       self.advanced = false
       self.evasion  = false
       self.aliases  = aliases
       self.max_length = max_length
       self.conditions = conditions
       self.fallbacks = fallbacks
+      self.mutual_exclusions = mutual_exclusions
 
       if attrs.is_a?(String) || attrs.length == 0
         self.required = required
@@ -230,6 +231,11 @@ def invalid_value_length?(value)
     #
     attr_accessor :max_length
 
+    #
+    # Array of options that are mutually exclusive with this one
+    #
+    attr_accessor :mutual_exclusions
+
     protected
 
     attr_writer   :required, :desc, :default # :nodoc:

lib/msf/core/opt_session.rb

@@ -0,0 +1,22 @@
+# -*- coding: binary -*-
+
+module Msf
+  ###
+  #
+  # Session option.
+  #
+  ###
+  class OptSession < OptInt
+    def type
+      'session'
+    end
+
+    def valid?(value, check_empty: false)
+      return false unless super
+
+      return true if @owner.framework.sessions.get(value)
+
+      false
+    end
+  end
+end

lib/msf/core/optional_session.rb

@@ -9,32 +9,43 @@ module Msf::OptionalSession
 
   def initialize(info = {})
     super
-    if framework.features.enabled?(Msf::FeatureManager::SMB_SESSION_TYPE)
+    if any_enabled?
       register_options(
         [
-          Msf::OptInt.new('SESSION', [ false, 'The session to run this module on' ]),
-          Msf::Opt::RHOST(nil, false),
+          Msf::OptSession.new('SESSION', [ false, 'The session to run this module on' ], mutual_exclusions: ['RHOST']),
+          Msf::Opt::RHOST(nil, false, mutual_exclusions: ['SESSION']),
           Msf::Opt::RPORT(nil, false)
         ]
       )
     end
 
-    if framework.features.enabled?(Msf::FeatureManager::POSTGRESQL_SESSION_TYPE)
+    if postgres_enabled?
       register_options(
         [
-          Msf::OptInt.new('SESSION', [ false, 'The session to run this module on' ]),
           Msf::OptString.new('DATABASE', [ false, 'The database to authenticate against', 'postgres']),
           Msf::OptString.new('USERNAME', [ false, 'The username to authenticate as', 'postgres']),
-          Msf::Opt::RHOST(nil, false),
-          Msf::Opt::RPORT(nil, false)
         ]
       )
     end
   end
 
   def session
-    return nil unless (framework.features.enabled?(Msf::FeatureManager::SMB_SESSION_TYPE) || framework.features.enabled?(Msf::FeatureManager::POSTGRESQL_SESSION_TYPE))
+    return nil unless any_enabled?
 
     super
   end
+
+  def any_enabled?
+    smb_enabled? || postgres_enabled?
+  end
+
+  private
+
+  def smb_enabled?
+    framework.features.enabled?(Msf::FeatureManager::SMB_SESSION_TYPE)
+  end
+
+  def postgres_enabled?
+    framework.features.enabled?(Msf::FeatureManager::POSTGRESQL_SESSION_TYPE)
+  end
 end

modules/auxiliary/scanner/smb/smb_enumshares.rb

@@ -47,7 +47,7 @@ def initialize(info = {})
 
     register_options(
       [
-        OptBool.new('SpiderShares', [false, 'Spider shares recursively', false]),
+        OptBool.new('SpiderShares', [false, 'Spider shares recursively', false], mutual_exclusions: ['SESSION']),
         OptBool.new('ShowFiles', [true, 'Show detailed information when spidering', false]),
         OptString.new('Share', [ false, 'Show only the specified share']),
         OptRegexp.new('HIGHLIGHT_NAME_PATTERN', [true, 'PCRE regex of resource names to highlight', 'username|password|user|pass|Groups.xml']),