ronin 0.2.4 → 0.3.0

data/bin/ronin

@@ -9,4 +9,4 @@ end
 
 require 'ronin/ui/command_line'
 
-Ronin::UI::CommandLine.run(*ARGV)
+Ronin::UI::CommandLine.start

data/bin/ronin-add

@@ -9,4 +9,4 @@ end
 
 require 'ronin/ui/command_line/commands/add'
 
-Ronin::UI::CommandLine::Commands::Add.run(*ARGV)
+Ronin::UI::CommandLine::Commands::Add.start

data/bin/ronin-console

@@ -9,4 +9,4 @@ end
 
 require 'ronin/ui/command_line/commands/console'
 
-Ronin::UI::CommandLine::Commands::Console.run(*ARGV)
+Ronin::UI::CommandLine::Commands::Console.start

data/bin/ronin-help

@@ -9,4 +9,4 @@ end
 
 require 'ronin/ui/command_line/commands/help'
 
-Ronin::UI::CommandLine::Commands::Help.run(*ARGV)
+Ronin::UI::CommandLine::Commands::Help.start

data/bin/ronin-install

@@ -9,4 +9,4 @@ end
 
 require 'ronin/ui/command_line/commands/install'
 
-Ronin::UI::CommandLine::Commands::Install.run(*ARGV)
+Ronin::UI::CommandLine::Commands::Install.start

data/bin/ronin-list

@@ -9,4 +9,4 @@ end
 
 require 'ronin/ui/command_line/commands/list'
 
-Ronin::UI::CommandLine::Commands::List.run(*ARGV)
+Ronin::UI::CommandLine::Commands::List.start

data/bin/ronin-remove

@@ -9,4 +9,4 @@ end
 
 require 'ronin/ui/command_line/commands/remove'
 
-Ronin::UI::CommandLine::Commands::Remove.run(*ARGV)
+Ronin::UI::CommandLine::Commands::Remove.start

data/bin/ronin-uninstall

@@ -9,4 +9,4 @@ end
 
 require 'ronin/ui/command_line/commands/uninstall'
 
-Ronin::UI::CommandLine::Commands::Uninstall.run(*ARGV)
+Ronin::UI::CommandLine::Commands::Uninstall.start

data/bin/ronin-update

@@ -9,4 +9,4 @@ end
 
 require 'ronin/ui/command_line/commands/update'
 
-Ronin::UI::CommandLine::Commands::Update.run(*ARGV)
+Ronin::UI::CommandLine::Commands::Update.start

data/lib/ronin.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,8 +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
-#++
 #
 
 require 'ronin/environment'
+require 'ronin/platform'
 require 'ronin/version'

data/lib/ronin/arch.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/extensions/meta'
@@ -54,34 +51,82 @@ module Ronin
     validates_is_number :address_length
 
     #
-    # Returns the name of the arch as a String.
+    # Converts the architecture to a String.
+    #
+    # @return [String]
+    #   The name of the architecture.
     #
     def to_s
-      @name.to_s
+      self.name.to_s
     end
 
     #
     # Defines a new builtin Arch with the specified _name_ and the given
     # _options_.
     #
-    def self.define(name,options={})
+    # @param [Symbol, String] name
+    #   The name of the architecture.
+    #
+    # @param [Hash] options
+    #   Additional options.
+    #
+    # @option options [Symbol, String] :endian
+    #   The endianness of the architecture.
+    #
+    # @option options [Integer] :address_length
+    #   The address-length of the architecture.
+    #
+    # @example Defining a builtin Arch
+    #   Arch.predefine :alpha, :endian => :big, :address_length => 8
+    #
+    # @example Retrieving a predefined Arch
+    #   Arch.alpha
+    #
+    def self.predefine(name,options={})
       super(name,options.merge(:name => name))
     end
 
