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

data/config/locales/en.yml

@@ -0,0 +1,209 @@
+en:
+  metasploit:
+    model:
+      ancestors:
+        metasploit/model/architecture:
+          search:
+            operator:
+              names:
+                abbreviation:
+                  help: "Abbreviation for architecture, such as x86, etc."
+                bits:
+                  help: "Number of bits supported by the architecture.  Certain architectures, such as those for programming languages like Ruby and PHP, do not have bits."
+                endianness:
+                  help: "Whether the architecture is big or little endian.  Certain architectures, such as those for programming languages like Ruby and PHP, do not have an endianness."
+                family:
+                  help: "The CPU architecture family.  For example x86_64 and x86 are both in the x86 family.  Certain architectures, such as those for programming languages like Ruby and PHP, do not have a family."
+
+        metasploit/model/author:
+          search:
+            operator:
+              names:
+                name:
+                  help: "Full name (first + last name) or handle of the author."
+
+        metasploit/model/authority:
+          search:
+            operator:
+              names:
+                abbreviation:
+                  help:  "Abbreviation or initialism for authority, such as CVE for 'Common Vulnerability and Exposures'."
+
+        metasploit/model/email_address:
+          search:
+            operator:
+              names:
+                domain:
+                  help: "The domain part of the email address after the '@'."
+                full:
+                  help: "The full email address <local>@<domain>"
+                local:
+                  help: "The local part of the email address before the '@'."
+
+        metasploit/model/module/action:
+          search:
+            operator:
+              names:
+                name:
+                  help: "The name of the module action."
+
+        metasploit/model/module/class:
+          search:
+            operator:
+              names:
+                full_name:
+                  help: "<module_type>/<reference_name>"
+                module_type:
+                  help: "The type of this module."
+                payload_type:
+                  help: "For payload modules, the type of payload, either 'single' or 'staged'."
+                reference_name:
+                  help: "The reference name relative to the module_type."
+
+        metasploit/model/module/instance:
+          search:
+            operator:
+              names:
+                app:
+                  help: "The type of application. either client or server, which maps to stance:passive or stance:aggressive, respectively."
+                author:
+                  help: "Either the author's name or email address.  Maps to authors.name, email_addresses.local, and/or email_addresses.domain."
+                description:
+                  help: "A long, paragraph description of what the module does."
+                disclosed_on:
+                  help: "The date the vulnerability exploited by this module was disclosed to the public."
+                license:
+                  help: "The name of the software license for the module's code."
+                name:
+                  help: "The human readable name of the module.  It can be thought of as the summary or title of the module."
+                os:
+                  help: "Module OS in platforms.name or targets.name."
+                platform:
+                  help: "Module platform in platforms.name or targets.name."
+                privileged:
+                  help: "Whether the module requires privileged access to run."
+                ref:
+                  help: "Reference to module using obsolete \"<context>-<id>\" syntax, which maps to the newer authorities.abbreviation, references.designation or references.url."
+                stance:
+                  help: "Whether the module is active or passive."
+                text:
+                  help: "Search most of the text fields of the module metadata.  Maps to description, name, actions.name, architectures.abbreviation, platform, or ref."
+
+        metasploit/model/module/rank:
+          search:
+            operator:
+              names:
+                name:
+                  help: "Name of the rank."
+                number:
+                  help: "Numerical value of the rank.  Higher numbers are better."
+
+        metasploit/model/module/target:
+          search:
+            operator:
+              names:
+                name:
+                  help: "Name of module target."
+
+        metasploit/model/platform:
+          search:
+            operator:
+              names:
+                fully_qualified_name:
+                  help: "Fully-qualified name of the platform."
+
+        metasploit/model/reference:
+          search:
+            operator:
+              names:
+                designation:
+                  help: "A designation (usually a string of numbers and dashes) assigned by the reference's authority.  If the reference has no authority, then only url will be set, such as for references to proof-of-concept (PoC) blog posts."
+                url:
+                  help: "URL to web page with information about referenced exploit.  The URL may be null if the authority is obsolete."
+
+      attributes:
+        metasploit/model/module/instance:
+          actions:
+            one: 'action'
+            other: 'actions'
+          module_authors:
+            one: 'module author'
+            other: 'module authors'
+          module_references:
+            one: 'module reference'
+            other: 'module references'
+          targets:
+            one: 'target'
+            other: 'targets'
+
+      errors:
+        messages:
+          boolean: "is not a boolean (false or true)."
+          model_invalid: "Validation failed: %{errors}"
+
+        models:
+          metasploit/model/module/instance:
+            attributes:
+              actions:
+                wrong_length: "cannot have any actions"
+
+              architectures:
+                extra: "has extra architectures (%{extra}) not found on targets"
+                missing: "is missing architectures (%{missing}) from targets"
+
+              module_architectures:
+                too_short: "is too short (minimum is %{count} module architectures)"
+                wrong_length: "cannot have any module architectures"
+
+              module_platforms:
+                too_short: "is too short (minimum is %{count} module platforms)"
+                wrong_length: "cannot have any module platforms"
+
+              module_references:
+                too_short: "is too short (minimum is %{count} module references)"
+                wrong_length: "cannot have any module references"
+
+              platforms:
+                extra: "has extra platforms (%{extra}) not found on targets"
+                missing: "is missing platforms (%{missing}) from targets"
+
+              targets:
+                too_short: "is too short (minimum is %{count} targets)"
+                wrong_length: "cannot have any targets"
+
+          metasploit/model/search/operation/date:
+            attributes:
+              value:
+                unparseable_date: "is not a parseable Date"
+
+          metasploit/model/search/operation/null:
+            attributes:
+              operator:
+                type: "is not a %{type}"
+
+          metasploit/model/search/operation/set:
+            attributes:
+              value:
+                inclusion: "is not part of the set (%{set})"
+
+          metasploit/model/search/operation/union:
+            attributes:
+              children:
+                too_short: "is too short (minimum is %{count} child)"
+
+          metasploit/model/search/operator/null:
+            attributes:
+              name:
+                unknown: "is unknown"
+
+          metasploit/model/search/query:
+            attributes:
+              operations:
+                too_short: "is too short (minimum is %{count} operation)"
+
+      search:
+        operator:
+          ancestors:
+            metasploit/model/search/operator/deprecated/authority:
+              help: "Modules with reference from the %{name} authority.  Maps to `authorities.abbreviation:%{name} references.designation:<value>`."
+

