metasploit-model 0.28.0 → 0.29.0

data/lib/metasploit/model/authority.rb

@@ -1,141 +0,0 @@
-# Code shared between `Mdm::Authority` and `Metasploit::Framework::Authority`.
-module Metasploit::Model::Authority
-  extend ActiveModel::Naming
-  extend ActiveSupport::Autoload
-  extend ActiveSupport::Concern
-
-  include Metasploit::Model::Translation
-
-  autoload :Bid
-  autoload :Cve
-  autoload :Msb
-  autoload :Osvdb
-  autoload :Pmasa
-  autoload :Secunia
-  autoload :UsCertVu
-  autoload :Waraxe
-  autoload :Zdi
-
-  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

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

@@ -1,10 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-# 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

@@ -1,31 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-# 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/derivation.rb

@@ -1,109 +0,0 @@
-# Allow to declare that attributes should be derived, which will set the attribute equal to derived_<attribute> if
-# the attribute is `nil` before validation.  Optionally, it can be checked if the attribute matches the
-# derived_<attribute> in a validation.
-#
-#
-# @example Full setup
-#   class Person < ActiveRecord::Base
-#     include Metasploit::Model::Derivation
-#
-#     #
-#     # Attributes
-#     #
-#
-#     # @!attributes [rw] first_name
-#     #   First Name.
-#     #
-#     #   @return [String]
-#
-#     # @!attribute [rw] full_name
-#     #   Full name. (Includes first and last name).
-#     #
-#     #   @return [String]
-#
-#     # @!attribute [rw] last_name
-#     #   Last name.
-#     #
-#     #   @return [String]
-#
-#     #
-#     # Derivations
-#     #
-#
-#     derives :full_name
-#
-#     #
-#     # Methods
-#     #
-#
-#     # Derives {#full_name} from {#first_name} and {#last_name}.
-#     #
-#     # @return [String] "<first_name> <last_name>"
-#     def derive_full_name
-#       "#{first_name} #{last_name}"
-#     end
-#   end
-module Metasploit::Model::Derivation
-  extend ActiveSupport::Autoload
-  extend ActiveSupport::Concern
-
-  autoload :FullName
-
-  included do
-    include ActiveModel::Validations
-    include ActiveModel::Validations::Callbacks
-
-    before_validation :derive
-  end
-
-  # Defines class methods include {#derives}, which can be used to declare derived attributes after mixing in
-  # {Metasploit::Model::Derivation}.
-  module ClassMethods
-    # Declares that the attribute should be derived using the derived_<attribute> method if it is `nil` before
-    # validation.
-    #
-    # @param attribute [Symbol] the name of the attribute.
-    # @param options [Hash{Symbol => Boolean}]
-    # @option options [Boolean] :validate (false) If `true`, validates `attribute` using {DerivationValidator}.  If
-    #   `false`, does no validation on `attribute`.
-    # @return [void]
-    def derives(attribute, options={})
-      options.assert_valid_keys(:validate)
-
-      validate = options.fetch(:validate, false)
-      validate_by_derived_attribute[attribute] = validate
-
-      if validate
-        validates attribute, :derivation => true
-      end
-    end
-
-    # Maps a derived attribute (declared with {#derives}) to whether the attribute should validate as a derivation.
-    #
-    # @return [Hash{Symbol => Boolean}]
-    def validate_by_derived_attribute
-      @validate_by_derived_attribute ||= {}
-    end
-  end
-
-  #
-  # Instance Methods
-  #
-
-  private
-
-  # Derives each attribute in {ClassMethods#validate_by_derived_attribute} if the attribute is `nil`.
-  #
-  # @return [void]
-  def derive
-    self.class.validate_by_derived_attribute.each_key do |attribute|
-      value = send(attribute)
-
-      # explicitly check for `nil` in case attribute is Boolean
-      if value.nil?
-        derived_value = send("derived_#{attribute}")
-        send("#{attribute}=", derived_value)
-      end
-    end
-  end
-end

