ronin 0.2.4 → 0.3.0

data/lib/ronin/static.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/static/static'

data/lib/ronin/static/finders.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/static/static'

data/lib/ronin/static/static.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 'set'
@@ -26,20 +23,32 @@ require 'set'
 module Ronin
   module Static
     #
-    # The Set of directories which contain static content.
+    # @return [Set]
+    #   The directories which contain static content.
     #
     def Static.static_dirs
       @@ronin_static_dirs ||= Set[]
     end
 
     #
-    # Adds the specified _path_ to the Set of static directories.
+    # Adds the path to the Set of static directories.
+    #
+    # @param [String] path
+    #   The path to add to +static_dirs+.
+    #
+    # @return [String]
+    #   The fully qualified form of the specified _path_.
+    #
+    # @example
+    #   Static.directory(File.join(File.dirname(__FILE__),'..','..','..','static'))
+    #
+    # @raise [RuntimeError] The specified _path_ is not a directory.
     #
     def Static.directory(path)
       path = File.expand_path(path)
 
       unless File.directory?(path)
-        raise("#{path.dump} must be a directory")
+        raise(RuntimeError,"#{path.dump} must be a directory")
       end
 
       Static.static_dirs << path

data/lib/ronin/templates.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,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/templates/template'
 require 'ronin/templates/erb'

data/lib/ronin/templates/erb.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,18 +16,26 @@
 # 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/templates/template'
+
 require 'erb'
 
 module Ronin
   module Templates
     module Erb
+      include Template
+      #
+      # Renders the inline ERB template in the scope of the object.
+      #
+      # @param [String] template
+      #   Source of the ERB template.
       #
-      # Renders the specified inline ERB _template_ in the scope of the
-      # object, returning the resulting +String+.
+      # @return [String]
+      #   Result of the rendered template.
       #
+      # @example
       #   @user = 'lolcats'
       #
       #   erb %{
@@ -43,13 +49,21 @@ module Ronin
       end
 
       #
-      # Renders the ERB template at the specified _path_ in the scope of the
-      # object, returning the resulting +String+.
+      # Renders an ERB template file in the scope of the object.
+      #
+      # @param [String] template_path
+      #   The relative path of the ERB template.
+      #
+      # @return [String]
+      #   Result of the rendered template.
       #
+      # @example
       #   erb_file 'path/to/template.erb'
       #
-      def erb_file(path)
-        erb(File.read(path))
+      def erb_file(template_path)
+        enter_template(template_path) do |path|
+          erb(File.read(path))
+        end
       end
     end
   end

data/lib/ronin/templates/template.rb

