Round 3 of documentation

Author: wchen-r7

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

@@ -17,7 +17,7 @@ def initialize(*args)
 
   # Creates a new framework console.
   #
-  # @param [Hash] opts (Optional) See Msf::Ui::Web::Driver#create_console
+  # @param [Hash] opts See Msf::Ui::Web::Driver#create_console
   # @return [Hash] Information about the new console, such as:
   #  * 'id' [Fixnum] The console's ID.
   #  * 'prompt' [String] The framework prompt (example: 'msf > ')
@@ -38,7 +38,7 @@ def rpc_create(opts={})
   # Returns a list of framework consoles.
   #
   # @return [Hash] Console information.
-  #  * 'consoles' [Array] consoles, each element is another hash that includes:
+  #  * 'consoles' [Array<Hash>] consoles, each element is another hash that includes:
   #    * 'id' [Fixnum] The console's ID
   #    * 'prompt' [String] The framework prompt (example: 'msf > ')
   #    * 'busy' [TrueClass] The console's busy state, or
@@ -151,6 +151,8 @@ def rpc_tabs(cid, line)
   #  * 'result' [String] A value that says 'failure'.
   #  If the console ID is valid, you will get the following that indicates the action was successful.
   #  * 'result' [String] A value that says 'success'.
+  # @example Here's how you would use this from the client:
+  #  rpc.call('console.session_kill', 4)
   def rpc_session_kill(cid)
     cid = cid.to_s
     return { 'result' => 'failure' } if not @console_driver.consoles[cid]
@@ -164,10 +166,12 @@ def rpc_session_kill(cid)
   # @param [Fixnum] cid Framework console ID.
   # @return [Hash] There are two different hashes you might get:
   #
-  # If the console ID is invalid, you will get a hash like the following:
-  # * 'result' [String] A value that says 'failure'.
-  # If the console ID is valid, you will get the following that indicates the action was successful.
-  # * 'result' [String] A value that says 'success'.
+  #  If the console ID is invalid, you will get a hash like the following:
+  #  * 'result' [String] A value that says 'failure'.
+  #  If the console ID is valid, you will get the following that indicates the action was successful.
+  #  * 'result' [String] A value that says 'success'.
+  # @example Here's how you would use this from the client:
+  #  rpc.call('console.session_detach', 4)
   def rpc_session_detach(cid)
     cid = cid.to_s
     return { 'result' => 'failure' } if not @console_driver.consoles[cid]

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

@@ -7,7 +7,7 @@ class RPC_Module < RPC_Base
   # Returns a list of exploit names.
   #
   # @return [Hash] A list of exploit names.
-  #  * 'modules' [Array] Exploit names, for example: ['windows/wins/ms04_045_wins']
+  #  * 'modules' [Array<string>] Exploit names, for example: ['windows/wins/ms04_045_wins']
   # @example Here's how you would use this from the client:
   #  rpc.call('module.exploits')
   def rpc_exploits
@@ -18,7 +18,7 @@ def rpc_exploits
   # Returns a list of auxiliary module names.
   #
   # @return [Hash] A list of auxiliary module names.
-  #  * 'modules' [Array] Auxiliary module names, for example: ['vsploit/pii/web_pii']
+  #  * 'modules' [Array<string>] Auxiliary module names, for example: ['vsploit/pii/web_pii']
   # @example Here's how you would use this from the client:
   #  rpc.call('module.auxiliary')
   def rpc_auxiliary
@@ -29,7 +29,7 @@ def rpc_auxiliary
   # Returns a list of payload module names.
   #
   # @return [Hash] A list of payload module names.
-  #  * 'modules' [Array] Payload module names, for example: ['windows/x64/shell_reverse_tcp']
+  #  * 'modules' [Array<string>] Payload module names, for example: ['windows/x64/shell_reverse_tcp']
   # @example Here's how you would use this from the client:
   #  rpc.call('module.payloads')
   def rpc_payloads
@@ -40,7 +40,7 @@ def rpc_payloads
   # Returns a list of encoder module names.
   #
   # @return [Hash] A list of encoder module names.
-  #  * 'modules' [Array] Encoder module names, for example: ['x86/unicode_upper']
+  #  * 'modules' [Array<string>] Encoder module names, for example: ['x86/unicode_upper']
   # @example Here's how you would use this from the client:
   #  rpc.call('module.encoders')
   def rpc_encoders
