Land #5059, @void-in's documentation clean up

lib/metasploit/framework/credential_collection.rb

@@ -79,7 +79,7 @@ def initialize(opts = {})
   # Adds a string as an addition private credential
   # to be combined in the collection.
   #
-  # @param [String] :private_str the string to use as a private
+  # @param [String] private_str the string to use as a private
   # @return [void]
   def add_private(private_str='')
     additional_privates << private_str
@@ -88,7 +88,7 @@ def add_private(private_str='')
   # Adds a string as an addition public credential
   # to be combined in the collection.
   #
-  # @param [String] :public_str the string to use as a public
+  # @param [String] public_str the string to use as a public
   # @return [void]
   def add_public(public_str='')
     additional_publics << public_str

lib/metasploit/framework/login_scanner/http.rb

@@ -189,13 +189,13 @@ def check_setup
 
         # Sends a HTTP request with Rex
         #
-        # @param [Hash] Native support includes the following (also see Rex::Proto::Http::Request#request_cgi)
-        # @option opts[String] 'host' The remote host
-        # @option opts[Fixnum] 'port' The remote port
-        # @option opts[Boolean] 'ssl' The SSL setting, TrueClass or FalseClass
-        # @option opts[String]  'proxies' The proxies setting
-        # @option opts[Credential] 'credential' A credential object
-        # @option opts['Hash'] 'context' A context
+        # @param [Hash] opts native support includes the following (also see Rex::Proto::Http::Request#request_cgi)
+        # @option opts [String] 'host' The remote host
+        # @option opts [Fixnum] 'port' The remote port
+        # @option opts [Boolean] 'ssl' The SSL setting, TrueClass or FalseClass
+        # @option opts [String]  'proxies' The proxies setting
+        # @option opts [Credential] 'credential' A credential object
+        # @option opts ['Hash'] 'context' A context
         # @raise [Rex::ConnectionError] One of these errors has occured: EOFError, Errno::ETIMEDOUT, Rex::ConnectionError, ::Timeout::Error
         # @return [Rex::Proto::Http::Response] The HTTP response
         # @return [NilClass] An error has occured while reading the response (see #Rex::Proto::Http::Client#read_response)
@@ -356,7 +356,7 @@ def set_sane_defaults
 
         # Combine the base URI with the target URI in a sane fashion
         #
-        # @param [String] The target URL
+        # @param [String] target_uri the target URL
         # @return [String] the final URL mapped against the base
         def normalize_uri(target_uri)
           (self.uri.to_s + "/" + target_uri.to_s).gsub(/\/+/, '/')

lib/metasploit/framework/login_scanner/symantec_web_gateway.rb

@@ -29,7 +29,7 @@ def check_setup
 
         # Returns the latest sid from Symantec Web Gateway.
         #