-    define :i386, :endian => :little, :address_length => 4
-    define :i486, :endian => :little, :address_length => 4
-    define :i686, :endian => :little, :address_length => 4
-    define :i986, :endian => :little, :address_length => 4
-    define :x86_64, :endian => :little, :address_length => 8
-    define :ia64, :endian => :little, :address_length => 8
-    define :ppc, :endian => :big, :address_length => 4
-    define :ppc64, :endian => :big, :address_length => 8
-    define :sparc, :endian => :big, :address_length => 4
-    define :sparc64, :endian => :big, :address_length => 8
-    define :mips_le, :endian => :little, :address_length => 4
-    define :mips_be, :endian => :big, :address_length => 4
-    define :arm_le, :endian => :little, :address_length => 4
-    define :arm_be, :endian => :big, :address_length => 4
+    # 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_64 Architecture
+    predefine :x86_64, :endian => :little, :address_length => 8
+
+    # The ia64 Architecture
+    predefine :ia64, :endian => :little, :address_length => 8
+
+    # The 32-bit PowerPC Architecture
+    predefine :ppc, :endian => :big, :address_length => 4
+
+    # The 64-bit PowerPC Architecture
+    predefine :ppc64, :endian => :big, :address_length => 8
+
+    # The 32-bit SPARC Architecture
+    predefine :sparc, :endian => :big, :address_length => 4
+
+    # The 64-bit SPARC Architecture
+    predefine :sparc64, :endian => :big, :address_length => 8
+
+    # The MIPS (little-endian) Architecture
+    predefine :mips_le, :endian => :little, :address_length => 4
+
+    # The MIPS (big-endian) Architecture
+    predefine :mips_be, :endian => :big, :address_length => 4
+
+    # The ARM (little-endian) Architecture
+    predefine :arm_le, :endian => :little, :address_length => 4
+
+    # The ARM (big-endian) Architecture
+    predefine :arm_be, :endian => :big, :address_length => 4
 
   end
 end

data/lib/ronin/author.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/model'
@@ -32,7 +29,7 @@ module Ronin
     include Model
 
     # Anonymouse author name
-    ANONYMOUSE = 'anonymous'
+    ANONYMOUSE = 'Anonymous'
 
     # Primary key of the author
     property :id, Serial
@@ -59,13 +56,26 @@ module Ronin
     # Creates a new Author object with the given _options_. If _block_ is
     # given, it will be passed the newly created Author object.
     #
-    # _info_ may contain the following keys:
-    # <tt>:name</tt>:: The name of the author. Defaults to +ANONYMOUSE+.
-    # <tt>:organization</tt>:: The organization of the author.
-    # <tt>:pgp_signature</tt>:: The PGP signature of the author.
-    # <tt>:email</tt>:: The email address of the author.
-    # <tt>:url</tt>:: The URL for the author.
-    # <tt>:biography</tt>:: The biography of the author.
+    # @param [Hash] options
+    #   Additional options.
+    #
+    # @option options [String] :name (ANONYMOUSE)
+    #   The name of the author.
+    #
+    # @option options [String] :organization
+    #   The organization the author belongs to.
+    #
+    # @option options [String] :pgp_signature
+    #   The PGP fingerprint of the author.
+    #
+    # @option options [String] :email
+    #   The email to contact the author.
+    #
+    # @option options [String] :url
+    #   The URL of the author.
+    #
+    # @option options [String] :biography
+    #   The biography of the author.
     #
     def initialize(options={},&block)
       super(options)
@@ -73,15 +83,14 @@ module Ronin
       block.call(self) if block
     end
 
-    def name
-      @name || ANONYMOUSE
-    end
-
     #
-    # Returns the name of the author.
+    # Converts the author to a String.
+    #
+    # @return [String]
+    #   The name of the author.
     #
     def to_s
-      @name.to_s
+      self.name.to_s
     end
 
   end

data/lib/ronin/cacheable.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/model'
@@ -102,13 +99,32 @@ module Ronin
         end
 
         #
-        # Loads the first object with the matching _attributes_.
+        # Loads the first object with matching attributes.
         #
