ronin-support 0.5.1 → 1.0.0.beta1

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

@@ -1,368 +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/mixins/mixin'
-require 'ronin/network/tcp'
-
-module Ronin
-  module Network
-    module Mixins
-      #
-      # Adds TCP convenience methods and connection parameters to a class.
-      #
-      # Defines the following parameters:
-      #
-      # * `host` (`String`) - TCP host.
-      # * `port` (`Integer`) - TCP port.
-      # * `local_host` (`String`) - TCP local host.
-      # * `local_port` (`Integer`) - TCP local port.
-      # * `server_host` (`String`) - TCP server host.
-      # * `server_port` (`Integer`) - TCP server port.
-      #
-      module TCP
-        include Mixin, Network::TCP
-
-        # TCP host
-        parameter :host, :type => String,
-                         :description => 'TCP host'
-
-        # TCP port
-        parameter :port, :type => Integer,
-                         :description => 'TCP port'
-
-        # TCP local host
-        parameter :local_host, :type => String,
-                               :description => 'TCP local host'
-
-        # TCP local port
-        parameter :local_port, :type => Integer,
-                               :description => 'TCP local port'
-
-        # TCP server host
-        parameter :server_host, :type => String,
-                                :description => 'TCP server host'
-
-        # TCP server port
-        parameter :server_port, :type => Integer,
-                                :description => 'TCP server port'
-
-        protected
-
-        #
-        # Tests whether the TCP port, specified by the `host` and `port`
-        # parameters, is open.
-        #
-        # @param [Integer] timeout (5)
-        #   The maximum time to attempt connecting.
-        #
-        # @return [Boolean, nil]
-        #   Specifies whether the remote TCP port is open.
-        #   If the connection was not accepted, `nil` will be returned.
-        #
-        # @see Network::TCP#tcp_open?
-        #
-        # @api public
-        #
-        # @since 0.5.0
-        #
-        def tcp_open?(timeout=nil)
-          print_info "Testing if #{host_port} is open ..."
-
-          super(self.host,self.port,self.local_host,self.local_port,timeout)
-        end
-
-        #
-        # Opens a TCP connection to the host and port specified by the
-        # `host` and `port` parameters. If the `local_host` and
-        # `local_port` parameters are set, they will be used for
-        # the local host and port of the TCP connection.
-        #
-        # @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 # => TCPSocket
-        #
-        # @example
-        #   tcp_connect do |socket|
-        #     socket.write("GET / HTTP/1.1\n\r\n\r")
-        #
-        #     puts socket.readlines
-        #     socket.close
-        #   end
-        #
-        # @see Network::TCP#tcp_connect
-        #
-        # @api public
-        #
-        def tcp_connect(&block)
-          print_info "Connecting to #{host_port} ..."
-
-          return super(self.host,self.port,self.local_host,self.local_port,&block)
-        end
-
-        #
-        # Connects to the host and port specified by the `host` and `port`
-        # parameters, then sends the given data.
-        #
-        # @param [String] data
-        #   The data to send through the connection.
-        #
-        # @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.
-        #
-        # @see Network::TCP#tcp_connect_and_send
-        #
-        # @api public
-        #
-        def tcp_connect_and_send(data,&block)
-          print_info "Connecting to #{host_port} ..."
-          print_debug "Sending data: #{data.inspect}"
-
-          return super(data,self.host,self.port,self.local_host,self.local_port,&block)
-        end
-
-        #
-        # Creates a TCP session to the host and port specified by the
-        # `host` and `port` parameters.
-        #
-        # @yield [socket]
-        #   If a block is given, it will be passed the newly created socket.
-        #   After the block has returned, the socket will be closed.
-        #
-        # @yieldparam [TCPsocket] socket
-        #   The newly created TCPSocket object.
-        #
-        # @return [nil]
-        #
-        # @see Network::TCP#tcp_session
-        #
-        # @api public
-        #
-        def tcp_session(&block)
-          print_info "Connecting to #{host_port} ..."
-
-          super(self.host,self.port,self.local_host,self.local_port,&block)
-
-          print_info "Disconnected from #{host_port}"
-          return nil
-        end
-
-        #
-        # Connects to the host and port specified by the `host` and `port`
-        # parameters, reads the banner then closes the connection.
-        #
-        # @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
-        #   # => "220 mx.google.com ESMTP c20sm3096959rvf.1"
-        #
-        # @see Network::TCP#tcp_banner
-        #
-        # @api public
-        #
-        def tcp_banner(&block)
-          print_debug "Grabbing banner from #{host_port}"
-
-          return super(self.host,self.port,self.local_host,self.local_port,&block)
-        end
-
-        #
-        # Connects to the host and port specified by the `host` and `port`
-        # parameters, sends the given data and then disconnects.
-        #
-        # @return [true]
-        #   The data was successfully sent.
-        #
-        # @example
-        #   buffer = "GET /" + ('A' * 4096) + "\n\r"
-        #   tcp_send(buffer)
-        #   # => true
-        #
-        # @see Network::TCP#tcp_send
-        #
-        # @api public
-        #
-        def tcp_send(data)
-          print_info "Connecting to #{host_port} ..."
-          print_debug "Sending data: #{data.inspect}"
-
-          super(data,self.host,self.port,self.local_host,self.local_port)
-
-          print_info "Disconnected from #{host_port}"
-          return true
-        end
-
-        #
-        # Creates a new TCPServer object listening on the `server_host`
-        # and `server_port` parameters.
-        #
-        # @yield [server]
-        #   The given block will be passed the newly created server.
-        #
-        # @yieldparam [TCPServer] server
-        #   The newly created server.
-        #
-        # @return [TCPServer]
-        #   The newly created server.
-        #
-        # @example
-        #   tcp_server
-        #
-        # @see Network::TCP#tcp_server
-        #
-        # @api public
-        #
-        def tcp_server(&block)
-          print_info "Listening on #{self.server_host_port} ..."
-
-          return super(self.server_port,self.server_host,&block)
-        end
-
-        #
-        # Creates a new temporary TCPServer object listening on the
-        # `server_host` and `server_port` parameters.
-        #
-        # @yield [server]
-        #   The given block will be passed the newly created server.
-        #   When the block has finished, the server will be closed.
-        #
-        # @yieldparam [TCPServer] server
-        #   The newly created server.
-        #
-        # @return [nil]
-        #
-        # @example
-        #   tcp_server_session do |server|
-        #     client1 = server.accept
-        #     client2 = server.accept
-        #
-        #     client2.write(server.read_line)
-        #
-        #     client1.close
-        #     client2.close
-        #   end
-        #
-        # @see Network::TCP#tcp_server_session
-        #
-        # @api public
-        #
-        def tcp_server_session(&block)
-          print_info "Listening on #{server_host_port} ..."
-
-          super(self.server_port,self.server_host,&block)
-
-          print_info "Closed #{server_host_port}"
-          return nil
-        end
-
-        #
-        # Creates a new temporary TCPServer object listening on
-        # `server_host` and `server_port` parameters.
-        # The TCPServer will accepting one client, pass the newly connected
-        # client to a given block, disconnects the client and stops
-        # listening.
-        #
-        # @yield [client]
-        #   The given block will be passed the newly connected client.
-        #   When the block has finished, the newly connected client and
-        #   the server will be closed.
-        #
-        # @yieldparam [TCPSocket] client
-        #   The newly connected client.
-        #
-        # @return [nil]
-        #
-        # @example
-        #   tcp_accept do |client|
-        #     client.puts 'lol'
-        #   end
-        #
-        # @see Network::TCP#tcp_accept
-        #
-        # @api public
-        #
-        # @since 0.5.0
-        #
-        def tcp_accept(&block)
-          print_info "Listening on #{server_host_port} ..."
-
-          super(self.server_port,self.server_host) do |client|
-            client_addr = client.peeraddr
-            client_host = (client_addr[2] || client_addr[3])
-            client_port = client_addr[1]
-
-            print_info "Client connected #{client_host}:#{client_port}"
-
-            yield client if block_given?
-
-            print_info "Disconnected client #{client_host}:#{client_port}"
-          end
-
-          print_info "Closed #{server_host_port}"
-          return nil
-        end
-
-        #
-        # @deprecated
-        #   Deprecated as of 0.5.0. Use {#tcp_accept} instead.
-        #
-        def tcp_single_server(&block)
-          tcp_accept(&block)
-        end
-
-        private
-
-        #
-        # The server host/port parameters.
-        #
-        # @return [String]
-        #   The server host/port parameters in String form.
-        #
-        # @since 0.4.0
-        #
-        # @api private
-        #
-        def server_host_port
-          "#{self.server_host}:#{self.server_port}"
-        end
-      end
-    end
-  end
-end