-        # @returns [String] The PHP Session ID for Symantec Web Gateway login
+        # @return [String] The PHP Session ID for Symantec Web Gateway login
         def get_last_sid
           @last_sid ||= lambda {
             # We don't have a session ID. Well, let's grab one right quick from the login page.

lib/msf/core/auxiliary/auth_brute.rb

@@ -108,9 +108,9 @@ def prepend_db_hashes(cred_collection)
   # This method takes a {Metasploit::Framework::CredentialCollection} and prepends existing SSHKeys
   # from the database. This allows the users to use the DB_ALL_CREDS option.
   #
-  # @param cred_collection [Metasploit::Framework::CredentialCollection]
+  # @param [Metasploit::Framework::CredentialCollection] cred_collection
   #    the credential collection to add to
-  # @return [Metasploit::Framework::CredentialCollection] the modified Credentialcollection
+  # @return [Metasploit::Framework::CredentialCollection] cred_collection the modified Credentialcollection
   def prepend_db_keys(cred_collection)
     if prepend_db_creds?
       each_ssh_cred do |cred|
@@ -140,8 +140,8 @@ def prepend_db_passwords(cred_collection)
   # {Metasploit::Framework::CredentialCollection} as dictated by the
   # selected datastore options.
   #
-  # @param [Metasploit::Framework::CredentialCollection] the credential collection to add to
-  # @param [Metasploit::Credential::Core] the Credential Core to process
+  # @param [Metasploit::Framework::CredentialCollection] cred_collection the credential collection to add to
+  # @param [Metasploit::Credential::Core] cred the credential to process
   def process_cred_for_collection(cred_collection, cred)
     msf_cred = cred.to_credential
     cred_collection.prepend_cred(msf_cred) if datastore['DB_ALL_CREDS']

lib/msf/core/auxiliary/jtr.rb

@@ -77,7 +77,7 @@ def new_john_cracker
   end
 
   # This method instantiates a {Metasploit::Framework::JtR::Wordlist}, writes the data
-  # out to a file and returns the {rex::quickfile} object.
+  # out to a file and returns the {Rex::Quickfile} object.
   #
   # @return [nilClass] if there is no active framework db connection
   # @return [Rex::Quickfile] if it successfully wrote the wordlist to a file

lib/msf/core/auxiliary/report.rb

@@ -113,13 +113,11 @@ def get_host(opts)
 
   #
   # Report a client connection
-  #
-  # opts must contain
-  #	:host      the address of the client connecting
-  #	:ua_string a string that uniquely identifies this client
-  # opts can contain
-  #	:ua_name a brief identifier for the client, e.g. "Firefox"
-  #	:ua_ver  the version number of the client, e.g. "3.0.11"
+  # @param opts [Hash] report client information based on user-agent
+  # @option opts [String] :host the address of the client connecting
+  # @option opts [String] :ua_string a string that uniquely identifies this client
+  # @option opts [String] :ua_name a brief identifier for the client, e.g. "Firefox"
+  # @option opts [String] :ua_ver  the version number of the client, e.g. "3.0.11"
   #
   def report_client(opts={})
     return if not db
@@ -161,7 +159,7 @@ def report_note(opts={})
   # by a module. This method is deprecated and the new Metasploit::Credential methods
   # should be used directly instead.
   #
-  # @param :opts [Hash] the option hash
+  # @param opts [Hash] the option hash
   # @option opts [String] :host the address of the host (also takes a {Mdm::Host})
   # @option opts [Fixnum] :port the port of the connected service
   # @option opts [Mdm::Service] :service an optional Service object to build the cred for

lib/msf/core/exploit/smb/client/psexec.rb

@@ -35,7 +35,7 @@ def initialize(info = {})
   # Retrieve the SERVICE_NAME option, generate a random
   # one if not already set.
   #
-  # @return service_name [String] the name of the service.
+  # @return [String] service_name the name of the service.
   def service_name
     @service_name ||= datastore['SERVICE_NAME']
     @service_name ||= Rex::Text.rand_text_alpha(8)
@@ -44,15 +44,15 @@ def service_name
   # Retrieve the SERVICE_DISPLAY_NAME option, generate a random
   # one if not already set.
   #
-  # @return service_display_name [String] the display name of the service.
+  # @return [String] the display name of the service.
   def display_name
     @display_name ||= datastore['SERVICE_DISPLAY_NAME']
     @display_name ||= Rex::Text.rand_text_alpha(16)
   end
 
   # Retrieve the SERVICE_DESCRIPTION option
   #
-  # @return service_description [String] the service description.
+  # @return [String] the service description.
   def service_description
     @service_description ||= datastore['SERVICE_DESCRIPTION']
   end

lib/msf/core/post/windows/mssql.rb

@@ -54,9 +54,9 @@ def check_for_sqlserver(instance = nil)
         end
 
         # Identifies a valid SQL Server command line client on the host and sets
-        # @sql_client
+        # sql_client
         #
-        # @see #sql_client
+        # @see sql_client
         # @return [String, nil] the SQL command line client
         def get_sql_client
           client = nil

lib/msf/core/post/windows/services.rb

@@ -528,7 +528,7 @@ def service_restart(name, start_type=START_TYPE_AUTO, server=nil)
   # Parses out a SERVICE_STATUS struct from the
   # lpServiceStatus out parameter
   #
-  # @param (lpServiceStatus)
+  # @param lpServiceStatus [String] the latest status of calling service
   #
   # @return [Hash] Containing SERVICE_STATUS values
   #

lib/msf/http/jboss/base.rb

@@ -49,7 +49,7 @@ def http_verb
 
   # Try to auto detect the target architecture and platform
   #
-  # @param [Array] The available targets
+  # @param [Array] available_targets The available targets
   # @return [Msf::Module::Target, nil] The detected target or nil
   def auto_target(available_targets)
     if http_verb == 'HEAD'

lib/msf/http/jboss/deployment_file_repository_scripts.rb

@@ -7,7 +7,7 @@ module Msf::HTTP::JBoss::DeploymentFileRepositoryScripts
   # to overcome the size limit in those requests
   #
   # @param stager_base [String] The name of the base of the stager.
-  # @param stager_jsp [String] The name name of the jsp stager.
+  # @param stager_jsp_name [String] The name name of the jsp stager.
   # @return [String] The JSP head stager.
   def head_stager_jsp(stager_base, stager_jsp_name)
     content_var = Rex::Text.rand_text_alpha(8+rand(8))

lib/msf/java/rmi/client.rb

@@ -111,7 +111,6 @@ def recv_return(opts = {})
         #
         # @param opts [Hash]
         # @option opts [Rex::Socket::Tcp] :sock
-        # @return [String]
         def safe_get_once(nsock = sock)
           data = ''
           begin

lib/msf/kerberos/client/cache_credential.rb

@@ -33,7 +33,7 @@ def create_cache(opts = {})
 
         # Builds a MIT Credential Cache principal
         #
-        # @param opts [Hash<{Symbol => <Fixnum, String, Array<String>}>]
+        # @param opts [Hash<{Symbol => <Fixnum, String, Array<String>>}>]
         # @option opts [Fixnum] :name_type
         # @option opts [String] :realm
         # @option opts [Array<String>] :components

lib/rex/proto/kerberos/client.rb

@@ -187,7 +187,7 @@ def recv_response_udp
 
         # Decodes a Kerberos response
         #
-        # @param input [String] the raw response message
+        # @param data [String] the raw response message
         # @return [<Rex::Proto::Kerberos::Model::KrbError, Rex::Proto::Kerberos::Model::KdcResponse>] the kerberos message response
         # @raise [RuntimeError] if the response can't be processed
         def decode_kerb_response(data)

modules/auxiliary/admin/2wire/xslt_password_reset.rb

@@ -52,15 +52,15 @@ def run
       return
     end
 
-    #check to see if we get HTTP OK
+    # check to see if we get HTTP OK
     if (res.code == 200)
       print_status("Okay, Got an HTTP 200 (okay) code. Verifying Server header")
     else
       print_error("Did not get HTTP 200, URL was not found. Exiting!")
       return
     end
 
-    #Check to verify server reported is a 2wire router
+    # Check to verify server reported is a 2wire router
     if (res.headers['Server'].match(/2wire Gateway/i))
       print_status("Server is a 2wire Gateway! Grabbing info\n")
     else
@@ -88,7 +88,7 @@ def run
       print_status("Hardware Version: #{hardware}")
     end
 
-    #Check the Software Version
+    # Check the Software Version
     if res.body.match(/<td class="data">(5\.\d{1,3}\.\d{1,3}\.\d{1,3})<\/td>/i)
       ver = $1
       print_status("Software version: #{ver}")

modules/auxiliary/admin/http/linksys_e1500_e2500_exec.rb

@@ -71,9 +71,9 @@ def run
     print_status("#{rhost}:#{rport} - Sending remote command: " + datastore['CMD'])
 
     cmd = datastore['CMD']
-    #original post request:
-    #data_cmd = "submit_button=Diagnostics&change_action=gozila_cgi&submit_type=start_ping&
-    #action=&commit=0&ping_ip=1.1.1.1&ping_size=%26#{cmd}%26&ping_times=5&traceroute_ip="
+    # original post request:
+    # data_cmd = "submit_button=Diagnostics&change_action=gozila_cgi&submit_type=start_ping&
+    # action=&commit=0&ping_ip=1.1.1.1&ping_size=%26#{cmd}%26&ping_times=5&traceroute_ip="
 
     vprint_status("#{rhost}:#{rport} - using the following target URL: #{uri}")
     begin

modules/auxiliary/admin/http/linksys_tmunblock_admin_reset_bof.rb

@@ -20,8 +20,8 @@ def initialize(info = {})
       },
       'Author'          =>
         [
-          'Craig Heffner',  #vulnerability discovery and original exploit
-          'Michael Messner <devnull[at]s3cur1ty.de>'  #metasploit module
+          'Craig Heffner',  # vulnerability discovery and original exploit
+          'Michael Messner <devnull[at]s3cur1ty.de>'  # metasploit module
         ],
       'License'         => MSF_LICENSE,
       'References'      =>

