ronin 1.0.0.pre4 → 1.0.0.rc1

data/ChangeLog.md

@@ -22,6 +22,7 @@
 * Require parameters ~> 0.2.3.
 * Require data_paths ~> 0.2.1.
 * Require contextify ~> 0.2.0.
+* Require env ~> 0.1.2.
 * Require pullr ~> 0.1.2.
 * Require thor ~> 0.14.3.
 * Require ripl ~> 0.3.0.

data/Gemfile

@@ -1,3 +1,5 @@
+require 'ore/specification'
+
 source 'https://rubygems.org'
 
 DATA_MAPPER = 'http://github.com/datamapper'
@@ -12,7 +14,7 @@ gemspec
 group :development do
   gem 'rake',         '~> 0.8.7'
 
-  gem 'ore-core',     '~> 0.1.0'
+  gem 'ore-core',     '~> 0.1.1'
   gem 'ore-tasks',    '~> 0.3.0'
   gem 'rspec',        '~> 2.3.0'
 

data/README.md

@@ -13,26 +13,24 @@ Ronin is a Ruby platform for exploit development and security research.
 Ronin allows for the rapid development and distribution of code, exploits
 or payloads over many common Source-Code-Management (SCM) systems.
 
-### Ruby
+### Hack with Ruby
 
-Ronin's Ruby environment allows security researchers to leverage Ruby with
-ease. The Ruby environment contains a multitude of convenience methods
-for working with data in Ruby, a Ruby Object Database, a customized Ruby
-Console and an extendable command-line interface.
+Ronin combines the flexibility of Ruby with countless convenience methods
+and libraries, to make Ruby usable for Offensive Security or Research work.
 
-### Extend
+### Organize Your Data
 
