ronin 0.1.0 → 0.1.1

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

@@ -1,204 +0,0 @@
-#
-#--
-# 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 'ronin/extensions/meta'
-
-module Ronin
-  module Runner
-    module Program
-      class Command
-
-        #
-        # Creates a new Command object. If a _block_ is given,
-        # it will be passed newly created Command object.
-        #
-        def initialize(&block)
-          @options = nil
-
-          block.call(self) if block
-        end
-
-        #
-        # Returns the name of the command.
-        #
-        def Command.command_name
-          ''
-        end
-
-        #
-        # Returns the short names of the command.
-        #
-        def Command.command_short_names
-          []
-        end
-
-        #
-        # Returns all the names of the command.
-        #
-        def self.command_names
-          [self.command_name] + self.command_short_names
-        end
-
-        #
-        # Creates a new command object and runs it with the
-        # given _args_.
-        #
-        def self.run(*args)
-          self.new.run(*args)
-        end
-
-        #
-        # Prints the help information for the command.
-        #
-        def self.help
-          self.new.help
-        end
-
-        #
-        # Returns the name of the command.
-        #
-        def command_name
-          self.class.command_name
-        end
-
-        #
-        # Returns the short names of the command.
-        #
-        def command_short_names
-          self.class.command_short_names
-        end
-
-        #
-        # Returns all the names of the command.
-        #
-        def command_names
-          self.class.command_names
-        end
-
-        #
-        # Runs the command with the given _args_. If a _block_ is
-        # given, it will be called after the specified _args_ have
-        # been parsed and the command has run.
-        #
-        def run(*args,&block)
-          arguments(*(options.parse(args)))
-
-          @options = nil
-
-          block.call if block
-          return self
-        end
-
-        #
-        # Prints the help information for the command.
-        #
-        def help
-          options.help
-          return self
-        end
-
-        #
-        # Returns the String form of the command.
-        #
-        def to_s
-          names.join(', ')
-        end
-
-        protected
-
-        #
-        # Registers the command with the specified _name_ and the given
-        # _short_names_.
-        #
-        def self.command(name,*short_names)
-          name = name.to_s
-          short_names = short_names.map { |short_name| short_name.to_s }
-
-          meta_def(:command_name) { name }
-          meta_def(:command_short_names) { short_names }
-
-          # register the command
-          Program.commands << self unless Program.commands.include?(self)
-
-          # register the command by name
-          Program.commands_by_name[name] = self
-
-          # register the command by it's short_names
-          short_names.each do |short_name|
-            Program.commands_by_name[short_name] = self
-          end
-
-          return self
-        end
-
-        #
-        # Defines the options of the command with the specified _usage_ and
-        # _block_.
-        #
-        def self.options(usage=nil,&block)
-          class_def(:options) do
-            @options ||= Options.command(:ronin,self.command_name,usage,&block)
-          end
-
-          return self
-        end
-
-        #
-        # Returns the options of the command.
-        #
-        def options
-          @options ||= Options.command(:ronin,command_name)
-        end
-
-        #
-        # See Program.error.
-        #
-        def error(message)
-          Program.error(message)
-        end
-
-        #
-        # See Program.success.
-        #
-        def success(&block)
-          Program.success(&block)
-        end
-
-        #
-        # See Program.fail.
-        #
-        def fail(*messages,&block)
-          Program.fail(*messages,&block)
-        end
-
-        #
-        # Processes the additional arguments specified by _args_.
-        #
-        def arguments(*args)
-        end
-
-      end
-    end
-  end
-end

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

