ronin 1.0.0 → 1.1.0.rc1

data/.yardopts

@@ -1,4 +1,3 @@
 --markup markdown --title 'Ronin Documentation' --protected
---plugin yard-parameters
 --plugin yard-dm
 --plugin yard-dm-is-predefined

data/ChangeLog.md

@@ -1,3 +1,67 @@
+### 1.1.0 / 2011-05-17
+
+* Require env ~> 0.2.
+* Require data_paths ~> 0.3.
+* Require ronin-support ~> 0.2.
+* Added `ronin/repositories`, for quickly loading all repositories.
+* Added {Ronin::AutoLoad}.
+* Added {Ronin::Arch.arm}.
+* Added {Ronin::Arch.mips}.
+* Added {Ronin::Arch.x86}.
+* Added timestamps to {Ronin::Campaign}.
+* Added the `created_at` timestamp to {Ronin::Target}.
+* Added {Ronin::Network::Mixins::HTTP#http_status}.
+* Added {Ronin::Network::Mixins::HTTP#http_ok?}.
+* Added {Ronin::Network::Mixins::HTTP#http_server}.
+* Added {Ronin::Network::Mixins::HTTP#http_powered_by}.
+* Added `print_info` method calls to {Ronin::Network::Mixins::HTTP}.
+* Added {Ronin::Script::InstanceMethods#run}.
+* Added {Ronin::Script::Exception}.
+* Added {Ronin::Script::Path#to_s}.
+* Added {Ronin::Script::ClassMethods#load_from}.
+* Added {Ronin::Repository#find_script}.
+* Added {Ronin::UI::CLI::Command#setup}.
+* Added {Ronin::UI::CLI::ResourcesCommand}.
+* Added {Ronin::UI::CLI::ScriptCommand}.
+* Added the `--database` option to {Ronin::UI::CLI::ModelCommand}.
+* Renamed `Ronin::Engine` to {Ronin::Script}.
+* Renamed `Ronin::Engine::Verifiable` to {Ronin::Script::Testable}.
+* Renamed `Ronin::Engine#engine_name` to
+  {Ronin::Script::InstanceMethods#script_type}.
+* Renamed `Ronin::Engine::InstanceMethods#load_original!` to
+  {Ronin::Script::InstanceMethods#load_script!}.
+* Renamed `Ronin::CachedFile` to {Ronin::Script::Path}.
+* Renamed `Ronin::UI::CLI::ModelCommand.model=` to
+  {Ronin::UI::CLI::ModelCommand.model}.
+* Renamed `Ronin::UI::CLI::ModelCommand#model` to
+  {Ronin::UI::CLI::ModelCommand.query_model}.
+* Renamed `Ronin::UI::CLI::ModelCommand#new_query` to
+  {Ronin::UI::CLI::ModelCommand#query}.
+* Renamed `Ronin::UI::CLI::ModelCommand#print_resource` to
+  {Ronin::UI::CLI::ResourcesCommand#print_resource}.
+* Renamed `Ronin::UI::CLI::ModelCommand#print_resources` to
+  {Ronin::UI::CLI::ResourcesCommand#print_resources}.
+* Removed `Ronin::Engine#method_missing`.
+* Extend `DataPaths::Finders` into {Ronin::Config}.
+* Fixed a RubyGems deprecation in {Ronin::Installation}.
+* Enabled verbose DataMapper logging if the `DEBUG` environment variable is
+  set.
+* Fixed a bug in {Ronin::Database::Migrations::Migration#initialize}, where
+  `:needs` was being overridden.
+* Ensure that {Ronin::Database::Migrations} preserves the order of loaded
+  migrations.
+* Set the length of {Ronin::Password.clear_text} to 256.
+* Set the length of {Ronin::License.url} to 256.
+* Merged `Ronin::Model::Cacheable` into {Ronin::Script}.
+* Repositories can now cache/load scripts from the `scripts/` directory.
+* Set {Ronin::UI::Output.handler} to {Ronin::UI::Output::Terminal::Raw},
+  when `STDOUT` is not a tty.
+* {Ronin::UI::CLI::ModelCommand#setup} now automatically calls
+  {Ronin::Database.setup}, before executing the command.
+* Merged `query_method` into {Ronin::UI::CLI::ModelCommand#query}.
+* Allow {Ronin::UI::CLI::ModelCommand.query_option} to map to Model
+  properties.
+
 ### 1.0.0 / 2011-03-25
 
 * Upgraded to the GPL-3 license.
@@ -52,7 +116,7 @@
 * Added {Ronin::Organization}.
 * Added {Ronin::Campaign}.
 * Added {Ronin::Target}.
-* Added {Ronin::Engine}.
+* Added `Ronin::Engine`.
 * Added {Ronin::UI::Output::Terminal::Raw}.
 * Added {Ronin::UI::Output::Terminal::Color}.
 * Added the `ronin-repos` command for listing, adding, installing and
@@ -74,8 +138,8 @@
 * Renamed `Ronin::Product` to {Ronin::Software}.
 * Renamed `Ronin::UI::CommandLine` to {Ronin::UI::CLI}.
 * Renamed `Ronin::Platform::Overlay` to {Ronin::Repository}.
-* Renamed `Ronin::Platform::CachedFile` to {Ronin::CachedFile}.
-* Renamed `Ronin::Platform::Cacheable` to {Ronin::Model::Cacheable}.
+* Renamed `Ronin::Platform::CachedFile` to `Ronin::CachedFile`.
+* Renamed `Ronin::Platform::Cacheable` to `Ronin::Model::Cacheable`.
 * Removed `Ronin::Platform::Extension`.
 * Removed `Ronin::Platform`.
 * Moved the `ronin-add`, `ronin-install`, `ronin-list` and `ronin-uninstall`

data/Gemfile

@@ -22,7 +22,7 @@ gemspec
 # gem 'dm-timestamps',      DM_VERSION, :git => "#{DM_URI}/dm-timestamps.git"
 
 # Library dependencies
-# gem 'ronin-support',	'~> 0.1.0', :git => "#{RONIN_URI}/ronin-support.git"
+# gem 'ronin-support',	'~> 0.2', :git => "#{RONIN_URI}/ronin-support.git"
 
 group :development do
   gem 'rake',         '~> 0.8.7'
@@ -35,15 +35,23 @@ group :development do
   gem 'dm-visualizer',  '~> 0.2.0'
 end
 
-group :test do
-  adapters = (ENV['ADAPTER'] || ENV['ADAPTERS'])
-  adapters = adapters.to_s.gsub(',',' ').split(' ') - ['in_memory']
-
-  DM_ADAPTERS = %w[sqlite3 postgres mysql oracle sqlserver]
-
-  unless (DM_ADAPTERS & adapters).empty?
-    adapters.each do |adapter|
-      gem "dm-#{adapter}-adapter", DM_VERSION, :git => "#{DM_URI}/dm-#{adapter}-adapter.git"
-    end
-  end
+#
+# To enable additional DataMapper adapters for development work or for
+# testing purposes, simple set the ADAPTER or ADAPTERS environment
+# variable:
+#
+#     export ADAPTER="postgres"
+#     bundle install
+#
+#     ./bin/ronin --database postgres://ronin@localhost/ronin
+#
+require 'set'
+
+DM_ADAPTERS = Set['postgres', 'mysql', 'oracle', 'sqlserver']
+
+adapters = (ENV['ADAPTER'] || ENV['ADAPTERS']).to_s
+adapters = Set.new(adapters.to_s.tr(',',' ').split)
+
+(DM_ADAPTERS & adapters).each do |adapter|
+  gem "dm-#{adapter}-adapter", DM_VERSION #, :git => "#{DM_URI}/dm-#{adapter}-adapter.git"
 end

data/README.md

@@ -156,19 +156,17 @@ Remove a Database:
 * [parameters](http://github.com/postmodern/parameters#readme)
   ~> 0.2, >= 0.2.3
 * [data_paths](http://github.com/postmodern/data_paths#readme)
-  ~> 0.2, >= 0.2.1
+  ~> 0.3
 * [object_loader](http://github.com/postmodern/object_loader#readme)
   ~> 1.0
 * [env](http://github.com/postmodern/env#readme)
-  ~> 0.1, >= 0.1.2
+  ~> 0.2
 * [pullr](http://github.com/postmodern/pullr#readme)
   ~> 0.1, >= 0.1.2
-* [hexdump](http://github.com/postmodern/hexdump#readme)
-  ~> 0.1
 * [thor](http://github.com/wycats/thor#readme)
   ~> 0.14.3
 * [ronin-support](http://github.com/ronin-ruby/ronin-support#readme)
-  ~> 0.1
+  ~> 0.2
 
 ## Install
 

data/gemspec.yml

@@ -53,11 +53,11 @@ dependencies:
   uri-query_params: ~> 0.5, >= 0.5.2
   open_namespace: ~> 0.3
   parameters: ~> 0.2, >= 0.2.3
-  data_paths: ~> 0.2, >= 0.2.1
+  # data_paths: ~> 0.3
+  data_paths: ~> 0.3.0.rc1
   object_loader: ~> 1.0
-  env: ~> 0.1, >= 0.1.2
+  env: ~> 0.2
   pullr: ~> 0.1, >= 0.1.2
-  hexdump: ~> 0.1
   ripl: ~> 0.3
   ripl-multi_line: ~> 0.2
   ripl-auto_indent: ~> 0.1
@@ -65,11 +65,11 @@ dependencies:
   ripl-color_result: ~> 0.3
   thor: ~> 0.14.3
   # Ronin dependencies:
-  ronin-support: ~> 0.1
+  # ronin-support: ~> 0.2
+  ronin-support: ~> 0.2.0.rc1
 
 development_dependencies:
   bundler: ~> 1.0.10
   yard: ~> 0.6.4
-  yard-parameters: ~> 0.1.0
   yard-dm: ~> 0.1.1
   yard-dm-is-predefined: ~> 0.2.0

data/lib/ronin/address.rb

@@ -18,13 +18,12 @@
 #
 
 require 'ronin/model'
+require 'ronin/organization'
+require 'ronin/target'
 
 require 'dm-timestamps'
 
 module Ronin
-  autoload :Organization, 'ronin/organization'
-  autoload :Target, 'ronin/target'
-
   #
   # A base model which represents an Internet Address, such as:
   #
@@ -69,6 +68,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def self.[](key)
       if key.kind_of?(String)
         first(:address => key)
@@ -85,6 +86,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def to_s
       self.address.to_s
     end
@@ -97,6 +100,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def inspect
       "#<#{self.class}: #{self.address}>"
     end

data/lib/ronin/arch.rb

@@ -61,12 +61,14 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def to_ary
       [self.endian, self.address_length]
     end
 
     #
-    # Defines a new predefined Arch.
+    # Defines a new pre-defined Arch.
     #
     # @param [Symbol, String] name
     #   The name of the architecture.
@@ -80,27 +82,20 @@ module Ronin
     # @option options [Integer] :address_length
     #   The address-length of the architecture.
     #
-    # @example Defining a predefined Arch
+    # @example Defining a pre-defined Arch
     #   Arch.predefine :alpha, :endian => :big, :address_length => 8
     #
-    # @example Retrieving a predefined Arch
+    # @example Retrieving a pre-defined Arch
     #   Arch.alpha
     #
+    # @api private
+    #
     def self.predefine(name,options={})
       super(name,options.merge(:name => name))
     end
 
-    # The i386 Architecture
-    predefine :i386, :endian => :little, :address_length => 4
-
-    # The i486 Architecture
-    predefine :i486, :endian => :little, :address_length => 4
-
-    # The i686 Architecture
-    predefine :i686, :endian => :little, :address_length => 4
-
-    # The i986 Architecture
-    predefine :i986, :endian => :little, :address_length => 4
+    # The x86 Architecture
+    predefine :x86, :endian => :little, :address_length => 4
 
     # The x86_64 Architecture
     predefine :x86_64, :endian => :little, :address_length => 8
@@ -132,5 +127,35 @@ module Ronin
     # The ARM (big-endian) Architecture
     predefine :arm_be, :endian => :big, :address_length => 4
 
+    #
+    # @see x86
+    #
+    def self.i386; x86; end
+
+    #
+    # @see x86
+    #
+    def self.i486; x86; end
+
+    #
+    # @see x86
+    #
+    def self.i686; x86; end
+
+    #
+    # @see x86
+    #
+    def self.i986; x86; end
+
+    #
+    # @see mips_be
+    #
+    def self.mips; mips_be; end
+
+    #
+    # @see arm_be
+    #
+    def self.arm; arm_be; end
+
   end
 end

data/lib/ronin/author.rb

@@ -54,6 +54,8 @@ module Ronin
     # @return [String]
     #   The name of the author.
     #
+    # @api public
+    #
     def to_s
       if self.email
         "#{self.name} <#{self.email}>"

data/lib/ronin/auto_load.rb

@@ -0,0 +1,67 @@
+#
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin.
+#
+# Ronin 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 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin 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 Ronin.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'open_namespace'
+
+module Ronin
+  #
+  # When included into other namespaces, it allows for auto-loading Classes
+  # or Modules via {#const_missing}.
+  #
+  # @since 1.1.0
+  #
+  module AutoLoad
+    def self.included(base)
+      base.send :include, OpenNamespace
+      base.send :extend, self
+    end
+
+    protected
+
+    #
+    # Transparently auto-loads Classes and Modules from their respective
+    # files using [OpenNamespace](http://rubydoc.info/gems/open_namespace).
+    #
+    # @param [String, Symbol] name
+    #   The name of the Class or Module to auto-load.
+    #
+    # @return [Class, Module]
+    #   The loaded Class or Module.
+    #
+    # @raise [NameError]
+    #   The Class or Module could not be found.
+    #
+    # @since 1.1.0
+    #
+    # @api public
+    #
+    def const_missing(name)
+      const = super(name)
+
+      if Object.const_defined?('DataMapper')
+        # if the loaded Class is a DataMapper Resource, re-finalize
+        if const < DataMapper::Resource
+          DataMapper.finalize
+        end
+      end
+
+      return const
+    end
+  end
+end

data/lib/ronin/campaign.rb

@@ -20,10 +20,11 @@
 require 'ronin/model'
 require 'ronin/model/has_unique_name'
 require 'ronin/model/has_description'
+require 'ronin/target'
 
-module Ronin
-  autoload :Target, 'ronin/target'
+require 'dm-timestamps'
 
+module Ronin
   #
   # Represents a grouping of targeted {Address}es.
   #
@@ -32,10 +33,14 @@ module Ronin
     include Model
     include Model::HasUniqueName
     include Model::HasDescription
+    include DataMapper::Timestamps
 
     # Primary key of the campaign
     property :id, Serial
 
+    # Defines the `created_at` and `updated_at` timestamps
+    timestamps :at
+
     # The targets of the campaign
     has 0..n, :targets
 
@@ -56,6 +61,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def self.targeting(addr)
       all(:addresses => {:address => addr})
     end
@@ -71,6 +78,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def self.targeting_orgs(names)
       all(:organizations => {:name => names})
     end
@@ -86,6 +95,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def targets?(addr)
       self.addresses.include?(address)
     end
@@ -104,6 +115,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def target!(addr)
       unless (address = Address.first(:address => addr))
         raise("unknown address #{addr.dump}")