ronin 0.2.4 → 0.3.0

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

@@ -0,0 +1,158 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+require 'ronin/network/helpers/helper'
+require 'ronin/network/telnet'
+
+module Ronin
+  module Network
+    module Helpers
+      module Telnet
+        include Helper
+
+        protected
+
+        #
+        # Creates a connection to a Telnet server. The +@host+, +@port+,
+        # +@telnet_user+, +@telnet_password+, +@telnet_proxy+ and
+        # +@telnet_ssl+ instance variables will also be used to connect
+        # to the Telnet server.
+        #
+        # @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 [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
+        #
+        # @since 0.3.0
+        #
+        def telnet_connect(options={},&block)
+          require_variable :host
+
+          options[:port] ||= @port
+          options[:user] ||= @telnet_user
+          options[:password] ||= @telnet_password
+
+          options[:proxy] ||= @telnet_proxy
+          options[:ssl] ||= @telnet_ssl
+
+          if @port
+            print_info "Connecting to #{@host}:#{@port} ..."
+          else
+            print_info "Connecting to #{@host} ..."
+          end
+
+          return ::Net.telnet_connect(@host,options,&block)
+        end
+
+        #
+        # Starts a session with a Telnet server. The +@host+, +@port+,
+        # +@telnet_user+, +@telnet_password+, +@telnet_proxy+ and
+        # +@telnet_ssl+ instance variables 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 telnet_connect
+        # @since 0.3.0
+        #
+        def telnet_session(options={},&block)
+          return telnet_connect(options) do |sess|
+            block.call(sess) if block
+            sess.close
+
+            if @port
+              print_info "Disconnecting to #{@host}:#{@port}"
+            else
+              print_info "Disconnecting to #{@host}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,197 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+require 'ronin/network/helpers/helper'
+require 'ronin/network/udp'
+
+module Ronin
+  module Network
+    module Helpers
+      module UDP
+        include Helper
+
+        protected
+
+        #
+        # Opens a UDP connection to the host and port specified by the
+        # +@host+ and +@port+ instance variables. If the +@local_host+ and
+        # +@local_port+ instance variables are set, they will be used for
+        # the local host and port of the UDP connection.
+        #
+        # @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
+        #   udp_connect
+        #   # => UDPSocket
+        #
+        # @example
+        #   udp_connect do |sock|
+        #     puts sock.readlines
+        #   end
+        #
+        # @since 0.3.0
+        #
+        def udp_connect(&block)
+          require_variable :host
+          require_variable :port
+
+          print_info "Connecting to #{@host}:#{@port} ..."
+
+          return ::Net.udp_connect(@host,@port,@local_host,@local_port,&block)
+        end
+
+        #
+        # Connects to the host and port specified by the +@host+ and +@port+
+        # instance variables, then sends the specified _data_. If the
+        # +@local_host+ and +@local_port+ instance variables are set, they
+        # will be used for the local host and port of the UDP connection.
+        #
+        # @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 [UDPsocket] socket
+        #   The newly created UDPSocket object.
+        #
+        # @return [UDPSocket]
+        #   The newly created UDPSocket object.
+        #
+        # @since 0.3.0
+        #
+        def udp_connect_and_send(data,&block)
+          require_variable :host
+          require_variable :port
+
+          print_info "Connecting to #{@host}:#{@port} ..."
+          print_debug "Sending data: #{data.inspect}"
+
+          return ::Net.udp_connect_and_send(data,@host,@port,@local_host,@local_port,&block)
+        end
+
+        #
+        # Creates a UDP session to the host and port specified by the
+        # +@host+ and +@port+ instance variables. If the +@local_host+ and
+        # +@local_port+ instance variables are set, they will be used for
+        # the local host and port of the UDP connection.
+        #
+        # @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.
+        #
+        # @since 0.3.0
+        #
+        def udp_session(&block)
+          require_variable :host
+          require_variable :port
+
+          print_info "Connecting to #{@host}:#{@port} ..."
+
+          ::Net.udp_session(@host,@port,@local_host,@local_port,&block)
+
+          print_info "Disconnected from #{@host}:#{@port}"
+          return nil
+        end
+
+        #
+        # Creates a new UDPServer object listening on +server_host+ and
+        # +server_port+.
+        #
+        # @yield [server]
+        #   The given block will be passed the newly created server.
+        #
+        # @yieldparam [UDPServer] server
+        #   The newly created server.
+        #
+        # @return [UDPServer]
+        #   The newly created server.
+        #
+        # @example
+        #   udp_server
+        #
+        # @since 0.3.0
+        #
+        def udp_server(&block)
+          require_variable :server_port
+
+          if @server_host
+            print_info "Listening on #{@server_host}:#{@server_port} ..."
+          else
+            print_info "Listening on #{@server_port} ..."
+          end
+
+          return ::Net.udp_server(@server_port,@server_host,&block)
+        end
+
+        #
+        # Creates a new UDPServer object listening on +server_host+ and
+        # +server_port+, passing it to the given _block then closing the
+        # server.
+        #
+        # @yield [server]
+        #   The given block will be passed the newly created server.
+        #   When the block has finished, the server will be closed.
+        #
+        # @yieldparam [UDPServer] server
+        #   The newly created server.
+        #
+        # @return [nil]
+        #
+        # @example
+        #   udp_server_session do |server|
+        #     data, sender = server.recvfrom(1024)
+        #   end
+        #
+        # @since 0.3.0
+        #
+        def udp_server_session(&block)
+          require_variable :server_port
+
+          if @server_host
+            print_info "Listening on #{@server_host}:#{@server_port} ..."
+          else
+            print_info "Listening on #{@server_port} ..."
+          end
+
+          ::Net.udp_server_session(&block)
+
+          if @server_host
+            print_info "Closed #{@server_host}:#{@server_port}"
+          else
+            print_info "Closed #{@server_port}"
+          end
+
+          return nil
+        end
+      end
+    end
+  end
+end

