metasploit-model 0.24.1.pre.semantic.pre.versioning.pre.2.pre.0

data/lib/metasploit/model/association.rb

@@ -0,0 +1,49 @@
+module Metasploit
+  module Model
+    # Allows registering the class name of assocations similar to ActiveRecord associations, so that ActiveModel
+    # associations can be reflected with the same API as ActiveRecord associations.
+    module Association
+      extend ActiveSupport::Concern
+
+      # Defines DSL for define associations on ActiveModels with {#association}, which can then be retrieved in bulk
+      # with {#association_by_name} or a single association's reflection by name with {#reflect_on_association}.
+      module ClassMethods
+        # Registers an association.
+        #
+        # @param name [to_sym] Name of the association
+        # @param options [Hash{Symbol => String}]
+        # @option options [String] :class_name Name of association's class.
+        # @return [Metasploit::Model::Association::Reflection] the reflection of the registered association.
+        # @raise [Metasploit::Model::Invalid] if name is blank.
+        # @raise [Metasploit::Model::Invalid] if :class_name is blank.
+        def association(name, options={})
+          association = Metasploit::Model::Association::Reflection.new(
+              :model => self,
+              :name => name.to_sym,
+              :class_name => options[:class_name]
+          )
+          association.valid!
+
+          association_by_name[association.name] = association
+        end
+
+        # Associations registered with {#association}.
+        #
+        # @return [Hash{Symbol => Metasploit::Model::Association::Reflection}] Maps
+        #   {Metasploit::Model::Association::Reflection#name} to {Metasploit::Model::Association::Reflection}.
+        def association_by_name
+          @association_by_name ||= {}
+        end
+
+        # Returns reflection for association with the given name.
+        #
+        # @param name [#to_sym] name of the association whose reflection to retrieve.
+        # @return [nil] if no association with the given `name`.
+        # @return [Metasploit::Model::Association::Reflection] if association with the given `name`.
+        def reflect_on_association(name)
+          association_by_name[name.to_sym]
+        end
+      end
+    end
+  end
+end

data/lib/metasploit/model/association/error.rb

@@ -0,0 +1,40 @@
+module Metasploit
+  module Model
+    module Association
+      # Error raised by {Metasploit::Model::Association::ClassMethods#reflect_on_association!}.
+      class Error < Metasploit::Model::Error
+        #
+        # Attributes
+        #
+
+        # @!attribute [r] model
+        #   ActiveModel on which the association with {#name} was not found.
+        #
+        #   @return [Class]
+        attr_reader :model
+
+        # @!attribute [r] name
+        #   Name of association that was not registered on {#model}.
+        #
+        #   @return [Symbol]
+        attr_reader :name
+
+        #
+        # Methods
+        #
+
+        # @param attributes [Hash{Symbol => Object}]
+        # @option attributes [Class] :model ActiveModel that is missing association with :name.
+        # @option attributes [Symbol] :name name of the association that is missing.
+        # @raise [KeyError] if :model is not given
+        # @raise [KeyError] if :name is not given
+        def initialize(attributes={})
+          @model = attributes.fetch(:model)
+          @name = attributes.fetch(:name)
+
+          super("#{model} does not have #{name} association.")
+        end
+      end
+    end
+  end
+end

data/lib/metasploit/model/author.rb

@@ -0,0 +1,58 @@
+module Metasploit
+  module Model
+    # Code shared between `Mdm::Author` and `Metasploit::Framework::Author`.
+    module Author
+      extend ActiveModel::Naming
+      extend ActiveSupport::Concern
+
+      include Metasploit::Model::Translation
+
+      included do
+        include ActiveModel::MassAssignmentSecurity
+        include ActiveModel::Validations
+        include Metasploit::Model::Search
+
+        #
+        # Mass Assignment Security
+        #
+
+        attr_accessible :name
+
+        #
+        # Search Attributes
+        #
+
+        search_attribute :name, :type => :string
+
+        #
+        # Validations
+        #
+
+        validates :name, :presence => true
+      end
+
+      #
+      # Associations
+      #
+
+      # @!attribute [r] email_addresses
+      #   Email addresses used by this author across all {#module_instances}.
+      #
+      #   @return [Array<Metasploit::Model::EmailAddress>]
+
+      # @!attribute [r] module_instances
+      #   Modules written by this author.
+      #
+      #   @return [Array<Metasploit::Model::Module::Instance>]
+
+      #
+      # Attributes
+      #
+
+      # @!attribute [rw] name
+      #   Full name (First + Last name) or handle of author.
+      #
+      #   @return [String]
+    end
+  end
+end

