ronin 0.2.4 → 0.3.0

data/lib/ronin/formatting/http.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/formatting/extensions/http'

data/lib/ronin/formatting/text.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/formatting/extensions/text'

data/lib/ronin/license.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'
@@ -48,71 +45,81 @@ module Ronin
     validates_is_unique :name
 
     #
-    # Returns the name of the license as a String.
+    # Converts the license to a String.
     #
-    def to_s
-      @name.to_s
-    end
-
-    #
-    # Defines a new builtin License object of the specified _name_ and the
-    # given _opts_. If block is given, it will be passed the newly created
-    # License object.
+    # @return [String]
+    #   The name of the license.
     #
-    # _options_ may contain the following keys:
-    # <tt>:description</tt>:: The description of the license.
-    # <tt>:url</tt>:: The URL to the license.
-    #
-    def self.define(name,options={})
-      super(name.downcase.gsub(/[\s_\-]+/,'_'),options.merge(:name => name))
+    def to_s
+      self.name.to_s
     end
 
-    # Creative Commons Licenses
-    define 'CC by',
-           :description => 'Creative Commons Attribution v3.0 License',
-           :url => 'http://creativecommons.org/licenses/by/3.0/'
-
-    define 'CC by-sa',
-           :description => 'Creative Commons Attribution-Share Alike v3.0 License',
-           :url => 'http://creativecommons.org/licenses/by-sa/3.0/'
-
-    define 'CC by-nd',
-           :description => 'Creative Commons Attribution-No Derivative Works v3.0 License',
-           :url => 'http://creativecommons.org/licenses/by-nd/3.0/'
-
-    define 'CC by-nc',
-           :description => 'Creative Commons Attribution-Noncommercial v3.0 License',
-           :url => 'http://creativecommons.org/licenses/by-nc/3.0/'
-
-    define 'CC by-nc-sa',
-           :description => 'Creative Commons Attribution-Noncommercial-Share Alike v3.0 License',
-           :url => 'http://creativecommons.org/licenses/by-nc-sa/3.0/'
-
-    define 'CC by-nc-nd',
-           :description => 'Creative Commons Attribution-Noncommercial-No Derivative Works v3.0 License',
-           :url => 'http://creativecommons.org/licenses/by-nc-nd/3.0/'
-
-    define 'CC0',
-           :description => 'Creative Commons Zero License',
-           :url => 'http://creativecommons.org/licenses/zero/1.0/'
-
-    # GNU Public Licenses
-    define 'GPL-2',
-           :description => 'GNU Public License v2.0',
-           :url => 'http://www.gnu.org/licenses/gpl-2.0.txt'
-
-    define 'GPL-3',
-           :description => 'GNU Public License v3.0',
-           :url => 'http://www.gnu.org/licenses/gpl-3.0.txt'
-
-    define 'LGPL-3',
-           :description => 'GNU Lesser General Public License v3.0',
-           :url => 'http://www.gnu.org/licenses/lgpl-3.0.txt'
-
-    # The MIT Licence
-    define 'MIT',
-           :description => 'The MIT Licence',
-           :url => 'http://www.opensource.org/licenses/mit-license.php'
+    # Creative Commons By-Attribution License
+    predefine :cc_by,
+              :name => 'CC by',
+              :description => 'Creative Commons Attribution v3.0 License',
+              :url => 'http://creativecommons.org/licenses/by/3.0/'
+
+    # Creative Commons By-Attribution Share-Alike License
+    predefine :cc_by_sa,
+              :name => 'CC by-sa',
+              :description => 'Creative Commons Attribution-Share Alike v3.0 License',
+              :url => 'http://creativecommons.org/licenses/by-sa/3.0/'
+
+    # Creative Commons By-Attribution No-Derivative Works License
+    predefine :cc_by_nd,
+              :name => 'CC by-nd',
+              :description => 'Creative Commons Attribution-No Derivative Works v3.0 License',
+              :url => 'http://creativecommons.org/licenses/by-nd/3.0/'
+
+    # Creative Commons By-Attribution Non-Commercial License
+    predefine :cc_by_nc,
+              :name => 'CC by-nc',
+              :description => 'Creative Commons Attribution-Noncommercial v3.0 License',
+              :url => 'http://creativecommons.org/licenses/by-nc/3.0/'
+
+    # Creative Commons By-Attribution Non-Commercial Share-Alike License
+    predefine :cc_by_nc_sa,
+              :name => 'CC by-nc-sa',
+              :description => 'Creative Commons Attribution-Noncommercial-Share Alike v3.0 License',
+              :url => 'http://creativecommons.org/licenses/by-nc-sa/3.0/'
+
+    # Creative Commons By-Attribution Non-Commercial No-Derivative Works
+    # License
+    predefine :cc_by_nc_nd,
+              :name => 'CC by-nc-nd',
+              :description => 'Creative Commons Attribution-Noncommercial-No Derivative Works v3.0 License',
+              :url => 'http://creativecommons.org/licenses/by-nc-nd/3.0/'
+
+    # Creative Commons Zero License
+    predefine :cc0,
+              :name => 'CC0',
+              :description => 'Creative Commons Zero License',
+              :url => 'http://creativecommons.org/licenses/zero/1.0/'
+
+    # General Public License, version 2
+    predefine :gpl2,
+              :name => 'GPL-2',
+              :description => 'GNU Public License v2.0',
+              :url => 'http://www.gnu.org/licenses/gpl-2.0.txt'
+
+    # General Public License, version 3
+    predefine :gpl3,
+              :name => 'GPL-3',
+              :description => 'GNU Public License v3.0',
+              :url => 'http://www.gnu.org/licenses/gpl-3.0.txt'
+
+    # Lesser General Public License, version 3
+    predefine :lgpl3,
+              :name => 'LGPL-3',
+              :description => 'GNU Lesser General Public License v3.0',
+              :url => 'http://www.gnu.org/licenses/lgpl-3.0.txt'
+
+    # The MIT "as-is" Licence
+    predefine :mit,
+              :name => 'MIT',
+              :description => 'The MIT Licence',
+              :url => 'http://www.opensource.org/licenses/mit-license.php'
 
   end
 end

