Merge commit '5e8f388ab8425bf2ef4c2fe33e6133b99ceb46d4' into psexec-mixin2

Author: Royce Davis

lib/msf/core/exploit/psexec.rb

@@ -13,12 +13,15 @@ module Exploit::Remote::Psexec
 	include Msf::Exploit::Remote::DCERPC
 	include Msf::Exploit::Remote::SMB
 
-	# Retrives output from the executed command
+	# Retrieves output from the executed command
+	#
+	# @example
+	#   get_output("C$", rhost, '\WINDOWS\Temp\outputfile.txt')
+	#
 	# @param smbshare [String] The SMBshare to connect to.  Usually C$
-	# @param ip [IP Address] Remote Host to Connect To
-	# @param file [File name] Path to the output file relative to the smbshare
-	#	Example: '\WINDOWS\Temp\outputfile.txt'
-	# @return output or nil if fails
+	# @param ip [String] Remote host to connect to
+	# @param file [String] Path to the output file relative to the +smbshare+
+	# @return [String,nil] output or nil if retrieval fails
 	def get_output(smbshare, ip, file)
 		begin
 			print_status("Getting the command output...")
@@ -35,12 +38,14 @@ def get_output(smbshare, ip, file)
 	end
 
 
-	# This method executes a single windows command.  If you want to
-	# retrieve the output of your command you'll have to echo it
-	# to a .txt file and then use the get_output method to retrieve it
-	# Make sure to use the cleanup_after method when you are done.
+	# Executes a single windows command.
+	#
+	# If you want to retrieve the output of your command you'll have to
+	# redirect its output to a file and then use {#get_output} to retrieve
+	# it. Make sure to use the {#cleanup_after} method when you are done.
+	#
 	# @param command [String] Should be a valid windows command
-	# @return true if everything wen't well
+	# @return [Boolean] true if everything wen't well
 	def psexec(command)
 
 		simple.connect("IPC$")
@@ -152,14 +157,17 @@ def psexec(command)
 		return true
 	end
 
-	# This is the cleanup method, removes .txt and .bat file/s created during execution
+	# This is the cleanup method, removes .txt and .bat file/s created
+	# during execution
+	#
+	# @example
+	#   cleanup_after("C$", rhost, '\WINDOWS\Temp\output.txt', 'C:\WINDOWS\Temp\batchfile.bat')
+	#
 	# @param smbshare [String] The SMBshare to connect to.  Usually C$
-	# @param ip [IP Address] Remote Host to Connect To
-	# @param text [File Path] Path to the text file relative to the smbshare
-	#	Example: '\WINDOWS\Temp\output.txt'
-	# @param bat [File Path] Full path to the batch file created
-	#	Example: 'C:\WINDOWS\Temp\batchfile.bat'
-	# @return only in the event of an error
+	# @param ip [String] IP address of remote host to connect to
+	# @param text [String] Path to the text file relative to the smbshare
+	# @param bat [String] Full path to the batch file created
+	# @return [StandarError] only in the event of an error
 	def cleanup_after(smbshare, ip, text, bat)
 		begin
 			# Try and do cleanup command/s
@@ -183,7 +191,7 @@ def cleanup_after(smbshare, ip, text, bat)
 	def check_cleanup(smbshare, ip, text)
 		simple.connect("\\\\#{ip}\\#{smbshare}")
 		begin
-			if checktext = simple.open(text, 'ro')
+			if simple.open(text, 'ro')
 				check = false
 			else
 				check = true