ronin 0.2.4 → 0.3.0

data/lib/ronin/code/reference.rb

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -18,7 +16,6 @@
 # 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
-#++
 #
 
 module Ronin
@@ -125,7 +122,7 @@ module Ronin
           return @value.send(name,*arguments,&block)
         end
 
-        raise(NoMethodError,name.id2name)
+        super(name,*arguments,&block)
       end
 
     end

data/lib/ronin/code/symbol_table.rb

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -18,7 +16,6 @@
 # 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/code/reference'

data/lib/ronin/code/token.rb

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -18,7 +16,6 @@
 # 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/code/emittable'

data/lib/ronin/config.rb

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -18,7 +16,6 @@
 # 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 'fileutils'
@@ -41,17 +38,17 @@ module Ronin
     TMP_DIR = FileUtils.mkdir_p(File.join(PATH,'tmp'))
 
     #
-    # Require the Ronin configuration file with the given _name_ in the
-    # Ronin configuration files directory. If _name_ is not given, than the
-    # main Ronin configuration file will be loaded.
+    # Loads the Ronin configuration file.
     #
-    # Load the main config file at <tt>~/.ronin/config.rb</tt>
+    # @param [String, nil] name
+    #   The optional name of the file to load within +CONFIG_DIR+.
+    #   If no name is given, +CONFIG_PATH+ will simply be loaded.
     #
+    # @example Load the main config file at <tt>~/.ronin/config.rb</tt>
     #   Config.load
     #   # => true
     #
-    # Load a specific config file in <tt>~/.ronin/config/</tt>
-    #
+    # @example Load a specific config file in <tt>~/.ronin/config/</tt>
     #   Config.load :sql
     #   # => true
     #
@@ -64,5 +61,29 @@ module Ronin
 
       require path if File.file?(path)
     end
+
+    #
+    # Auto-creates a directory within {TMP_DIR}.
+    #
+    # @param [String] sub_path
+    #   The sub-path within {TMP_DIR}.
+    #
+    # @return [String]
+    #   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
+
+        return path
+      end
+
+      return TMP_DIR
+    end
   end
 end

data/lib/ronin/database.rb

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -18,7 +16,6 @@
 # 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/database/database'

data/lib/ronin/database/database.rb

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -18,11 +16,8 @@
 # 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
-#++
 #
 
-gem 'addressable', '2.0.2'
-
 require 'ronin/database/exceptions/invalid_config'
 require 'ronin/model'
 require 'ronin/arch'
@@ -47,16 +42,16 @@ module Ronin
     DEFAULT_LOG_LEVEL = :info
 
     # Default configuration of the database
-    DEFAULT_CONFIG = {
-      :adapter => 'sqlite3',
-      :database => File.join(Config::PATH,'database.sqlite3')
-    }
+    DEFAULT_CONFIG = "sqlite3://" + File.join(Config::PATH,'database.sqlite3')
 
     #
     # Returns the Database configuration that is stored in the
     # +CONFIG_FILE+. Defaults to +DEFAULT_CONFIG+ if +CONFIG_FILE+ does not
     # exist.
     #
+    # @raise [InvalidConfig]
+    #   The config file did not contain a YAML Hash or String.
+    #
     def Database.config
       unless (class_variable_defined?('@@ronin_database_config'))
         @@ronin_database_config = DEFAULT_CONFIG
@@ -76,27 +71,41 @@ module Ronin
     end
 
     #
-    # Sets the Database configuration to the specified _configuration_.
+    # Sets the Database configuration.
+    #
+    # @param [String, Hash] configuration
+    #   The DataMapper configuration to set the Ronin::Database with.
     #
     def Database.config=(configuration)
       @@ronin_database_config = configuration
     end
 
     #
-    # Returns the current Database log.
+    # @return [DataMapper::Logger, nil]
+    #   The current Database log.
     #
     def Database.log
       @@ronin_database_log ||= nil
     end
 
     #
-    # Setup the Database log with the given _options_.
+    # Setup the Database log.
+    #
+    # @param [Hash] options
+    #   Additional options.
+    #
+    # @option options [String] :path (DEFAULT_LOG_PATH)
+    #   The path of the log file.
     #
-    # _options_ may contain the following keys:
-    # <tt>:path</tt>:: The path of the log file. Defaults to
-    #                  +DEFAULT_LOG_PATH+.
-    # <tt>:stream</tt>:: The stream to use for the log.
-    # <tt>:level</tt>:: The level of messages to log.
+    # @option options [IO] :stream
+    #   The stream to use for the log.
+    #
+    # @option options [Symbol] :level
+    #   The level of messages to log.
+    #   May be either +:fatal+, +:error+, +:warn+, +:info+ or +:debug+.
+    #
+    # @return [DataMapper::Logger]
+    #   The new Database log.
     #
     def Database.setup_log(options={})
       path = (options[:path] || DEFAULT_LOG_PATH)
@@ -107,7 +116,8 @@ module Ronin
     end
 
     #
-    # Returns +true+ if the Database is setup, returns +false+ otherwise.
+    # @return [Boolean]
+    #   Specifies wether or not the Database is setup.
     #
     def Database.setup?
       repository = DataMapper.repository(Model::REPOSITORY_NAME)
@@ -116,7 +126,11 @@ module Ronin
     end
 
     #
