ronin-support 0.3.0 → 0.4.0.rc1

data/lib/ronin/network/extensions/tcp/net.rb

@@ -17,302 +17,8 @@
 # along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'socket'
+require 'ronin/network/tcp'
 
 module Net
-  #
-  # Creates a new TCPSocket object connected to a given host and port.
-  #
-  # @param [String] host
-  #   The host to connect to.
-  #
-  # @param [Integer] port
-  #   The port to connect to.
-  #
-  # @param [String] local_host (nil)
-  #   The local host to bind to.
-  #
-  # @param [Integer] local_port (nil)
-  #   The local port to bind to.
-  #
-  # @yield [socket]
-  #   If a block is given, it will be passed the newly created socket.
-  #
-  # @yieldparam [TCPsocket] socket
-  #   The newly created TCPSocket object.
-  #
-  # @return [TCPSocket]
-  #   The newly created TCPSocket object.
-  #
-  # @example
-  #   Net.tcp_connect('www.hackety.org',80) # => TCPSocket
-  #
-  # @example
-  #   Net.tcp_connect('www.wired.com',80) do |sock|
-  #     sock.write("GET /\n\n")
-  #     puts sock.readlines
-  #     sock.close
-  #   end
-  #
-  # @api public
-  #
-  def Net.tcp_connect(host,port,local_host=nil,local_port=nil)
-    host = host.to_s
-    local_host = if local_host
-                   local_host.to_s
-                 end
-
-    sock = TCPSocket.new(host,port,local_host,local_port)
-
-    yield sock if block_given?
-    return sock
-  end
-
-  #
-  # Creates a new TCPSocket object, connected to a given host and port.
-  # The given data will then be written to the newly created TCPSocket.
-  #
-  # @param [String] data
-  #   The data to send through the connection.
-  #
-  # @param [String] host
-  #   The host to connect to.
-  #
-  # @param [Integer] port
-  #   The port to connect to.
-  #
-  # @param [String] local_host (nil)
-  #   The local host to bind to.
-  #
-  # @param [Integer] local_port (nil)
-  #   The local port to bind to.
-  #
-  # @yield [socket]
-  #   If a block is given, it will be passed the newly created socket.
-  #
-  # @yieldparam [TCPsocket] socket
-  #   The newly created TCPSocket object.
-  #
-  # @api public
-  #
-  def Net.tcp_connect_and_send(data,host,port,local_host=nil,local_port=nil)
-    sock = Net.tcp_connect(host,port,local_host,local_port)
-    sock.write(data)
-
-    yield sock if block_given?
-    return sock
-  end
-
-  #
-  # Creates a new temporary TCPSocket object, connected to the given host
-  # and port.
-  #
-  # @param [String] host
-  #   The host to connect to.
-  #
-  # @param [Integer] port
-  #   The port to connect to.
-  #
-  # @param [String] local_host (nil)
-  #   The local host to bind to.
-  #
-  # @param [Integer] local_port (nil)
-  #   The local port to bind to.
-  #
-  # @yield [socket]
-  #   If a block is given, it will be passed the newly created socket.
-  #   After the block has returned, the socket will then be closed.
-  #
-  # @yieldparam [TCPsocket] socket
-  #   The newly created TCPSocket object.
-  #
-  # @return [nil]
-  #
-  # @api public
-  #
-  def Net.tcp_session(host,port,local_host=nil,local_port=nil)
-    sock = Net.tcp_connect(host,port,local_host,local_port)
-
-    yield sock if block_given?
-
-    sock.close
-    return nil
-  end
-
-  #
-  # Reads the banner from the service running on the given host and port.
-  #
-  # @param [String] host
-  #   The host to connect to.
-  #
-  # @param [Integer] port
-  #   The port to connect to.
-  #
-  # @param [String] local_host (nil)
-  #   The local host to bind to.
-  #
-  # @param [Integer] local_port (nil)
-  #   The local port to bind to.
-  #
-  # @yield [banner]
-  #   If a block is given, it will be passed the grabbed banner.
-  #
-  # @yieldparam [String] banner
-  #   The grabbed banner.
-  #
-  # @return [String]
-  #   The grabbed banner.
-  #
-  # @example
-  #   Net.tcp_banner('pop.gmail.com',25)
-  #   # => "220 mx.google.com ESMTP c20sm3096959rvf.1"
-  #
-  # @api public
-  #
-  def Net.tcp_banner(host,port,local_host=nil,local_port=nil)
-    banner = nil
-
-    Net.tcp_session(host,port,local_host,local_port) do |sock|
-      banner = sock.readline.strip
-    end
-
-    yield banner if block_given?
-    return banner
-  end
-
-  #
-  # Connects to a specified host and port, sends the given data and then
-  # closes the connection.
-  #
-  # @param [String] data
-  #   The data to send through the connection.
-  #
-  # @param [String] host
-  #   The host to connect to.
-  #
-  # @param [Integer] port
-  #   The port to connect to.
-  #
-  # @param [String] local_host (nil)
-  #   The local host to bind to.
-  #
-  # @param [Integer] local_port (nil)
-  #   The local port to bind to.
-  #
-  # @return [true]
-  #   The data was successfully sent.
-  #
-  # @example
-  #   buffer = "GET /" + ('A' * 4096) + "\n\r"
-  #   Net.tcp_send(buffer,'victim.com',80)
-  #   # => true
-  #
-  # @api public
-  #
-  def Net.tcp_send(data,host,port,local_host=nil,local_port=nil)
-    Net.tcp_session(host,port,local_host,local_port) do |sock|
-      sock.write(data)
-    end
-
-    return true
-  end
-
-  #
-  # Creates a new TCPServer listening on a given host and port.
-  #
-  # @param [Integer] port
-  #   The local port to listen on.
-  #
-  # @param [String] host ('0.0.0.0')
-  #   The host to bind to.
-  #
-  # @return [TCPServer]
-  #   The new TCP server.
-  #
-  # @example
-  #   Net.tcp_server(1337)
-  #
-  # @api public
-  #
-  def Net.tcp_server(port,host='0.0.0.0')
-    host = host.to_s
-
-    server = TCPServer.new(host,port)
-    server.listen(3)
-
-    yield server if block_given?
-    return server
-  end
-
-  #
-  # Creates a new temporary TCPServer listening on a host and port.
-  #
-  # @param [Integer] port
-  #   The local port to bind to.
-  #
-  # @param [String] host ('0.0.0.0')
-  #   The host to bind to.
-  #
-  # @yield [server]
-  #   The block which will be called after the server has been created.
-  #   After the block has finished, the server will be closed.
-  #
-  # @yieldparam [TCPServer] server
-  #   The newly created TCP server.
-  #
-  # @return [nil]
-  #
-  # @example
-  #   Net.tcp_server_session(1337) do |server|
-  #     client1 = server.accept
-  #     client2 = server.accept
-  #
-  #     client2.write(server.read_line)
-  #
-  #     client1.close
-  #     client2.close
-  #   end
-  #
-  # @api public
-  #
-  def Net.tcp_server_session(port,host='0.0.0.0',&block)
-    server = Net.tcp_server(port,host,&block)
-    server.close()
-    return nil
-  end
-
-  #
-  # Creates a new TCPServer listening on a given host and port,
-  # accepts only one client and then stops listening.
-  #
-  # @param [Integer] port
-  #   After the block has finished, the client and the server will be
-  #   closed.
-  #
-  # @yieldparam [TCPSocket] client
-  #   The newly connected client.
-  #
-  # @return [nil]
-  #
-  # @example
-  #   Net.tcp_single_server(1337) do |client|
-  #     client.puts 'lol'
-  #   end
-  #
-  # @api public
-  #
-  def Net.tcp_single_server(port,host='0.0.0.0')
-    host = host.to_s
-
-    server = TCPServer.new(host,port)
-    server.listen(1)
-
-    client = server.accept
-
-    yield client if block_given?
-
-    client.close
-    server.close
-    return nil
-  end
+  extend Ronin::Network::TCP
 end

