ronin-support 0.5.1 → 1.0.0.beta1

data/lib/ronin/network/telnet.rb

@@ -1,264 +0,0 @@
-#
-# 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 'net/telnet'
-
-module Ronin
-  module Network
-    #
-    # Provides helper methods for communicating with Telnet services.
-    #
-    module Telnet
-      # Default telnet port
-      DEFAULT_PORT = 23
-
-      # The default prompt regular expression
-      DEFAULT_PROMPT = /[$%#>] \z/n
-
-      # The default timeout
-      DEFAULT_TIMEOUT = 10
-
-      #
-      # @return [Integer]
-      #   The default Ronin Telnet port.
-      #
-      # @api public
-      #
-      def self.default_port
-        @default_port ||= DEFAULT_PORT
-      end
-
-      #
-      # Sets the default Ronin Telnet port.
-      #
-      # @param [Integer] port
-      #   The new default Ronin Telnet port.
-      #
-      # @api public
-      #
-      def self.default_port=(port)
-        @default_port = port
-      end
-
-      #
-      # @return [Regexp]
-      #   The default Ronin Telnet prompt pattern.
-      #
-      # @api public
-      #
-      def self.default_prompt
-        @default_prompt ||= DEFAULT_PROMPT
-      end
-
-      #
-      # Sets the default Ronin Telnet prompt pattern.
-      #
-      # @param [Regexp] prompt
-      #   The new default Ronin Telnet prompt pattern.
-      #
-      # @api public
-      #
-      def self.default_prompt=(prompt)
-        @default_prompt = prompt
-      end
-
-      #
-      # @return [Integer]
-      #   The default Ronin Telnet timeout.
-      #
-      # @api public
-      #
-      def self.default_timeout
-        @default_timeout ||= DEFAULT_TIMEOUT
-      end
-
-      #
-      # Sets the default Ronin Telnet timeout.
-      #
-      # @param [Integer] timeout
-      #   The new default Ronin Telnet timeout.
-      #
-      # @api public
-      #
-      def self.default_timeout=(timeout)
-        @default_timeout = timeout
-      end
-
-      #
-      # @return [Telnet, IO, nil]
-      #   The Ronin Telnet proxy.
-      #
-      # @api public
-      #
-      def self.proxy
-        @proxy ||= nil
-      end
-
-      #
-      # Sets the Ronin Telnet proxy.
-      #
-      # @param [Telnet, IO, nil] new_proxy
-      #   The new Ronin Telnet proxy.
-      #
-      # @api public
-      #
-      def self.proxy=(new_proxy)
-        @proxy = new_proxy
-      end
-
-      #
-      # Creates a new Telnet connection.
-      #
-      # @param [String] host
-      #   The host to connect to.
-      #
-      # @param [Hash] options
-      #   Additional options.
-      #
-      # @option options [Integer] :port (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 (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 (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 (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
-      #   telnet_connect('towel.blinkenlights.nl')
-      #   # => #<Net::Telnet: ...>
-      #
-      # @api public
-      #
-      def telnet_connect(host,options={})
-        telnet_options = {
-          'Host'       => host.to_s,
-          'Port'       => (options[:port]      || Telnet.default_port),
-          'Binmode'    => (options[:binmode]   || false),
-          'Waittime'   => (options[:wait_time] || 0),
-          'Prompt'     => (options[:prompt]    || Telnet.default_prompt),
-          'Timeout'    => (options[:timeout]   || Telnet.default_timeout)
-        }
-
-        if (options[:telnet] && !options[:plain])
-          telnet_options['Telnetmode'] = true
-        end
-
-        if options[:output_log]
-          telnet_options['Output_log'] = options[:output_log]
-        end
-
-        if options[:dump_log]
-          telnet_options['Dump_log'] = options[:dump_log]
-        end
-
-        if (proxy = (options[:proxy] || Telnet.proxy))
-          telnet_options['Proxy'] = proxy
-        end
-
-        session = Net::Telnet.new(telnet_options)
-        session.login(options[:user],options[:password]) if options[: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
-      #   telnet_session('towel.blinkenlights.nl') do |movie|
-      #     movie.each_line { |line| puts line }
-      #   end
-      #
-      # @see #telnet_connect
-      #
-      # @api public
-      #
-      def telnet_session(host,options={})
-        session = telnet_connect(host,options)
-
-        yield session if block_given?
-
-        session.close
-        return nil
-      end
-    end
-  end
-end

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

@@ -1,191 +0,0 @@
-#
-# 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 UDP
-      #
-      # The UDP Proxy allows for inspecting and manipulating UDP protocols.
-      #
-      # ## Example
-      #
-      #     require 'ronin/network/udp/proxy'
-      #     require 'hexdump'
-      #
-      #     Ronin::Network::UDP::Proxy.start(:port => 1337, :server => ['4.2.2.1', 53]) do |proxy|
-      #       hex = Hexdump::Dumper.new
-      #
-      #       proxy.on_client_data do |(client,(host,port)),server,data|
-      #         puts "#{host}:#{port} -> #{proxy}"
-      #         hex.dump(data)
-      #       end
-      #
-      #       proxy.on_server_data do |(client,(host,port)),server,data|
-      #         puts "#{host}:#{port} <- #{proxy}"
-      #         hex.dump(data)
-      #       end
-      #     
-      #     end
-      #
-      # @since 0.5.0
-      #
-      class Proxy < Network::Proxy
-
-        #
-        # Opens the UDP Proxy.
-        #
-        # @api public
-        #
-        def open
-          @socket = UDPSocket.new
-          @socket.bind(@host,@port)
-        end
-
-        #
-        # Polls the connections for data/errors and the proxy socket for
-        # new client connections.
-        #
-        # @api public
-        #
-        def poll
-          sockets = [@socket] + server_connections
-
-          readable, writtable, errors = IO.select(sockets,nil,sockets)
-
-          (errors & server_connections).each do |server_socket|
-            client_socket = client_connection_for(server_socket)
-
-            close_connection(client_socket,server_socket)
-          end
-
-          (readable & server_connections).each do |server_socket|
-            client_socket  = client_connection_for(server_socket)
-            data, addrinfo = recv(server_socket)
-
-            server_data(client_socket,server_socket,data)
-          end
-
-          if readable.include?(@socket)
-            data, addrinfo = recv(@socket)
-
-            client_socket = [@socket, [addrinfo[3], addrinfo[1]]]
-            server_socket = (@connections[client_socket] ||= open_server_connection)
-
-            client_data(client_socket,server_socket,data)
-          end
-        end
-
-        #
-        # Sends data to a connection.
-        #
-        # @param [UDPSocket, (UDPSocket, (String, Integer))] connection
-        #   The connection from the proxy to the server, or the proxy socket
-        #   and host/port of the client.
-        #
-        # @param [String] data
-        #   The data to be sent.
-        #
-        # @api public
-        #
-        def send(connection,data)
-          case connection
-          when Array
-            socket, (host, port) = connection
-
-            socket.send(data,0,host,port)
-          when UDPSocket
-            connection.send(data,0)
-          end
-        end
-
-        #
-        # Receives data from a connection.
-        #
-        # @param [UDPSocket, (UDPSocket, (String, Integer))] connection
-        #   The connection from the proxy to the server, or the proxy socket
-        #   and the address of a client.
-        #
-        # @return [String, (String, Array)]
-        #   The data received.
-        #
-        # @api public
-        #
-        def recv(connection)
-          case connection
-          when Array
-            socket, (host, port) = connection
-
-            socket.recvfrom(@buffer_size)
-          when UDPSocket
-            connection.recvfrom(@buffer_size)
-          end
-        end
-
-        protected
-
-        #
-        # Creates a new connection from the proxy to the server.
-        #
-        # @return [UDPSocket]
-        #   The new UDPSocket to the server.
-        #
-        def open_server_connection
-          socket = UDPSocket.new
-          socket.connect(@server_host,@server_port)
-
-          return socket
-        end
-
-        #
-        # Closes a connection from the client to the proxy.
-        #
-        # @param [(UDPSocket, (String, Integer))] connection
-        #   The UDP Proxy socket and the host/port of the client.
-        #
-        # @note no-op
-        #
-        def close_client_connection(connection)
-          # no-op
-        end
-
-        #
-        # Closes the connection from the proxy to the server.
-        #
-        # @param [UDPSocket] connection
-        #   The UDPSocket from the proxy to the server.
-        #
-        def close_server_connection(connection)
-          connection.close
-        end
-
-        #
-        # Closes the UDP proxy socket.
-        #
-        def close_proxy
-          @socket.close
-        end
-
-      end
-    end
-  end
-end