ronin-support 0.2.0 → 0.3.0

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

@@ -0,0 +1,227 @@
+#
+# Copyright (c) 2006-2011 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/udp'
+require 'ronin/ui/output/helpers'
+require 'ronin/mixin'
+
+require 'parameters'
+
+module Ronin
+  module Network
+    module Mixins
+      #
+      # Adds UDP convenience methods and connection parameters to a class.
+      #
+      # Defines the following parameters:
+      #
+      # * `host` (`String`) - UDP host.
+      # * `port` (`Integer`) - UDP port.
+      # * `local_host` (`String`) - UDP local host.
+      # * `local_port` (`Integer`) - UDP local port.
+      # * `server_host` (`String`) - UDP server host.
+      # * `server_port` (`Integer`) - UDP server port.
+      #
+      module UDP
+        include Mixin
+
+        mixin UI::Output::Helpers, Parameters
+
+        mixin do
+          # UDP host
+          parameter :host, :type => String,
+                           :description => 'UDP host'
+
+          # UDP port
+          parameter :port, :type => Integer,
+                           :description => 'UDP port'
+
+          # UDP local host
+          parameter :local_host, :type => String,
+                                 :description => 'UDP local host'
+
+          # UDP local port
+          parameter :local_port, :type => Integer,
+                                 :description => 'UDP local port'
+
+          # UDP server host
+          parameter :server_host, :type => String,
+                                  :description => 'UDP server host'
+
+          # UDP server port
+          parameter :server_port, :type => Integer,
+                                  :description => 'UDP server port'
+        end
+
+        protected
+
+        #
+        # Opens a UDP 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 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
+        #
+        # @api public
+        #
+        def udp_connect(&block)
+          print_info "Connecting to #{self.host}:#{self.port} ..."
+
+          return ::Net.udp_connect(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. If the `local_host` and
+        # `local_port` instance methods 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.
+        #
+        # @api public
+        #
+        def udp_connect_and_send(data,&block)
+          print_info "Connecting to #{self.host}:#{self.port} ..."
+          print_debug "Sending data: #{data.inspect}"
+
+          return ::Net.udp_connect_and_send(data,self.host,self.port,self.local_host,self.local_port,&block)
+        end
+
+        #
+        # Creates a UDP session 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 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.
+        #
+        # @return [nil]
+        #
+        # @api public
+        #
+        def udp_session(&block)
+          print_info "Connecting to #{self.host}:#{self.port} ..."
+
+          ::Net.udp_session(self.host,self.port,self.local_host,self.local_port,&block)
+
+          print_info "Disconnected from #{self.host}:#{self.port}"
+          return nil
+        end
+
+        #
+        # Creates a new UDPServer object listening on `server_host` and
+        # `server_port` parameters.
+        #
+        # @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
+        #
+        # @api public
+        #
+        def udp_server(&block)
+          if self.server_host
+            print_info "Listening on #{self.server_host}:#{self.server_port} ..."
+          else
+            print_info "Listening on #{self.server_port} ..."
+          end
+
+          return ::Net.udp_server(self.server_port,self.server_host,&block)
+        end
+
+        #
+        # Creates a new temporary UDPServer 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 [UDPServer] server
+        #   The newly created server.
+        #
+        # @return [nil]
+        #
+        # @example
+        #   udp_server_session do |server|
+        #     data, sender = server.recvfrom(1024)
+        #   end
+        #
+        # @api public
+        #
+        def udp_server_session(&block)
+          if self.server_host
+            print_info "Listening on #{self.server_host}:#{self.server_port} ..."
+          else
+            print_info "Listening on #{self.server_port} ..."
+          end
+
+          ::Net.udp_server_session(&block)
+
+          if self.server_host
+            print_info "Closed #{self.server_host}:#{self.server_port}"
+          else
+            print_info "Closed #{self.server_port}"
+          end
+
+          return nil
+        end
+      end
+    end
+  end
+end

data/lib/ronin/network/ssl.rb

@@ -19,31 +19,37 @@
 
 require 'ronin/network/extensions/ssl'
 
+begin
+  require 'openssl'
+rescue ::LoadError
+end
+
 module Ronin
   module Network
     #
     # SSL helper methods.
     #
     module SSL
+      # Maps SSL verify modes to `OpenSSL::SSL::VERIFY_*` constants.
       #
-      # Returns the OpenSSL verify mode.
-      #
-      # @param [Symbol, String] mode
-      #   The name of the verify mode.
+      # @return [Hash{Symbol => Integer}]
       #
-      # @return [Integer]
-      #   The verify mode number used by OpenSSL.
+      # @since 1.3.0
       #
       # @api private
       #
-      def SSL.verify(mode=nil)
-        verify_mode = 'VERIFY_' + (mode || :none).to_s.upcase
+      VERIFY = Hash.new do |hash,key|
+        verify_const = if key
+                         "VERIFY_#{key.to_s.upcase}"
+                       else
+                         'VERIFY_NONE'
+                       end
 
-        unless OpenSSL::SSL.const_defined?(verify_mode)
-          raise(RuntimeError,"unknown verify mode #{mode}")
+        unless OpenSSL::SSL.const_defined?(verify_const)
+          raise(RuntimeError,"unknown verify mode #{key}")
         end
 
-        return OpenSSL::SSL.const_get(verify_mode)
+        hash[key] = OpenSSL::SSL.const_get(verify_const)
       end
     end
   end

data/lib/ronin/path.rb

@@ -82,14 +82,14 @@ module Ronin
           raise(ArgumentError,"negative argument")
         end
 
-        path = self.new('..')
+        path = new('..')
         path.separator = separator
 
         dirs = (['..'] * (n-1))
 
         return Path.new(path.join(*dirs))
       when Enumerable
-        return n.map { |i| self.up(i) }
+        return n.map { |i| up(i) }
       else
         raise(ArgumentError,"The first argument of Path.up must be either an Integer or Enumerable")
       end
@@ -120,7 +120,7 @@ module Ronin
       # join the path
       sub_path = names.join(@separator)
 
-      path = if self.root?
+      path = if root?
                # prefix the root dir
                self.to_s + sub_path
              else

data/lib/ronin/spec/ui/output.rb

@@ -0,0 +1,28 @@
+#
+# Copyright (c) 2006-2011 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/ui/output'
+
+require 'rspec'
+
+RSpec.configure do |spec|
+  spec.before(:suite) do
+    Ronin::UI::Output.silent! unless ENV['DEBUG']
+  end
+end

data/lib/ronin/support.rb

@@ -22,5 +22,8 @@ require 'ronin/formatting'
 require 'ronin/network'
 require 'ronin/path'
 require 'ronin/templates'
+require 'ronin/ui/output'
 require 'ronin/support/inflector'
 require 'ronin/support/version'
+
+include Ronin::UI::Output::Helpers

data/lib/ronin/support/version.rb

@@ -20,6 +20,6 @@
 module Ronin
   module Support
     # ronin-support version
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/lib/ronin/ui/output.rb

@@ -0,0 +1,21 @@
+#
+# Copyright (c) 2006-2011 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/ui/output/output'
+require 'ronin/ui/output/helpers'

data/lib/ronin/ui/output/helpers.rb

@@ -0,0 +1,248 @@
+#
+# Copyright (c) 2006-2011 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/ui/output/output'
+
+module Ronin
+  module UI
+    module Output
+      #
+      # Helper methods for printing output.
+      #
+      module Helpers
+        #
+        # Writes data unless output has been silenced.
+        #
+        # @param [String, Object] data
+        #   The data to write.
+        #
+        # @return [Integer, nil]
+        #   The number of bytes written.
+        #
+        # @since 1.0.0
+        #
+        # @api public
+        #
+        def write(data)
+          unless Output.silent?
+            data = data.to_s
+
+            Output.handler.write(data)
+            return data.length
+          end
+        end
+
+        #
+        # Prints a character.
+        #
+        # @param [String, Integer] data
+        #   The character or byte to print.
+        #
+        # @return [String, Integer]
+        #   The byte or character.
+        #
+        # @since 1.0.0
+        #
+        # @api public
+        #
+        def putc(data)
+          char = data.chr if data.kind_of?(Integer)
+
+          write(data)
+          return data
+        end
+
+        #
+        # Prints one or more messages.
+        #
+        # @param [Array] messages
+        #   The messages to print.
+        #
+        # @example
+        #   puts 'some data'
+        #
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        def puts(*messages)
+          unless messages.empty?
+            messages.each { |message| write("#{message}#{$/}") }
+          else
+            write($/)
+          end
+
+          return nil
+        end
+
+        #
+        # Prints formatted data.
+        #
+        # @param [String] format
+        #   The format string.
+        #
+        # @param [Array] data
+        #   The data to format.
+        #
+        # @return [nil]
+        # 
+        # @since 1.0.0
+        #
+        # @api public
+        #
+        def printf(format,*data)
+          write(format % data)
+          return nil
+        end
+
+        #
+        # Prints an `info` message.
+        #
+        # @param [Array] message
+        #   The message to print.
+        #
+        # @return [Boolean]
+        #   Specifies whether the messages were successfully printed.
+        #
+        # @example
+        #   print_info "Connecting ..."
+        #
+        # @example Print a formatted message.
+        #   print_info "Connected to %s", host
+        #
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        def print_info(*message)
+          unless Output.silent?
+            Output.handler.print_info(format_message(message))
+            return true
+          end
+
+          return false
+        end
+
+        #
+        # Prints a `debug` message.
+        #
+        # @param [Array, String] message
+        #   The message to print.
+        #
+        # @return [Boolean]
+        #   Specifies whether the messages were successfully printed.
+        #
+        # @example Print a formatted message.
+        #   print_debug "vars: %p %p", vars[0], vars[1]
+        #
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        def print_debug(*message)
+          if (Output.verbose? && !(Output.silent?))
+            Output.handler.print_debug(format_message(message))
+            return true
+          end
+
+          return false
+        end
+
+        #
+        # Prints a `warning` message.
+        #
+        # @param [Array, String] message
+        #   The message to print.
+        #
+        # @return [Boolean]
+        #   Specifies whether the messages were successfully printed.
+        #
+        # @example
+        #   print_warning "Detecting a restricted character in the buffer"
+        #
+        # @example Print a formatted message.
+        #   print_warning "Malformed input detected: %p", user_input
+        #
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        def print_warning(*message)
+          if (Output.verbose? && !(Output.silent?))
+            Output.handler.print_warning(format_message(message))
+            return true
+          end
+          
+          return false
+        end
+
+        #
+        # Prints an `error` message.
+        #
+        # @param [Array, String] message
+        #   The message to print.
+        #
+        # @return [Boolean]
+        #   Specifies whether the messages were successfully printed.
+        #
+        # @example
+        #   print_error "Could not connect!"
+        #
+        # @example Print a formatted message.
+        #   print_error "%p: %s", error.class, error.message
+        #
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        def print_error(*message)
+          unless Output.silent?
+            Output.handler.print_error(format_message(message))
+            return true
+          end
+
+          return false
+        end
+
+        protected
+
+        #
+        # Formats a message to be printed.
+        #
+        # @param [Array] message
+        #   The message and additional Objects to format.
+        #
+        # @return [String]
+        #   The formatted message.
+        #
+        # @since 1.0.0
+        #
+        # @api private
+        #
+        def format_message(message)
+          if message.length == 1
+            message[0]
+          else
+            message[0] % message[1..-1]
+          end
+        end
+      end
+    end
+  end
+end