-    # Call the given _block_ then run auto-upgrades on the Database.
+    # Updates the Database, by running auto-upgrades, but only if the
+    # Database is already setup.
+    #
+    # @yield []
+    #   The block to call before the Database is updated.
     #
     def Database.update!(&block)
       block.call if block
@@ -126,9 +140,14 @@ module Ronin
     end
 
     #
-    # Sets up the Database with the given _configuration_. If
-    # _configuration is not given, +DEFAULT_CONFIG+ will be used to setup
-    # the Database.
+    # Sets up the Database.
+    #
+    # @param [String, Hash] configuration
+    #   The DataMapper configuration to use to setup the Database.
+    # 
+    # @yield []
+    #   The block to call after the Database has been setup, but before
+    #   it is updated.
     #
     def Database.setup(configuration=Database.config,&block)
       # setup the database log

data/lib/ronin/database/exceptions.rb

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -18,7 +16,6 @@
 # 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/database/exceptions/invalid_config'

data/lib/ronin/database/exceptions/invalid_config.rb

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -18,7 +16,6 @@
 # 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
-#++
 #
 
 module Ronin

data/lib/ronin/environment.rb

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -18,7 +16,6 @@
 # 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/config'
@@ -28,7 +25,6 @@ require 'ronin/path'
 require 'ronin/network'
 require 'ronin/database'
 require 'ronin/ui'
-require 'ronin/ronin'
 
 require 'chars'
 require 'pp'

data/lib/ronin/extensions.rb

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -18,12 +16,10 @@
 # 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/extensions/meta'
 require 'ronin/extensions/kernel'
-require 'ronin/extensions/hash'
 require 'ronin/extensions/uri'
 require 'ronin/extensions/string'
 require 'ronin/extensions/file'

data/lib/ronin/extensions/array.rb

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -18,18 +16,22 @@
 # 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
-#++
 #
 
 class Array
 
   #
-  # Returns the power set of the array. Shamelessly borrowed from
-  # http://johncarrino.net/blog/2006/08/11/powerset-in-ruby/.
+  # Calculates the power-set of the Array.
   #
+  # @return [Array]
+  #   The power set of the array.
+  #
+  # @example
   #   [1,2,3].power_set
   #   # => [[], [3], [2], [2, 3], [1], [1, 3], [1, 2], [1, 2, 3]]
   #
+  # @see http://johncarrino.net/blog/2006/08/11/powerset-in-ruby/
+  #
   def power_set
     inject([[]]) do |power_set,element|
       sub_set = []

data/lib/ronin/extensions/file.rb

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -18,7 +16,6 @@
 # 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
-#++
 #
 
 class File
@@ -26,6 +23,14 @@ class File
   #
   # Writes the specified _data_ to the specified _path_.
   #
+  # @param [String] path
+  #   The path of the file to write to.
+  #
+  # @param [String] data
+  #   The data to write to the file.
+  #
+  # @return [nil]
+  #
   def File.write(path,data)
     File.open(path,'w') { |file| file.write(data) }
   end

data/lib/ronin/extensions/ip_addr.rb

@@ -1,7 +1,5 @@
 #
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
+# Ronin - A Ruby platform for exploit development and security research.
 #
 # Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -18,7 +16,6 @@
 # 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 'ipaddr'
@@ -28,20 +25,33 @@ class IPAddr
   include Enumerable
 
   #
-  # Iterates over the CIDR or globbed address range, passing each
-  # address in the range to the specified _block_. Supports both
-  # IPv4 and IPv6 address ranges.
+  # Iterates over each IP address within the IP Address range. Supports
+  # both IPv4 and IPv6 address ranges.
   #
+  # @param [String] cidr_or_glob
+  #   The IP address range to iterate over.
+  #   May be in standard CIDR notation or globbed format.
+  #
+  # @yield [ip]
+  #   The block which will be passed each IP address contained within the
+  #   IP address range.
+  #
+  # @yieldparam [String] ip
+  #   An IP address within the IP address range.
+  #
+  # @example Enumerate through a CIDR range
   #   IPAddr.each('10.1.1.1/24') do |ip|
-  #     ...
+  #     puts ip
   #   end
   #
+  # @example Enumerate through a globbed IP range
   #   IPAddr.each('10.1.1-5.*') do |ip|
-  #     ...
+  #     puts ip
   #   end
   #
+  # @example Enumerate through a globbed IPv6 range
   #   IPAddr.each('::ff::02-0a::c3') do |ip|
-  #     ...
+  #     puts ip
   #   end
   #
   def IPAddr.each(cidr_or_glob,&block)
@@ -102,10 +112,20 @@ class IPAddr
   end
 
   #
-  # Iterates over each IP address that is included in the addresses mask,
-  # passing each address to the specified _block_.
+  # Iterates over each IP address that is included in the addresses netmask.
+  # Supports both IPv4 and IPv6 addresses.
+  #
+  # @yield [ip]
+  #   The block which will be passed every IP address covered be the
+  #   netmask of the IPAddr object.
+  #
+  # @yieldparam [String] ip
+  #   An IP address.
+  #
+  # @example
+  #   netblock = IPAddr.new('10.1.1.1/24')
   #
-  #   IPAddr.new('10.1.1.1/24').each do |ip|
+  #   netblock.each do |ip|
   #     puts ip
   #   end
   #