ronin 0.2.4 → 0.3.0

data/lib/ronin/ui/hexdump.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,7 +16,6 @@
 # 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/ui/hexdump/hexdump'

data/lib/ronin/ui/hexdump/extensions.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,7 +16,6 @@
 # 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/ui/hexdump/extensions/file'

data/lib/ronin/ui/hexdump/extensions/file.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,7 +16,6 @@
 # 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/ui/hexdump/hexdump'
@@ -26,8 +23,13 @@ require 'ronin/ui/hexdump/hexdump'
 class File
 
   #
-  # Hexdumps the contents of the File at the specified _path_
-  # to the given _output_ stream.
+  # Hexdumps the contents of the File.
+  #
+  # @param [String] path
+  #   The path to the File to hexdump.
+  #
+  # @param [IO] output
+  #   The output stream to print the hexdump to.
   #
   def self.hexdump(path,output=STDOUT)
     self.open(path) do |file|

data/lib/ronin/ui/hexdump/extensions/kernel.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,14 +16,15 @@
 # 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/ui/hexdump/hexdump'
 
 module Kernel
   #
-  # Hexdumps the specified _object_ to the given _output_ stream.
+  # Hexdumps an object.
+  #
+  # @see Ronin::UI::Hexdump.dump
   #
   def hexdump(object,output=STDOUT)
     Ronin::UI::Hexdump.dump(object,output)

data/lib/ronin/ui/hexdump/hexdump.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,14 +16,19 @@
 # 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
-#++
 #
 
 module Ronin
   module UI
     module Hexdump
       #
-      # Hexdumps the specified _object_ to the given _output_ stream.
+      # Hexdumps an object.
+      #
+      # @param [#each_byte] object
+      #   The object to hexdump, must respond to the +each_byte+ method.
+      #
+      # @param [IO] output
+      #   The output stream to print the hexdump to.
       #
       def Hexdump.dump(object,output=STDOUT)
         index = 0

data/lib/ronin/{sessions/exceptions.rb → ui/output.rb}

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A ruby development 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,7 +16,7 @@
 # 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/sessions/exceptions/variable_missing'
+require 'ronin/ui/output/output'
+require 'ronin/ui/output/helpers'

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