data/lib/metasploit/model/authority.rb

@@ -0,0 +1,134 @@
+module Metasploit
+  module Model
+    # Code shared between `Mdm::Authority` and `Metasploit::Framework::Authority`.
+    module Authority
+      extend ActiveModel::Naming
+      extend ActiveSupport::Concern
+
+      include Metasploit::Model::Translation
+
+      included do
+        include ActiveModel::MassAssignmentSecurity
+        include ActiveModel::Validations
+        include Metasploit::Model::Search
+
+        #
+        # Mass Assignment Security
+        #
+
+        attr_accessible :abbreviation
+        attr_accessible :obsolete
+        attr_accessible :summary
+        attr_accessible :url
+
+        #
+        # Search Attributes
+        #
+
+        search_attribute :abbreviation, :type => :string
+
+        #
+        # Validations
+        #
+
+        validates :abbreviation,
+                  :presence => true
+      end
+
+      #
+      # Associations
+      #
+
+      # @!attribute [rw] references
+      #   {Metasploit::Model::Reference References} that use this authority's scheme for their
+      #   {Metasploit::Model::Reference#authority}.
+      #
+      #   @return [Array<Metasploit::Model::Reference>]
+
+      # @!attribute [r] module_instances
+      #   {Metasploit::Model::Module::Instance Modules} that have a reference with this authority.
+      #
+      #   @return [Array<Metasploit::Model::Module::Instance>]
+
+      # @!attribute [r] vulns
+      #   Vulnerabilities that have a reference under this authority.
+      #
+      #   @return [Array<Metasploit::Model::Vuln>]
+
+      #
+      # Attributes
+      #
+
+      # @!attribute [rw] abbreviation
+      #   Abbreviation or initialism for authority, such as CVE for 'Common Vulnerability and Exposures'.
+      #
+      #   @return [String]
+
+      # @!attribute [rw] obsolete
+      #   Whether this authority is obsolete and no longer exists on the internet.
+      #
+      #   @return [false]
+      #   @return [true] {#url} may be `nil` because authory no longer has a web site.
+
+      # @!attribute [rw] summary
+      #   An expansion of the {#abbreviation}.
+      #
+      #   @return [String, nil]
+
+      # @!attribute [rw] url
+      #   URL to the authority's home page or root URL for their {#references} database.
+      #
+      #   @return [String, nil]
+
+      #
+      # Instance Methods
+      #
+
+      # Returns the {Metasploit::Model::Reference#url URL} for a {Metasploit::Model::Reference#designation designation}.
+      #
+      # @param designation [String] {Metasploit::Model::Reference#designation}.
+      # @return [String] {Metasploit::Model::Reference#url}
+      # @return [nil] if this {Metasploit::Model::Authority} is {#obsolete}.
+      # @return [nil] if this {Metasploit::Model::Authority} does have a way to derive URLS from designations.
+      def designation_url(designation)
+        url = nil
+
+        if extension
+          url = extension.designation_url(designation)
+        end
+
+        url
+      end
+
+      # Returns module that include authority specific methods.
+      #
+      # @return [Module] if {#abbreviation} has a corresponding module under the Metasploit::Model::Authority namespace.
+      # @return [nil] otherwise.
+      def extension
+        begin
+          extension_name.constantize
+        rescue NameError
+          nil
+        end
+      end
+
+      # Returns name of module that includes authority specific methods.
+      #
+      # @return [String] unless {#abbreviation} is blank.
+      # @return [nil] if {#abbreviation} is blank.
+      def extension_name
+        extension_name = nil
+
+        unless abbreviation.blank?
+          # underscore before camelize to eliminate -'s
+          relative_model_name = abbreviation.underscore.camelize
+          # don't scope to self.class.name so that authority extension are always resolved the same in Mdm and
+          # Metasploit::Framework.
+          extension_name = "Metasploit::Model::Authority::#{relative_model_name}"
+        end
+
+        extension_name
+      end
+    end
+  end
+end

