Fill out steam module metadata

Author: jhart-r7

modules/auxiliary/scanner/steam/server_info.rb

@@ -13,61 +13,31 @@ def initialize(info = {})
     super(
       update_info(
         info,
-        # TODO: fill in all of this
-        'Name'           => 'UDP Scanner Example',
+        'Name'           => 'Gather Steam Server Information',
         'Description'    => %q(
-          This module is an example of how to send probes to UDP services
-          en-masse, analyze any responses, and then report on any discovered
-          hosts, services, vulnerabilities or otherwise noteworthy things.
-          Simply address any of the TODOs.
+          This module uses the A2S_INFO request to obtain information from a Steam server.
         ),
-        'Author'         => 'Joe Contributor <joe_contributor[at]example.com>',
+        'Author'         => 'Jon Hart <jon_hart[at]rapid7.com',
         'References'     =>
           [
-            ['URL', 'https://example.com/~jcontributor']
+            # TODO: add more from https://developer.valvesoftware.com/wiki/Server_queries,
+            # perhaps in different modules
+            ['URL', 'https://developer.valvesoftware.com/wiki/Server_queries#A2S_INFO']
           ],
-        'DisclosureDate' => 'Mar 15 2014',
         'License'        => MSF_LICENSE
       )
     )
 
     register_options(
     [
-      # TODO: change to the port you need to scan
-      #Opt::RPORT(27015)
-      Opt::RPORT(4672)
+      Opt::RPORT(27015)
     ], self.class)
 
-    # TODO: add any advanced, special options here, otherwise remove
-    register_advanced_options(
-    [
-      OptBool.new('SPECIAL', [true, 'Try this special thing', false])
-    ], self.class)
-  end
-
-  def setup
-    super
-    # TODO: do any sort of preliminary sanity checking, like perhaps validating some options
-    # in the datastore, etc.
   end
 
   # TODO: construct the appropriate probe here.
   def build_probe
-    #@probe ||= "\xFF\xFF\xFF\xFFTSource Engine Query\x00"
-    @probe ||= "\xe4\x01"
-  end
-
-  # TODO: this is called before the scan block for each batch of hosts.  Do any
-  # per-batch setup here, otherwise remove it.
-  def scanner_prescan(batch)
-    super
-  end
-
-  # TODO: this is called for each IP in the batch.  This will send all of the
-  # necessary probes.  If something different must be done for each IP, do it
-  # here, otherwise remove it.
-  def scan_host(ip)
-    super
+    @probe ||= "\xFF\xFF\xFF\xFFTSource Engine Query\x00"
   end
 
   # Called for each response packet
@@ -77,45 +47,19 @@ def scanner_process(response, src_host, _src_port)
     puts "Got something from #{src_host}"
     #puts response.unpack("NCCZ*Z*Z*Z*SCCCCCCCZ*C")
 
-    # TODO: store something about this response, perhaps the response itself,
-    # some metadata obtained by analyzing it, the proof that it is vulnerable
-    # to something, etc.  In this example, we simply look for any response
-    # with a sequence of 5 useful ASCII characters and, iff found, we store
-    # that sequence
-    /(?<relevant>[\x20-\x7E]{5})/ =~ response && @results[src_host] << relevant
   end
 
   # Called after the scan block
   def scanner_postscan(_batch)
-    @results.each_pair do |host, relevant_responses|
-      peer = "#{host}:#{rport}"
-
-      # report on the host
+    @results.each_pair do |host, info|
       report_host(host: host)
-
-      # report on the service, since it responded
       report_service(
         host: host,
         proto: 'udp',
         port: rport,
-        name: 'example',
-        # show at most 4 relevant responses
-        info: relevant_responses[0, 4].join(',')
+        name: 'Steam',
+        info: info
       )
-
-      if relevant_responses.empty?
-        vprint_status("#{peer} Not vulnerable to something")
-      else
-        print_good("#{peer} Vulnerable to something!")
-        report_vuln(
-          host: host,
-          port: rport,
-          proto: 'udp',
-          name: 'something!',
-          info: "Got #{relevant_responses.size} response(s)",
-          refs: references
-        )
-      end
     end
   end
 end