librex 0.0.20 → 0.0.21

data/lib/rex/socket/comm/local.rb.ut.rb

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', '..', '..'))
+
+require 'test/unit'
+require 'rex/exceptions'
+require 'rex/socket/parameters'
+require 'rex/socket/comm/local'
+
+class Rex::Socket::Comm::Local::UnitTest < Test::Unit::TestCase
+
+	def test_create_tcp
+		test_port   = 64432
+		test_server = TCPServer.new('127.0.0.1', test_port)
+
+		# Create a stream connection to the stub listener
+		stream = nil
+
+		assert_nothing_raised {
+			stream = Rex::Socket::Comm::Local.create(
+				Rex::Socket::Parameters.from_hash(
+					'PeerHost' => '127.0.0.1',
+					'PeerPort' => test_port,
+					'Proto'    => 'tcp'))
+		}
+
+		assert_kind_of(Rex::IO::Stream, stream, "valid Stream instance")
+		assert_kind_of(Rex::Socket::Tcp, stream, "valid Tcp instance")
+		stream.close
+
+		# Now create a bare connection to the listener
+		stream = nil
+
+		assert_nothing_raised {
+			stream = Rex::Socket::Comm::Local.create(
+				Rex::Socket::Parameters.from_hash(
+					'PeerHost' => '127.0.0.1',
+					'PeerPort' => test_port,
+					'Proto'    => 'tcp',
+					'Bare'     => true))
+		}
+
+		assert_kind_of(Socket, stream, "valid Socket instance")
+
+		assert_raise(Rex::ConnectionRefused, "connection refused failed") {
+			Rex::Socket::Comm::Local.create(
+				Rex::Socket::Parameters.from_hash(
+					'PeerHost' => '127.0.0.1',
+					'PeerPort' => 1,
+					'Proto'    => 'tcp',
+					'Bare'     => true))
+		}
+
+		stream.close
+
+		test_server.close
+	end
+
+	def test_create_tcp_server
+		# TODO
+	end
+
+	def test_create_udp
+		# TODO
+	end
+
+	def test_create_invalid
+		assert_raise(Rex::UnsupportedProtocol, "invalid protocol check failed") {
+			Rex::Socket::Comm::Local.create(
+				Rex::Socket::Parameters.from_hash(
+					'Proto' => 'invalid'))
+		}
+	end
+
+end

data/lib/rex/socket/ip.rb

@@ -0,0 +1,130 @@
+require 'rex/socket'
+
+###
+#
+# This class provides methods for interacting with a IP socket.
+#
+###
+module Rex::Socket::Ip
+
+	include Rex::Socket
+
+	##
+	#
+	# Factory
+	#
+	##
+
+	#
+	# Creates the client using the supplied hash.
+	#
+	def self.create(hash = {})
+		hash['Proto'] = 'ip'
+		self.create_param(Rex::Socket::Parameters.from_hash(hash))
+	end
+
+	#
+	# Wrapper around the base socket class' creation method that automatically
+	# sets the parameter's protocol to IP.
+	#
+	def self.create_param(param)
+		param.proto = 'ip'
+		Rex::Socket.create_param(param)
+	end
+
+	##
+	#
+	# IP connected state methods
+	#
+	##
+
+	#
+	# Write the supplied datagram to the connected IP socket.
+	#
+	def write(gram)
+		raise RuntimeError, "IP sockets must use sendto(), not write()"
+	end
+
+	alias put write
+
+	#
+	# Read a datagram from the IP socket.
+	#
+	def read(length = 65535)
+		raise RuntimeError, "IP sockets must use recvfrom(), not read()"
+	end
+
+	##
+	#
+	# IP non-connected state methods
+	#
+	##
+
+	#
+	# Sends a datagram to the supplied host:port with optional flags.
+	#
+	def sendto(gram, peerhost, flags = 0)
+		dest = ::Socket.pack_sockaddr_in(0, peerhost)
+
+		# Some BSDs require byteswap for len and offset
+		if(
+			Rex::Compat.is_freebsd or
+			Rex::Compat.is_netbsd or
+			Rex::Compat.is_bsdi or
+			Rex::Compat.is_macosx
+		  )
+			gram=gram.dup
+			gram[2,2]=gram[2,2].unpack("n").pack("s")
+			gram[6,2]=gram[6,2].unpack("n").pack("s")
+		end
+
+		begin
+			send(gram, flags, dest)
+		rescue  ::Errno::EHOSTUNREACH,::Errno::ENETDOWN,::Errno::ENETUNREACH,::Errno::ENETRESET,::Errno::EHOSTDOWN,::Errno::EACCES,::Errno::EINVAL,::Errno::EADDRNOTAVAIL
+			return nil
+		end
+
+	end
+
+	#
+	# Receives a datagram and returns the data and host of the requestor
+	# as [ data, host ].
+	#
+	def recvfrom(length = 65535, timeout=def_read_timeout)
+		begin
+			if ((rv = ::IO.select([ fd ], nil, nil, timeout)) and
+			    (rv[0]) and (rv[0][0] == fd)
+			   )
+					data, saddr    = super(length)
+					af, host       = Rex::Socket.from_sockaddr(saddr)
+
+					return [ data, host ]
+			else
+				return [ '', nil ]
+			end
+		rescue Exception
+			return [ '', nil ]
+		end
+	end
+
+	#
+	# Calls recvfrom and only returns the data
+	#
+	def get(timeout=nil)
+		data, saddr = recvfrom(65535, timeout)
+		return data
+	end
+
+	#
+	# The default number of seconds to wait for a read operation to timeout.
+	#
+	def def_read_timeout
+		10
+	end
+
+	def type?
+		return 'ip'
+	end
+
+end
+