@@ -0,0 +1,130 @@
+#
+# 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/static/finders'
+
+module Ronin
+  module Templates
+    module Template
+      include Static::Finders
+
+      protected
+
+      #
+      # A stack of directories to search for other templates within.
+      #
+      # @return [Array]
+      #   The stack of directory paths.
+      #
+      # @since 0.3.0
+      #
+      def template_dirs
+        @template_dirs ||= []
+      end
+
+      #
+      # The first path in +template_dirs+, that will be used to search for
+      # other templates in.
+      #
+      # @return [String, nil]
+      #   Returns the first path in template_dirs, or +nil+ if
+      #   template_dirs is empty.
+      #
+      # @since 0.3.0
+      #
+      def template_dir
+        template_dirs.first
+      end
+
+      #
+      # Finds the template within the +template_dir+ or uses
+      # Static::Finders#find_static_file to search through all
+      # +static+ directories for the template.
+      #
+      # @param [String] sub_path
+      #   The relative path of the template to find.
+      #
+      # @return [String, nil]
+      #   Returns the absolute path to the template, or +nil+ if the
+      #   template could not be found.
+      #
+      # @example
+      #   find_template 'sub/path/template.erb'
+      #
+      # @since 0.3.0
+      #
+      def find_template(sub_path)
+        sub_path = sub_path.to_s
+
+        if template_dir
+          path = File.expand_path(File.join(template_dir,sub_path))
+
+          return path if File.file?(path)
+        end
+
+        return find_static_file(sub_path)
+      end
+
+      #
+      # Finds the template, pushing the directory that the template resides
+      # within to +template_dirs+, calls the given _block_ and then pops
+      # the directory off of +template_dirs+.
+      #
+      # @param [String] sub_path
+      #   The relative path of the template to find.
+      #
+      # @yield [path]
+      #   The block to be called after the directory of the template has
+      #   been pushed onto +template_dirs+. After the block has returned,
+      #   the directory will be popped off of +template_dirs+.
+      #
+      # @yieldparam [String] path
+      #   The absolute path of the template.
+      #
+      # @return [Object]
+      #   Result of the given block.
+      #
+      # @raise [RuntimeError]
+      #   The template was not found.
+      #
+      # @example
+      #   enter_template('sub/path/template.erb') do |path|
+      #     # do stuff with the full path
+      #   end
+      #
+      # @since 0.3.0
+      #
+      def enter_template(sub_path,&block)
+        sub_path = sub_path.to_s
+
+        unless (path = find_template(sub_path))
+          raise(RuntimeError,"could not find template #{sub_path.dump}",caller)
+        end
+
+        template_dirs.unshift(File.dirname(path))
+
+        result = block.call(path)
+
+        template_dirs.shift
+        return result
+      end
+    end
+  end
+end

data/lib/ronin/ui.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,11 +16,9 @@
 # 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/verbose'
-require 'ronin/ui/diagnostics'
+require 'ronin/ui/output'
 require 'ronin/ui/hexdump'
 require 'ronin/ui/console'
 require 'ronin/ui/shell'

data/lib/ronin/ui/command_line.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/command_line/command'

data/lib/ronin/ui/command_line/command.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,127 +16,198 @@
 # 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/command_line/options'
+require 'ronin/ui/output'
+
+require 'thor'
+require 'extlib'
 
 module Ronin
   module UI
     module CommandLine
-      class Command
+      class Command < Thor
 
-        # The name of the command
-        attr_reader :name
+        include Thor::Actions
+        include Output::Helpers
 
-        # The options for the command
-        attr_reader :options
+        default_task :default
+        map '-h' => :help
 
         #
         # Creates a new Command object.
         #
-        def initialize(name,&block)
-          @name = name.to_s
-
-          defaults()
+        # @param [Array] arguments
+        #   Command-line arguments.
+        #
+        # @param [Hash] options
+        #   Additional command-line options.
+        #
+        # @param [Hash] config
+        #   Additional configuration.
+        #
+        def initialize(arguments=[],options={},config={})
+          @indent = 0
 
-          Options.new(@name) do |opts|
-            define_options(opts)
+          super(arguments,options,config)
+        end
 
-            @options = opts
+        def self.start(arguments=ARGV,config={})
+          unless map[arguments.first.to_s]
+            arguments = [default_task] + arguments
           end
 
-          block.call(self) if block
+          super(arguments,config)
         end
 
-        #
-        # Creates a new command object and runs it with the given _args_.
-        #
-        def self.run(*args)
-          name = File.basename($0)
-          name.gsub!(/^ronin-/,'')
+        no_tasks do
+          def invoke(task,arguments)
+            UI::Output.verbose = options.verbose?
+            UI::Output.quiet = options.quiet?
+            UI::Output.silent = options.silent?
 
-          cmd = self.new(name)
+            if options.nocolor?
+              UI::Output::Handler.color = false
+            end
 
-          begin
-            cmd.arguments(*(cmd.options.parse(args)))
-          rescue OptionParser::MissingArgument,
-                 OptionParser::InvalidOption => e
-            STDERR.puts e
-            exit -1
+            super(task,arguments)
           end
-
-          return true
         end
 
