Fix YARD documentation

Author: jvazquez-r7

lib/msf/http/jboss/base.rb

@@ -1,9 +1,12 @@
 # -*- coding: binary -*-
+
 module Msf::HTTP::JBoss::Base
-  # Call the specified uri to deploy the payload / stager
-  # @param opts [Hash] Hash of configuration options.
+
+  # Deploys a WAR through HTTP uri invoke
+  #
+  # @param opts [Hash] Hash containing {Exploit::Remote::HttpClient#send_request_cgi} options
   # @param num_attempts [Integer] The number of attempts 
-  # @return [ClientRequest] or nil 
+  # @return [Rex::Proto::Http::Response, nil] The {Rex::Proto::Http::Response} response if exists, nil otherwise
   def deploy(opts = {}, num_attempts = 5)
     uri = opts['uri']
 
@@ -36,6 +39,9 @@ def deploy(opts = {}, num_attempts = 5)
     end
   end
 
+  # Provides the HTTP verb used
+  #
+  # @return [String] The HTTP verb in use
   def http_verb
     datastore['VERB']
   end

lib/msf/http/jboss/bean_shell.rb

@@ -1,11 +1,13 @@
 # -*- coding: binary -*-
+
 module Msf::HTTP::JBoss::BeanShell
 
   DEFAULT_PACKAGES = %w{ deployer scripts }
 
-  # Try to deploy a BSH script using different packages
-  # @param [String] A BSH script
-  # @return [String] the package used to deploy the script or nil if it fails
+  # Deploys a Bean Shell script with a set of JBOSS default packages
+  #
+  # @param bsh_script [String] The Bean Shell script to deploy
+  # @return [String, nil] The package name used to deploy the script, nil otherwise
   def deploy_bsh(bsh_script)
     package = nil
 
@@ -24,10 +26,11 @@ def deploy_bsh(bsh_script)
     package
   end
 
-  # Try to deploy a BSH script using the specified package
-  # @param [String] A BSH script
-  # @param [String] The package used to deploy the script
-  # @return [Boolean] Wether the script get deployed or not
+  # Deploys a Bean Shell script using the specified package
+  #
+  # @param bsh_script [String] The Bean Shell script to deploy
+  # @param package [String] The package used to deploy the script
+  # @return [Boolean] `true` if the script gets deployed, `false` otherwise
   def deploy_package(bsh_script, package)
     success = false
 
@@ -50,18 +53,19 @@ def deploy_package(bsh_script, package)
     success
   end
 
-  # Invokes bsh_script on the JBoss AS via BSHDeployer
-  # @param [String] A BSH script
-  # @param [String] The package used to deploy the script
-  # @return [ClientRequest] 
+  # Invokes a Bean Shell script on the JBoss via BSHDeployer
+  #
+  # @param bsh_script [String] A Bean Shell script
+  # @param package [String] The package used to deploy the script
+  # @return [Rex::Proto::Http::Response, nil] The {Rex::Proto::Http::Response} response, nil if timeout
   def invoke_bsh_script(bsh_script, package)
     params =  { }
     params.compare_by_identity
     params['action']     = 'invokeOpByName'
     params['name']       = "jboss.#{package}:service=BSHDeployer"
     params['methodName'] = 'createScriptDeployment'
     params['argType']    = 'java.lang.String'
-    params['arg0']       = bsh_script #Rex::Text.uri_encode(bsh_script)
+    params['arg0']       = bsh_script
     params['argType']    = 'java.lang.String'
     params['arg1']       = Rex::Text.rand_text_alphanumeric(8+rand(8)) + '.bsh'
 

lib/msf/http/jboss/bean_shell_scripts.rb

@@ -1,9 +1,12 @@
 # -*- coding: binary -*-
+
 module Msf::HTTP::JBoss::BeanShellScripts
 
-  # Generate a BSH script
+  # Generates a Bean Shell Script.
+  #
+  # @param type [Symbol] The Bean Shell script type, `:create` or `:delete`.
   # @param opts [Hash] Hash of configuration options.
-  # @return [String] A BSH script 
+  # @return [String] A Bean Shell script.
   def generate_bsh(type, opts ={})
     bean_shell = nil
     case type
@@ -16,10 +19,11 @@ def generate_bsh(type, opts ={})
     bean_shell
   end
 
-  # Generate a stager to write the exploded WAR file to the deploy/
-  # directory. This is used to bypass the size limit for GET/HEAD requests
-  # @param [String] The name of the app to deploy
-  # @return [String] The jsp stager
+  # Generate a stager JSP to write a WAR file to the deploy/ directory.
+  # This is used to bypass the size limit for GET/HEAD requests.
+  #
+  # @param app_base [String] The name of the WAR app to write.
+  # @return [String] The JSP stager.
   def stager_jsp(app_base)
     decoded_var = Rex::Text.rand_text_alpha(8+rand(8))
     file_path_var = Rex::Text.rand_text_alpha(8+rand(8))
@@ -51,9 +55,15 @@ def stager_jsp(app_base)
     stager_jsp
   end
 
-  # Generate a BSH script to deploy the WAR 
-  # @param opts [Hash] Hash of configuration options.
-  # @return [String] A BSH script to deploy the WAR 
+  # Generate a Bean Shell script which creates files inside the JBOSS's deploy
+  #   directory.
+  #
+  # @param opts [Hash] Hash containing the options to create the Bean Shell
+  #   Script.
+  # @option opts :dir [Symbol] The dir where place the file.
+  # @option opts :file [Symbol] The file path.
+  # @option opts :contents [Symbol] The file contents.
+  # @return [String] A Bean Shell script to create the file.
   def create_file_bsh(opts = {})
     dir = opts[:dir]
     file = opts[:file]
@@ -75,13 +85,15 @@ def create_file_bsh(opts = {})
 fstream.close();
     EOT
 
-    vprint_status("Creating deploy/#{file} via BSHDeployer")
     payload_bsh_script
   end
 
-  # Generate a BSH script to delete an application 
-  # @param opts [Hash] Hash of configuration options.
-  # @return [String] A BSH script to delete an application
+  # Generate a Bean Shell script to delete files from the JBoss's /deploy
+  #   directory.
+  #
+  # @param opts [Hash] Hash containing the files to delete, the values are
+  #   the files paths.
+  # @return [String] A Bean Shell script to delete files.
   def delete_files_bsh(opts = {})
     script = "String jboss_home = System.getProperty(\"jboss.server.home.dir\");\n"
     opts.values.each do |v|