ronin 0.1.1 → 0.1.2

data/lib/ronin/program/program.rb

@@ -1,168 +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/program/command'
-require 'ronin/program/options'
-require 'ronin/program/exceptions/unknown_command'
-require 'ronin/console'
-require 'ronin/version'
-
-module Ronin
-  module Program
-    #
-    # Returns the commands registered with the Program.
-    #
-    def Program.commands
-      @@ronin_commands ||= []
-    end
-
-    #
-    # Returns the Hash of the Command names and their Command objects
-    # registered with the Program.
-    #
-    def Program.commands_by_name
-      @@ronin_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 { |mesg| Program.error(mesg) }
-
-      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[0] }.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)
-      opts = 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.')
-      }
-      
-      return opts.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

data/lib/ronin/rpc/interactive.rb

@@ -1,55 +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/shell'
-
-module Ronin
-  module RPC
-    class Interactive < Ronin::Shell
-
-      # The service to interactive with
-      attr_reader :service
-
-      #
-      # Creates a new Interactive object using the specified _service_ and
-      # the given _options_. If a _block_ is given it will be passed the
-      # newly created Interactive object.
-      #
-      def initialize(service,options={},&block)
-        @service = service
-
-        super(options,&block)
-      end
-
-      #
-      # Starts a newly created Interactive object with the specified
-      # _service_ with the given _options_. If a _block_ is given, it will
-      # be passed the newly created Interactive object, before it is started.
-      #
-      def Interactive.start(service,options={},&block)
-        Interactive.new(service,options,&block).start
-      end
-
-    end
-  end
-end

data/lib/ronin/rpc/interactive_console.rb

@@ -1,58 +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/rpc/interactive'
-require 'ronin/rpc/console'
-
-module Ronin
-  module RPC
-    class InteractiveConsole < Interactive
-
-      #
-      # Creates a new InteractiveConsole object with the specified _console_
-      # service. If a _block_ is given it will be
-      #
-      def initialize(console,&block)
-        super(console,:prompt => '>>',&block)
-      end
-
-      #
-      # Starts a newly created InteractiveConsole object with the specified
-      # _service_. If a _block_ is given, it will be passed the newly
-      # created InteractiveShell object, before it is started.
-      #
-      def self.start(console,&block)
-        self.new(console,&block).start
-      end
-
-      #
-      # Evaluates the specified _code_ through the Console service and
-      # prints the natively formated return-value.
-      #
-      def process_command(code)
-        puts "=> #{@service.inspect(code)}"
-      end
-
-    end
-  end
-end

data/lib/ronin/rpc/interactive_shell.rb

@@ -1,59 +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/rpc/interactive'
-require 'ronin/shell'
-
-module Ronin
-  module RPC
-    class InteractiveShell < Interactive
-
-      #
-      # Creates a new InteractiveShell object with the specified _shell_
-      # service. If a _block_ is given it will be passed the newly created
-      # InteractiveShell object.
-      #
-      def initialize(shell,&block)
-        super(shell,:prompt => '$',&block)
-      end
-
-      #
-      # Starts a newly created InteractiveShell object using the specified
-      # _shell_ service. If a _block_ is given, it will be passed the newly
-      # created InteractiveShell before it is started.
-      #
-      def self.start(shell,&block)
-        self.new(shell,&block).start
-      end
-
-      #
-      # Executes the specified _command_ through the Shell service
-      # and prints the output of the command.
-      #
-      def process_command(command)
-        @service.system(command)
-      end
-
-    end
-  end
-end

data/lib/ronin/shell.rb

