Land rapid7#2229 - Re-implement fail_with() function

Author: wchen-r7

lib/msf/core/exploit.rb

@@ -101,81 +101,6 @@ module CheckCode
 		Unsupported = [ 'unsupported', "This exploit does not support check." ]
 	end
 
-
-
-	##
-	#
-	# Constants indicating the reason for an unsuccessful exploit attempt
-	#
-	##
-	module Failure
-
-		#
-		# No confidence in success or failure
-		#
-		None            = 'none'
-
-		#
-		# No confidence in success or failure
-		#
-		Unknown         = 'unknown'
-
-		#
-		# The network service was unreachable (connection refused, etc)
-		#
-		Unreachable     = 'unreachable'
-
-		#
-		# The exploit settings were incorrect
-		#
-		BadConfig       = 'bad-config'
-
-		#
-		# The network service disconnected us mid-attempt
-		#
-		Disconnected    = 'disconnected'
-
-		#
-		# The application endpoint or specific service was not found
-		#
-		NotFound        = 'not-found'
-
-		#
-		# The application replied in an unexpected fashion
-		#
-		UnexpectedReply = 'unexpected-reply'
-
-		#
-		# The exploit triggered some form of timeout
-		#
-		TimeoutExpired  = 'timeout-expired'
-
-		#
-		# The exploit was interrupted by the user
-		#
-		UserInterrupt   = 'user-interrupt'
-
-		#
-		# The application replied indication we do not have access
-		#
-		NoAccess        = 'no-access'
-
-		#
-		# The target is not compatible with this exploit or settings
-		#
-		NoTarget        = 'no-target'
-
-		#
-		# The application response indicated it was not vulnerable
-		#
-		NotVulnerable   = 'not-vulnerable'
-
-		#
-		# The payload was delivered but no session was opened (AV, network, etc)
-		#
-		PayloadFailed   = 'payload-failed'
-	end
-
 	#
 	# The various basic types of exploits
 	#

lib/msf/core/module.rb

@@ -734,6 +734,85 @@ def search_filter(search_string)
 		false
 	end
 
+	#
+	# Support fail_with for all module types, allow specific classes to override
+	#
+	def fail_with(reason, msg=nil)
+		raise RuntimeError, "#{reason.to_s}: #{msg}"
+	end
+
+	#
+	# Constants indicating the reason for an unsuccessful module attempt
+	#
+	module Failure
+		
+		#
+		# No confidence in success or failure
+		#
+		None            = 'none'
+
+		#
+		# No confidence in success or failure
+		#
+		Unknown         = 'unknown'
+
+		#
+		# The network service was unreachable (connection refused, etc)
+		#
+		Unreachable     = 'unreachable'
+
+		#
+		# The exploit settings were incorrect
+		#
+		BadConfig       = 'bad-config'
+
+		#
+		# The network service disconnected us mid-attempt
+		#
+		Disconnected    = 'disconnected'
+
+		#
+		# The application endpoint or specific service was not found
+		#
+		NotFound        = 'not-found'
+
+		#
+		# The application replied in an unexpected fashion
+		#
+		UnexpectedReply = 'unexpected-reply'
+
+		#
+		# The exploit triggered some form of timeout
+		#
+		TimeoutExpired  = 'timeout-expired'
+
+		#
+		# The exploit was interrupted by the user
+		#
+		UserInterrupt   = 'user-interrupt'
+
+		#
+		# The application replied indication we do not have access
+		#
+		NoAccess        = 'no-access'
+
+		#
+		# The target is not compatible with this exploit or settings
+		#
+		NoTarget        = 'no-target'
+
+		#
+		# The application response indicated it was not vulnerable
+		#
+		NotVulnerable   = 'not-vulnerable'
+
+		#
+		# The payload was delivered but no session was opened (AV, network, etc)
+		#
+		PayloadFailed   = 'payload-failed'
+	end	
+
+
 	##
 	#
 	# Just some handy quick checks

modules/auxiliary/gather/apple_safari_webarchive_uxss.rb

@@ -93,7 +93,7 @@ def cleanup
 	#
 	def use_zlib
 		if (!Rex::Text.zlib_present? and datastore['HTTP::compression'] == true)
-			fail_with(Exploit::Failure::Unknown, "zlib support was not detected, yet the HTTP::compression option was set.  Don't do that!")
+			fail_with(Failure::Unknown, "zlib support was not detected, yet the HTTP::compression option was set.  Don't do that!")
 		end
 	end
 

modules/exploits/aix/rpc_cmsd_opcode21.rb

@@ -83,7 +83,7 @@ def brute_exploit(brute_target)
 
 		begin
 			if (not sunrpc_create('udp', 100068, 4))
-				fail_with(Exploit::Failure::Unknown, 'sunrpc_create failed')
+				fail_with(Failure::Unknown, 'sunrpc_create failed')
 			end
 
 			# spray the heap a bit (work around powerpc cache issues)

modules/exploits/bsdi/softcart/mercantec_softcart.rb

@@ -72,7 +72,7 @@ def brute_exploit(address)
 				'uri'   => normalize_uri(datastore['URI'])
 			}, 5)
 			@mercantec = (res and res.body and res.body =~ /Copyright.*Mercantec/)
-			fail_with(Exploit::Failure::NotFound, "The target is not a Mercantec CGI") if not @mercantec
+			fail_with(Failure::NotFound, "The target is not a Mercantec CGI") if not @mercantec
 		end
 
 		buffer =

modules/exploits/freebsd/ftp/proftp_telnet_iac.rb

