ronin 0.2.4 → 0.3.0

data/lib/ronin/ui/command_line/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/exceptions/unknown_command'
@@ -36,45 +33,63 @@ module Ronin
       DEFAULT_COMMAND = 'console'
 
       #
-      # Returns the commands registered with the command-line utility.
+      # All command-line names of Commands available to the CommandLine.
+      #
+      # @return [Array]
+      #   The command-line names of available Command classes.
       #
       def CommandLine.commands
         unless class_variable_defined?('@@ronin_commands')
           pattern = File.join('lib',COMMANDS_DIR,'*.rb')
-          paths = Gem.find_resources(pattern)
-          
-          @@ronin_commands = []
-            
-          paths.each do |path|
-            name = File.basename(path).gsub(/\.rb$/,'')
-
-            @@ronin_commands << name unless @@ronin_commands.include?(name)
-          end
+
+          @@ronin_commands = Gem.find_resources(pattern).map { |path|
+            File.basename(path).gsub(/\.rb$/,'')
+          }.uniq
         end
 
         return @@ronin_commands
       end
 
       #
-      # Returns +true+ if a command exists with the specified _name_,
-      # returns +false+ otherwise.
+      # Searches for the command with the matching name.
+      #
+      # @param [String, Symbol] name
+      #   The name of the command to search for.
+      #
+      # @return [Boolean]
+      #   Specifies whether a command exists with the matching name.
       #
       def CommandLine.has_command?(name)
         CommandLine.commands.include?(name.to_s)
       end
 
       #
-      # Returns the Command registered with the command-line utility
-      # with the specified _name_.
+      # Searches for a Command class with the matching command-line name.
+      #
+      # @param [String, Symbol] name
+      #   The command-line name of the command to search for.
+      #
+      # @return [Ronin::UI::Command]
+      #   The Command registered with the command-line utility with the
+      #   matching command-line _name_.
       #
+      # @raise [UnknownCommand]
+      #   No valid command could be found or loaded with the matching
+      #   command-line _name_.
+      #
+      # @example
       #   CommandLine.get_command('gen_overlay')
       #   # => Ronin::UI::CommandLine::Commands::GenOverlay
       #
+      # @example
+      #   CommandLine.get_command('gen-overlay')
+      #   # => Ronin::UI::CommandLine::Commands::GenOverlay
+      #
       def CommandLine.get_command(name)
         name = name.to_s
 
-        #eventually someone is going to use a space or - which is going mess things up
-        #we will take care of this ahead of time here
+        # eventually someone is going to use a space or - which is going
+        # mess things up we will take care of this ahead of time here
         name.gsub!(/[\s-]/, '_')
 
         begin
@@ -93,29 +108,37 @@ module Ronin
 
         command = Commands.const_get(class_name)
 
-        unless command.respond_to?(:run)
-          raise(UnknownCommand,"command #{name.dump} must provide a 'run' method",caller)
+        unless command.respond_to?(:start)
+          raise(UnknownCommand,"command #{name.dump} must provide a 'start' method",caller)
         end
 
         return command
       end
 
       #
-      # Runs the command-line utility with the given _argv_ Array. If the
-      # first argument is a sub-command name, the command-line utility will
-      # attempt to find and execute the Command with the same name.
+      # Runs the CommandLine utility. If the first argument is a Command
+      # name, the CommandLine utility will attempt to find and run
+      # the Command with the matching command-line name. If the first
+      # argument is an option, or there are no arguments, the
+      # +DEFAULT_COMMAND+ will be ran.
+      #
+      # @param [Array] argv
+      #   Command-line arguments which are used to select the Command to
+      #   run, and which will be passed to the Command.
+      #
+      # @return [true]
+      #   The command was successfully ran.
       #
-      def CommandLine.run(*argv)
-        if (argv.empty? || argv.first[0..0]=='-')
+      def CommandLine.start(argv=ARGV)
+        if (argv.empty? || argv.first[0,1]=='-')
           name = DEFAULT_COMMAND
-          argv = ARGV
         else
           name = argv.first
           argv = argv[1..-1]
         end
 
         begin
-          CommandLine.get_command(name).run(*argv)
+          CommandLine.get_command(name).start(argv)
         rescue UnknownCommand => e
           STDERR.puts e
           exit -1

data/lib/ronin/ui/command_line/commands/add.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'
@@ -30,73 +27,48 @@ module Ronin
       module Commands
         class Add < Command
 
