ronin 0.3.0 → 1.0.0.pre1

data/lib/ronin/model/has_authors.rb

@@ -0,0 +1,22 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program 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 2 of the License, or
+# (at your option) any later version.
+#
+# This program 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 this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+require 'ronin/model/has_authors/class_methods'
+require 'ronin/model/has_authors/has_authors'

data/lib/ronin/model/has_description/class_methods.rb

@@ -0,0 +1,44 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program 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 2 of the License, or
+# (at your option) any later version.
+#
+# This program 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 this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+module Ronin
+  module Model
+    module HasDescription
+      module ClassMethods
+        #
+        # Finds models with descriptions containing a given fragment of
+        # text.
+        #
+        # @param [String] fragment
+        #   The fragment of text to match descriptions with.
+        #
+        # @return [Array<Model>]
+        #   The found models.
+        #
+        # @example
+        #   Exploit.describing 'bypass'
+        #
+        def describing(fragment)
+          all('description.like' => "%#{fragment}%")
+        end
+      end
+    end
+  end
+end

data/lib/ronin/model/has_description/has_description.rb

@@ -0,0 +1,42 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program 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 2 of the License, or
+# (at your option) any later version.
+#
+# This program 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 this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+require 'ronin/model/has_description/class_methods'
+require 'ronin/model/types/description'
+require 'ronin/model/model'
+
+module Ronin
+  module Model
+    #
+    # Adds a `description` property to a model.
+    #
+    module HasDescription
+      def self.included(base)
+        base.send :include, Model
+        base.send :extend, ClassMethods
+
+        base.module_eval do
+          # The description of the model
+          property :description, Model::Types::Description
+        end
+      end
+    end
+  end
+end

data/lib/ronin/model/has_description.rb

@@ -1,7 +1,7 @@
 #
 # Ronin - A Ruby platform for exploit development and security research.
 #
-# Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -18,61 +18,5 @@
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #
 
-require 'ronin/model'
-
-module Ronin
-  module Model
-    module HasDescription
-      include DataMapper::Types
-
-      def self.included(base)
-        base.module_eval do
-          include Ronin::Model
-
-          # The description of the model
-          property :description, Text
-
-          #
-          # Finds models with descriptions containing the specified
-          # _fragment_.
-          #
-          # @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
-    end
-  end
-end
+require 'ronin/model/has_description/class_methods'
+require 'ronin/model/has_description/has_description'

data/lib/ronin/{network/helpers/helper.rb → model/has_license/class_methods.rb}

@@ -1,7 +1,7 @@
 #
 # Ronin - A Ruby platform for exploit development and security research.
 #
-# Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -18,33 +18,27 @@
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #
 
-require 'ronin/ui/output/helpers'
-
 module Ronin
-  module Network
-    module Helpers
-      module Helper
-        include UI::Output::Helpers
-
-        protected
-
+  module Model
+    module HasLicense
+      module ClassMethods
         #
-        # Tests wether an instance variable has been set.
+        # Finds all models associated with a given license.
         #
-        # @return [true]
-        #   The instance variable has been set.
+        # @param [Symbol, String] name
+        #   The name of the license which models are associated with.
         #
-        # @raise [RuntimeError]
-        #   The instance variable was not set.
+        # @return [Array<Model>]
+        #   The models associated with a given license.
         #
-        # @since 0.3.0
+        # @example
+        #   LicensedModel.licensed_under(:cc_by_nc)
+        #   # => [#<Ronin::LicensedModel: ...>, ...]
         #
-        def require_variable(name)
-          if instance_variable_get("@#{name}").nil?
-            raise(RuntimeError,"the instance variable @#{name} was not set",caller)
-          end
-
-          return true
+        # @since 1.0.0
+        #
+        def licensed_under(name)
+          all(self.license.name => name.to_s)
         end
       end
     end

data/lib/ronin/model/has_license/has_license.rb

@@ -0,0 +1,64 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program 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 2 of the License, or
+# (at your option) any later version.
+#
+# This program 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 this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+require 'ronin/model/has_license/class_methods'
+require 'ronin/model/model'
+require 'ronin/license'
+
+module Ronin
+  module Model
+    #
+    # Adds a `license` relation between a model and the {License} model.
+    #
+    module HasLicense
+      def self.included(base)
+        base.send :include, Model
+        base.send :extend, ClassMethods
+
+        base.module_eval do
+          # The license
+          belongs_to :license, :required => false,
+                               :model => 'Ronin::License'
+
+        end
+
+        License.has License.n, base.relationship_name, :model => base.name
+      end
+
+      #
+      # Sets the license of the model.
+      #
+      # @param [Symbol, String] name
+      #   The name of the license to use.
+      #
+      # @return [License]
+      #   The new license of the model.
+      #
+      # @example
+      #   license! :mit
+      #
+      # @since 1.0.0
+      #
+      def license!(name)
+        self.license = Ronin::License.predefined_resource(name)
+      end
+    end
+  end
+end

data/lib/ronin/model/has_license.rb

@@ -1,7 +1,7 @@
 #
 # Ronin - A Ruby platform for exploit development and security research.
 #
-# Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -18,40 +18,5 @@
 # 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