@@ -1,81 +0,0 @@
-module Ronin
-  class Shell
-
-    # Default shell prompt
-    DEFAULT_PROMPT = '>'
-
-    # Shell name to use
-    attr_accessor :name
-
-    # Shell prompt
-    attr_accessor :prompt
-
-    #
-    # Creates a new Shell object with the given _options_. If a _block_ is
-    # given it will be passed the newly created Shell object.
-    #
-    # _options_ may contain the following keys:
-    # <tt>:name</tt>:: The name of the shell.
-    # <tt>:prompt</tt>::The prompt to use for the shell.
-    #
-    def initialize(options={},&block)
-      @name = options[:name]
-      @prompt = (options[:prompt] || DEFAULT_PROMPT)
-
-      block.call(self) if block
-    end
-
-    #
-    # Creates and starts a new Shell object with the specified _options_.
-    # If a _block_ is given, it will be passed the newly created Shell
-    # object before it is started.
-    #
-    def self.start(options={},&block)
-      self.new(options,&block).start
-    end
-
-    #
-    # Starts the shell.
-    #
-    def start
-      history_rollback = 0
-
-      loop do
-        line = Readline.readline("#{@name}#{@prompt} ")
-
-        if line =~ /^\s*exit\s*$/
-          exit_shell
-          break
-        else
-          Readline::HISTORY << line
-          history_rollback += 1
-
-          begin
-            process_command(line)
-          rescue => e
-            puts "#{e.class.name}: #{e.message}"
-          end
-        end
-      end
-
-      history_rollback.times do
-        Readline::HISTORY.pop
-      end
-
-      return nil
-    end
-
-    #
-    # Default method that processes commands.
-    #
-    def process_command(command)
-    end
-
-    #
-    # Default method that will be called when the shell is exited.
-    #
-    def exit_shell
-    end
-
-  end
-end

data/spec/parameters/parameters_spec.rb

@@ -1,109 +0,0 @@
-require 'ronin/parameters'
-
-require 'spec_helper'
-
-describe Parameters do
-  before(:all) do
-    class TestParameters
-      include Parameters
-
-      parameter :var, :description => 'Test parameter'
-
-      parameter :var_with_default,
-                :default => 'thing',
-                :description => 'This parameter has a default value'
-
-    end
-
-    class InheritedParameters < TestParameters
-
-      parameter :child_var, :description => 'Child parameter'
-
-    end
-  end
-
-  describe "in a Class" do
-    it "should provide parameters" do
-      TestParameters.params.should_not be_empty
-    end
-
-    it "can have default values for parameters" do
-      TestParameters.param_value(:var_with_default).should == 'thing'
-    end
-
-    it "should provide class methods for paremters" do
-      TestParameters.var = 1
-      TestParameters.var.should == 1
-    end
-
-    it "should inherite the super-classes parameters" do
-      InheritedParameters.has_param?(:var).should == true
-      InheritedParameters.has_param?(:child_var).should == true
-    end
-
-    it "should provide direct access to the parameter objects" do
-      @param = TestParameters.get_param(:var)
-
-      @param.should_not be_nil
-      @param.name.should == :var
-    end
-
-    it "raise a ParamNotFound exception when directly accessing non-existent parameter objects" do
-      lambda { TestParameters.get_param(:unknown) }.should raise_error(Parameters::ParamNotFound)
-    end
-
-    it "should provide descriptions for parameters" do
-      TestParameters.describe_param(:var).should_not be_empty
-    end
-  end
-
-  describe "in an Object" do
-    before(:all) do
-      @test = TestParameters.new
-      @test_inherited = InheritedParameters.new
-    end
-
-    it "can have default values for parameters" do
-      @test.param_value(:var_with_default).should == 'thing'
-    end
-
-    it "should provide instance methods for parameters" do
-      @test.var = 2
-      @test.var.should == 2
-    end
-
-    it "should set instance variables for paramters" do
-      @test.instance_variable_get('@var_with_default').should == 'thing'
-
-      @test.var = 3
-      @test.instance_variable_get('@var').should == 3
-    end
-
-    it "should contain the parameters from all ancestors" do
-      @test_inherited.has_param?(:var).should == true
-      @test_inherited.has_param?(:child_var).should == true
-    end
-
-    it "should provide direct access to the parameter objects" do
-      @param = @test.get_param(:var)
-
-      @param.should_not be_nil
-      @param.name.should == :var
-    end
-
-    it "should raise a ParamNotFound exception when directly accessing non-existent parameter objects" do
-      lambda { @test.get_param(:unknown) }.should raise_error(Parameters::ParamNotFound)
-    end
-
-    it "should allow for setting parameters en-mass" do
-      @test.set_params(:var => 3, :var_with_default => 7)
-
-      @test.param_value(:var).should == 3
-      @test.param_value(:var_with_default).should == 7
-    end
-
-    it "should provide descriptions for parameters" do
-      @test.describe_param(:var).should_not be_empty
-    end
-  end
-end