-          def defaults
-            @cache = nil
-            @media = nil
-            @uri = nil
-          end
-
-          def define_options(opts)
-            opts.usage = 'PATH [options]'
-
-            opts.options do
-              opts.on('-C','--cache DIR','Specify an alternate overlay cache') do |dir|
-                @cache = dir
-              end
-
-              opts.on('-m','--media MEDIA','Spedify the media-type of the overlay') do |media|
-                @media = media.to_sym
-              end
-
-              opts.on('-L','--local','Similiar to: -m local') do
-                @media = nil
-              end
-
-              opts.on('--rsync','Alias for -m rsync') do
-                @media = :rsync
-              end
-
-              opts.on('--svn','Alias for -m svn') do
-                @media = :svn
-              end
-
-              opts.on('--hg','Alias for -m hg') do
-                @media = :hg
-              end
-
-              opts.on('--git','Alias for -m git') do
-                @media = :git
-              end
-
-              opts.on('-U','--uri URI','Specify the source URI of the overlay') do |uri|
-                @uri = uri
-              end
+          desc "add PATH", "Add a local overlay to the Overlay cache"
+          method_option :cache, :type => :string, :aliases => '-C'
+          method_option :media, :type => :string, :aliases => '-m'
+          method_option :local, :type => :boolean, :aliases => '-L'
+          method_option :rsync, :type => :boolean
+          method_option :svn, :type => :boolean
+          method_option :hg, :type => :boolean
+          method_option :git, :type => :boolean
+          method_option :uri, :type => :string, :aliaes => '-U'
+
+          def default(path)
+            if options[:cache]
+              Platform.load_overlays(options[:cache])
             end
 
-            opts.arguments(
-              'PATH' => 'Add the overlay located at the specified PATH'
-            )
-
-            opts.summary %{
-              Add a local overlay located at the specified PATH to the
-              Overlay cache
-            }
-          end
-
-          def arguments(*args)
-            unless args.length == 1
-              fail('only one overlay path maybe specified')
+            overlay_options = {:path => path}
+
+            overlay_options[:media] = if options[:media]
+                                        options[:media].to_sym
+                                      elsif options.local?
+                                        nil
+                                      elsif options.rsync?
+                                        :rsync
+                                      elsif options.svn?
+                                        :svn
+                                      elsif options.hg?
+                                        :hg
+                                      elsif options.git?
+                                        :git
+                                      end
+
+            if options[:uri]
+              overlay_options[:uri] = options[:uri]
             end
 
-            Platform.load_overlays(@cache) if @cache
-
-            overlay_options = {:path => args.first}
-
-            overlay_options[:media] = @media if @media
-            overlay_options[:uri] = @uri if @uri
-
-            Platform.add(overlay_options) do |overlay|
-              puts "Overlay #{overlay.name.dump} added."
+            begin
+              Platform.add(overlay_options) do |overlay|
+                print_info "Overlay #{overlay.name.dump} added."
+              end
+            rescue Platform::OverlayNotFound, Platform::OverlayCached => e
+              print_error e.message
+              exit -1
             end
           end
 

data/lib/ronin/ui/command_line/commands/console.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,13 +16,13 @@
 # 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'
-require 'ronin/ui/verbose'
+require 'ronin/ui/output'
 require 'ronin/ui/console'
 require 'ronin/database'
+require 'ronin/version'
 
 module Ronin
   module UI
@@ -32,36 +30,34 @@ module Ronin
       module Commands
         class Console < Command
 
-          def define_options(opts)
-            opts.usage = '<command> [options]'
-            opts.options do
-              opts.on('-D','--database URI','The URI for the Database') do |uri|
-                Database.config = uri.to_s
-              end
+          map '-V' => :version
 
-              opts.on('-r','--require LIB','Require the specified library or path') do |lib|
-                UI::Console.auto_load << lib.to_s
-              end
+          desc "console", "start the Ronin Console"
+          method_option :database, :type => :string, :aliases => '-D'
+          method_option :require, :type => :array, :aliases => '-r'
+          method_option :verbose, :type => :boolean, :aliases => '-v'
 
-              opts.on('-v','--verbose','Enables verbose output') do
-                UI::Verbose.enable!
+          def default
+            if options[:require]
+              options[:require].each do |path|
+                UI::Console.auto_load << path
               end