-        #
-        # Prints the help information for the command.
-        #
-        def self.help
-          self.new.help
-        end
+        desc "command [ARGS...]", "default task to run"
+        method_option :verbose, :type => :boolean, :default => false, :aliases => '-v'
+        method_option :quiet, :type => :boolean, :default => true, :aliases => '-q'
+        method_option :silent, :type => :boolean, :default => true, :aliases => '-Q'
+        method_option :color, :type => :boolean, :default => true
+        method_option :nocolor, :type => :boolean, :default => false
 
         #
-        # Prints the help information for the command.
+        # Default method to call after the options have been parsed.
         #
-        def help
-          @options.help
-          return self
+        def default(*arguments)
         end
 
+        desc "help", "displays the help for the command"
+
         #
-        # Returns the String form of the command.
+        # Prints the help information for the command and exists.
         #
-        def to_s
-          @name.to_s
+        def help
+          self.class.help(
+            shell, 
+            self.class.default_task,
+            :short => false,
+            :ident => 2,
+            :namespace => false
+          )
         end
 
         protected
 
         #
-        # Prints the specified error _message_.
+        # Returns the name of the command.
         #
-        def error(message)
-          STDERR.puts "ronin: #{@name}: #{message}"
-          return false
+        def name
+          self.class.name.split('::').last.snake_case
         end
 
         #
-        # Calls the specified _block_, then exists with the status code of 0.
+        # Increases the indentation out output temporarily.
         #
-        def success(&block)
-          block.call
-          exit 0
+        # @param [Integer] n
+        #   The number of spaces to increase the indentation by.
+        #
+        # @yield []
+        #   The block will be called after the indentation has been
+        #   increased. After the block has returned, the indentation will
+        #   be returned to normal.
+        #
+        # @return [nil]
+        #
+        def indent(n=2,&block)
+          @indent += n
+
+          block.call()
+
+          @indent -= n
+          return nil
         end
 
         #
-        # Prints the given error _message_ and exits unseccessfully from the
-        # command-line utility. If a _block_ is given, it will be called before
-        # any error _message_ are printed.
+        # Print the given messages with indentation.
         #
-        def fail(message,&block)
-          block.call() if block
-
-          error(message)
-          exit -1
+        # @param [Array] messages
+        #   The messages to print, one per-line.
+        #
+        def puts(*messages)
+          super(*(messages.map { |mesg| (' ' * @indent) + mesg.to_s }))
         end
 
         #
-        # Setup the command default values.
+        # Prints a given title.
         #
-        def defaults
+        # @param [String] title
+        #   The title to print.
+        #
+        def print_title(title)
+          puts "[ #{title} ]"
         end
 
         #
-        # Define the command-line options for the command.
+        # Prints a given Array.
+        #
+        # @param [Array] array 
+        #   The Array to print.
         #
-        def define_options(opts)
+        # @param [Hash] options
+        #   Additional options.
+        #
+        # @option options [String] :title
+        #   The optional title to print before the contents of the Array.
+        #
+        # @return [nil]
+        #
+        def print_array(array,options={})
+          print_title(options[:title]) if options[:title]
+
+          indent do
+            array.each { |value| puts value }
+          end
+
+          puts "\n" if options[:title]
+          return nil
         end
 
         #
-        # Processes the additional arguments specified by _args_.
+        # Prints a given Hash.
+        #
+        # @param [Hash] hash
+        #   The Hash to print.
+        #
+        # @param [Hash] options
+        #   Additional options.
+        #
+        # @option options [String] :title
+        #   The optional title to print before the contents of the Hash.
+        #
+        # @return [nil]
         #
-        def arguments(*args)
+        def print_hash(hash,options={})
+          align = hash.keys.map { |name|
+            name.to_s.length
+          }.max
+
+          print_title(options[:title]) if options[:title]
+
+          indent do
+            hash.each do |name,value|
+              name = "#{name}:".ljust(align)
+              puts "#{name}\t#{value}"
+            end
+          end
+
+          puts "\n" if options[:title]
+          return nil
         end
 
       end