ronin 0.2.4 → 0.3.0

data/lib/ronin/ui/command_line/commands/list.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,11 @@
 # 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/platform/overlay'
+require 'ronin/ui/output'
+require 'ronin/platform'
 
 module Ronin
   module UI
@@ -30,83 +28,67 @@ module Ronin
       module Commands
         class List < Command
 
-          def defaults
-            @cache = nil
-            @verbose = false
-          end
-
-          def define_options(opts)
-            opts.usage = '[NAME ...] [options]'
-
-            opts.options do
-              opts.on('-C','--cache DIR','Specify an alternate overlay cache') do |dir|
-                @cache = dir
-              end
+          desc "list [NAME]", "List all Overlays or a specific one"
+          method_option :cache, :type => :string, :aliases => '-C'
+          method_option :verbose, :type => :boolean, :aliaes => '-v'
 
-              opts.on('-v','--verbose','Enable verbose output') do
-                @verbose = true
-              end
+          def default(name=nil)
+            if options[:cache]
+              Platform.load_overlays(options[:cache])
             end
 
-            opts.arguments(
-              'NAME' => 'Overlay to display'
-            )
-
-            opts.summary %{
-              Display all or the specified repositories within the Overlay
-              cache
-            }
-          end
-
-          def arguments(*args)
-            Platform.load_overlays(@cache) if @cache
-
-            if args.empty?
-              # list all overlays by name
-              Platform.overlays.each_overlay do |overlay|
-                puts "  #{overlay}"
+            unless name
+              indent do
+                # list all overlays by name
+                Platform.overlays.each_overlay do |overlay|
+                  puts overlay
+                end
               end
 
               return
             end
 
-            # list specified overlays
-            args.each do |name|
+            begin
+              # list a specific overlay
               overlay = Platform.overlays.get(name)
+            rescue Platform::OverlayNotFound => e
+              print_error e.message
+              exit -1
+            end
 
-              puts "[ #{overlay.name} ]\n\n"
+            print_title overlay.name
 
-              puts "  Path: #{overlay.path}"
-              puts "  Media: #{overlay.media}" if overlay.media
-              puts "  URI: #{overlay.uri}" if overlay.uri
+            indent do
+              puts "Path: #{overlay.path}"
+              puts "Media: #{overlay.media}" if overlay.media
+              puts "URI: #{overlay.uri}" if overlay.uri
 
-              if @verbose
+              if UI::Output.verbose?
                 putc "\n"
 
                 if overlay.title
-                  puts "  Title: #{overlay.title}"
+                  puts "Title: #{overlay.title}"
                 end
 
                 if overlay.source
-                  puts "  Source URI: #{overlay.source}"
+                  puts "Source URI: #{overlay.source}"
                 end
 
                 if overlay.source_view
-                  puts "  Source View: #{overlay.source_view}"
+                  puts "Source View: #{overlay.source_view}"
                 end
 
                 if overlay.website
-                  puts "  Website: #{overlay.website}"
+                  puts "Website: #{overlay.website}"
                 end
 
                 unless overlay.extensions.empty?
-                  puts "  Extensions:\n\n"
-                  overlay.extensions.each { |ext| puts "    #{ext}" }
-                  putc "\n"
+                  print_array(overlay.extensions, :title => 'Extensions')
                 end
 
                 if overlay.description
-                  puts "  Description:\n\n    #{overlay.description}\n\n"
+                  puts "Description:\n\n"
+                  indent { puts "#{overlay.description}\n\n" }
                 else
                   putc "\n"
                 end

data/lib/ronin/ui/command_line/commands/remove.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,10 @@
 # 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/platform/overlay'
+require 'ronin/platform'
 
 module Ronin
   module UI
@@ -30,38 +27,21 @@ module Ronin
       module Commands
         class Remove < Command
 
-          def defaults
-            @cache = nil
-            @verbose = false
-          end
-
-          def define_options(opts)
-            opts.usage = 'NAME [...] [options]'
+          desc "remove NAME", "Remove the specified Overlay"
+          method_option :cache, :type => :string, :aliases => '-C'
 