data/lib/metasploit/model/derivation/full_name.rb

@@ -1,19 +0,0 @@
-# Methods for deriving full_name from module_type and reference_name in `Mdm::Module::Ancestor`,
-# `Mdm::Module::Class`, `Metasploit::Framework::Module::Ancestor`, and `Metasploit::Framework::Module::Class`.
-module Metasploit::Model::Derivation::FullName
-  # Derives full_name by combining module_type and reference_name in the same way used to create modules using
-  # Msf::ModuleManager#create in metasploit-framework.
-  #
-  # @return [String] <module_type>/<reference_name>
-  # @return [nil] if module_type is `nil`.
-  # @return [nil] if reference_name is `nil`.
-  def derived_full_name
-    derived = nil
-
-    if module_type and reference_name
-      derived = "#{module_type}/#{reference_name}"
-    end
-
-    derived
-  end
-end

data/lib/metasploit/model/email_address.rb

@@ -1,124 +0,0 @@
-# Code shared between `Mdm::EmailAddress` and `Metasploit::Framework::EmailAddress`.
-module Metasploit::Model::EmailAddress
-  extend ActiveModel::Naming
-  extend ActiveSupport::Concern
-
-  include Metasploit::Model::Translation
-
-  included do
-    include ActiveModel::MassAssignmentSecurity
-    include ActiveModel::Validations
-    include Metasploit::Model::Derivation
-    include Metasploit::Model::Search
-
-    #
-    # Derivations
-    #
-
-    derives :domain, :validate => true
-    derives :full, :validate => true
-    derives :local, :validate => true
-
-    #
-    # Mass Assignment Security
-    #
-
-    attr_accessible :domain
-    attr_accessible :full
-    attr_accessible :local
-
-    #
-    # Search Attributes
-    #
-
-    search_attribute :domain, :type => :string
-    search_attribute :full, :type => :string
-    search_attribute :local, :type => :string
-
-    #
-    # Validations
-    #
-
-    validates :domain, :presence => true
-    validates :local, :presence => true
-  end
-
-  #
-  # Associations
-  #
-
-  # @!attribute [rw] module_authors
-  #   Credits where {#authors} used this email address for {#module_instances modules}.
-  #
-  #   @return [Array<Metasploit::Model::Module::Author>]
-
-  # @!attribute [r] authors
-  #   Authors that used this email address.
-  #
-  #   @return [Array<Metasploit::Model::Author>]
-
-  # @!attribute [r] module_instances
-  #   Modules where this email address was used.
-  #
-  #   @return [Array<Metasploit::Module::Instance>]
-
-  #
-  # Attributes
-  #
-
-  # @!attribute [rw] domain
-  #   The domain part of the email address after the `'@'`.
-  #
-  #   @return [String]
-
-  # @!attribute [rw] full
-  #   The full email address.
-  #
-  #   @return [String] <{#local}>@<{#domain}
-
-  # @!attribute [rw] local
-  #   The local part of the email address before the `'@'`.
-  #
-  #   @return [String]
-
-  #
-  # Methods
-  #
-
-  # Derives {#domain} from {#full}
-  #
-  # @return [String] if {#full} is present
-  # @return [nil] if {#full} is not present
-  def derived_domain
-    domain = nil
-
-    if full.present?
-      _local, domain = full.split('@', 2)
-    end
-
-    domain
-  end
-
-  # Derives {#full} from {#domain} and {#local}
-  #
-  # @return [String]
-  def derived_full
-    if domain.present? && local.present?
-      "#{local}@#{domain}"
-    end
-  end
-
-  # Derives {#local} from {#full}.
-  #
-  # @return [String] if {#full} is present
-  # @return [nil] if {#full} is not present
-  def derived_local
-    local = nil
-
-    if full.present?
-      local, _domain = full.split('@', 2)
-    end
-
-    local
-  end
-end