@@ -0,0 +1,121 @@
+#
+# 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 'thor/shell/basic'
+require 'thor/shell/color'
+
+module Ronin
+  module UI
+    module Output
+      module Handler
+        #
+        # The shell to use for output.
+        #
+        # @since 0.3.0
+        #
+        def self.shell
+          @@ronin_output_shell ||= Thor::Shell::Color.new
+        end
+
+        #
+        # Changes color output.
+        #
+        # @param [Boolean] mode
+        #   The new color mode.
+        #
+        # @return [Boolean]
+        #   The new color mode.
+        #
+        # @since 0.3.0
+        #
+        def Handler.color=(mode)
+          if mode
+            @@ronin_output_shell = Thor::Shell::Color.new
+          else
+            @@ronin_output_shell = Thor::Shell::Basic.new
+          end
+
+          return mode
+        end
+
+        #
+        # Prints one or more messages.
+        #
+        # @param [Array] messages
+        #   The messages to print.
+        #
+        # @since 0.3.0
+        #
+        def self.puts(*messages)
+          Kernel.puts(*messages)
+        end
+
+        #
+        # Prints one or more messages as +info+ messages.
+        #
+        # @param [Array] messages
+        #   The messages to print.
+        #
+        # @since 0.3.0
+        #
+        def self.print_info(*messages)
+          shell.say messages.map { |mesg| "[-] #{mesg}" }.join($/), :green
+        end
+
+        #
+        # Prints one or more messages as +debug+ mssages.
+        #
+        # @param [Array] messages
+        #   The messages to print.
+        #
+        # @since 0.3.0
+        #
+        def self.print_debug(*messages)
+          shell.say messages.map { |mesg| "[+] #{mesg}" }.join($/), :cyan
+        end
+
+        #
+        # Prints one or more messages as +warning+ mssages.
+        #
+        # @param [Array] messages
+        #   The messages to print.
+        #
+        # @since 0.3.0
+        #
+        def self.print_warning(*messages)
+          shell.say messages.map { |mesg| "[*] #{mesg}" }.join($/), :yellow
+        end
+
+        #
+        # Prints one or more messages as +error+ mssages.
+        #
+        # @param [Array] messages
+        #   The messages to print.
+        #
+        # @since 0.3.0
+        #
+        def self.print_error(*messages)
+          shell.say messages.map { |mesg| "[!] #{mesg}" }.join($/), :red
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,110 @@
+#
+# 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/ui/output/output'
+
+module Ronin
+  module UI
+    module Output
+      module Helpers
+        protected
+
+        #
+        # Prints one or more messages.
+        #
+        # @param [Array] messages
+        #   The messages to print.
+        #
+        # @example
+        #   puts 'some data'
+        #
+        # @since 0.3.0
+        #
+        def puts(*messages)
+          Output.handler.puts(*messages) unless Output.silent?
+        end
+
+        #
+        # Prints one or more messages as +info+ output.
+        #
+        # @param [Array] messages
+        #   The messages to print.
+        #
+        # @example
+        #   print_info 'Connecting ...'
+        #
+        # @since 0.3.0
+        #
+        def print_info(*messages)
+          Output.handler.print_info(*messages) unless Output.silent?
+        end
+
+        #
+        # Prints one or more messages as +debug+ output.
+        #
+        # @param [Array] messages
+        #   The messages to print.
+        #
+        # @example
+        #   print_debug "var1: #{var1.inspect}"
+        #
+        # @since 0.3.0
+        #
+        def print_debug(*messages)
+          if (Output.verbose? && !(Output.silent?))
+            Output.handler.print_debug(*messages)
+          end
+        end
+
+        #
+        # Prints one or more messages as +warning+ output.
+        #
+        # @param [Array] messages
+        #   The messages to print.
+        #
+        # @example
+        #   print_warning 'Detecting a restricted character in the buffer'
+        #
+        # @since 0.3.0
+        #
+        def print_warning(*messages)
+          if (Output.verbose? && !(Output.silent?))
+            Output.handler.print_warning(*messages)
+          end
+        end
+
+        #
+        # Prints one or more messages as +error+ output.
+        #
+        # @param [Array] messages
+        #   The messages to print.
+        #
+        # @example
+        #   print_error 'Could not connect!'
+        #
+        # @since 0.3.0
+        #
+        def print_error(*messages)
+          Output.handler.print_error(*messages) unless Output.silent?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,144 @@
+#
+# 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/ui/output/handler'
+
+module Ronin
+  module UI
+    module Output
+      #
+      # @return [Boolean]
+      #   Specifies whether verbose output is enabled.
+      #
+      # @since 0.3.0
+      #
+      def Output.verbose?
+        (@@ronin_verbose ||= :quiet) == :verbose
+      end
+
+      #
+      # @return [Boolean]
+      #   Specifies whether quiet output is enabled.
+      #
+      # @since 0.3.0
+      #
+      def Output.quiet?
+        (@@ronin_verbose ||= :quiet) == :quiet
+      end
+
+      #
+      # @return [Boolean]
+      #   Specifies whether silent output is enabled.
+      #
+      # @since 0.3.0
+      #
+      def Output.silent?
+        (@@ronin_verbose ||= :quiet) == :silent
+      end
+
+      #
+      # Changes the verbose mode.
+      #
+      # @param [Boolean] mode
+      #   The new verbose mode.
+      #
+      # @return [Boolean]
+      #   The new verbose mode.
+      #
+      # @since 0.3.0
+      #
+      def Output.verbose=(mode)
+        if mode
+          @@ronin_verbose = :verbose
+        else
+          @@ronin_verbose = :quiet
+        end
+
+        return mode
+      end
+
+      #
+      # Changes verbose output.
+      #
+      # @param [Boolean] mode
+      #   The new quiet mode.
+      #
+      # @return [Boolean]
+      #   The new quiet mode.
+      #
+      # @since 0.3.0
+      #
+      def Output.quiet=(mode)
+        if mode
+          @@ronin_verbose = :quiet
+        else
+          @@ronin_verbose = :verbose
+        end
+
+        return mode
+      end
+
+      #
+      # Changes verbose output.
+      #
+      # @param [Boolean] mode
+      #   The new quiet mode.
+      #
+      # @return [Boolean]
+      #   The new quiet mode.
+      #
+      # @since 0.3.0
+      #
+      def Output.silent=(mode)
+        if mode
+          @@ronin_verbose = :silent
+        else
+          @@ronin_verbose = :quiet
+        end
+
+        return mode
+      end
+
+      #
+      # @return [Ronin::UI::Output::Handler]
+      #   The current Output handler.
+      #
+      # @since 0.3.0
+      #
+      def Output.handler
+        @@ronin_output ||= Handler
+      end
+
+      #
+      # Sets the current Output handler.
+      #
+      # @param [Handler] new_handler
+      #   The new output handler to use. Must provide the +puts+,
+      #   +print_info+, +print_debug+, +print_warning+ and +print_error+
+      #   class methods.
+      #
+      # @since 0.3.0
+      #
+      def Output.handler=(new_handler)
+        @@ronin_output = new_handler
+      end
+    end
+  end
+end