-            opts.options do
-              opts.on('-C','--cache DIR','Specify an alternate overlay cache') do |dir|
-                @cache = dir
-              end
-
-              opts.on('-v','--verbose','Enable verbose output') do
-                @verbose = true
-              end
+          def default(name)
+            if options[:cache]
+              Platform.load_overlays(options[:cache])
             end
 
-            opts.arguments(
-              'NAME' => 'The overlay to remove'
-            )
-
-            opts.summary('Remove the specified repositories')
-          end
-
-          def arguments(*args)
-            Platform.load_overlays(@cache) if @cache
-
-            args.each do |name|
+            begin
               Platform.remove(name) do |overlay|
-                puts "Removing Overlay #{overlay.name.dump} ..."
+                print_info "Removing Overlay #{overlay.name.dump} ..."
               end
+            rescue Platform::OverlayNotFound => e
+              print_error e.message
+              exit -1
             end
           end
 

data/lib/ronin/ui/command_line/commands/uninstall.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,38 +27,21 @@ module Ronin
       module Commands
         class Uninstall < Command
 
-          def defaults
-            @cache = nil
-            @verbose = false
-          end
-
-          def define_options(opts)
-            opts.usage = 'NAME [NAME ...] [options]'
+          desc "uninstall NAME", "Uninstall the specified Overlay"
+          method_option :cache, :type => :string, :aliases => '-C'
 
-            opts.options do
-              opts.on('-C','--cache DIR','Specify an alternate overlay cache') do |dir|
-                @cache = dir
-              end
-
-              opts.on('-v','--verbose','Enable verbose output') do
-                @verbose = true
-              end
+          def default(name)
+            if options[:cache]
+              Platform.load_overlays(options[:cache])
             end
 
-            opts.arguments(
-              'NAME' => 'The overlay to uninstall'
-            )
-
-            opts.summary('Uninstall the specified repositories')
-          end
-
-          def arguments(*args)
-            Platform.load_overlays(@cache) if @cache
-
-            args.each do |name|
+            begin
               Platform.uninstall(name) do
-                puts "Uninstalling Overlay #{name.dump} ..."
+                print_info "Uninstalling Overlay #{name.dump} ..."
               end
+            rescue Platform::OverlayNotFound => e
+              print_error e.message
+              exit -1
             end
           end
 

data/lib/ronin/ui/command_line/commands/update.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,45 +27,28 @@ module Ronin
       module Commands
         class Update < Command
 
-          def defaults
-            @cache = nil
-            @verbose = false
-          end
-
-          def define_options(opts)
-            opts.usage = '[NAME ...] [options]'
-
-            opts.options do
-              opts.on('-C','--cache DIR','Specify an alternate overlay cache') do |dir|
-                @cache = dir
-              end
+          desc "update [NAME]", "Update all Overlays or just a specified Overlay"
+          method_option :cache, :type => :string, :aliases => '-C'
 
-              opts.on('-v','--verbose','Enable verbose output') do
-                @verbose = true
-              end
+          def default(name=nil)
+            if options[:cache]
+              Platform.load_overlays(options[:cache])
             end
 
-            opts.arguments(
-              'NAME' => 'The overlay to update'
-            )
-
-            opts.summary('Updates all or the specified repositories')
-          end
-
-          def arguments(*args)
-            Platform.load_overlays(@cache) if @cache
-
             update = lambda { |overlay|
-              puts "Updating Overlay #{overlay.name.dump} ..."
+              print_info "Updating Overlay #{overlay.name.dump} ..."
               overlay.update
             }
 
-            if args.empty?
-              Platform.overlays.each_overlay(&update)
-            else
-              args.each do |name|
-                update.call(Platform.overlays.update(name))
+            if name
+              begin
+                update.call(Platform.overlays.get(name))
+              rescue Platform::OverlayNotFound => e
+                print_error e.message
+                exit -1
               end
+            else
+              Platform.overlays.each_overlay(&update)
             end
           end
 

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

data/lib/ronin/ui/command_line/exceptions/unknown_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,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
-#++
 #
 
 module Ronin

data/lib/ronin/ui/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,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/config'
@@ -41,29 +38,38 @@ module Ronin
       COMPLETION = true
 
       #