@@ -148,7 +148,7 @@ def exploit
 				print_status("FTP Banner: #{banner.strip}")
 				version = m[1]
 			else
-				fail_with(Exploit::Failure::NoTarget, "No matching target")
+				fail_with(Failure::NoTarget, "No matching target")
 			end
 
 			regexp = Regexp.escape(version)
@@ -160,14 +160,14 @@ def exploit
 			end
 
 			if (not @mytarget)
-				fail_with(Exploit::Failure::NoTarget, "No matching target")
+				fail_with(Failure::NoTarget, "No matching target")
 			end
 
 			print_status("Selected Target: #{@mytarget.name}")
 
 			pl = exploit_regenerate_payload(@mytarget.platform, arch)
 			if not pl
-				fail_with(Exploit::Failure::Unknown, 'Unable to regenerate payload!')
+				fail_with(Failure::Unknown, 'Unable to regenerate payload!')
 			end
 		else
 			print_status("Trying target #{@mytarget.name}...")

modules/exploits/freebsd/local/mmap.rb

@@ -69,7 +69,7 @@ def upload_payload
 		fname = datastore['WritableDir']
 		fname = "#{fname}/" unless fname =~ %r'/$'
 		if fname.length > 36
-			fail_with(Exploit::Failure::BadConfig, "WritableDir can't be longer than 33 characters")
+			fail_with(Failure::BadConfig, "WritableDir can't be longer than 33 characters")
 		end
 		fname = "#{fname}#{Rex::Text.rand_text_alpha(4)}"
 
@@ -100,11 +100,11 @@ def upload_exploit(payload_fname)
 
 	def exploit
 		payload_fname = upload_payload
-		fail_with(Exploit::Failure::NotFound, "Payload failed to upload") if payload_fname.nil?
+		fail_with(Failure::NotFound, "Payload failed to upload") if payload_fname.nil?
 		print_status("Payload #{payload_fname} uploaded.")
 
 		exploit_fname = upload_exploit(payload_fname)
-		fail_with(Exploit::Failure::NotFound, "Exploit failed to upload") if exploit_fname.nil?
+		fail_with(Failure::NotFound, "Exploit failed to upload") if exploit_fname.nil?
 		print_status("Exploit #{exploit_fname} uploaded.")
 
 		register_files_for_cleanup(payload_fname, exploit_fname)

modules/exploits/freebsd/telnet/telnet_encrypt_keyid.rb

@@ -97,7 +97,7 @@ def exploit_target(t)
 		loop do
 			data = sock.get_once(-1, 5) rescue nil
 			if not data
-				fail_with(Exploit::Failure::Unknown, "This system does not support encryption")
+				fail_with(Failure::Unknown, "This system does not support encryption")
 			end
 			break if data.index("\xff\xfa\x26\x02\x01")
 		end

modules/exploits/linux/ftp/proftp_sreplace.rb

@@ -165,7 +165,7 @@ def exploit
 				print_status("FTP Banner: #{banner.strip}")
 				version = m[1]
 			else
-				fail_with(Exploit::Failure::NoTarget, "No matching target")
+				fail_with(Failure::NoTarget, "No matching target")
 			end
 
 			regexp = Regexp.escape(version)
@@ -177,7 +177,7 @@ def exploit
 			end
 
 			if (not mytarget)
-				fail_with(Exploit::Failure::NoTarget, "No matching target")
+				fail_with(Failure::NoTarget, "No matching target")
 			end
 
 			print_status("Selected Target: #{mytarget.name}")
@@ -193,7 +193,7 @@ def exploit
 
 		pwd = send_cmd(['PWD'])
 		if pwd !~ /257\s\"(.+)\"/
-			fail_with(Exploit::Failure::Unknown, "Unable to get current working directory")
+			fail_with(Failure::Unknown, "Unable to get current working directory")
 		end
 		pwd = $1
 		pwd << "/" if pwd[-1,1] != "/"

modules/exploits/linux/ftp/proftp_telnet_iac.rb

@@ -325,7 +325,7 @@ def exploit
 				print_status("FTP Banner: #{banner.strip}")
 				version = m[1]
 			else
-				fail_with(Exploit::Failure::NoTarget, "No matching target")
+				fail_with(Failure::NoTarget, "No matching target")
 			end
 
 			regexp = Regexp.escape(version)
@@ -337,7 +337,7 @@ def exploit
 			end
 
 			if (not mytarget)
-				fail_with(Exploit::Failure::NoTarget, "No matching target")
+				fail_with(Failure::NoTarget, "No matching target")
 			end
 
 			print_status("Selected Target: #{mytarget.name}")
@@ -383,7 +383,7 @@ def exploit
 		# Make sure we didn't introduce instability
 		addr_badchars = "\x09\x0a\x0b\x0c\x20"
 		if idx = Rex::Text.badchar_index(addrs, addr_badchars)
-			fail_with(Exploit::Failure::Unknown, ("One or more address contains a bad character! (0x%02x @ 0x%x)" % [addrs[idx,1].unpack('C').first, idx]))
+			fail_with(Failure::Unknown, ("One or more address contains a bad character! (0x%02x @ 0x%x)" % [addrs[idx,1].unpack('C').first, idx]))
 		end
 
 		buf << addrs
@@ -432,7 +432,7 @@ def exploit
 			end
 
 			if not session_created?
-				fail_with(Exploit::Failure::Unknown, "Unable to guess the cookie value, sorry :-/")
+				fail_with(Failure::Unknown, "Unable to guess the cookie value, sorry :-/")
 			end
 		else
 			sock.put(buf)