@@ -1,73 +0,0 @@
-#
-#--
-# 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 AddCommand < Command
-
-        command :add
-
-        options('PATH [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|
-              opts.settings.media = media
-            end
-
-            opts.on('-U','--uri URI','Specify the source URI of the repository') do |uri|
-              opts.settings.uri = uri
-            end
-          end
-
-          opts.arguments do
-            opts.arg('PATH','Add the repository located at the specified PATH')
-          end
-
-          opts.summary('Add a local repository located at the specified PATH to the repository cache')
-
-        end
-
-        def arguments(*args)
-          unless args.length==1
-            fail('add: only one repository path maybe specified')
-          end
-
-          path = args.first
-
-          Cache::Overlay.save_cache do
-            Cache::Overlay.add(path,options.settings.media,options.settings.uri) do |repo|
-              puts "Overlay #{repo} added."
-            end
-          end
-        end
-
-      end
-    end
-  end
-end

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

@@ -1,65 +0,0 @@
-#
-#--
-# 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

@@ -1,81 +0,0 @@
-#
-#--
-# 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/program.rb

@@ -1,175 +0,0 @@
-#
-#--
-# 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/command'
-require 'ronin/runner/program/options'
-require 'ronin/runner/program/exceptions/unknown_command'
-require 'ronin/console'
-require 'ronin/version'
-
-module Ronin
-  module Runner
-    module Program
-      #
-      # Returns the commands registered with the Program.
-      #
-      def Program.commands
-        @@commands ||= []
-      end
-
-      #
-      # Returns the Hash of the Command names and their Command objects
-      # registered with the Program.
-      #
-      def Program.commands_by_name
-        @@commands_by_name ||= {}
-      end
-
-      #
-      # Returns +true+ if the a Command with the specified _name_ was
-      # registered with the Program.
-      #
-      def Program.has_command?(name)
-        Program.commands_by_name.has_key?(name.to_s)
-      end
-
-      #
-      # Returns the Command registered with the Program with the specified
-      # _name_.
-      #
-      def Program.get_command(name)
-        name = name.to_s
-
-        unless Program.has_command?(name)
-          raise(UnknownCommand,"unknown command #{name.dump}",caller)
-        end
-
-        return Program.commands_by_name[name]
-      end
-
-      #
-      # Prints the specified error _message_.
-      #
-      def Program.error(message)
-        STDERR.puts "ronin: #{message}"
-        return false
-      end
-
-      #
-      # Exits successfully from the Program. If a _block_ is given, it will
-      # be called before the Program is exited.
-      #
-      def Program.success(&block)
-        block.call(self) if block
-        exit
-      end
-
-      #
-      # Prints the given error _messages_ and exits unseccessfully from the
-      # Program. If a _block_ is given, it will be called before any
-      # error _messages_ are printed.
-      #
-      def Program.fail(*messages,&block)
-        block.call(self) if block
-
-        messages.each do |mesg|
-          Program.error(mesg)
-        end
-
-        exit -1
-      end
-
-      #
-      # If a _topic_ is given, the help message for that _topic_ will be
-      # printed, otherwise a list of available commands will be printed.
-      #
-      def Program.help(topic=nil)
-        if topic
-          begin
-            get_command(topic).help
-          rescue UnknownCommand => exp
-            Program.fail(exp)
-          end
-        else
-          puts 'Available commands:'
-
-          Program.commands.sort_by { |cmd|
-            cmd.command_names.first
-          }.each { |cmd|
-            puts "  #{cmd.command_names.join(', ')}"
-          }
-        end
-      end
-
-      #
-      # The default command to run with the given _argv_ Array when no
-      # sub-command is given.
-      #
-      def Program.default_command(*argv)
-        Options.new('ronin','<command> [options]') { |opts|
-          opts.options do |opts|
-            opts.on('-r','--require LIB','require the specified library or path') do |lib|
-              Console.auto_load << lib.to_s
-            end
-
-            opts.on('-V','--version','print version information and exit') do
-              Program.success do
-                puts "Ronin #{Ronin::VERSION}"
-              end
-            end
-          end
-
-          opts.summary('Ronin is a Ruby development platform designed for information security','and data exploration tasks.')
-        }.parse(argv) { |opts,args|
-          Console.start
-        }
-      end
-
-      #
-      # Runs the Program with the given _argv_ Array. If the first argument
-      # is a sub-command name, the Program will attempt to find and execute
-      # the Command with the same name.
-      #
-      def Program.run(*argv)
-        begin
-          if (argv.empty? || argv[0][0..0]=='-')
-            Program.default_command(*argv)
-          else
-            cmd = argv.first
-            argv = argv[1..-1]
-
-            if Program.has_command?(cmd)
-              Program.commands_by_name[cmd].run(*argv)
-            else
-              Program.fail("unknown command #{cmd.dump}")
-            end
-          end
-        rescue OptionParser::MissingArgument, OptionParser::InvalidOption => e
-          Program.fail(e)
-        end
-
-        return true
-      end
-    end
-  end
-end

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

@@ -1,35 +0,0 @@
-#
-#--
-# 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'
-
-module Ronin
-  module Runner
-    #
-    # See Program.run.
-    #
-    def Runner.program(argv)
-      Program.run(*argv)
-    end
-  end
-end

data/lib/ronin/runner/program.rb

@@ -1,26 +0,0 @@
-#
-#--
-# 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 'ronin/runner/program/commands'
-require 'ronin/runner/program/runner'