-      # Returns the default Console prompt style, defaults to +PROMPT+.
+      # @return [String]
+      #   The default Console prompt style.
       #
       def Console.prompt
         @@ronin_console_prompt ||= PROMPT
       end
 
       #
-      # Sets the default Console prompt style to the specified _style_.
+      # Sets the default Console prompt style.
+      #
+      # @param [String] style
+      #   The new Console prompt style to use.
       #
       def Console.prompt=(style)
         @@ronin_console_prompt = style
       end
 
       #
-      # Returns the default Console indent setting, defaults to +INDENT+.
+      # @return [Boolean]
+      #   The default Console indent setting.
       #
       def Console.indent
         @@ronin_console_indent ||= INDENT
       end
 
       #
-      # Sets the default Console indent setting to the specified _mode_.
+      # Sets the default Console indent setting.
+      #
+      # @param [Boolean] mode
+      #   The new default Console indent setting.
       #
+      # @example
       #   Console.indent = false
       #   # => false
       #
@@ -72,32 +78,38 @@ module Ronin
       end
 
       #
-      # Returns the default Console back trace limit, defaults to
-      # +BACKTRACE_DEPTH+.
+      # @return [Integer]
+      #   The default Console back-trace depth.
       #
       def Console.backtrace_depth
         @@ronin_console_backtrace_depth ||= BACKTRACE_DEPTH
       end
 
       #
-      # Sets the default Console back trace depth to the specified _depth_.
+      # Sets the default Console back-trace depth.
+      #
+      # @param [Integer] depth
+      #   The new default Console back-trace depth.
       #
       def Console.backtrace_depth=(depth)
         @@ronin_console_backtrace_depth = depth
       end
 
       #
-      # Returns the default Console tab-completion mode, defaults to
-      # +COMPLETION+.
+      # @return [Boolean]
+      #   The default Console tab-completion setting.
       #
       def Console.completion
         @@ronin_console_completion ||= COMPLETION
       end
 
       #
-      # Sets the default Console tab-completion mode to the specified
-      # _mode_.
+      # Sets the default Console tab-completion setting.
       #
+      # @param [Boolean] mode
+      #   The new default Console tab-completion setting.
+      #
+      # @example
       #   Console.completion = false
       #   # => false
       #
@@ -106,23 +118,38 @@ module Ronin
       end
 
       #
-      # Returns the Array of files to require when the Console starts.
+      # @return [Array]
+      #   The files to require when the Console starts.
       #
       def Console.auto_load
         @@ronin_console_auto_load ||= []
       end
 
       #
-      # Calls the specified _block_ from within the Console after it is
+      # Adds a block to be ran from within the Console after it is
       # started.
       #
+      # @yield []
+      #   The block to be ran from within the Console.
+      #
       def Console.setup(&block)
         Console.setup_blocks << block if block
       end
 
       #
-      # Starts a Console with the given _script_. If a _block_ is given, it
-      # will be called from within the Console.
+      # Starts a Console.
+      #
+      # @param [String] script
+      #   The path to a script to run within the Console.
+      #
+      # @yield []
+      #   The block to be ran within the Console, after it has been setup.
+      #
+      # @example
+      #   Console.start
+      #
+      # @example
+      #   console.start { @var = 'hello' }
       #
       def Console.start(script=nil,&block)
         IRB.setup(script)
@@ -137,9 +164,13 @@ module Ronin
 
         # configure the IRB context
         irb.context.main.instance_eval do
-          require 'ronin/environment'
-          require 'ronin/platform'
+          require 'ronin'
+          require 'ronin/ui/output'
+
+          # include the output helpers
+          include Ronin::UI::Output::Helpers
 
+          # setup irb completion
           require 'irb/completion' if Ronin::UI::Console.completion
 
           # require any of the auto-load paths
@@ -170,8 +201,8 @@ module Ronin
       protected
 
       #
-      # Returns the Array of setup_blocks to run within the Console after it
-      # is started.
+      # @return [Array]
+      #   The blocks to be ran from within the Console after it is started.
       #
       def Console.setup_blocks
         @@console_setup_blocks ||= []