ronin 1.4.1 → 1.5.0.rc1

data/.document

@@ -2,3 +2,4 @@ lib/**/*.rb
 - 
 ChangeLog.md
 COPYING.txt
+man/*.md

data/.gitignore

@@ -1,5 +1,6 @@
 doc
 pkg
+man/*.[1-9]
 vendor/cache
 Gemfile.lock
 .bundle

data/ChangeLog.md

@@ -1,9 +1,46 @@
+### 1.5.0 / 2012-05-28
+
+* Require ronin-support ~> 0.5.
+* Added {Ronin::UI::CLI::Command#setup}.
+* Added {Ronin::UI::CLI::Command#cleanup}.
+* Added {Ronin::UI::CLI::Command.examples}.
+* Added the {Ronin::UI::CLI::Commands::Net::Proxy net:proxy} ronin command.
+* Added man-pages for each `ronin` command.
+* Added more specs for the {Ronin::UI::CLI::Command} DSL methods.
+* Added {Ronin::AutoLoad::ClassMethods#require_const}, to also
+  finalize auto-loaded DataMapper models.
+* Renamed `Ronin::Database.setup_log` to {Ronin::Database.log}.
+* Allow {Ronin::Database.setup} to accept a URI for the `default` repository.
+* Allow `ronin/spec/database` to test against other Databases,
+  specified by the `ADAPTER` environment variable.
+  * If `ADAPTER` is set to `mysql` or `postgres`, then `ronin/spec/database`
+    will connect to the `ronin_test` database with username/password
+    `ronin_test`.
+  * By default `ronin/spec/database` will test against a temporary sqlite3
+    database.
+* Allow console `!command`s to embed Ruby expressions:
+
+        >> !ncat #{ip} #{port}
+
+* Moved console `!command` logic into {Ronin::UI::Console::Shell}.
+  * `!command`s now only execute shell commands.
+* Moved console `.command` logic into {Ronin::UI::Console::Commands}.
+  * `.command`s are now reserved only for special console commands
+    (ex: `.edit`).
+* Improved recognition of console `!command`s and `.command`s.
+* Do not allow executing console commands while in multi-line mode!
+* Fixed bug in {Ronin::UI::CLI::Command} that was disabling colour output.
+* Improved `--help` output of `ronin` commands by adding `examples` and more
+  `:description`s to options.
+* Changed `ronin help COMMAND` to display the man-page for the given command.
+* No longer honor the `DEBUG` environment variable. Use `ruby -w` or `ruby -d`
+  instead.
+
 ### 1.4.1 / 2012-04-01
 
 * Removed dependencey on env.
 * Removed `#to_ary` methods from Ronin Models that were causing
   `SystemStackError: stack level too deep` exceptions. Fixes issue #4.
-* Ensure that {Ronin::AutoLoad} will finalize models loaded via `require_const`.
 * {Ronin::UI::CLI::Command#start} now rescues Interupts.
 
 ### 1.4.0 / 2012-02-12

data/Gemfile

@@ -7,9 +7,7 @@ RONIN_URI  = 'http://github.com/ronin-ruby'
 
 gemspec
 
-platforms :jruby do
-  gem 'jruby-openssl',	'~> 0.7'
-end
+gem 'jruby-openssl',	'~> 0.7', :platforms => :jruby
 
 # DataMapper dependencies
 # gem 'data_objects',       DO_VERSION, :git => "#{DM_URI}/do.git"
@@ -26,17 +24,19 @@ end
 # gem 'dm-timestamps',      DM_VERSION, :git => "#{DM_URI}/dm-timestamps.git"
 
 # Library dependencies
-# gem 'ronin-support',	'~> 0.4.0.rc1', :git => "#{RONIN_URI}/ronin-support.git"
+# gem 'ronin-support',	'~> 0.5.0.rc1', :git => "#{RONIN_URI}/ronin-support.git",
+#                                       :branch => '0.5.0'
 
 group :development do
-  gem 'rake',         '~> 0.8'
+  gem 'rake',           '~> 0.8'
+  gem 'rubygems-tasks', '~> 0.1'
+  gem 'rspec',          '~> 2.4'
 
-  gem 'ore-tasks',    '~> 0.4'
-  gem 'rspec',        '~> 2.4'
+  gem 'redcarpet',      '~> 2.1'
+  gem 'md2man',         '~> 1.2', :git => 'http://github.com/postmodern/md2man.git', :branch => 'rake_task'
 
-  gem 'kramdown',       '~> 0.12'
-  gem 'ruby-graphviz',  '~> 0.9'
-  gem 'dm-visualizer',  '~> 0.2'
+  gem 'ruby-graphviz',  '~> 0.9.10'
+  gem 'dm-visualizer',  '~> 0.2.0'
 end
 
 #

data/README.md

@@ -185,7 +185,7 @@ Remove a Database:
 * [ripl-color_result](https://github.com/janlelis/ripl-color_result#readme)
   ~> 0.3
 * [ronin-support](https://github.com/ronin-ruby/ronin-support#readme)
-  ~> 0.4
+  ~> 0.5
 
 ## Install
 

data/Rakefile

@@ -18,8 +18,16 @@ end
 
 require 'rake'
 
-require 'ore/tasks'
-Ore::Tasks.new
+require 'rubygems/tasks'
+Gem::Tasks.new(:sign => {:checksum => true, :pgp => true}) do |tasks|
+  tasks.scm.tag.format  = 'v%s'
+  tasks.console.command = 'ripl'
+  tasks.console.options = %w[
+    -rripl/multi_line
+    -rripl/auto_indent
+    -rripl/color_result
+  ]
+end
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new
@@ -71,3 +79,6 @@ YARD::Rake::YardocTask.new
 
 desc "Generates all documentation"
 task :docs => [:yard, 'dm:doc:graphviz']
+
+require 'md2man/task'
+Md2Man::Task.new

data/bin/ronin-net-proxy

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+root_dir = File.expand_path(File.join(File.dirname(__FILE__),'..'))
+if File.directory?(File.join(root_dir,'.git'))
+  Dir.chdir(root_dir) do |path|
+    require 'bundler'
+
+    begin
+      Bundler.setup(:default)
+    rescue Bundler::BundlerError => e
+      warn e.message
+      warn "Run `bundle install` to install missing gems"
+      exit e.status_code
+    end
+  end
+end
+
+lib_dir = File.join(root_dir,'lib')
+$LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+require 'ronin/ui/cli/commands/net/proxy'
+
+Ronin::UI::CLI::Commands::Net::Proxy.start

data/gemspec.yml

@@ -33,6 +33,25 @@ post_install_message: |
 
   *************************************************************************
 
+generated_files:
+ - man/ronin.1
+ - man/ronin-campaigns.1
+ - man/ronin-console.1
+ - man/ronin-creds.1
+ - man/ronin-database.1
+ - man/ronin-emails.1
+ - man/ronin-exec.1
+ - man/ronin-help.1
+ - man/ronin-hosts.1
+ - man/ronin-install.1
+ - man/ronin-ips.1
+ - man/ronin-net-proxy.1
+ - man/ronin-repos.1
+ - man/ronin-uninstall.1
+ - man/ronin-update.1
+ - man/ronin-urls.1
+ - man/ronin-wordlist.1
+
 required_ruby_version: ">= 1.8.7"
 
 dependencies:
@@ -62,10 +81,10 @@ dependencies:
   ripl-short_errors: ~> 0.1
   ripl-color_result: ~> 0.3
   # Ronin dependencies:
-  ronin-support: ~> 0.4
+  ronin-support: ~> 0.5.0.rc1
 
 development_dependencies:
   bundler: ~> 1.0
-  yard: ~> 0.7
+  yard: ~> 0.8
   yard-dm: ~> 0.1
   yard-dm-is-predefined: ~> 0.2

data/lib/bond/completions/ronin.rb

@@ -19,11 +19,22 @@
 
 require 'ronin/config'
 require 'ronin/ui/console/commands'
+require 'ronin/ui/console/shell'
 
 require 'set'
 
-complete(:on => /^[\!\.][a-zA-Z]\w*/) do |cmd|
-  prefix = cmd[0,1]
+complete(:on => Ronin::UI::Console::Commands::PATTERN) do |cmd|
+  name     = cmd[1..-1]
+  commands = Set[]
+  
+  Ronin::UI::Console::Commands.singleton_methods.each do |method|
+    commands << ".#{method}" if method.start_with?(name)
+  end
+
+  commands
+end
+
+complete(:on => Ronin::UI::Console::Shell::PATTERN) do |cmd|
   name   = cmd[1..-1]
   glob   = "#{name}*"
   paths  = Set[]