data/lib/ronin/model.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/model'

data/lib/ronin/model/has_description.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'
@@ -36,11 +33,43 @@ module Ronin
           property :description, Text
 
           #
-          # Finds models with descriptions similar to the specified
-          # _description_.
+          # Finds models with descriptions containing the specified
+          # _fragment_.
           #
-          def self.describing(description)
-            self.all(:description.like => "%#{description}%")
+          # @param [String] fragment
+          #   The fragment of text to match descriptions with.
+          #
+          # @example
+          #   Exploit.describing 'bypass'
+          #
+          def self.describing(fragment)
+            self.all(:description.like => "%#{fragment}%")
+          end
+
+          #
+          # Strips leading and trailing white-space from each line, then sets
+          # the description property.
+          #
+          # @param [String] new_text
+          #   The new description to use.
+          #
+          # @example
+          #   self.description = %{
+          #     Some text here.
+          #
+          #     More text.
+          #   }
+          #
+          # @since 0.3.0
+          #
+          def description=(new_text)
+            sanitized_lines = []
+
+            new_text.to_s.each_line do |line|
+              sanitized_lines << line.strip
+            end
+
+            attribute_set(:description,sanitized_lines.join("\n").strip)
           end
         end
       end

data/lib/ronin/model/has_license.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,13 @@
 # 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'
 require 'ronin/license'
 
+require 'extlib'
+
 module Ronin
   module Model
     module HasLicense
@@ -32,14 +31,16 @@ module Ronin
           include Ronin::Model
 
           # The license
-          belongs_to :license,
-                     :child_key => [:license_id],
-                     :class_name => 'Ronin::License'
+          belongs_to :license, :nullable => true
 
           #
           # Returns all models having the predefined license with the
-          # predefined _name_.
+          # specified _name_.
+          #
+          # @param [Symbol, String] name
+          #   The name of the license which models are associated with.
           #
+          # @example
           #   LicensedModel.licensed_under(:cc_by_nc)
           #   # => [#<Ronin::LicensedModel: ...>, ...]
           #
