ronin 0.0.9

data/lib/ronin/runner/program/commands/help.rb

@@ -0,0 +1,52 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2007 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/runner/program/command'
+
+module Ronin
+  module Runner
+    module Program
+      class HelpCommand < Command
+
+        command :help
+
+        options('[COMMAND]') do |opts|
+          opts.arguments do
+            opts.arg('COMMAND','The command to view')
+          end
+
+          opts.summary('View a list of supported commands or information on a specific command')
+        end
+
+        def arguments(*args)
+          unless args.length<=1
+            fail('help: only one command maybe specified')
+          end
+
+          success { Program.help(args.first) }
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/runner/program/commands/install.rb

@@ -0,0 +1,65 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2007 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/runner/program/command'
+require 'ronin/cache/overlay'
+
+module Ronin
+  module Runner
+    module Program
+      class InstallCommand < Command
+
+        command :install
+
+        options('URI [options]') do |opts|
+          opts.settings.media = nil
+          opts.settings.uri = nil
+
+          opts.options do
+            opts.on('-m','--media [MEDIA]','Spedify the media-type of the repository') do |media|
+              options.settings.media = media
+            end
+          end
+
+          opts.arguments do
+            opts.arg('URI','The URI of the repository to install')
+          end
+
+          opts.summary('Installs the repository located at the specified URI')
+        end
+
+        def arguments(args)
+          unless args.length==1
+            fail('install: only one repository URI maybe specified')
+          end
+
+          Cache::Overlay.save_cache do
+            Cache::Overlay.install(:uri => args.first, :media => options.settings.media) do |repo|
+              puts "Overlay #{repo} has been installed."
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ronin/runner/program/commands/list.rb

@@ -0,0 +1,81 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2007 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/runner/program/command'
+require 'ronin/cache/overlay'
+
+module Ronin
+  module Runner
+    module Program
+      class ListCommand < Command
+
+        command :list, :ls
+
+        options('[NAME ...] [options]') do |opts|
+          opts.options
+
+          opts.arguments do
+            opts.arg('NAME','Overlay to display')
+          end
+
+          opts.summary('Display all or the specified repositories within the repository cache')
+        end
+
+        def arguments(*args)
+          if args.empty?
+            # list all repositories by name
+            Cache::Overlay.each do |repo|
+              puts "  #{repo}"
+            end
+          else
+            # list specified repositories
+            args.each do |name|
+              repo = Cache::Overlay.get(name)
+
+              puts "[ #{repo} ]\n\n"
+
+              puts "  path: #{repo.path}" if options.settings.verbose
+              puts "  media: #{repo.media}"
+              puts "  uri: #{repo.uri}" if repo.uri
+
+              if repo.description
+                puts "  description:\n\n    #{repo.description}"
+              end
+
+              puts "\n"
+
+              if options.settings.verbose
+                puts "  extensions:\n\n"
+
+                repo.each_extension do |ext|
+                  puts "    #{ext}"
+                end
+              end
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/runner/program/commands/remove.rb

@@ -0,0 +1,57 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2007 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/runner/program/command'
+require 'ronin/cache/overlay'
+
+module Ronin
+  module Runner
+    module Program
+      class RemoveCommand < Command
+
+        command :remove, :rm
+
+        options('NAME [NAME ...] [options]') do |opts|
+          opts.options
+
+          opts.arguments do
+            opts.arg('NAME','The repository to remove')
+          end
+
+          opts.summary('Remove the specified repositories')
+        end
+
+        def arguments(*args)
+          args.each do |name|
+            Cache::Overlay.save_cache do
+              Cache::Overlay.remove(name) do |repo|
+                puts "Removing #{repo}..."
+              end
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/runner/program/commands/uninstall.rb

@@ -0,0 +1,57 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2007 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/runner/program/command'
+require 'ronin/cache/overlay'
+
+module Ronin
+  module Runner
+    module Program
+      class UninstallCommand < Command
+
+        command :uninstall
+
+        options('NAME [NAME ...] [options]') do |opts|
+          opts.options
+
+          opts.arguments do
+            opts.arg('NAME','The repository to uninstall')
+          end
+
+          opts.summary('Uninstall the specified repositories')
+        end
+
+        def arguments(*args)
+          args.each do |name|
+            Cache::Overlay.save_cache do
+              Cache::Overlay.uninstall(name) do |repo|
+                puts "Uninstalling #{repo}..."
+              end
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/runner/program/commands/update.rb

@@ -0,0 +1,55 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2007 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/runner/program/command'
+require 'ronin/cache/overlay'
+
+module Ronin
+  module Runner
+    module Program
+      class UpdateCommand < Command
+
+        command :update, :up
+
+        options('[NAME ...] [options]') do |opts|
+          opts.options
+
+          opts.arguments do
+            opts.arg('NAME','The repository to update')
+          end
+
+          opts.summary('Updates all or the specified repositories')
+        end
+
+        def arguments(*args)
+          if args.empty?
+            Cache::Overlay.each { |repo| repo.update }
+          else
+            args.each { |name| Cache::Overlay.update(name) }
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/runner/program/exceptions.rb