data/lib/metasploit/model.rb

@@ -0,0 +1,38 @@
+#
+# Gems
+#
+require 'active_model'
+require 'active_support'
+# not loaded by default with require 'active_support'
+require 'active_support/dependencies'
+
+#
+# Project
+#
+require 'metasploit/model/version'
+
+# Only include the Rails engine when using Rails.  This allows the non-Rails projects, like metasploit-framework to use
+# the validators by calling Metasploit::Model.require_validators.
+if defined? Rails
+  require 'metasploit/model/engine'
+end
+
+# Top-level namespace shared between metasploit-model, metasploit-framework, and Pro.
+module Metasploit
+  # The namespace for this gem.  All code under the {Metasploit::Model} namespace is code that is shared between
+  # in-memory ActiveModels in metasploit-framework and database ActiveRecords in metasploit_data_models.  Having a
+  # separate gem for this shard code outside of metasploit_data_models is necessary as metasploit_data_models is an
+  # optional dependency for metasploit-framework as metasploit-framework can work without a database.
+  module Model
+    require 'metasploit/model/configured'
+    extend Metasploit::Model::Configured
+
+    lib_metasploit_pathname = Pathname.new(__FILE__).dirname
+    lib_pathname = lib_metasploit_pathname.parent
+    configuration.root = lib_pathname.parent
+
+    configuration.autoload.relative_paths << File.join('app', 'validators')
+  end
+end
+
+Metasploit::Model.setup

data/lib/metasploit/model/architecture.rb