@@ -32,14 +43,14 @@ complete(:on => /^[\!\.][a-zA-Z]\w*/) do |cmd|
   Ronin::Config::BIN_DIRS.each do |dir|
     Dir.glob(File.join(dir,glob)) do |path|
       if (File.file?(path) && File.executable?(path))
-        paths << "#{prefix}#{File.basename(path)}"
+        paths << "!#{File.basename(path)}"
       end
     end
   end
 
   # add the black-listed keywords last
-  Ronin::UI::Console::Commands::BLACKLIST.each do |keyword|
-    paths << "#{prefix}#{keyword}" if keyword.start_with?(name)
+  Ronin::UI::Console::Shell::BLACKLIST.each do |keyword|
+    paths << "!#{keyword}" if keyword.start_with?(name)
   end
 
   paths

data/lib/ronin/arch.rb

@@ -24,7 +24,7 @@ require 'dm-is-predefined'
 
 module Ronin
   #
-  # Represents a Computer Architecture and pre-defines many other common
+  # Represents a Computer Architecture and predefines many other common
   # architectures ({x86}, {x86_64}, {ia64}, {ppc}, {ppc64}, {sparc},
   # {sparc64}, {mips} and {arm}).
   #
@@ -114,19 +114,19 @@ module Ronin
     # The 64-bit SPARC Architecture
     predefine :sparc64, :endian => :big, :address_length => 8
 
