ronin-support 0.4.1 → 0.5.0.rc1

data/lib/ronin/network/smtp/email.rb

@@ -117,7 +117,7 @@ module Ronin
         # @return [String]
         #   Properly formatted SMTP message.
         #
-        # @see http://www.ruby-doc.org/stdlib/libdoc/net/smtp/rdoc/classes/Net/SMTP.html
+        # @see http://rubydoc.info/stdlib/net/Net/SMTP
         #
         # @api public
         #

data/lib/ronin/network/smtp/smtp.rb

@@ -36,7 +36,7 @@ module Ronin
       #
       # @api public
       #
-      def SMTP.default_port
+      def self.default_port
         @default_port ||= DEFAULT_PORT
       end
 
@@ -48,7 +48,7 @@ module Ronin
       #
       # @api public
       #
-      def SMTP.default_port=(port)
+      def self.default_port=(port)
         @default_port = port
       end
 
@@ -69,7 +69,7 @@ module Ronin
       #
       # @api public
       #
-      def SMTP.message(options={},&block)
+      def self.message(options={},&block)
         Email.new(options,&block).to_s
       end
 
@@ -136,10 +136,9 @@ module Ronin
         host = host.to_s
         port = (options[:port] || SMTP.default_port)
 
-        helo = options[:helo]
-
-        auth = options[:auth]
-        user = options[:user]
+        helo     = options[:helo]
+        auth     = options[:auth]
+        user     = options[:user]
         password = options[:password]
 
         session = Net::SMTP.start(host,port,helo,user,password,auth)
@@ -206,7 +205,7 @@ module Ronin
       #                                        :message_id => 'XXXX',
       #                                        :body => 'Hello'
       #
-      # @example Using the block.
+      # @example Using the block:
       #   smtp_send_message('www.example.com') do |email|
       #     email.to = 'joe@example.com'
       #     email.from 'eve@example.com'

data/lib/ronin/network/ssl.rb

@@ -22,7 +22,6 @@ require 'ronin/network/tcp'
 begin
   require 'openssl'
 rescue ::LoadError
-  $stderr.puts "WARNING: Ruby was not compiled with OpenSSL support"
 end
 
 module Ronin
@@ -100,8 +99,6 @@ module Ronin
       # @example
       #   socket = ssl_connect('twitter.com',443)
       #
-      # @see http://rubydoc.info/stdlib/openssl/OpenSSL/SSL/SSLSocket
-      #
       # @api public
       #
       def ssl_connect(host,port,options={})
@@ -168,13 +165,11 @@ module Ronin
       #
       # @example
       #   ssl_session('twitter.com',443) do |sock|
-      #     sock.write("GET / HTTP/1.1\n\r\n\r")
+      #     sock.write("GET /\n\n")
       #
       #     sock.each_line { |line| puts line }
       #   end
       #
-      # @see http://rubydoc.info/stdlib/openssl/OpenSSL/SSL/SSLSocket
-      #
       # @api public
       #
       def ssl_session(host,port,options={},&block)

data/lib/ronin/network/tcp.rb

@@ -17,308 +17,5 @@
 # along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'socket'
-
-module Ronin
-  module Network
-    #
-    # Provides helper methods for using the TCP protocol.
-    #
-    module TCP
-      #
-      # 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 ('0.0.0.0')
-      #   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
-      #   tcp_connect('www.hackety.org',80) # => TCPSocket
-      #
-      # @example
-      #   tcp_connect('www.wired.com',80) do |socket|
-      #     socket.write("GET / HTTP/1.1\n\r\n\r")
-      #
-      #     puts socket.readlines
-      #     socket.close
-      #   end
-      #
-      # @api public
-      #
-      def tcp_connect(host,port,local_host=nil,local_port=0)
-        host       = host.to_s
-        local_host = (local_host || '0.0.0.0').to_s
-
-        socket = TCPSocket.new(host,port,local_host,local_port)
-
-        yield socket if block_given?
-        return socket
-      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 tcp_connect_and_send(data,host,port,local_host=nil,local_port=0)
-        socket = tcp_connect(host,port,local_host,local_port)
-        socket.write(data)
-
-        yield socket if block_given?
-        return socket
-      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 tcp_session(host,port,local_host=nil,local_port=0)
-        socket = tcp_connect(host,port,local_host,local_port)
-
-        yield socket if block_given?
-
-        socket.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
-      #   tcp_banner('pop.gmail.com',25)
-      #   # => "220 mx.google.com ESMTP c20sm3096959rvf.1"
-      #
-      # @api public
-      #
-      def tcp_banner(host,port,local_host=nil,local_port=0)
-        banner = nil
-
-        tcp_session(host,port,local_host,local_port) do |socket|
-          banner = socket.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"
-      #   tcp_send(buffer,'victim.com',80)
-      #   # => true
-      #
-      # @api public
-      #
-      def tcp_send(data,host,port,local_host=nil,local_port=0)
-        tcp_session(host,port,local_host,local_port) do |socket|
-          socket.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
-      #   tcp_server(1337)
-      #
-      # @api public
-      #
-      def tcp_server(port=0,host=nil)
-        host = (host || '0.0.0.0').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
-      #   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 tcp_server_session(port=0,host=nil,&block)
-        server = 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
-      #   tcp_single_server(1337) do |client|
-      #     client.puts 'lol'
-      #   end
-      #
-      # @api public
-      #
-      def tcp_single_server(port=0,host=nil)
-        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
-    end
-  end
-end
+require 'ronin/network/tcp/tcp'
+require 'ronin/network/tcp/proxy'