@@ -0,0 +1,24 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2008 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/runner/program/exceptions/unknown_command'

data/lib/ronin/runner/program/exceptions/unknown_command.rb

@@ -0,0 +1,31 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2008 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
+#++
+#
+
+module Ronin
+  module Runner
+    module Program
+      class UnknownCommand < RuntimeError
+      end
+    end
+  end
+end

data/lib/ronin/runner/program/options.rb

@@ -0,0 +1,205 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2008 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/runner/program/program'
+
+require 'optparse'
+require 'ostruct'
+
+module Ronin
+  module Runner
+    class Options
+
+      # Settings used by the options
+      attr_reader :settings
+
+      #
+      # Creates a new Options object with the specified _program_ name
+      # and the given _banner_. If a _block_ is given, it will be passed
+      # the newly created Options object.
+      #
+      def initialize(program,banner=nil,&block)
+        @settings = OpenStruct.new
+        @settings.verbose = false
+
+        @help_block = proc { help }
+
+        @verbose_block = proc {
+          @settings.verbose = true
+        }
+
+        @parser = OptionParser.new do |opts|
+          if banner
+            opts.banner = "Usage: #{program} #{banner}"
+            opts.separator ''
+          end
+        end
+
+        block.call(self) if block
+      end
+
+      #
+      # Creates a new Options object for a Command with the specified
+      # _program_ name, command _name_ and the given _banner_. If a _block_
+      # is given, it will be passed the newly created Options object.
+      #
+      def Options.command(program,name,banner=nil,&block)
+        return Options.new(program,"#{name} #{banner}",&block) if banner
+        return Options.new(program,name,&block)
+      end
+
+      #
+      # Call the specified _block_ when the given option _flags_ are parsed.
+      #
+      def on(*flags,&block)
+        @parser.on(*flags,&block)
+        return self
+      end
+
+      #
+      # Calls the specified _block_ when the verbose option flag is parsed.
+      #
+      def on_verbose(&block)
+        @verbose_block = block
+        return self
+      end
+
+      #
+      # Calls the specified _block_ when the help option-flag is parsed.
+      #
+      def on_help(&block)
+        @help_block = block
+        return self
+      end
+
+      #
+      # Adds a section separator with the specified _text_.
+      #
+      def separator(text)
+        @parser.separator(text)
+        return self
+      end
+
+      #
+      # Adds an options section to the help message. If a _block_ is given
+      # it will be called before any default options are added.
+      #
+      def options(&block)
+        @parser.separator '  Options:'
+
+        block.call(self) if block
+
+        @parser.on('-v','--verbose','produce excess output',&(@verbose_block))
+        @parser.on('-h','--help','print this message',&(@help_block))
+        @parser.separator ''
+
+        return self
+      end
+
+      #
+      # Adds an the argument with the specified _name_ and _description_
+      # to the arguments section of the help message of these options.
+      #
+      def arg(name,description)
+        @parser.separator "    #{name}\t#{description}"
+        return self
+      end
+
+      #
+      # Creates an arguments section in the help message and calls the
+      # given _block_.
+      #
+      def arguments(&block)
+        if block
+          @parser.separator '  Arguments:'
+
+          block.call(self)
+
+          @parser.separator ''
+        end
+
+        return self
+      end
+
+      #
+      # Addes a summary section with the specified _lines_.
+      #
+      def summary(*lines)
+        @parser.separator '  Summary:'
+
+        lines.each do |line|
+          @parser.separator "    #{line}"
+        end
+
+        @parser.separator ''
+        return self
+      end
+
+      #
+      # Adds a defaults section with the specified _flags_.
+      #
+      def defaults(*flags)
+        @parser.separator '  Defaults:'
+
+        flags.each do |flag|
+          @parser.separator "    #{flag}"
+        end
+
+        @parser.separator ''
+        return self
+      end
+
+      #
+      # Prints the help message and exits successfully. If a _block_ is
+      # given it will be called after the help message has been print
+      # and before the Program has exited.
+      #
+      def help(&block)
+        Program.success do
+          puts @parser
+
+          block.call(self) if block
+        end
+      end
+
+      #
+      # Parses the specified _argv_ Array. If a _block_ is given it will
+      # be passed the left-over arguments. Returns the left-over arguments.
+      #
+      def parse(argv,&block)
+        args = @parser.parse(argv)
+
+        block.call(self,args) if block
+        return args
+      end
+
+      #
+      # Returns a String representation of the OptParse parser.
+      #
+      def to_s
+        @parser.to_s
+      end
+
+    end
+  end
+end