-    # The MIPS (little-endian) Architecture
+    # The MIPS (little endian) Architecture
     predefine :mips_le, :endian => :little, :address_length => 4
 
-    # The MIPS (big-endian) Architecture
+    # The MIPS (big endian) Architecture
     predefine :mips_be, :endian => :big, :address_length => 4
 
     # Alias to {mips_be}.
     predefine :mips, :name => 'mips_be', :endian => :big, :address_length => 4
 
-    # The ARM (little-endian) Architecture
+    # The ARM (little endian) Architecture
     predefine :arm_le, :endian => :little, :address_length => 4
 
-    # The ARM (big-endian) Architecture
+    # The ARM (big endian) Architecture
     predefine :arm_be, :endian => :big, :address_length => 4
 
     # Alias to {arm_be}.

data/lib/ronin/auto_load.rb

@@ -34,7 +34,28 @@ module Ronin
     end
 
     module ClassMethods
-      protected
+      #
+      # Requires the file that should contain the constant.
+      #
+      # @param [String, Symbol] name
+      #   The name of the constant.
+      #
+      # @return [Class, Module, nil]
+      #   The loaded constant.
+      #
+      # @since 1.5.0
+      #
+      # @api public
+      #
+      def require_const(name)
+        const = super(name)
+
+        if (const && const < DataMapper::Resource)
+          const.finalize
+        end
+
+        return const
+      end
 
       #
       # Transparently auto-loads Classes and Modules from their respective

data/lib/ronin/campaign.rb

@@ -97,7 +97,7 @@ module Ronin
     #
     # @api public
     #
-    def targets?(addr)
+    def targets?(address)
       self.addresses.include?(address)
     end
 

data/lib/ronin/database/database.rb