-      def self.included(base)
-        base.module_eval do
-          include Ronin::Model
-
-          # The license
-          belongs_to :license, :nullable => true
-
-          #
-          # Returns all models having the predefined license with the
-          # 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: ...>, ...]
-          #
-          def self.licensed_under(name)
-            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
-end
+require 'ronin/model/has_license/class_methods'
+require 'ronin/model/has_license/has_license'

data/lib/ronin/model/has_name/class_methods.rb

@@ -0,0 +1,47 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program 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 2 of the License, or
+# (at your option) any later version.
+#
+# This program 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 this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+module Ronin
+  module Model
+    module HasName
+      module ClassMethods
+        #
+        # Finds models with names containing a given fragment of text.
+        #
+        # @param [String] fragment
+        #   The fragment of text to search for within the names of models.
+        #
+        # @return [Array<Model>]
+        #   The found models.
+        #
+        # @example
+        #   Exploit.named 'ProFTP'
+        #
+        def named(fragment)
+          # create a query like operator on name manually, to avoid
+          # DataMapper confusing the name property with Class#name.
+          name_like = DataMapper::Query::Operator.new(:name, :like)
+
+          return all(name_like => "%#{fragment}%")
+        end
+      end
+    end
+  end
+end

data/lib/ronin/model/has_name/has_name.rb

@@ -0,0 +1,53 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program 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 2 of the License, or
+# (at your option) any later version.
+#
+# This program 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 this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+require 'ronin/model/has_name/class_methods'
+require 'ronin/model/model'
+
+module Ronin
+  module Model
+    #
+    # Adds a `name` property to a model.
+    #
+    module HasName
+      def self.included(base)
+        base.send :include, Model
+        base.send :extend, ClassMethods
+
+        base.module_eval do
+          # The name of the model
+          property :name, String, :required => true, :index => true
+        end
+      end
+
+      #
+      # Converts the named resource into a String.
+      #
+      # @return [String]
+      #   The name of the resource.
+      #
+      # @since 1.0.0
+      #
+      def to_s
+        self.name.to_s
+      end
+    end
+  end
+end

data/lib/ronin/model/has_name.rb

@@ -1,7 +1,7 @@
 #
 # Ronin - A Ruby platform for exploit development and security research.
 #
-# Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -18,35 +18,5 @@
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #
 
-require 'ronin/model'
-
-module Ronin
-  module Model
-    module HasName
-      def self.included(base)
-        base.module_eval do
-          include Ronin::Model
-
-          # The name of the model
-          property :name, String, :index => true
-
-          # Validations
-          validates_present :name
-
-          #
-          # Finds models with names containing the specified _fragment_.
-          #
-          # @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
-    end
-  end
-end
+require 'ronin/model/has_name/class_methods'
+require 'ronin/model/has_name/has_name'

data/lib/ronin/model/has_title/class_methods.rb

@@ -0,0 +1,43 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program 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 2 of the License, or
+# (at your option) any later version.
+#
+# This program 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 this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+module Ronin
+  module Model
+    module HasTitle
+      module ClassMethods
+        #
+        # Finds models with titles containing a given fragment of text.
+        #
+        # @param [String] fragment
+        #   The fragment of text to match titles with.
+        #
+        # @return [Array<Model>]
+        #   The found models.
+        #
+        # @example
+        #   Vuln.titled 'bypass'
+        #
+        def titled(fragment)
+          all('title.like' => "%#{fragment}%")
+        end
+      end
+    end
+  end
+end

data/lib/ronin/model/has_title/has_title.rb

@@ -0,0 +1,41 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program 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 2 of the License, or
+# (at your option) any later version.
+#
+# This program 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 this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+require 'ronin/model/has_title/class_methods'
+require 'ronin/model/model'
+
+module Ronin
+  module Model
+    #
+    # Adds a `title` property to a model.
+    #
+    module HasTitle
+      def self.included(base)
+        base.send :include, Model
+        base.send :extend, ClassMethods
+
+        base.module_eval do
+          # The title of the model
+          property :title, String
+        end
+      end
+    end
+  end
+end

data/lib/ronin/model/has_title.rb

@@ -0,0 +1,22 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program 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 2 of the License, or
+# (at your option) any later version.
+#
+# This program 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 this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+require 'ronin/model/has_title/class_methods'
+require 'ronin/model/has_title/has_title'

data/lib/ronin/model/has_unique_name.rb

@@ -0,0 +1,52 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program 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 2 of the License, or
+# (at your option) any later version.
+#
+# This program 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 this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#
+
+require 'ronin/model/has_name/class_methods'
+
+module Ronin
+  module Model
+    #
+    # Adds a unique `name` property to a model.
+    #
+    module HasUniqueName
+      def self.included(base)
+        base.send :include, Model
+        base.send :extend, HasName::ClassMethods
+
+        base.module_eval do
+          # The name of the model
+          property :name, String, :required => true, :unique => true
+        end
+      end
+
+      #
+      # Converts the named resource into a String.
+      #
+      # @return [String]
+      #   The name of the resource.
+      #
+      # @since 1.0.0
+      #
+      def to_s
+        self.name.to_s
+      end
+    end
+  end
+end