@@ -51,7 +51,7 @@ def rpc_encoders
   # Returns a list of NOP module names.
   #
   # @return [Hash] A list of NOP module names.
-  #  * 'modules' [Array] NOP module names, for example: ['x86/single_byte']
+  #  * 'modules' [Array<string>] NOP module names, for example: ['x86/single_byte']
   # @example Here's how you would use this from the client:
   #  rpc.call('module.nops')
   def rpc_nops
@@ -62,7 +62,7 @@ def rpc_nops
   # Returns a list of post module names.
   #
   # @return [Hash] A list of post module names.
-  #  * 'modules' [Array] Post module names, for example: ['windows/wlan/wlan_profile']
+  #  * 'modules' [Array<string>] Post module names, for example: ['windows/wlan/wlan_profile']
   # @example Here's how you would use this from the client:
   #  rpc.call('module.post')
   def rpc_post
@@ -280,17 +280,18 @@ def rpc_encode_formats
   # @param [String] data Data to encode.
   # @param [encoder] encoder Encoder module name. For example: 'x86/single_byte'.
   # @param [Hash] options Encoding options, such as:
-  #  * 'format' [String] Encoding format.
-  #  * 'badchars' [String] Bad characters.
-  #  * 'platform' [String] Platform.
-  #  * 'arch' [String] Architecture.
-  #  * 'ecount' [Fixnum] Number of times to encode.
-  #  * 'inject' [TrueClass] To enable injection.
-  #  * 'template' [String] The template file (an executable).
-  #  * 'template_path' [String] Template path.
-  #  * 'addshellcode' [String] Custom shellcode.
-  # @raise [Msf::RPC::Exception] Invalid format (Error 500).
-  # @raise [Msf::RPC::Exception] Failure to encode (Error 500).
+  # @option options [String] 'format' Encoding format.
+  # @option options [String] 'badchars' Bad characters.
+  # @option options [String] 'platform' Platform.
+  # @option options [String] 'arch' Architecture.
+  # @option options [Fixnum] 'ecount' Number of times to encode.
+  # @option options [TrueClass] 'inject' To enable injection.
+  # @option options [String] 'template' The template file (an executable).
+  # @option options [String] 'template_path' Template path.
+  # @option options [String] 'addshellcode' Custom shellcode.
+  # @raise [Msf::RPC::Exception] Error could be one of these:
+  #                              * 500 Invalid format
+  #                              * 500 Failure to encode
   # @return The encoded data
   #  * 'encoded' [String] The encoded data in the format you specify.
   # @example Here's how you would use this from the client:

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

@@ -3,8 +3,19 @@ module Msf
 module RPC
 class RPC_Plugin < RPC_Base
 
+  # Loads a framework plugin.
+  #
+  # @param [String] path The plugin filename (without the extension). It will try to find your plugin
+  #                 in either one of these directories:
+  #                 * msf/plugins/
+  #                 * ~/.msf4/plugins/
+  # @param [Hash] xopts Options to pass to the plugin.
+  # @return [Hash] A hash indicating whether the action was successful or not.
+  #  * 'result' [String] A value that either says 'success' or 'failure'.
+  # @example Here's how you would use this from the client:
+  #  # Load the nexpose plugin
+  #  rpc.call('plugin.load', 'nexpose')
   def rpc_load(path, xopts = {})
-
     opts  = {}
 
     xopts.each do |k,v|
@@ -35,6 +46,14 @@ def rpc_load(path, xopts = {})
 
   end
 
+
+  # Unloads a framework 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.
+  #  * 'result' [String] A value that either says 'success' or 'failure'.
+  # @example Here's how you would use this from the client:
+  #  rpc.call('plugin.unload', 'nexpose')
   def rpc_unload(name)
     self.framework.plugins.each { |plugin|
       # Unload the plugin if it matches the name we're searching for
@@ -47,6 +66,13 @@ def rpc_unload(name)
 
   end
 
+
+  # Returns a list of plugins loaded by framework.
+  #
+  # @return [Hash] All the plugins loaded.
+  #  * 'plugins' [Array<string>] A list of plugin names.
+  # @example Here's how you would use this from the client:
+  #  rpc.call('plugin.loaded')
   def rpc_loaded
     ret = {}
     ret[:plugins] = []