data/lib/ronin/network/mixins/telnet.rb

@@ -1,208 +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/mixins/mixin'
-require 'ronin/network/telnet'
-
-module Ronin
-  module Network
-    module Mixins
-      #
-      # Adds Telnet convenience methods and connection parameters to a
-      # class.
-      #
-      # Defines the following parameters:
-      #
-      # * `host` (`String`) - Telnet host.
-      # * `port` (`Integer`) - Telnet port.
-      # * `telnet_user` (`String`) - Telnet user to login as.
-      # * `telnet_password` (`String`) - Telnet password to login with.
-      # * `telnet_proxy` (`String`) - Telnet proxy.
-      # * `telnet_ssl` (`Boolean`) - Enable Telnet over SSL. Defaults to `true`.
-      #
-      module Telnet
-        include Mixin, Network::Telnet
-
-        # Telnet host
-        parameter :host, :type => String,
-                         :description => 'Telnet host'
-
-        # Telnet port
-        parameter :port, :type => Integer,
-                         :description => 'Telnet port'
-
-        # Telnet user
-        parameter :telnet_user, :type => String,
-                                :description => 'Telnet user to login as'
-
-        # Telnet password
-        parameter :telnet_password, :type => String,
-                                    :description => 'Telnet password to login with'
-
-        # Telnet proxy
-        parameter :telnet_proxy, :description => 'Telnet proxy'
-
-        # Enable Telnet SSL
-        parameter :telnet_ssl, :type => true,
-                               :description => 'Enable Telnet over SSL'
-
-        protected
-
-        #
-        # Creates a connection to a Telnet server. The `host`, `port`,
-        # `telnet_user`, `telnet_password`, `telnet_proxy` and
-        # `telnet_ssl` parameters will also be used to connect to the
-        # Telnet server.
-        #
-        # @param [Hash] options
-        #   Additional options.
-        #
-        # @option options [Integer] :port (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 (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 (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 (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 [connection]
-        #   If a block is given, it will be passed the newly created
-        #   Telnet connection.
-        #
-        # @yieldparam [Net::Telnet] connection
-        #   The newly created Telnet connection.
-        #
-        # @return [Net::Telnet]
-        #   The Telnet session
-        #
-        # @example
-        #   telnet_connect
-        #   # => Net::Telnet
-        #
-        # @see Network::Telnet#telnet_connect
-        #
-        # @api public
-        #
-        def telnet_connect(options={},&block)
-          print_info "Connecting to #{host_port} ..."
-
-          return super(self.host,telnet_merge_options(options),&block)
-        end
-
-        #
-        # Starts a session with a Telnet server. The `host`, `port`,
-        # `telnet_user`, `telnet_password`, `telnet_proxy` and
-        # `telnet_ssl` parameters will also be used to connect to the
-        # Telnet server.
-        #
-        # @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.
-        #
-        # @example
-        #   telnet_session do |movie|
-        #     movie.each_line { |line| puts line }
-        #   end
-        #
-        # @see Network::Telnet#telnet_session
-        #
-        # @api public
-        #
-        def telnet_session(options={},&block)
-          super(telnet_merge_options(options)) do |sess|
-            yield sess if block_given?
-
-            print "Logging out ..."
-          end
-
-          print_info "Disconnected to #{host_port}"
-          return nil
-        end
-
-        private
-
-        #
-        # Merges the Telnet parameters into the options for {Network::Telnet}
-        # methods.
-        #
-        # @param [Hash] options
-        #   The original options.
-        #
-        # @return [Hash]
-        #   The merged options.
-        #
-        # @since 0.4.0
-        #
-        # @api private
-        #   
-        def telnet_merge_options(options={})
-          options[:port]     ||= self.port
-          options[:user]     ||= self.telnet_user
-          options[:password] ||= self.telnet_password
-
-          options[:proxy] ||= self.telnet_proxy
-          options[:ssl]   ||= self.telnet_ssl
-
-          return options
-        end
-      end
-    end
-  end
-end