modules/auxiliary/admin/http/rails_devise_pass_reset.rb

@@ -130,7 +130,7 @@ def reset_one(password, report=false)
           return false
         end
       when 302
-        #Success!
+        # Success!
         return true
       else
         print_error("ERROR: received code #{res.code}")

modules/auxiliary/admin/http/typo3_winstaller_default_enc_keys.rb

@@ -100,20 +100,20 @@ def run
   else
     print_status("Rotating through known encryption keys")
     encryption_keys = [
-      #TYPO3 4.3.x - 4.4.x
+      # TYPO3 4.3.x - 4.4.x
       'd696ab49a803d7816021cb1768a6917d',
       '47d1e990583c9c67424d369f3414728e6793d9dc2ae3429d488a7374bc85d2a0b19b62de67d46a6079a75f10934288d3',
       '7b13b2203029ed80337f27127a9f1d28c2597f4c08c9a07b782b674731ecf5328c4d900851957899acdc6d4f911bf8b7',
-      #TYPO3 4.4.7+
+      # TYPO3 4.4.7+
       'fbbdebd9091d914b3cd523485afe7b03e6006ade4125e4cf4c46195b3cecbb9ae0fe0f7b5a9e72ea2ac5f17b66f5abc7',
-      #TYPO3 4.5.0
+      # TYPO3 4.5.0
       'def76f1d8139304b7edea83b5f40201088ba70b20feabd8b2a647c4e71774b7b0e4086e4039abaf5d4f6a521f922e8a2',
       'bac0112e14971f00431639342415ff22c3c3bf270f94175b8741c0fa95df244afb61e483c2facf63cffc320ed61f2731',
-      #TYPO3 4.5.2
+      # TYPO3 4.5.2
       '14b1225e2c277d55f54d18665791f114f4244f381113094e2a19dfb680335d842e10460995eb653d105a562a5415d9c7',
-      #TYPO3 4.5.3
+      # TYPO3 4.5.3
       '5d4eede80d5cec8df159fd869ec6d4041cd2fc0136896458735f8081d4df5c22bbb0665ddac56056023e01fbd4ab5283',
-      #TYPO3 4.5.4 - 4.5.7
+      # TYPO3 4.5.4 - 4.5.7
       'b2aae63def4c512ce8f4386e57b8a48b40312de30775535cbff60a6eab356809a0b596edaad49c725d9963d93aa2ffae',
       ]
   end