data/lib/metasploit/model/authority/bid.rb

@@ -0,0 +1,10 @@
+# BugTraq ID authority-specific code.
+module Metasploit::Model::Authority::Bid
+  # Returns URL to {Metasploit::Model::Reference#designation BugTraq ID's} page on SecurityFocus' site.
+  #
+  # @param designation [String] N+ BugTraq ID.
+  # @return [String] URL
+  def self.designation_url(designation)
+    "http://www.securityfocus.com/bid/#{designation}"
+  end
+end

data/lib/metasploit/model/authority/cve.rb

@@ -0,0 +1,10 @@
+# Common Vulnerabilities and Exposures authority-specific code.
+module Metasploit::Model::Authority::Cve
+  # Returns URL to {Metasploit::Model::Reference#designation the CVE ID's} page on CVE Details.
+  #
+  # @param designation [String] YYYY-NNNN CVE ID.
+  # @return [String] URL
+  def self.designation_url(designation)
+    "http://cvedetails.com/cve/CVE-#{designation}"
+  end
+end

data/lib/metasploit/model/authority/msb.rb

@@ -0,0 +1,10 @@
+# Microsoft Security Bulletin authority-specific code.
+module Metasploit::Model::Authority::Msb
+  # Returns URL to {Metasploit::Model::Reference#designation the security bulletin's} page on Technet.
+  #
+  # @param designation [String] MSYY-NNN Security Bulletin ID.
+  # @return [String] URL
+  def self.designation_url(designation)
+    "http://www.microsoft.com/technet/security/bulletin/#{designation}"
+  end
+end

data/lib/metasploit/model/authority/osvdb.rb

@@ -0,0 +1,10 @@
+# Open Sourced Vulnerability Database authority-specific code.
+module Metasploit::Model::Authority::Osvdb
+  # Returns URL to {Metasploit::Model::Reference#designation OSVDB ID's} page.
+  #
+  # @param designation [String] N+ OSVDB ID.
+  # @return [String] URL
+  def self.designation_url(designation)
+    "http://www.osvdb.org/#{designation}/"
+  end
+end

data/lib/metasploit/model/authority/pmasa.rb

@@ -0,0 +1,10 @@
+# phpMyAdmin Security Announcement authority-specific code.
+module Metasploit::Model::Authority::Pmasa
+  # Returns URL to {Metasploit::Model::Reference#designation phpMyAdmin Security Advisory's} page on phpMyAdmin's site.
+  #
+  # @param designation [String] YYYY-N phpMyAdmin Security Advisory ID.
+  # @return [String] URL
+  def self.designation_url(designation)
+    "http://www.phpmyadmin.net/home_page/security/PMASA-#{designation}.php"
+  end
+end

data/lib/metasploit/model/authority/secunia.rb

@@ -0,0 +1,10 @@
+# Secunia authority-specific code.
+module Metasploit::Model::Authority::Secunia
+  # Returns URL to {Metasploit::Model::Reference#designation Secunia Advisory ID's} page on Secunia.
+  #
+  # @param designation [String] NNNNN Secunia Advisory ID.
+  # @return [String] URL
+  def self.designation_url(designation)
+    "https://secunia.com/advisories/#{designation}/"
+  end
+end

data/lib/metasploit/model/authority/us_cert_vu.rb

@@ -0,0 +1,10 @@
+# United States Computer Emergency Readiness Team Vulnerability Notes Database authority-specific code.
+module Metasploit::Model::Authority::UsCertVu
+  # Returns URL to {Metasploit::Model::Reference#designation Vul ID's} page on US CERT Notes Database.
+  #
+  # @param designation [String] N US CERT ID.
+  # @return [String] URL
+  def self.designation_url(designation)
+    "http://www.kb.cert.org/vuls/id/#{designation}"
+  end
+end

data/lib/metasploit/model/authority/waraxe.rb