data/lib/rex/socket/parameters.rb

@@ -0,0 +1,345 @@
+require 'rex/socket'
+
+###
+#
+# This class represents the set of parameters that are used to create
+# a socket, whether it be a server or client socket.
+#
+###
+class Rex::Socket::Parameters
+
+	##
+	#
+	# Factory
+	#
+	##
+
+	#
+	# Creates an instance of the Parameters class using the supplied hash.
+	#
+	def self.from_hash(hash)
+		return self.new(hash)
+	end
+
+	##
+	#
+	# Constructor
+	#
+	##
+
+	#
+	# Initializes the attributes from the supplied hash.  The following hash
+	# keys can be specified.
+	#
+	# PeerHost / PeerAddr
+	#
+	# 	The remote host to connect to.
+	#
+	# PeerPort
+	#
+	# 	The remote port to connect to.
+	#
+	# LocalHost / LocalAddr
+	#
+	# 	The local host to communicate from, if any.
+	#
+	# LocalPort
+	#
+	# 	The local port to communicate from, if any.
+	#
+	# Bare
+	#
+	# 	Create a bare socket.
+	#
+	# Server
+	#
+	# 	Whether or not this should be a server.
+	#
+	# SSL
+	#
+	# 	Whether or not SSL should be used.
+	#
+	# SSLVersion
+	#
+	# 	Specify SSL2, SSL3, or TLS1 (SSL3 is default)
+	#	
+	# Proxies
+	#
+	#	List of proxies to use.
+	#
+	# Proto
+	#
+	#	The underlying protocol to use.
+	#
+	# IPv6
+	#
+	#	Force the use of IPv6.
+	#
+	# Comm
+	#
+	# 	The underlying Comm class to use to create the socket for this parameter
+	# 	set.
+	#
+	# Context
+	#
+	# 	A context hash that can allow users of this parameter class instance to
+	# 	determine who is responsible for requesting that a socket be created.
+	#
+	# Retries
+	#
+	# 	The number of times a connection should be retried.
+	#
+	# Timeout
+	#
+	# 	The number of seconds before a connection should time out
+	#
+	
+	def initialize(hash)
+		if (hash['PeerHost'])
+			self.peerhost = hash['PeerHost']
+		elsif (hash['PeerAddr'])
+			self.peerhost = hash['PeerAddr']
+		else
+			self.peerhost = nil
+		end
+
+		if (hash['LocalHost'])
+			self.localhost = hash['LocalHost']
+		elsif (hash['LocalAddr'])
+			self.localhost = hash['LocalAddr']
+		else
+			self.localhost = '0.0.0.0'
+		end
+
+		if (hash['PeerPort'])
+			self.peerport = hash['PeerPort'].to_i
+		else
+			self.peerport = 0
+		end
+
+		if (hash['LocalPort'])
+			self.localport = hash['LocalPort'].to_i
+		else
+			self.localport = 0
+		end
+
+		if (hash['Bare'])
+			self.bare = hash['Bare']
+		else
+			self.bare = false
+		end
+
+		if (hash['SSL'] and hash['SSL'].to_s =~ /^(t|y|1)/i)
+			self.ssl = true
+		else
+			self.ssl = false
+		end
+		
+		if (hash['SSLVersion'] and hash['SSLVersion'].to_s =~ /^(SSL2|SSL3|TLS1)$/i)
+			self.ssl_version = hash['SSLVersion']
+		end
+		
+		if hash['Proxies']	
+			self.proxies = hash['Proxies'].split('-').map{|a| a.strip}.map{|a| a.split(':').map{|b| b.strip}}
+		end
+		
+		# The protocol this socket will be using
+		if (hash['Proto'])
+			self.proto = hash['Proto'].downcase
+		else
+			self.proto = 'tcp'
+		end
+
+		# Whether or not the socket should be a server
+		self.server    = hash['Server'] || false
+
+		# The communication subsystem to use to create the socket
+		self.comm      = hash['Comm']
+
+		# The context that was passed in, if any.
+		self.context   = hash['Context'] || {}
+		
+		# If no comm was supplied, try to use the comm that is best fit to
+		# handle the provided host based on the current routing table.
+		if( self.server )
+			if (self.comm == nil and self.localhost)
+				self.comm  = Rex::Socket::SwitchBoard.best_comm(self.localhost)
+			end
+		else
+			if (self.comm == nil and self.peerhost)
+				self.comm  = Rex::Socket::SwitchBoard.best_comm(self.peerhost)
+			end
+		end
+
+		# If we still haven't found a comm, we default to the local comm.
+		self.comm      = Rex::Socket::Comm::Local if (self.comm == nil)
+		
+		# If we are a UDP server, turn off the server flag as it was only set when 
+		# creating the UDP socket in order to avail of the switch board above.
+		if( self.server and self.proto == 'udp' )
+			self.server = false
+		end
+		
+		# The number of connection retries to make (client only)
+		if hash['Retries']
+			self.retries = hash['Retries'].to_i
+		else
+			self.retries = 0
+		end
+
+		# The number of seconds before a connect attempt times out (client only)
+		if hash['Timeout']
+			self.timeout = hash['Timeout'].to_i
+		else
+			self.timeout = 5
+		end
+	
+		# Whether to force IPv6 addressing
+		self.v6        = hash['IPv6'] || false
+	end
+
+	##
+	#
+	# Conditionals
+	#
+	##
+
+	#
+	# Returns true if this represents parameters for a server.
+	#
+	def server?
+		return (server == true)
+	end
+
+	#
+	# Returns true if this represents parameters for a client.
+	#
+	def client?
+		return (server == false)
+	end
+
+	#
+	# Returns true if the protocol for the parameters is TCP.
+	#
+	def tcp?
+		return (proto == 'tcp')
+	end
+
+	#
+	# Returns true if the protocol for the parameters is UDP.
+	#
+	def udp?
+		return (proto == 'udp')
+	end
+
+	#
+	# Returns true if the protocol for the parameters is IP.
+	#
+	def ip?
+		return (proto == 'ip')
+	end
+	
+	#
+	# Returns true if the socket is a bare socket that does not inherit from
+	# any extended Rex classes.
+	#
+	def bare?
+		return (bare == true)
+	end
+
+	#
+	# Returns true if SSL has been requested.
+	#
+	def ssl?
+		return ssl
+	end
+
+	#
+	# Returns true if IPv6 has been enabled
+	#
+	def v6?
+		return v6
+	end
+
+
+	##
+	#
+	# Attributes
+	#
+	##
+
+	#
+	# The remote host information, equivalent to the PeerHost parameter hash
+	# key.
+	#
+	attr_accessor :peerhost
+	#
+	# The remote port.  Equivalent to the PeerPort parameter hash key.
+	#
+	attr_accessor :peerport
+	#
+	# The local host.  Equivalent to the LocalHost parameter hash key.
+	#
+	attr_accessor :localhost
+	#
+	# The local port.  Equivalent to the LocalPort parameter hash key.
+	#
+	attr_accessor :localport
+	#
+	# The protocol to to use, such as TCP.  Equivalent to the Proto parameter
+	# hash key.
+	#
+	attr_accessor :proto
+	#
+	# Whether or not this is a server.  Equivalent to the Server parameter hash
+	# key.
+	#
+	attr_accessor :server
+	#
+	# The Comm class that should be used to create the underlying socket.
+	#
+	attr_accessor :comm
+	#
+	# The context hash that was passed in to the structure.
+	#
+	attr_accessor :context
+	#
+	# The number of attempts that should be made.
+	#
+	attr_accessor :retries
+	#
+	# The number of seconds before a connection attempt should time out.
+	#
+	attr_accessor :timeout
+	#
+	# Whether or not this is a bare (non-extended) socket instance that should
+	# be created.
+	#
+	attr_accessor :bare
+	#
+	# Whether or not SSL should be used to wrap the connection.
+	#
+	attr_accessor :ssl
+	#
+	# What version of SSL to use (SSL2, SSL3, TLS1)
+	#
+	attr_accessor :ssl_version
+	#
+	# Whether we should use IPv6
+	#
+	attr_accessor :v6
+
+
+	attr_accessor :proxies
+
+
+	##
+	#
+	# Synonyms
+	#
+	##
+	
+	alias peeraddr  peerhost
+	alias localaddr localhost
+
+end