modules/auxiliary/admin/maxdb/maxdb_cons_exec.rb

@@ -37,7 +37,7 @@ def initialize(info = {})
   def run
     connect
 
-    #Grab the MaxDB info.
+    # Grab the MaxDB info.
     pdbmsrv =  "\x5A\x00\x00\x00\x03\x5B\x00\x00\x01\x00\x00\x00\xFF\xFF\xFF\xFF"
     pdbmsrv << "\x00\x00\x04\x00\x5A\x00\x00\x00\x00\x02\x42\x00\x04\x09\x00\x00"
     pdbmsrv << "\x00\x40\x00\x00\xD0\x3F\x00\x00\x00\x40\x00\x00\x70\x00\x00\x00"
@@ -60,7 +60,7 @@ def run
       print_status(info)
     end
 
-    #Send our command.
+    # Send our command.
     len = 39 + datastore['CMD'].length
 
     data =  len.chr + "\x00\x00\x00\x03\x3F\x00\x00\x01\x00\x00\x00\x54\x0D\x00\x00"

modules/auxiliary/admin/misc/sercomm_dump_config.rb

@@ -47,8 +47,8 @@ def initialize(info={})
       'License'        => MSF_LICENSE,
       'Author'         =>
         [
-          'Eloi Vanderbeken <eloi.vanderbeken[at]gmail.com>', #Initial discovery, poc
-          'Matt "hostess" Andreko <mandreko[at]accuvant.com>' #Msf module
+          'Eloi Vanderbeken <eloi.vanderbeken[at]gmail.com>', # Initial discovery, poc
+          'Matt "hostess" Andreko <mandreko[at]accuvant.com>' # Msf module
         ],
       'References'     =>
         [
@@ -174,7 +174,7 @@ def dump_configuration
 
     unless length == data.length
       vprint_warning("#{peer} - Inconsistent length / data packet")
-      #return nil
+      # return nil
     end
 
     return { :length => length, :data => data }