data/lib/ronin/network/extensions/telnet/net.rb

@@ -19,140 +19,6 @@
 
 require 'ronin/network/telnet'
 
-require 'net/telnet'
-
 module Net
-  #
-  # Creates a new Telnet connection.
-  #
-  # @param [String] host
-  #   The host to connect to.
-  #
-  # @param [Hash] options
-  #   Additional options.
-  #
-  # @option options [Integer] :port (Ronin::Network::Telnet.default_port)
-  #   The port to connect to.
-  #
-  # @option options [Boolean] :binmode
-  #   Indicates that newline substitution shall not be performed.
-  #
-  # @option options [String] :output_log
-  #   The name of the file to write connection status messages and all
-  #   received traffic to.
-  #
-  # @option options [String] :dump_log
-  #   Similar to the `:output_log` option, but connection output is also
-  #   written in hexdump format.
-  #
-  # @option options [Regexp] :prompt (Ronin::Network::Telnet.default_prompt)
-  #   A regular expression matching the host command-line prompt sequence,
-  #   used to determine when a command has finished.
-  #
-  # @option options [Boolean] :telnet (true)
-  #   Indicates that the connection shall behave as a telnet connection.
-  #
-  # @option options [Boolean] :plain
-  #   Indicates that the connection shall behave as a normal TCP
-  #   connection.
-  #
-  # @option options [Integer] :timeout (Ronin::Network::Telnet.default_timeout)
-  #   The number of seconds to wait before timing out both the initial
-  #   attempt to connect to host, and all attempts to read data from the
-  #   host.
-  #
-  # @option options [Integer] :wait_time
-  #   The amount of time to wait after seeing what looks like a prompt.
-  #
-  # @option options [Net::Telnet, IO] :proxy (Ronin::Network::Telnet.proxy)
-  #   A proxy object to used instead of opening a direct connection to the
-  #   host.
-  #
-  # @option options [String] :user
-  #   The user to login as.
-  #
-  # @option options [String] :password
-  #   The password to login with.
-  #
-  # @yield [session]
-  #   If a block is given, it will be passed the newly created Telnet
-  #   session.
-  #
-  # @yieldparam [Net::Telnet] session
-  #   The newly created Telnet session.
-  #
-  # @return [Net::Telnet]
-  #   The Telnet session
-  #
-  # @example
-  #   Net.telnet_connect('towel.blinkenlights.nl')
-  #   # => #<Net::Telnet: ...>
-  #
-  # @api public
-  #
-  def Net.telnet_connect(host,options={})
-    host = host.to_s
-    telnet_options = {}
-
-    telnet_options['Host'] = host
-    telnet_options['Port'] = (options[:port] || Ronin::Network::Telnet.default_port)
-    telnet_options['Binmode'] = options[:binmode]
-    telnet_options['Output_log'] = options[:output_log]
-    telnet_options['Dump_log'] = options[:dump_log]
-    telnet_options['Prompt'] = (options[:prompt] || Ronin::Network::Telnet.default_prompt)
-
-    if (options[:telnet] && !options[:plain])
-      telnet_options['Telnetmode'] = true
-    end
-
-    telnet_options['Timeout'] = (options[:timeout] || Ronin::Network::Telnet.default_timeout)
-    telnet_options['Waittime'] = options[:wait_time]
-    telnet_options['Proxy'] = (options[:proxy] || Ronin::Network::Telnet.proxy)
-
-    user = options[:user]
-    passwd = options[:passwd]
-
-    session = Net::Telnet.new(telnet_options)
-    session.login(user,passwd) if user
-
-    yield session if block_given?
-    return session
-  end
-
-  #
-  # Starts a new Telnet session.
-  #
-  # @param [String] host
-  #   The host to connect to.
-  #
-  # @param [Hash] options
-  #   Additional options.
-  #
-  # @yield [session]
-  #   If a block is given, it will be passed the newly created
-  #   Telnet session. After the block has returned, the Telnet session
-  #   will be closed.
-  #
-  # @yieldparam [Net::Telnet] session
-  #   The newly created Telnet session.
-  #
-  # @return [nil]
-  #
-  # @example
-  #   Net.telnet_session('towel.blinkenlights.nl') do |movie|
-  #     movie.each_line { |line| puts line }
-  #   end
-  #
-  # @see Net.telnet_session
-  #
-  # @api public
-  #
-  def Net.telnet_session(host,options={})
-    session = Net.telnet_connect(host,options)
-
-    yield session if block_given?
-
-    session.close
-    return nil
-  end
+  extend Ronin::Network::Telnet
 end