+            end
 
-              opts.on('-V','--version','Print version information and exit') do
-                success do
-                  puts "Ronin #{Ronin::VERSION}"
-                end
-              end
+            if options[:database]
+              Database.config = options[:database]
             end
 
-            opts.summary %{
-              Ronin is a Ruby development platform designed for information
-              security and data exploration tasks.
-            }
+            UI::Console.start
           end
 
-          def arguments(*args)
-            UI::Console.start
+          desc "version", "displays the version"
+
+          #
+          # Prints the version information and exists.
+          #
+          def version
+            puts "Ronin #{Ronin::VERSION}"
           end
 
         end

data/lib/ronin/ui/command_line/commands/help.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'
@@ -30,37 +27,21 @@ module Ronin
       module Commands
         class Help < Command
 
-          def define_options(opts)
-            opts.usage = '[COMMAND]'
+          desc "help [COMMAND]", "Displays the list of available commands or prints information on a specific command"
 
-            opts.arguments(
-              'COMMAND' => 'The command to view'
-            )
-
-            opts.summary %{
-              View a list of supported commands or information on a
-              specific command
-            }
-          end
-
-          def arguments(*args)
-            if args.length > 1
-              fail('only one command maybe specified')
-            end
-
-            topic = args.first
-
-            if topic
+          def default(command=nil)
+            if command
               begin
-                CommandLine.get_command(topic).run('--help')
+                CommandLine.get_command(command).start(['--help'])
               rescue UnknownCommand
-                fail("unknown sub-command #{topic.dump}")
+                print_error "unknown command #{command.dump}"
+                exit -1
               end
             else
-              puts 'Available sub-commands:'
+              puts 'Available commands:'
 
-              CommandLine.commands.sort.each do |name|
-                puts "  #{name}"
+              indent do
+                CommandLine.commands.sort.each { |name| puts name }
               end
             end
           end

data/lib/ronin/ui/command_line/commands/install.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'
@@ -30,60 +27,38 @@ module Ronin
       module Commands
         class Install < Command
 
-          def defaults
-            @cache = nil
-            @media = nil
-          end
-
-          def define_options(opts)
-            opts.usage = 'URI [options]'
-
-            opts.options do
-              opts.on('-C','--cache DIR','Specify an alternate overlay cache') do |dir|
-                @cache = dir
-              end
-
-              opts.on('-m','--media MEDIA','Spedify the media-type of the overlay') do |media|
-                @media = media.to_sym
-              end
-
-              opts.on('--rsync','Alias for -m rsync') do
-                @media = :rsync
-              end
-
-              opts.on('--svn','Alias for -m svn') do
-                @media = :svn
-              end
-
-              opts.on('--hg','Alias for -m hg') do
-                @media = :hg
-              end
-
-              opts.on('--git','Alias for -m git') do
-                @media = :git
-              end
+          desc "install URI", "Installs the Overlay located at the specified URI"
+          method_option :cache, :type => :string, :aliases => '-C'
+          method_option :media, :type => :string, :aliases => '-m'
+          method_option :rsync, :type => :boolean
+          method_option :svn, :type => :boolean
+          method_option :hg, :type => :boolean
+          method_option :git, :type => :boolean
+
+          def default(uri)
+            if options[:cache]
+              Platform.load_overlays(options[:cache])
             end
 
-            opts.arguments(
-              'URI' => 'The URI of the overlay to install'
-            )
-
-            opts.summary %{
-              Installs the overlay located at the specified URI
-            }
-          end
-
-          def arguments(*args)
-            unless args.length == 1
-              fail('only one overlay URI maybe specified')
-            end
-
-            uri = args.first
-
-            Platform.load_overlays(@cache) if @cache
-
-            Platform.install(:uri => uri, :media => @media) do |overlay|
-              puts "Overlay #{overlay.name.dump} has been installed."
+            media = if options[:media]
+                      options[:media].to_sym
+                    elsif options.rsync?
+                      :rsync
+                    elsif options.svn?
+                      :svn
+                    elsif options.hg?
+                      :hg
+                    elsif options.git?
+                      :git
+                    end
+
+            begin
+              Platform.install(:uri => uri, :media => media) do |overlay|
+                print_info "Overlay #{overlay.name.dump} has been installed."
+              end
+            rescue Platform::OverlayCached => e
+              print_error e.message
+              exit -1
             end
           end