-Ronin's more specialized features are provided by additional Ronin
-libraries, which users can choose to install. These libraries can allow
-one to write and run Exploits and Payloads, scan for PHP vulnerabilities,
-perform Google Dorks  or run 3rd party scanners.
+Ronin comes with a Database designed for Security data and accessible from
+Ruby using [DataMapper](http://datamapper.org). With Ronin, storing or
+querying IP addresses, Hosts, Ports, URLs, Passwords is as simple as a
+single line of Ruby.
 
-### Publish
+### Share Code
 
-Ronin allows users to publish and share code, exploits, payloads or other
-data via Ronin Repositories. Repositories are directories of code and data
-that can be hosted on any SVN, Hg, Git or Rsync server. Ronin makes it easy
-to create, install and update Repositories.
+Ronin allows sharing code with the community, or just your friends, via
+Ronin Repositories. Ronin Repositories are like lazier versions of
+[RubyGems](http://rubygems.org/), that can be hosted with SubVersion,
+Mercurial or Git.
 
 ## Features
 
@@ -42,8 +40,7 @@ to create, install and update Repositories.
     * [Mercurial (Hg)](http://mercurial.selenic.com/)
     * [Git](http://git-scm.com/)
     * Rsync
-* Provides Object Database using [DataMapper](http://datamapper.org)
-  with:
+* Provides a Database using [DataMapper](http://datamapper.org) with:
   * {Ronin::Author}
   * {Ronin::License}
   * {Ronin::Arch}
@@ -79,7 +76,7 @@ to create, install and update Repositories.
   * Pretty-Print loaded.
   * `print_info`, `print_error`, `print_warning` and `print_debug`
     output helper methods with color-output.
-* Provides an extendable command-line interface based on
+* Provides an extensible command-line interface based on
   [Thor](http://github.com/wycats/thor#readme).
 
 ## Synopsis
@@ -151,6 +148,7 @@ Remove a Database:
 * [parameters](http://github.com/postmodern/parameters) ~> 0.2.2
 * [data_paths](http://github.com/postmodern/data_paths) ~> 0.2.1
 * [contextify](http://github.com/postmodern/contextify/) ~> 0.1.6
+* [env](http://github.com/postmodern/env) ~> 0.1.2
 * [pullr](http://github.com/postmodern/pullr/) ~> 0.1.2
 * [thor](http://github.com/wycats/thor/) ~> 0.14.2
 * [ronin-support](http://github.com/ronin-ruby/ronin-support/) ~> 0.1.0
@@ -187,7 +185,7 @@ for Ronin that provides various generators.
 ### Ronin SQL
 
 [Ronin SQL](http://github.com/ronin-ruby/ronin-sql#readme) is a Ruby library
-for Ronin that provids support for SQL related security tasks, such as
+for Ronin that provides support for SQL related security tasks, such as
 scanning for and exploiting SQL injections.
 
 ### Ronin PHP

data/Rakefile

@@ -23,6 +23,7 @@ Ore::Tasks.new
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new
+task :test => :spec
 task :default => :spec
 
 require 'dm-visualizer/rake/graphviz_task'

data/gemspec.yml

@@ -59,6 +59,7 @@ dependencies:
   parameters: ~> 0.2.3
   data_paths: ~> 0.2.1
   contextify: ~> 0.2.0
+  env: ~> 0.1.2
   pullr: ~> 0.1.2
   thor: ~> 0.14.3
   ripl: ~> 0.3.0
@@ -67,7 +68,7 @@ dependencies:
   ripl-short_errors: ~> 0.1.0
   ripl-color_result: ~> 0.2.0
   # Ronin dependencies:
-  ronin-support: ~> 0.1.0.pre3
+  ronin-support: ~> 0.1.0.rc1
 
 development_dependencies:
   bundler: ~> 1.0.0

data/lib/ronin.rb

@@ -17,6 +17,9 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
+#
+# Loads up the full Ronin environment.
+#
 require 'ronin/bootstrap'
 require 'ronin/environment'
 require 'ronin/version'

data/lib/ronin/address.rb

@@ -25,6 +25,13 @@ require 'dm-timestamps'
 require 'dm-tags'
 
 module Ronin
+  #
+  # A base model which represents an Internet Address, such as:
+  #
+  # * {MACAddress}
+  # * {IPAddress}
+  # * {HostName}
+  #
   class Address
 
     include Model
@@ -45,9 +52,6 @@ module Ronin
     # The targets associated with the address
     has 0..n, :targets
 
-    # The remote files associated with the address
-    has 0..n, :remote_files, :through => :targets
-
     # The campaigns targeting the address
     has 0..n, :campaigns, :through => :targets
 

data/lib/ronin/arch.rb

@@ -66,7 +66,7 @@ module Ronin
     end
 
     #
-    # Defines a new builtin Arch.
+    # Defines a new predefined Arch.
     #
     # @param [Symbol, String] name
     #   The name of the architecture.
@@ -80,7 +80,7 @@ module Ronin
     # @option options [Integer] :address_length
     #   The address-length of the architecture.
     #
-    # @example Defining a builtin Arch
+    # @example Defining a predefined Arch
     #   Arch.predefine :alpha, :endian => :big, :address_length => 8
     #
     # @example Retrieving a predefined Arch

data/lib/ronin/bootstrap.rb

@@ -17,6 +17,9 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
+#
+# Loads the Ronin configuration and sets up the Database.
+#
 require 'ronin/config'
 require 'ronin/database'
 

data/lib/ronin/cached_file.rb

@@ -58,7 +58,7 @@ module Ronin
     # The path to require to access the Class of the cached object.
     #
     # @return [String]
-    #   The possible path infered from the class name.
+    #   The possible path inferred from the class name.
     #
     def model_path
       if self.model_name

data/lib/ronin/campaign.rb

@@ -20,12 +20,12 @@
 require 'ronin/model'
 require 'ronin/model/has_unique_name'
 require 'ronin/model/has_description'
-require 'ronin/config'
 require 'ronin/target'
 
-require 'fileutils'
-
 module Ronin
+  #
+  # Represents a grouping of targeted {Address}es.
+  #
   class Campaign
 
     include Model
@@ -111,34 +111,5 @@ module Ronin
       return Target.first_or_create(:campaign => self, :address => address)
     end
 
-    #
-    # The file-name to use for the campaign.
-    #
-    # @return [String, nil]
-    #   The File System safe name to use for the campaign.
-    #
-    # @since 1.0.0
-    #
-    def filename
-      self.name.downcase.gsub(/[^a-z0-9]+/,'_') if self.name
-    end
-
-    #
-    # The directory to store files related to the campaign.
-    #
-    # @return [String, nil]
-    #   The path to the directory.
-    #
-    # @since 1.0.0
-    #
-    def directory
-      if self.name
-        path = File.join(Config::CAMPAIGNS_DIR,filename)
-
-        FileUtils.mkdir(path) unless File.directory?(path)
-        return path
-      end
-    end
-
   end
 end

data/lib/ronin/class_methods.rb

@@ -18,7 +18,24 @@
 #
 
 module Ronin
+  #
+  # Class methods that are included when {Ronin} is included.
+  #
   module ClassMethods
+    #
+    # Catches missing constants and searches the {Ronin} namespace.
+    #
+    # @param [Symbol] name
+    #   The constant name.
+    #
+    # @return [Object]
+    #   The found constant.
+    #
+    # @raise [NameError]
+    #   The constant could not be found within {Ronin}.
+    #
+    # @since 1.0.0
+    #
     def const_missing(name)
       Ronin.send(:const_missing,name) || super(name)
     end

data/lib/ronin/config.rb

@@ -17,54 +17,58 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
+require 'env'
 require 'data_paths'
 require 'fileutils'
 
 module Ronin
+  #
+  # Configuration information for Ronin.
+  #
   module Config
     include DataPaths
 
     # The users home directory
-    HOME = File.expand_path(ENV['HOME'] || ENV['HOMEPATH'])
+    HOME = Env.home
 
     # Ronin home directory
-    PATH = File.join(HOME,'.ronin')
+    PATH = HOME.join('.ronin')
 
     # Configuration files directory
-    CONFIG_DIR = File.join(PATH,'config')
+    CONFIG_DIR = PATH.join('config')
 
     # Directory which repositories are installed into
-    REPOS_DIR = File.join(PATH,'repos')
+    REPOS_DIR = PATH.join('repos')
 
     # Temporary file directory
-    TMP_DIR = File.join(PATH,'tmp')
+    TMP_DIR = PATH.join('tmp')
 
-    # Directory for storing files for campaigns
-    CAMPAIGNS_DIR = File.join(PATH,'campaigns')
-    
-    FileUtils.mkdir(PATH) unless File.directory?(PATH)
-    FileUtils.mkdir(CONFIG_DIR) unless File.directory?(PATH)
-    FileUtils.mkdir(TMP_DIR) unless File.directory?(TMP_DIR)
-    FileUtils.mkdir(CAMPAIGNS_DIR) unless File.directory?(CAMPAIGNS_DIR)
+    PATH.mkdir unless PATH.directory?
+    CONFIG_DIR.mkdir unless PATH.directory?
+    TMP_DIR.mkdir unless TMP_DIR.directory?
 
     #
     # Loads the Ronin configuration file.
     #
     # @param [Symbol, String, nil] name
-    #   The optional name of the file to load within +CONFIG_DIR+.
+    #   The optional name of the file to load within {CONFIG_DIR}.
     #
-    # @example Load the config file at `~/.ronin/config/ronin.rb`
+    # @example Load the config file at `~/.ronin/config.rb`
     #   Config.load
     #   # => true
     #
-    # @example Load a specific config file in `~/.ronin/config/`
+    # @example Load the config file at `~/.ronin/config/sql.rb`
     #   Config.load :sql
     #   # => true
     #
-    def Config.load(name=:ronin)
-      path = File.expand_path(File.join(CONFIG_DIR,name.to_s))
+    def Config.load(name=nil)
+      path = if name
+               CONFIG_DIR.join("#{name}.rb").expand_path
+             else
+               PATH.join('config.rb')
+             end
 
-      require path if File.file?(path)
+      require path if path.file?
     end
 
     #
@@ -73,18 +77,15 @@ module Ronin
     # @param [String] sub_path
     #   The sub-path within {TMP_DIR}.
     #
-    # @return [String]
+    # @return [Pathname]
     #   The full path within {TMP_DIR}.
     #
     def Config.tmp_dir(sub_path=nil)
       if sub_path
         sub_path = File.expand_path(File.join('',sub_path))
-        path = File.join(TMP_DIR,sub_path)
-
-        unless File.exist?(path)
-          FileUtils.mkdir_p(path)
-        end
+        path = TMP_DIR.join(sub_path)
 
+        path.mkpath unless path.exist?
         return path
       end
 

data/lib/ronin/credential.rb

@@ -22,6 +22,9 @@ require 'ronin/password'
 require 'ronin/model'
 
 module Ronin
+  #
+  # Represents Credentials used to access services or websites.
+  #
   class Credential
 
     include Model

data/lib/ronin/database/migrations.rb

@@ -45,7 +45,6 @@ require 'ronin/database/migrations/create_countries_table'
 require 'ronin/database/migrations/create_organizations_table'
 require 'ronin/database/migrations/create_campaigns_table'
 require 'ronin/database/migrations/create_targets_table'
-require 'ronin/database/migrations/create_remote_files_table'
 require 'ronin/database/migrations/create_cached_files_table'
 require 'ronin/database/migrations/create_repositories_table'
 

data/lib/ronin/database/migrations/create_credentials_table.rb

@@ -46,12 +46,11 @@ module Ronin
             column :open_port_id, Integer
             column :email_address_id, Integer
             column :url_id, Integer
-            column :proxy_id, Integer
           end
 
           create_index :ronin_credentials,
                        :user_name_id, :password_id,
-                       :open_port_id, :email_address_id, :url_id, :proxy_id,
+                       :open_port_id, :email_address_id, :url_id,
                        :name => :unique_index_ronin_credentials,
                        :unique => true
         end

data/lib/ronin/database/migrations/graph.rb

@@ -27,6 +27,9 @@ require 'tsort'
 module Ronin
   module Database
     module Migrations
+      #
+      # Sorts and runs {Migration}s based on their dependencies.
+      #
       class Graph
 
         include Enumerable
@@ -171,7 +174,7 @@ module Ronin
           end
 
           if position > 1
-            # explicit define a dependencey on the previous migration position
+            # explicit define a dependency on the previous migration position
             options[:needs] = [position - 1]
           end
 
@@ -202,7 +205,7 @@ module Ronin
         #   If no block is given, an enumerator object will be returned.
         #
         # @raise [UnknownMigration]
-        #   A migration had a dependencey on an unknown migration.
+        #   A migration had a dependency on an unknown migration.
         #
         # @since 1.0.1
         #
@@ -240,7 +243,7 @@ module Ronin
         #   If no block is given, an enumerator object will be returned.
         #
         # @raise [UnknownMigration]
-        #   A migration had a dependencey on an unknown migration.
+        #   A migration had a dependency on an unknown migration.
         #
         # @since 1.0.1
         #