data/lib/ronin/network/extensions/udp/net.rb

@@ -17,220 +17,8 @@
 # along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'socket'
+require 'ronin/network/udp'
 
 module Net
-  #
-  # Creates a new UDPSocket object connected to a given host and port.
-  #
-  # @param [String] host
-  #   The host to connect to.
-  #
-  # @param [Integer] port
-  #   The port to connect to.
-  #
-  # @param [String] local_host (nil)
-  #   The local host to bind to.
-  #
-  # @param [Integer] local_port (nil)
-  #   The local port to bind to.
-  #
-  # @yield [socket]
-  #   If a block is given, it will be passed the newly created socket.
-  #
-  # @yieldparam [UDPsocket] socket
-  #   The newly created UDPSocket object.
-  #
-  # @return [UDPSocket]
-  #   The newly created UDPSocket object.
-  #
-  # @example
-  #   Net.udp_connect('www.hackety.org',80)
-  #   # => UDPSocket
-  #
-  # @example
-  #   Net.udp_connect('www.wired.com',80) do |sock|
-  #     puts sock.readlines
-  #   end
-  #
-  # @api public
-  #
-  def Net.udp_connect(host,port,local_host=nil,local_port=nil)
-    host = host.to_s
-    local_host = if local_host
-                   local_host.to_s
-                 end
-
-    sock = UDPSocket.new(host,port,local_host,local_port)
-
-    yield sock if block_given?
-    return sock
-  end
-
-  #
-  # Creates a new UDPSocket object, connected to a given host and port.
-  # The given data will then be written to the newly created UDPSocket.
-  #
-  # @param [String] data
-  #   The data to send through the connection.
-  #
-  # @param [String] host
-  #   The host to connect to.
-  #
-  # @param [Integer] port
-  #   The port to connect to.
-  #
-  # @param [String] local_host (nil)
-  #   The local host to bind to.
-  #
-  # @param [Integer] local_port (nil)
-  #   The local port to bind to.
-  #
-  # @yield [socket]
-  #   If a block is given, it will be passed the newly created socket.
-  #
-  # @yieldparam [UDPsocket] socket
-  #   The newly created UDPSocket object.
-  #
-  # @return [UDPSocket]
-  #   The newly created UDPSocket object.
-  #
-  # @api public
-  #
-  def Net.udp_connect_and_send(data,host,port,local_host=nil,local_port=nil)
-    sock = Net.udp_connect(host,port,local_host,local_port)
-    sock.write(data)
-
-    yield sock if block_given?
-    return sock
-  end
-
-  #
-  # Creates a new temporary UDPSocket object, connected to the given host
-  # and port.
-  #
-  # @param [String] host
-  #   The host to connect to.
-  #
-  # @param [Integer] port
-  #   The port to connect to.
-  #
-  # @param [String] local_host (nil)
-  #   The local host to bind to.
-  #
-  # @param [Integer] local_port (nil)
-  #   The local port to bind to.
-  #
-  # @yield [socket]
-  #   If a block is given, it will be passed the newly created socket.
-  #   After the block has returned, the socket will then be closed.
-  #
-  # @yieldparam [UDPsocket] socket
-  #   The newly created UDPSocket object.
-  #
-  # @return [nil]
-  #
-  # @api public
-  #
-  def Net.udp_session(host,port,local_host=nil,local_port=nil)
-    sock = Net.udp_connect(host,port,local_host,local_port)
-
-    yield sock if block_given?
-
-    sock.close
-    return nil
-  end
-
-  #
-  # Reads the banner from the service running on the given host and port.
-  #
-  # @param [String] host
-  #   The host to connect to.
-  #
-  # @param [Integer] port
-  #   The port to connect to.
-  #
-  # @param [String] local_host (nil)
-  #   The local host to bind to.
-  #
-  # @param [Integer] local_port (nil)
-  #   The local port to bind to.
-  #
-  # @yield [banner]
-  #   If a block is given, it will be passed the grabbed banner.
-  #
-  # @yieldparam [String] banner
-  #   The grabbed banner.
-  #
-  # @return [String]
-  #   The grabbed banner.
-  #
-  # @api public
-  #
-  def Net.udp_banner(host,port,local_host=nil,local_port=nil)
-    banner = nil
-
-    Net.udp_session(host,port,local_host,local_port) do |sock|
-      banner = sock.readline
-    end
-
-    yield banner if block_given?
-    return banner
-  end
-
-  #
-  # Creates a new UDPServer listening on a given host and port.
-  #
-  # @param [Integer] port
-  #   The local port to listen on.
-  #
-  # @param [String] host ('0.0.0.0')
-  #   The host to bind to.
-  #
-  # @return [UDPServer]
-  #   The new UDP server.
-  #
-  # @example
-  #   Net.udp_server(1337)
-  #
-  # @api public
-  #
-  def Net.udp_server(port,host='0.0.0.0')
-    host = host.to_s
-    server = UDPServer.new(host,port)
-
-    yield server if block_given?
-    return server
-  end
-
-  #
-  # Creates a new temporary UDPServer listening on a given host and port.
-  #
-  # @param [Integer] port
-  #   The local port to bind to.
-  #
-  # @param [String] host ('0.0.0.0')
-  #   The host to bind to.
-  #
-  # @yield [server]
-  #   The block which will be called after the server has been created.
-  #   After the block has finished, the server will be closed.
-  #
-  # @yieldparam [UDPServer] server
-  #   The newly created UDP server.
-  #
-  # @return [nil]
-  #
-  # @example
-  #   Net.udp_server_session(1337) do |server|
-  #     data, sender = server.recvfrom(1024)
-  #   end
-  #
-  # @api public
-  #
-  def Net.udp_server_session(port,host='0.0.0.0',&block)
-    server = Net.udp_server(port,host,&block)
-    server.close()
-    return nil
-  end
+  extend Ronin::Network::UDP
 end