@@ -47,6 +48,9 @@ module Ronin
             self.all(:license_id => Ronin::License[name].id)
           end
         end
+
+        model_name = base.name.split('::').last.snake_case.plural.to_sym
+        License.has License.n, model_name, :model => base.name
       end
     end
   end

data/lib/ronin/model/has_name.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'
@@ -37,10 +34,16 @@ module Ronin
           validates_present :name
 
           #
-          # Finds models with names like the specified _name_.
+          # Finds models with names containing the specified _fragment_.
           #
-          def self.named(name)
-            self.all(:name.like => "%#{name}%")
+          # @param [String] fragment
+          #   The fragment of text to search for within the names of models.
+          #
+          # @example
+          #   Exploit.named 'ProFTP'
+          #
+          def self.named(fragment)
+            self.all(:name.like => "%#{fragment}%")
           end
         end
       end

data/lib/ronin/model/has_version.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'
@@ -33,6 +30,19 @@ module Ronin
           # The version of the model
           property :version, String, :default => '0.1', :index => true
 
+          #
+          # Finds all models with a specific version.
+          #
+          # @param [String] version
+          #   The specific version to search for.
+          #
+          # @return [Array]
+          #   The models with the specific version.
+          #
+          def self.revision(version)
+            self.all(:version => version.to_s)
+          end
+
           #
           # Finds latest version of the model.
           #

data/lib/ronin/model/model.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,9 @@
 # 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 'extlib'
 require 'dm-core'
 require 'dm-types'
 require 'dm-validations'
@@ -38,10 +34,18 @@ module Ronin
       unless base.ancestors.include?(DataMapper::Resource)
         base.module_eval do
           include DataMapper::Resource
-          include DataMapper::AutoMigrations
+          include DataMapper::Migrations
+
+          def self.allocate
+            resource = super
+            resource.instance_eval("initialize()")
+
+            return resource
+          end
 
           #
-          # Returns the default repository name for the model.
+          # @return [Symbol]
+          #   The default repository name used for the model.
           #
           def self.default_repository_name
             Model::REPOSITORY_NAME
@@ -49,16 +53,69 @@ module Ronin
 
           # The class type property
           property :type, Discriminator
+        end
+      end
+    end
 
-          #
-          # Finds the first resource by conditions, or initializes a new
-          # resource with the attributes if none found.
-          #
-          def self.first_or_new(query,attributes={})
-            first(query) || new(query.merge(attributes))
+    #
+    # Formats the attributes of the model into human readable names
+    # and values.
+    #
+    # @param [Hash] options
+    #   Additional options.
+    #
+    # @option options [Array<Symbol>] :exclude ([])
+    #   A list of attribute names to exclude.
+    #
+    # @yield [name, value]
+    #   If a block is given, it will be passed the name and humanized
+    #   value of each attribute.
+    #
+    # @yieldparam [String] name
+    #   The humanized name of the attribute.
+    #
+    # @yieldparam [String] value
+    #   The human readable value of the attribute.
+    #
+    # @return [Hash{String => String}]
+    #   A hash of the humanly readable names and values of the attributes.
+    #
+    def humanize_attributes(options={},&block)
+      exclude = [:id, :type]
+
+      if options[:exclude]
+        exclude += options[:exclude]
+      end
+
+      formatter = lambda { |value|
+        if value.kind_of?(Array)
+          value.map(&formatter).join(', ')
+        elsif value.kind_of?(Symbol)
+          Extlib::Inflection.humanize(value)
+        else
+          value.to_s
+        end
+      }
+
+      formatted = {}
+
+      self.attributes.each do |name,value|
+        next if (value.nil? || (value.respond_to?(:empty?) && value.empty?))
+
+        unless (exclude.include?(name) || value.nil?)
+          name = name.to_s
+
+          unless name[-3..-1] == '_id'
+            name = Extlib::Inflection.humanize(name)
+            value = formatter.call(value)
+
+            block.call(name,value) if block
+            formatted[name] = value
           end
         end
       end
+
+      return formatted
     end
   end
 end