@@ -0,0 +1,31 @@
+# Waraxe authority-specific code.
+module Metasploit::Model::Authority::Waraxe
+  #
+  # CONSTANTS
+  #
+
+  # Regular expression for breaking up designation into year and number
+  DESIGNATION_REGEXP = /\A(?<year>\d+)-SA#(?<number>\d+)\Z/
+
+  #
+  # Methods
+  #
+
+  # Returns URL to {Metasploit::Model::Reference#designation Waraxe Security Advisory's} page on Waraxe's site.
+  #
+  # @param designation [String] YYYY-SA#N+ Waraxe fully-qualified ID.
+  # @return [String] URL
+  # @return [nil] if designation does not match {DESIGNATION_REGEXP}.
+  def self.designation_url(designation)
+    match = DESIGNATION_REGEXP.match(designation)
+    url = nil
+
+    if match
+      number = match[:number]
+
+      url = "http://www.waraxe.us/advisory-#{number}.html"
+    end
+
+    url
+  end
+end

data/lib/metasploit/model/authority/zdi.rb

@@ -0,0 +1,10 @@
+# Zero Day Initiative authority-specific code.
+module Metasploit::Model::Authority::Zdi
+  # Returns URL to {Metasploit::Model::Reference#designation the ZDI ID's} page on ZDI.
+  #
+  # @param designation [String] YY-NNNN ZDI ID.
+  # @return [String] URL
+  def self.designation_url(designation)
+    "http://www.zerodayinitiative.com/advisories/ZDI-#{designation}"
+  end
+end

data/lib/metasploit/model/base.rb

@@ -0,0 +1,25 @@
+# Superclass for all Metasploit::Models.  Just adds a default {#initialize} to make models mimic behavior of
+# ActiveRecord::Base subclasses.
+class Metasploit::Model::Base
+  include ActiveModel::Validations
+
+  # After ActiveModel::Validations so Metasploit::Model::Translation is favored over ActiveModel::Translation
+  include Metasploit::Model::Translation
+
+  # @param attributes [Hash{Symbol => String,nil}]
+  def initialize(attributes={})
+    attributes.each do |attribute, value|
+      public_send("#{attribute}=", value)
+    end
+  end
+
+  # Validates the model.
+  #
+  # @return [void]
+  # @raise [Metasploit::Model::Invalid] if invalid
+  def valid!
+    unless valid?
+      raise Metasploit::Model::Invalid.new(self)
+    end
+  end
+end

data/lib/metasploit/model/configuration.rb

@@ -0,0 +1,72 @@
+# @note This can't be a model in app/models because it is used to setup the autoload_path to app/models.
+#
+# Configuration for a gem's autoload and i18n load paths that works outside of the railties or rails engines systems.
+class Metasploit::Model::Configuration
+  # no autoload paths yet, so have to explicitly require
+  require 'metasploit/model/configuration/parent'
+  extend Metasploit::Model::Configuration::Parent
+
+  #
+  # Attributes
+  #
+
+  # @!attribute [rw] root
+  #   The root of the gem.  All relative paths are resolved relative to {#root}.
+  #
+  #   @return [Pathname]
+
+  #
+  # Children
+  #
+
+  # @!macro [attach] child
+  #   @!attribute [rw] $1_class
+  #     The `Class` used to create {#$1}.
+  #
+  #     @return [Class]
+  #
+  #   @!method $1
+  #     The $1 configuration.
+  #
+  #     @return [Object] an instance of {#$1_class}
+  #
+  #   @!method $1_class
+  #     The `Class` used to create {#$1}.
+  #
+  #     @return [Class]
+  child :autoload
+  child :i18n
+
+  #
+  # Methods
+  #
+
+  # The root of the gem.
+  #
+  # @return [Pathname] root of gem
+  # @raise [Metasploit::Model::Configuration::Error] if {#root=} is not called prior to calling {#root}.
+  def root
+    unless instance_variable_defined?(:@root)
+      raise Metasploit::Model::Configuration::Error, "#{self.class}.root not set prior to use"
+    end
+
+    @root
+  end
+
+  # Sets root of this gem.
+  #
+  # @param root [Pathname, String]
+  # @return [String]
+  def root=(root)
+    @root = Pathname.new root
+  end
+
+  # Sets up {#autoload} and {#i18n}
+  #
+  # @return [void]
+  # @raise [Metasploit::Model::Invalid] if {#configuration} {Metasploit::Model::Configuration#root} is not set.
+  def setup
+    autoload.setup
+    i18n.setup
+  end
+end