ronin-support 0.3.0 → 0.4.0.rc1

data/lib/ronin/network/ssl.rb

@@ -17,7 +17,7 @@
 # along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'ronin/network/extensions/ssl'
+require 'ronin/network/tcp'
 
 begin
   require 'openssl'
@@ -27,9 +27,11 @@ end
 module Ronin
   module Network
     #
-    # SSL helper methods.
+    # Provides helper methods for communicating with SSL-enabled services.
     #
     module SSL
+      extend TCP
+
       # Maps SSL verify modes to `OpenSSL::SSL::VERIFY_*` constants.
       #
       # @return [Hash{Symbol => Integer}]
@@ -52,5 +54,132 @@ module Ronin
         hash[key] = OpenSSL::SSL.const_get(verify_const)
       end
     end
+
+    #
+    # Establishes a SSL connection.
+    #
+    # @param [String] host
+    #   The host to connect to.
+    #
+    # @param [Integer] port
+    #   The port to connect to.
+    #
+    # @param [Hash] options
+    #   Additional options.
+    #
+    # @option options [String] :local_host
+    #   The local host to bind to.
+    #
+    # @option options [Integer] :local_port
+    #   The local port to bind to.
+    #
+    # @option options [Symbol] :verify
+    #   Specifies whether to verify the SSL certificate.
+    #   May be one of the following:
+    #
+    #   * `:none`
+    #   * `:peer`
+    #   * `:client_once`
+    #   * `:fail_if_no_peer_cert`
+    #
+    # @option options [String] :cert
+    #   The path to the SSL certificate.
+    #
+    # @option options [String] :key
+    #   The path to the SSL key.
+    #
+    # @yield [ssl_socket]
+    #   The given block will be passed the new SSL Socket.
+    #
+    # @yieldparam [OpenSSL::SSL::SSLSocket] ssl_socket
+    #   The new SSL Socket.
+    #
+    # @return [OpenSSL::SSL::SSLSocket]
+    #   the new SSL Socket.
+    #
+    # @example
+    #   socket = ssl_connect('twitter.com',443)
+    #
+    # @api public
+    #
+    def ssl_connect(host,port,options={})
+      local_host = options[:local_host]
+      local_port = options[:local_port]
+
+      socket = tcp_connect(host,port,local_host,local_port)
+
+      ssl_context = OpenSSL::SSL::SSLContext.new()
+      ssl_context.verify_mode = SSL::VERIFY[options[:verify]]
+
+      if options[:cert]
+        cert_file = File.new(options[:cert])
+        ssl_context.cert = OpenSSL::X509::Certificate.new(cert_file)
+      end
+
+      if options[:key]
+        key_file = File.new(options[:key])
+        ssl_context.key = OpenSSL::PKey::RSA.new(key_file)
+      end
+
+      ssl_socket = OpenSSL::SSL::SSLSocket.new(socket,ssl_context)
+      ssl_socket.sync_close = true
+      ssl_socket.connect
+
+      yield ssl_socket if block_given?
+      return ssl_socket
+    end
+
+    #
+    # Creates a new temporary SSL connection.
+    #
+    # @param [String] host
+    #   The host to connect to.
+    #
+    # @param [Integer] port
+    #   The port to connect to.
+    #
+    # @param [Hash] options
+    #   Additional options.
+    #
+    # @option options [String] :local_host
+    #   The local host to bind to.
+    #
+    # @option options [Integer] :local_port
+    #   The local port to bind to.
+    #
+    # @option options [Symbol] :verify
+    #   Specifies whether to verify the SSL certificate.
+    #
+    # @option options [String] :cert
+    #   The path to the SSL certificate.
+    #
+    # @option options [String] :key
+    #   The path to the SSL key.
+    #
+    # @yield [ssl_socket]
+    #   The given block will be passed the temporary SSL Socket.
+    #
+    # @yieldparam [OpenSSL::SSL::SSLSocket] ssl_socket
+    #   The temporary SSL Socket.
+    #
+    # @return [nil]
+    #
+    # @example
+    #   ssl_session('twitter.com',443) do |sock|
+    #     sock.write("GET /\n\n")
+    #
+    #     sock.each_line { |line| puts line }
+    #   end
+    #
+    # @api public
+    #
+    def ssl_session(host,port)
+      ssl_socket = ssl_connect(host,port)
+
+      yield ssl_socket if block_given?
+
+      ssl_socket.close
+      return nil
+    end
   end
 end

data/lib/ronin/network/tcp.rb

@@ -17,4 +17,309 @@
 # along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'ronin/network/extensions/tcp'
+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 (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
+      #   tcp_connect('www.hackety.org',80) # => TCPSocket
+      #
+      # @example
+      #   tcp_connect('www.wired.com',80) do |sock|
+      #     sock.write("GET /\n\n")
+      #     puts sock.readlines
+      #     sock.close
+      #   end
+      #
+      # @api public
+      #
+      def 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 tcp_connect_and_send(data,host,port,local_host=nil,local_port=nil)
+        sock = 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 tcp_session(host,port,local_host=nil,local_port=nil)
+        sock = 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
+      #   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=nil)
+        banner = nil
+
+        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"
+      #   tcp_send(buffer,'victim.com',80)
+      #   # => true
+      #
+      # @api public
+      #
+      def tcp_send(data,host,port,local_host=nil,local_port=nil)
+        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
+      #   tcp_server(1337)
+      #
+      # @api public
+      #
+      def 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
+      #   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,host='0.0.0.0',&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,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
+    end
+  end
+end