minor RPC documentation tweaks

Author: Brent Cook

lib/msf/core/rpc/v10/client.rb

@@ -22,6 +22,7 @@ class Client
 
 
   # Initializes the RPC client to connect to: https://127.0.0.1:3790 (TLS1)
+  # The connection information is overridden through the optional info hash.
   #
   # @param [Hash] info Information needed for the initialization.
   # @option info [String] :token A token used by the client.

lib/msf/core/rpc/v10/rpc_auth.rb

@@ -80,8 +80,8 @@ def rpc_logout(token)
   end
 
 
-  # Returns a list of authentication tokens including the temporary ones, permanent, or the ones
-  # stored in the backend.
+  # Returns a list of authentication tokens, including the ones that are
+  # temporary, permanent, or stored in the backend.
   #
   # @return [Hash] A hash that contains a list of authentication tokens. It contains the following key:
   #  * 'tokens' [Array<string>] An array of tokens.
@@ -130,7 +130,8 @@ def rpc_token_add(token)
   end
 
 
-  # Generates a random 32-byte authentication token, and automatically saved to the database.
+  # Generates a random 32-byte authentication token. The token is added to the
+  # database as a side-effect.
   #
   # @return [Hash] A hash indicating the action was successful, also the new token.
   #  It contains the following keys:

lib/msf/core/rpc/v10/rpc_console.rb

@@ -143,7 +143,7 @@ def rpc_tabs(cid, line)
   end
 
 
-  # Kills a framework session that serves the same purpose as [CTRL]+[C] to abort an interactive session.
+  # Kills a framework session. This serves the same purpose as [CTRL]+[C] to abort an interactive session.
   # You might also want to considering using the session API calls instead of this.
   #
   # @param [Fixnum] cid Framework console ID.
@@ -159,7 +159,8 @@ def rpc_session_kill(cid)
   end
 
 
-  # Detaches a framework session that serves the same purpos as [CTRL]+[Z] to background an interactive session.
+  # Detaches a framework session. This serves the same purpose as [CTRL]+[Z] to
+  # background an interactive session.
   #
   # @param [Fixnum] cid Framework console ID.
   # @return [Hash] A hash indicating whether the action was successful or not. It contains:

lib/msf/core/rpc/v10/rpc_db.rb

@@ -1476,7 +1476,7 @@ def rpc_report_loot(xopts)
   end
 
 
-  # Returns all the looted data.
+  # Returns all the looted items.
   #
   # @param [Hash] xopts Filters that narrow down the search:
   # @option xopts [Hash] :workspace Workspace name.
@@ -1765,7 +1765,7 @@ def rpc_del_client(xopts)
   end
 
 
-  # Sets the driver for the database, or returns the current one.
+  # Sets the driver for the database or returns the current one.
   #
   # @param [Hash] xopts Options:
   # @option [String] :workspace Workspace name.

lib/msf/core/rpc/v10/rpc_module.rb

@@ -70,7 +70,7 @@ def rpc_post
   end
 
 
-  # Returns the metadata of the module.
+  # Returns the metadata for a module.
   #
   # @param [String] mtype Module type. Supported types include (case-sensitive):
   #                       * exploit
@@ -279,7 +279,7 @@ def rpc_encode_formats
   end
 
 
-  # Encoders data with an encoder.
+  # Encodes data with an encoder.
   #
   # @param [String] data Data to encode.
   # @param [encoder] encoder Encoder module name. For example: 'x86/single_byte'.

lib/msf/core/rpc/v10/rpc_plugin.rb

@@ -3,7 +3,7 @@ module Msf
 module RPC
 class RPC_Plugin < RPC_Base
 
-  # Loads a framework plugin.
+  # Loads a plugin.
   #
   # @param [String] path The plugin filename (without the extension). It will try to find your plugin
   #                 in either one of these directories:
@@ -48,7 +48,7 @@ def rpc_load(path, xopts = {})
   end
 
 
-  # Unloads a framework plugin.
+  # Unloads a plugin.
   #
   # @param [String] name The plugin filename (without the extension). For example: 'nexpose'.
   # @return [Hash] A hash indicating whether the action was successful or not.
@@ -69,7 +69,7 @@ def rpc_unload(name)
   end
 
 
-  # Returns a list of plugins loaded by framework.
+  # Returns a list of loaded plugins.
   #
   # @return [Hash] All the plugins loaded. It contains the following key:
   #                * 'plugins' [Array<string>] A list of plugin names.

lib/msf/core/rpc/v10/rpc_session.rb

@@ -157,7 +157,7 @@ def rpc_shell_upgrade( sid, lhost, lport)
   # @raise [Msf::RPC::Exception] An error that could be one of these:
   #                              * 500 Session ID is unknown.
   #                              * 500 Invalid session type.
-  # @return [Hash] It contains the following key: 
+  # @return [Hash] It contains the following key:
   #  * 'data' [String] Data read.
   # @example Here's how you would use this from the client:
   #  rpc.call('session.meterpreter_read', 2)
@@ -314,7 +314,7 @@ def rpc_meterpreter_session_detach(sid)
   end
 
 
-  # Kills a meterpreter session. Serves the same purpose as [CTRL]+[C]
+  # Kills a meterpreter session. Serves the same purpose as [CTRL]+[C].
   #
   # @param [Fixnum] sid Session ID.
   # @raise [Msf::RPC::Exception] An error that could be one of these:
@@ -365,7 +365,7 @@ def rpc_meterpreter_tabs(sid, line)
   #                              * 500 Session ID is unknown.
   #                              * 500 Invalid session type.
   # @return [Hash] A hash indicating the action was successful. It contains the following key:
-  #  * 'result' [String] 'success' 
+  #  * 'result' [String] 'success'
   # @example Here's how you would use this from the client:
   #  rpc.call('session.meterpreter_run_single', 3, 'getpid')
   def rpc_meterpreter_run_single( sid, data)
@@ -388,7 +388,7 @@ def rpc_meterpreter_run_single( sid, data)
   # @param [Fixnum] sid Session ID.
   # @param [String] data Meterpreter script name.
   # @return [Hash] A hash indicating the action was successful. It contains the following key:
-  #  * 'result' [String] 'success' 
+  #  * 'result' [String] 'success'
   # @example Here's how you would use this from the client:
   #  rpc.call('session.meterpreter_script', 3, 'checkvm')
   def rpc_meterpreter_script( sid, data)