data/lib/ronin/network/http.rb

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -18,159 +16,8 @@
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
-#++
 #
 
+require 'ronin/network/http/exceptions'
+require 'ronin/network/http/http'
 require 'ronin/network/extensions/http'
-require 'ronin/network/http/exceptions/unknown_request'
-
-module Ronin
-  module Network
-    module HTTP
-      # Common HTTP proxy port
-      COMMON_PROXY_PORT = 8080
-
-      #
-      # Returns the default Ronin HTTP proxy port to use for HTTP proxies.
-      #
-      def HTTP.default_proxy_port
-        @@http_default_proxy_port ||= COMMON_PROXY_PORT
-      end
-
-      #
-      # Sets the default Ronin HTTP proxy port to the specified _port_.
-      #
-      def HTTP.default_proxy_port=(port)
-        @@http_default_proxy_port = port
-      end
-
-      #
-      # Returns the default Ronin HTTP proxy hash.
-      #
-      def HTTP.default_proxy
-        {:host => nil, :port => HTTP.default_proxy_port, :user => nil, :pass => nil}
-      end
-
-      #
-      # Returns the Ronin HTTP proxy hash.
-      #
-      def HTTP.proxy
-        @@http_proxy ||= default_proxy
-      end
-
-      #
-      # Resets the Ronin HTTP proxy setting.
-      #
-      def HTTP.disable_proxy
-        @@http_proxy = default_proxy
-      end
-
-      #
-      # Returns the default Ronin HTTP User-Agent.
-      #
-      def HTTP.user_agent
-        @@http_user_agent ||= nil
-      end
-
-      #
-      # Sets the default Ronin HTTP User-Agent to the specified _agent_.
-      #
-      def HTTP.user_agent=(agent)
-        @@http_user_agent = agent
-      end
-
-      #
-      # Expands the given HTTP _options_.
-      #
-      def HTTP.expand_options(options={})
-        new_options = options.dup
-
-        if new_options[:url]
-          url = URI(new_options.delete(:url).to_s)
-
-          new_options[:host] = url.host
-          new_options[:port] = url.port
-
-          new_options[:user] = url.user if url.user
-          new_options[:password] = url.password if url.password
-
-          unless url.path.empty?
-            new_options[:path] = url.path
-          else
-            new_options[:path] = '/'
-          end
-
-          new_options[:path] << "?#{url.query}" if url.query
-        else
-          new_options[:port] ||= ::Net::HTTP.default_port
-          new_options[:path] ||= '/'
-        end
-
-        if (proxy = new_options[:proxy])
-          proxy[:port] ||= Ronin::Network::HTTP.default_proxy_port
-        else
-          new_options[:proxy] = Ronin::Network::HTTP.proxy
-        end
-
-        return new_options
-      end
-
-      #
-      # Returns Ronin HTTP headers created from the given _options_.
-      #
-      def HTTP.headers(options={})
-        headers = {}
-
-        if HTTP.user_agent
-          headers['User-Agent'] = HTTP.user_agent
-        end
-
-        if options
-          options.each do |name,value|
-            header_name = name.to_s.split(/[\s+_-]/).map { |word|
-              word.capitalize
-            }.join('-')
-
-            headers[header_name] = value.to_s
-          end
-        end
-
-        return headers
-      end
-
-      #
-      # Creates an HTTP request object with the specified _type_ and
-      # given _options_. If type does not represent the name of an Net:HTTP
-      # Request Class an UnknownRequest exception will be raised.
-      #
-      def HTTP.request(options={})
-        unless options[:method]
-          raise(ArgumentError,"the :method option must be specified",caller)
-        end
-
-        name = options[:method].to_s.capitalize
-
-        unless Net::HTTP.const_defined?(name)
-          raise(UnknownRequest,"unknown HTTP request type #{name.dump}",caller)
-        end
-
-        headers = HTTP.headers(options[:headers])
-        path = (options[:path] || '/').to_s
-
-        request = Net::HTTP.const_get(name).new(path,headers)
-
-        if (user = options.delete(:user))
-          user = user.to_s
-
-          if (password = options.delete(:password))
-            password = password.to_s
-          end
-
-          request.basic_auth(user,password)
-        end
-
-        return request
-      end
-    end
-  end
-end