data/lib/ronin/network/tcp/proxy.rb

@@ -0,0 +1,377 @@
+#
+# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin Support.
+#
+# Ronin Support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin Support is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'ronin/network/proxy'
+
+require 'socket'
+
+module Ronin
+  module Network
+    module TCP
+      #
+      # The TCP Proxy allows for inspecting and manipulating TCP protocols.
+      #
+      # ## Callbacks
+      #
+      # In addition to the events supported by the {Network::Proxy Proxy}
+      # base class, the TCP Proxy also supports the following callbacks.
+      #
+      # ### client_connect
+      #
+      # When a client connects to the proxy:
+      #
+      #     on_client_connect do |client|
+      #       puts "[connected] #{client.remote_address.ip_address}:#{client.remote_addre
+      #     end
+      #
+      # ### client_disconnect
+      #
+      # When a client disconnects from the proxy:
+      #
+      #     on_client_disconnect do |client,server|
+      #       puts "[disconnected] #{client.remote_address.ip_address}:#{client.remote_ad
+      #     end
+      #
+      # ### server_connect
+      #
+      # When the server accepts a connection from the proxy:
+      #
+      #     on_server_connect do |client,server|
+      #       puts "[connected] #{proxy}"
+      #     end
+      #
+      # ### server_disconnect
+      #
+      # When the server closes a connection from the proxy.
+      #
+      #     on_server_disconnect do |client,server|
+      #       puts "[disconnected] #{proxy}"
+      #     end
+      #
+      # ### connect
+      #
+      # Alias for {#on_server_connect}.
+      #
+      # ### disconnect
+      #
+      # Alias for {#on_client_disconnect}.
+      #
+      # @since 0.5.0
+      #
+      class Proxy < Network::Proxy
+
+        #
+        # Creates a new TCP Proxy.
+        #
+        # @see Network::Proxy#initialize
+        #
+        def initialize(options={})
+          super(options) do |proxy|
+            @callbacks[:client_connect]    = []
+            @callbacks[:client_disconnect] = []
+            @callbacks[:server_connect]    = []
+            @callbacks[:server_disconnect] = []
+
+            yield proxy if block_given?
+          end
+        end
+
+        #
+        # Opens the proxy.
+        #
+        # @api public
+        #
+        def open
+          @socket = TCPServer.new(@host,@port)
+        end
+
+        #
+        # Polls the connections for data.
+        #
+        # @api public
+        #
+        def poll
+          sockets = [@socket] + client_connections + server_connections
+
+          readable, writtable, errors = IO.select(sockets,nil,sockets)
+
+          (errors & client_connections).each do |client_socket|
+            server_socket = server_connection_for(client_socket)
+
+            client_disconnect(client_socket,server_socket)
+          end
+
+          (errors & server_connections).each do |server_socket|
+            client_socket = client_connection_for(server_socket)
+
+            server_disconnect(client_socket,server_socket)
+          end
+
+          (readable & client_connections).each do |client_socket|
+            server_socket = server_connection_for(client_socket)
+            data          = recv(client_socket)
+
+            unless data.empty?
+              client_data(client_socket,server_socket,data)
+            else
+              client_disconnect(client_socket,server_socket)
+            end
+          end
+
+          (readable & server_connections).each do |server_socket|
+            client_socket = client_connection_for(server_socket)
+            data          = recv(server_socket)
+
+            unless data.empty?
+              server_data(client_socket,server_socket,data)
+            else
+              server_disconnect(client_socket,server_socket)
+            end
+          end
+
+          if readable.include?(@socket)
+            client_connect(@socket.accept)
+          end
+        end
+
+        #
+        # Sends data to a connection.
+        #
+        # @param [TCPSocket] connection
+        #   A TCP connection to write data to.
+        # 
+        # @param [String] data
+        #   The data to write.
+        #
+        # @api public
+        #
+        def send(connection,data)
+          connection.send(data,0)
+        end
+
+        #
+        # Receives data from a connection.
+        #
+        # @param [TCPSocket] connection
+        #   The TCP connection to receive data from.
+        #
+        # @return [String, nil]
+        #   The received data.
+        #
+        # @api public
+        #
+        def recv(connection)
+          connection.recv(@buffer_size)
+        end
+
+        #
+        # Registers a callback for when a client connects.
+        #
+        # @yield [client]
+        #   The block will be passed each newly connected client.
+        #
+        # @yieldparam [TCPSocket] client
+        #   The connection from the client to the proxy.
+        #
+        # @example
+        #   on_client_connect do |client|
+        #     puts "[connected] #{client.remote_address.ip_address}:#{client.remote_address.ip_port}"
+        #   end
+        #
+        # @api public
+        #
+        def on_client_connect(&block)
+          @callbacks[:client_connect] << block
+        end
+
+        #
+        # Registers a callback for when a client disconnects.
+        #
+        # @yield [client, server]
+        #   The block will be passed each disconnected client and their
+        #   connection to the server.
+        #
+        # @yieldparam [TCPSocket] client
+        #   The connection from the client to the proxy.
+        #
+        # @yieldparam [TCPSocket] server
+        #   The connection from the proxy to the server.
+        #
+        # @example
+        #   on_client_disconnect do |client,server|
+        #     puts "[disconnected] #{client.remote_address.ip_address}:#{client.remote_address.ip_port}"
+        #   end
+        #
+        # @api public
+        #
+        def on_client_disconnect(&block)
+          @callbacks[:client_disconnect] << block
+        end
+
+        alias on_disconnect on_client_disconnect
+
+        #
+        # Registers a callback for when the server accepts a connection.
+        #
+        # @yield [client, server]
+        #   The block will be passed each connected client and their newly
+        #   formed connection to the server.
+        #
+        # @yieldparam [TCPSocket] client
+        #   The connection from the client to the proxy.
+        #
+        # @yieldparam [TCPSocket] server
+        #   The connection from the proxy to the server.
+        #
+        # @example
+        #   on_server_connect do |client,server|
+        #     puts "[connected] #{proxy}"
+        #   end
+        #
+        # @api public
+        #
+        def on_server_connect(&block)
+          @callbacks[:server_connect] << block
+        end
+
+        alias on_connect on_server_connect
+
+        #
+        # Registers a callback for when the server closes a connection.
+        #
+        # @yield [client, server]
+        #   The block will be passed the each client connection and the
+        #   recently disconnected server connection.
+        #
+        # @yieldparam [TCPSocket] client
+        #   The connection from the client to the proxy.
+        #
+        # @yieldparam [TCPSocket] server
+        #   The connection from the proxy to the server.
+        #
+        # @example
+        #   on_server_disconnect do |client,server|
+        #     puts "[disconnected] #{proxy}"
+        #   end
+        #
+        # @api public
+        #
+        def on_server_disconnect(&block)
+          @callbacks[:server_disconnect] << block
+        end
+
+        protected
+
+        #
+        # Creates a new connection to the server.
+        #
+        # @return [TCPSocket]
+        #   A new connection.
+        #
+        def open_server_connection
+          TCPSocket.new(@server_host,@server_port)
+        end
+
+        #
+        # Closes a connection from the client.
+        #
+        # @param [TCPSocket] socket
+        #   The connection from the client.
+        #
+        def close_client_connection(socket)
+          socket.close
+        end
+
+        #
+        # Closes a connection to the server.
+        #
+        # @param [TCPSocket] socket
+        #   The connection to the server.
+        #
+        def close_server_connection(socket)
+          socket.close
+        end
+
+        #
+        # Closes the TCP proxy.
+        #
+        def close_proxy
+          @socket.close
+        end
+
+        #
+        # Triggers the `client_connect` event.
+        #
+        # @param [connection] client_connection
+        #   The new connection from a client to the proxy.
+        #
+        def client_connect(client_connection)
+          callback(:client_connect,client_connection) do
+            server_connect(client_connection)
+          end
+        end
+
+        #
+        # Triggers the `client_disconnect` event.
+        #
+        # @param [connection] client_connection
+        #   The connection from a client to the proxy.
+        #
+        # @param [connection] server_connection
+        #   The connection from the proxy to the server.
+        #
+        def client_disconnect(client_connection,server_connection)
+          callback(:client_disconnect,client_connection,server_connection) do
+            close_connection(client_connection,server_connection)
+          end
+        end
+
+        #
+        # Triggers the `server_connect` event.
+        #
+        # @param [connection] client_connection
+        #   The connection from a client to the proxy.
+        #
+        def server_connect(client_connection)
+          server_connection = open_server_connection
+
+          callback(:server_connect,client_connection,server_connection) do
+            @connections[client_connection] = server_connection
+          end
+        end
+
+        #
+        # Triggers the `server_disconnect` event.
+        #
+        # @param [connection] client_connection
+        #   The connection from a client to the proxy.
+        #
+        # @param [connection] server_connection
+        #   The connection from the proxy to the server.
+        #
+        def server_disconnect(client_connection,server_connection)
+          callback(:server_disconnect,client_connection,server_connection) do
+            close_connection(client_connection)
+          end
+        end
+
+      end
+    end
+  end
+end