-        def self.load_first(attributes={})
-          if (obj = self.first(attributes))
-            obj.load_original!
-          end
+        # @param [Hash] attributes
+        #   Attributes to search for.
+        #
+        # @yield [objs]
+        #   If a block is given, it will be passed all matching
+        #   objects to be filtered down. The first object from the filtered
+        #   objects will end up being selected.
+        #
+        # @yieldparam [Array<Cacheable>] objs
+        #   All matching objects.
+        #
+        # @return [Cacheable]
+        #   The loaded cached objects.
+        #
+        def self.load_first(attributes={},&block)
+          obj = if block
+                  objs = self.all(attributes)
+
+                  (block.call(objs) || objs).first
+                else
+                  self.first(attributes)
+                end
 
+          obj.load_original! if obj
           return obj
         end
       end
@@ -119,15 +135,27 @@ module Ronin
     end
 
     #
-    # List of cacheable models.
+    # @return [Array]
+    #   List of cacheable models.
     #
     def Cacheable.models
       @@ronin_cacheable_models ||= []
     end
 
     #
-    # Loads all cacheable objects from the specified _path_. If a _block_
-    # is given, it will be passed each loaded object.
+    # Loads all cacheable objects from the specified _path_.
+    #
+    # @param [String] path
+    #   The path to load the objects from.
+    #
+    # @yield [obj]
+    #   If a block is given, it will be passed each loaded object.
+    #
+    # @yieldparam [Cacheable] obj
+    #   An object loaded from the specified _path_.
+    #
+    # @return [Array]
+    #   All objects loaded from the specified _path_.
     #
     def Cacheable.load_all_from(path,&block)
       path = File.expand_path(path)
@@ -148,7 +176,10 @@ module Ronin
     end
 
     #
-    # Cache all objects defined in the file at the specified _path_.
+    # Cache all objects defined in a file.
+    #
+    # @param [String] path
+    #   The path to cache all objects from.
     #
     def Cacheable.cache_all(path)
       path = File.expand_path(path)
@@ -159,15 +190,17 @@ module Ronin
     end
 
     #
-    # Returns +true+ if the original code has been loaded, returns +false+
-    # otherwise.
+    # @return [Boolean]
+    #   Specifies whether the original code has been loaded into the
+    #   object.
     #
     def original_loaded?
       @original_loaded == true
     end
 
     #
-    # Load the code from the cached file for the object.
+    # Loads the code from the cached file for the object, and instance evals
+    # it into the object.
     #
     def load_original!
       if (self.cached_path && !(@original_loaded))
@@ -182,8 +215,10 @@ module Ronin
 
     #
     # Deletes any previously cached copies of the object and caches it into
-    # the database. Returns +true+ if the object was successfully cached,
-    # returns +false+ otherwise.
+    # the database.
+    #
+    # @return [Boolean]
+    #   Specifies whether the object was successfully cached,
     #
     def cache!
       if self.cached_path
@@ -201,9 +236,10 @@ module Ronin
     # Deletes any previous cached copies of the object and caches it into
     # the database, only if the file where the object was originally cached 
     # from was modified. The object will also be destroyed if the file
-    # where the object was originally cached from is missing. Returns
-    # +true+ if the object was successfully synced, returns +false+
-    # otherwise.
+    # where the object was originally cached from is missing.
+    #
+    # @return [Boolean]
+    #   Specifies whether the object was successfully synced.
     #
     def sync!
       if (self.cached_path && self.cached_timestamp)
@@ -224,8 +260,8 @@ module Ronin
     end
 
     #
-    # Returns +true+ if the object has been prepared to be cached,
-    # returns +false+ otherwise.
+    # @return [Boolean]
+    #   Specifies whether the object has been prepared to be cached,
     #
     def prepared_for_cache?
       @cache_prepared == true
@@ -246,6 +282,10 @@ module Ronin
     #
     # Will run the specified _block_ when the object is about to be cached.
     #
+    # @yield []
+    #   The block will be ran inside the object when the object is to be
+    #   prepared for caching.
+    #
     def cache(&block)
       @cache_block = block
     end

data/lib/ronin/code/emittable.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