@@ -64,7 +64,7 @@ module Ronin
     #
     # @api private
     #
-    def Database.repositories
+    def self.repositories
       if @repositories.empty?
         @repositories[:default] = DEFAULT_REPOSITORY
 
@@ -97,7 +97,7 @@ module Ronin
     #
     # @api semipublic
     #
-    def Database.repository?(name)
+    def self.repository?(name)
       repositories.has_key?(name.to_sym)
     end
 
@@ -114,7 +114,7 @@ module Ronin
     #
     # @api private
     #
-    def Database.save
+    def self.save
       yield if block_given?
 
       File.open(CONFIG_FILE,'w') do |file|
@@ -131,7 +131,7 @@ module Ronin
     end
 
     #
-    # Setup the Database log.
+    # Returns or sets up the Database log.
     #
     # @param [Hash] options
     #   Additional options.
@@ -151,18 +151,21 @@ module Ronin
     #   * `:info`
     #   * `:debug`
     #
-    # @return [true]
-    #   Specifies that the log has been setup.
+    # @return [DataMapper::Logger]
+    #   The Database Logger.
     #
-    # @api private
+    # @api semipublic
     #
-    def Database.setup_log(options={})
-      path = options.fetch(:path,DEFAULT_LOG_PATH)
-      stream = options.fetch(:stream,File.new(path,'w+'))
-      level = options.fetch(:level,DEFAULT_LOG_LEVEL)
+    def self.log(options={})
+      unless (@log && options.empty?)
+        path   = options.fetch(:path,DEFAULT_LOG_PATH)
+        stream = options.fetch(:stream,File.new(path,'w+'))
+        level  = options.fetch(:level,DEFAULT_LOG_LEVEL)
 
-      @log = DataMapper::Logger.new(stream,level)
-      return true
+        @log = DataMapper::Logger.new(stream,level)
+      end
+
+      return @log
     end
 
     #
@@ -176,7 +179,7 @@ module Ronin
     #
     # @api semipublic
     #
-    def Database.setup?(name=:default)
+    def self.setup?(name=:default)
       repository = DataMapper.repository(name)
 
       return repository.class.adapters.has_key?(repository.name)
@@ -192,7 +195,7 @@ module Ronin
     #
     # @api semipublic
     #
-    def Database.upgrade!
+    def self.upgrade!
       if setup?
         Migrations.migrate_up!
       else
@@ -203,23 +206,31 @@ module Ronin
     #
     # Sets up the Database.
     #
+    # @param [String, Hash] uri
+    #   The optional default repository to setup instead of {repositories}.
+    #
     # @see Database.upgrade!
     #
     # @api semipublic
     #
-    def Database.setup
+    def self.setup(uri=nil)
       # setup the database log
       unless @log
-        if ($DEBUG || ENV['DEBUG'])
-          setup_log(:stream => $stderr, :level => :debug)
+        if $DEBUG
+          log(:stream => $stderr, :level => :debug)
         else
-          setup_log
+          log
         end
       end
 
-      # setup the database repositories
-      repositories.each do |name,uri|
-        DataMapper.setup(name,uri)
+      if uri
+        # only setup the default database repositories
+        DataMapper.setup(:default,uri)
+      else
+        # setup the database repositories
+        repositories.each do |name,uri|
+          DataMapper.setup(name,uri)
+        end
       end
 
       # finalize the Models
@@ -245,7 +256,7 @@ module Ronin
     #
     # @api public
     #
-    def Database.repository(name,&block)
+    def self.repository(name,&block)
       name = name.to_sym
 
       unless repository?(name)
@@ -274,7 +285,7 @@ module Ronin
     #
     # @api private
     #
-    def Database.clear(name)
+    def self.clear(name)
       name = name.to_sym
 
       unless repository?(name)
@@ -302,7 +313,7 @@ module Ronin
     #
     # @api public
     #
-    def Database.map
+    def self.map
       results = []
 
       repositories.each_key do |name|