@@ -0,0 +1,346 @@
+module Metasploit
+  module Model
+    # Code shared between `Mdm::Architecture` and `Metasploit::Framework::Architecture`.
+    module Architecture
+      extend ActiveModel::Naming
+      extend ActiveSupport::Concern
+
+      include Metasploit::Model::Translation
+
+      #
+      # CONSTANTS
+      #
+
+      # Valid values for {#abbreviation}
+      ABBREVIATIONS = [
+          'armbe',
+          'armle',
+          'cbea',
+          'cbea64',
+          'cmd',
+          'dalvik',
+          'firefox',
+          'java',
+          'mipsbe',
+          'mipsle',
+          'nodejs',
+          'php',
+          'ppc',
+          'ppc64',
+          'python',
+          'ruby',
+          'sparc',
+          'tty',
+          'x86',
+          'x86_64'
+      ]
+      # Valid values for {#bits}.
+      BITS = [
+          32,
+          64
+      ]
+      # Valid values for {#endianness}.
+      ENDIANNESSES = [
+          'big',
+          'little'
+      ]
+      # Valid values for {#family}.
+      FAMILIES = [
+          'arm',
+          'cbea',
+          'javascript',
+          'mips',
+          'ppc',
+          'sparc',
+          'x86'
+      ]
+      # Attributes for seeds.  Ensures that in-database seeds for `Mdm::Architecture` and in-memory seeds for
+      # `Metasploit::Framework::Architecture` are the same.
+      SEED_ATTRIBUTES = [
+          {
+              :abbreviation => 'armbe',
+              :bits => 32,
+              :endianness => 'big',
+              :family => 'arm',
+              :summary => 'Little-endian ARM'
+          },
+          {
+              :abbreviation => 'armle',
+              :bits => 32,
+              :endianness => 'little',
+              :family => 'arm',
+              :summary => 'Big-endian ARM'
+          },
+          {
+              :abbreviation => 'cbea',
+              :bits => 32,
+              :endianness => 'big',
+              :family => 'cbea',
+              :summary => '32-bit Cell Broadband Engine Architecture'
+          },
+          {
+              :abbreviation => 'cbea64',
+              :bits => 64,
+              :endianness => 'big',
+              :family => 'cbea',
+              :summary => '64-bit Cell Broadband Engine Architecture'
+          },
+          {
+              :abbreviation => 'cmd',
+              :bits => nil,
+              :endianness => nil,
+              :family => nil,
+              :summary => 'Command Injection'
+          },
+          {
+              :abbreviation => 'dalvik',
+              :bits => nil,
+              :endianness => nil,
+              :family => nil,
+              :summary => 'Dalvik process virtual machine used in Google Android'
+          },
+          {
+              abbreviation: 'firefox',
+              bits: nil,
+              endianness: nil,
+              family: 'javascript',
+              summary: "Firefox's privileged javascript API"
+          },
+          {
+              :abbreviation => 'java',
+              :bits => nil,
+              :endianness => 'big',
+              :family => nil,
+              :summary => 'Java'
+          },
+          {
+              :abbreviation => 'mipsbe',
+              :bits => 32,
+              :endianness => 'big',
+              :family => 'mips',
+              :summary => 'Big-endian MIPS'
+          },
+          {
+              :abbreviation => 'mipsle',
+              :bits => 32,
+              :endianness => 'little',
+              :family => 'mips',
+              :summary => 'Little-endian MIPS'
+          },
+          {
+              abbreviation: 'nodejs',
+              bits: nil,
+              endianness: nil,
+              family: 'javascript',
+              summary: 'NodeJS'
+          },
+          {
+              :abbreviation => 'php',
+              :bits => nil,
+              :endianness => nil,
+              :family => nil,
+              :summary => 'PHP'
+          },
+          {
+              :abbreviation => 'ppc',
+              :bits => 32,
+              :endianness => 'big',
+              :family => 'ppc',
+              :summary => '32-bit Peformance Optimization With Enhanced RISC - Performance Computing'
+          },
+          {
+              :abbreviation => 'ppc64',
+              :bits => 64,
+              :endianness => 'big',
+              :family => 'ppc',
+              :summary => '64-bit Performance Optimization With Enhanced RISC - Performance Computing'
+          },
+          {
+              :abbreviation => 'python',
+              :bits => nil,
+              :endianness => nil,
+              :family => nil,
+              :summary => 'Python'
+          },
+          {
+              :abbreviation => 'ruby',
+              :bits => nil,
+              :endianness => nil,
+              :family => nil,
+              :summary => 'Ruby'
+          },
+          {
+              :abbreviation => 'sparc',
+              :bits => nil,
+              :endianness => nil,
+              :family => 'sparc',
+              :summary => 'Scalable Processor ARChitecture'
+          },
+          {
+              :abbreviation => 'tty',
+              :bits => nil,
+              :endianness => nil,
+              :family => nil,
+              :summary => '*nix terminal'
+          },
+          {
+              :abbreviation => 'x86',
+              :bits => 32,
+              :endianness => 'little',
+              :family => 'x86',
+              :summary => '32-bit x86'
+          },
+          {
+              :abbreviation => 'x86_64',
+              :bits => 64,
+              :endianness => 'little',
+              :family => 'x86',
+              :summary => '64-bit x86'
+          }
+      ]
+
+      included do
+        include ActiveModel::Validations
+        include Metasploit::Model::Search
+
+        #
+        # Search Attributes
+        #
+
+        search_attribute :abbreviation,
+                         type: {
+                             set: :string
+                         }
+        search_attribute :bits,
+                         type: {
+                             set: :integer
+                         }
+        search_attribute :endianness,
+                         type: {
+                             set: :string
+                         }
+        search_attribute :family,
+                         type: {
+                             set: :string
+                         }
+
+        #
+        # Validations
+        #
+
+        validates :abbreviation,
+                  :inclusion => {
+                      :in => ABBREVIATIONS
+                  }
+        validates :bits,
+                  :inclusion => {
+                      :allow_nil => true,
+                      :in => BITS
+                  }
+        validates :endianness,
+                  :inclusion => {
+                      :allow_nil => true,
+                      :in => ENDIANNESSES
+                  }
+        validates :family,
+                  :inclusion => {
+                      :allow_nil => true,
+                      :in => FAMILIES
+                  }
+        validates :summary,
+                  :presence => true
+      end
+
+      # Adds <attribute>_set methods to class.
+      module ClassMethods
+        # Set of valid values to search for `attribute`.  Does not include `nil` as search syntax cannot differentiate
+        # '' and nil when parsing.
+        #
+        # @param attribute [Symbol] attribute name.
+        # @return [Set]
+        def self.set(attribute)
+          SEED_ATTRIBUTES.each_with_object(Set.new) { |attributes, set|
+            value = attributes.fetch(attribute)
+
+            unless value.nil?
+              set.add value
+            end
+          }
+        end
+
+        # @!method abbreviation_set
+        #   Set of valid {Metasploit::Model::Architecture#abbreviation} for search.
+        #
+        #   @return [Set<String>]
+        #
+        # @!method bits_set
+        #   Set of valid {Metasploit::Model::Architecture#bits} for search.
+        #
+        #   @return [Set<Integer>]
+        #
+        # @!method endianness_set
+        #   Set of valid {Metasploit::Model::Architecture#endianness} for search.
+        #
+        #   @return [Set<String>]
+        #
+        # @!method family_set
+        #   Set of valid {Metasploit::Model::Architecture#family} for search.
+        #
+        #   @return [Set<String>]
+        [:abbreviation, :bits, :endianness, :family].each do |attribute|
+          # calculate external to method so it is only calculated once
+          set = self.set(attribute)
+
+          define_method("#{attribute}_set") do
+            set
+          end
+        end
+      end
+
+      #
+      # Associations
+      #
+
+      # @!attribute [r] module_instances
+      #   {Metasploit::Model::Module::Instance Modules} that have this {Metasploit::Model::Module::Architecture} as a
+      #   {Metasploit::Model::Module::Instance#architectures support architecture}.
+      #
+      #   @return [Array<Metasploit::Model::Module::Instance>]
+
+      #
+      # Attributes
+      #
+
+      # @!attribute [rw] abbreviation
+      #   Abbreviation used for the architecture.  Will match ARCH constants in metasploit-framework.
+      #
+      #   @return [String]
+
+      # @!attribute [rw] bits
+      #   Number of bits supported by this architecture.
+      #
+      #   @return [32] if 32-bit
+      #   @return [64] if 64-bit
+      #   @return [nil] if bits aren't applicable, such as for non-CPU architectures like ruby, etc.
+
+      # @!attribute [rw] endianness
+      #   The endianness of the architecture.
+      #
+      #   @return ['big'] if big endian
+      #   @return ['little'] if little endian
+      #   @return [nil] if endianness is not applicable, such as for software architectures like tty.
+
+      # @!attribute [rw] family
+      #   The CPU architecture family.
+      #
+      #   @return [String] if a CPU architecture.
+      #   @return [nil] if not a CPU architecture.
+
+      # @!attribute [rw] summary
+      #   Sentence length summary of architecture.  Usually an expansion of the abbreviation or initialism in the
+      #   {#abbreviation} and the {#bits} and {#endianness} in prose.
+      #
+      #   @return [String]
+    end
+  end
+end