wg-metasploit_data_models 4.1.4.01 → 4.1.4.02

data/app/models/mdm/note.rb

@@ -0,0 +1,125 @@
+# Data gathered or derived from the {#host} or {#service} such as its {#ntype fingerprint}.
+class Mdm::Note < ApplicationRecord
+  
+  #
+  # Associations
+  #
+
+  # @!attribute [rw] host
+  #   The host to which this note is attached.
+  #
+  #   @return [Mdm::Host] if note is attached to an {Mdm::Host}.
+  #   @return [nil] if note is attached to an {Mdm::Service}.
+  belongs_to :host,
+             class_name: 'Mdm::Host',
+             counter_cache: :note_count,
+             inverse_of: :notes
+
+  # @!attribute [rw] service
+  #   The service to which this note is attached.
+  #
+  #   @return [Mdm::Service] if note is attached to an {Mdm::Service}.
+  #   @return [nil] if not is attached to an {Mdm::Host}.
+  belongs_to :service,
+             class_name: 'Mdm::Service',
+             inverse_of: :notes
+
+  # @!attribute [rw] vuln
+  #   The vuln to which this note is attached.
+  #
+  #   @return [Mdm::Vuln] if note is attached to an {Mdm::Vuln}.
+  #   @return [nil] if not is attached to an {Mdm::Host}.
+  belongs_to :vuln,
+             class_name: 'Mdm::Vuln',
+             inverse_of: :notes
+
+  # @!attribute [rw] workspace
+  #   The workspace in which the {#host} or {#service} exists.
+  #
+  #   @return [Mdm::Workspace]
+  belongs_to :workspace,
+             class_name: 'Mdm::Workspace',
+             inverse_of: :notes
+
+  #
+  # Attributes
+  #
+
+  # @!attribute [rw] created_at
+  #   When the note was created.
+  #
+  #   @return [DateTime]
+
+  # @!attribute [rw] critical
+  #   Whether this note is critical or not.
+  #
+  #   @return [Boolean]
+
+  # @!attribute [rw] data
+  #   A Hash of data about the {#host} or {#service}.
+  #
+  #   @return [Hash]
+
+  # @!attribute [rw] ntype
+  #   The type of note.  Usually a dot-separateed name like 'host.updated.<foo>'.
+  #
+  #   @return [String]
+
+  # @!attribute [rw] seen
+  #   Whether any user has seen this note.
+  #
+  #   @return [Boolean]
+
+  # @!attribute [rw] updated_at
+  #   The last time the note was updated.
+  #
+  #   @return [DateTime]
+
+  #
+  # Callbacks
+  #
+
+  after_save :normalize
+
+  #
+  # Scopes
+  #
+
+  scope :flagged, -> { where('critical = true AND seen = false') }
+
+  scope :visible, -> { where(Mdm::Note[:ntype].not_in(['web.form', 'web.url', 'web.vuln'])) }
+
+  scope :search, lambda { |*args|
+    joins(:host).
+      where(
+        "(notes.data NOT ILIKE 'BAh7%' AND notes.data LIKE ?) " +
+          "OR (notes.data ILIKE 'BAh7%' AND decode(notes.data, 'base64') LIKE ?) " +
+          'OR notes.ntype ILIKE ? ' +
+          'OR COALESCE(hosts.name, CAST(hosts.address AS TEXT)) ILIKE ?',
+        "%#{args[0]}%", "%#{args[0]}%", "%#{args[0]}%", "%#{args[0]}%"
+      )
+  }
+
+  #
+  # Serializations
+  #
+
+  serialize :data, ::MetasploitDataModels::Base64Serializer.new
+
+  private
+
+  # {Mdm::Host::OperatingSystemNormalization#normalize_os Normalizes the host operating system} if the note is a
+  # {#ntype fingerprint}.
+  #
+  # @return [void]
+  def normalize
+    if saved_change_to_data? and ntype =~ /fingerprint/ && host.workspace.present? && !host.workspace.import_fingerprint
+      host.normalize_os
+    end
+  end
+
+  public
+
+  Metasploit::Concern.run(self)
+end
+

data/app/models/mdm/payload.rb

@@ -0,0 +1,103 @@
+# A payload that has been generated by Metasploit and used to establish {Mdm::Session}.
+class Mdm::Payload < ApplicationRecord
+  extend ActiveSupport::Autoload
+
+  include Metasploit::Model::Search
+
+  #
+  # Associations
+  #
+
+
+  #
+  # Attributes
+  #
+
+  # @!attribute [rw] name
+  #   The name of this payload.
+  #
+  #   @return [String]
+
+  # @!attribute [rw] uuid
+  #   A unique identifier for this payload. The UUID is encoded to include specific information.
+  #   See lib/msf/core/payload/uuid.rb in the https://github.com/rapid7/metasploit-framework repo.
+  #
+  #   @return [String]
+
+  # @!attribute [rw] uuid_mask
+  #   The number of bytes of the UUID that this payload has embedded within it. This is to support
+  #   legacy payloads that limit the UUID to 8 bytes
+  #
+  #   @return [Integer]
+
+  # @!attribute [rw] timestamp
+  #   The Unix format timestamp when this payload was created.
+  #
+  #   @return [Integer]
+
+  # @!attribute [rw] arch
+  #   The architecture this payload supports.
+  #   Valid values are located at lib/msf/core/payload/uuid.rb in the https://github.com/rapid7/metasploit-framework repo.
+  #
+  #   @return [String]
+
+  # @!attribute [rw] platform
+  #   The platform this payload supports.
+  #   Valid values are located at lib/msf/core/payload/uuid.rb in the https://github.com/rapid7/metasploit-framework repo.
+  #
+  #   @return [String]
+
+  # @!attribute [rw] urls
+  #   The unique, encoded urls used to host this payload. Only applicable for http(s) payloads
+  #
+  #   @return [Array]
+
+  # @!attribute [rw] description
+  #   A description of why this payload was created and what it is being used for.
+  #
+  #   @return [String]
+
+  # @!attribute [rw] raw_payload
+  #   A URL pointing to where the binary payload can be downloaded from.
+  #
+  #   @return [String]
+
+  # @!attribute [rw] raw_payload_hash
+  #   The unique hash value for the generated payload binary
+  #
+  #   @return [String]
+
+  # @!attribute [rw] build_status
+  #   The current status of the job building the payload binary. Valid values are "started", "completed", and "error"
+  #
+  #   @return [String]
+
+  # @!attribute [rw] build_opts
+  #   A hash containing various options used to build this payload
+  #
+  #   @return [Hash]
+
+
+  #
+  # Validations
+  #
+
+
+  #
+  # Search Attributes
+  #
+
+  search_attribute :uuid,
+                   type: :string
+
+  #
+  # Serializations
+  #
+
+  serialize :urls
+  serialize :build_opts
+
+  public
+
+  Metasploit::Concern.run(self)
+end

data/app/models/mdm/profile.rb

@@ -0,0 +1,45 @@
+# User settings.
+class Mdm::Profile < ApplicationRecord
+  #
+  # Attributes
+  #
+
+  # @!attribute active
+  #   Whether this is the currently active profile.
+  #
+  #   @return [true] if this is the active profile.
+  #   @return [false] if this profile is inactive and another profile is active.
+
+  # @!attribute created_at
+  #   When this profile was created.
+  #
+  #   @return [DateTime]
+
+  # @!attribute name
+  #   Name of this profile to distinguish it from other profiles.
+  #
+  #   @return [String]
+
+  # @!attribute owner
+  #   Owner of this profile.
+  #
+  #   @return ['<system>'] System-wide profile for all users.
+  #   @return [String] Name of user that uses this profile.
+
+  # @!attribute updated_at
+  #   The last time this profile was updated.
+  #
+  #   @return [DateTime]
+
+  #
+  # Serializations
+  #
+
+  # Global settings.
+  #
+  # @return [Hash]
+  serialize :settings, MetasploitDataModels::Base64Serializer.new
+
+  Metasploit::Concern.run(self)
+end
+

data/app/models/mdm/ref.rb

@@ -0,0 +1,48 @@
+# An external vulnerability reference for vulnerabilities that aren't part of a module.  {Mdm::Module::Ref} should be
+# used whenever possible and Mdm::Ref should only be used when the vulnerability is from an import and can't be
+# correlated to a module and its {Mdm::Module::Detail}.
+class Mdm::Ref < ApplicationRecord
+  #
+  # Associations
+  #
+
+  # @!attribute [r] module_refs
+  #   {Mdm::Module::Ref Mdm::Module::Refs} with the same name as this ref.
+  #
+  #   @return [Array<Mdm::Module::Ref>]
+  has_many :module_refs,
+           :class_name => 'Mdm::Module::Ref',
+           :foreign_key => :name,
+           :primary_key => :name
+
+  # @!attribute [rw] vulns_refs
+  #   Join model to {Mdm::Vuln Mdm::Vulns}.  Use {#vulns} to get the actual {Mdm::Vuln Mdm::Vulns}.
+  #
+  #   @todo MSP-3066
+  #   @return [Array<Mdm::VulnRef>]
+  has_many :vulns_refs,
+           :class_name => 'Mdm::VulnRef',
+           inverse_of: :ref
+
+  #
+  # Through :vuln_refs
+  #
+
+  # @!attribute [rw] vulns
+  #   Vulnerabilities referenced by this reference.
+  #
+  #   @return [Array<Mdm::Vuln>]
+  has_many :vulns, :class_name => 'Mdm::Vuln', :through => :vulns_refs
+
+  #
+  # Attributes
+  #
+
+  # @!attribute [rw] name
+  #   Designation for external reference.  May include a prefix for the authority, such as 'CVE-', in which case the
+  #   rest of the name is the designation assigned by that authority.
+  #
+  #   @return [String]
+
+  Metasploit::Concern.run(self)
+end

data/app/models/mdm/route.rb

@@ -0,0 +1,28 @@
+# Network route that goes through a {#session} to allow accessing IPs on the remote end of the session.
+class Mdm::Route < ApplicationRecord
+  
+  #
+  # Associations
+  #
+
+  # The session over which this route traverses.
+  belongs_to :session,
+             class_name: 'Mdm::Session',
+             inverse_of: :routes
+
+  #
+  # Attributes
+  #
+
+  # @!attribute netmask
+  #   The netmask for this route.
+  #
+  #   @return [String]
+
+  # @!attribute subnet
+  #   The subnet for this route.
+  #
+  #   @return [String]
+
+  Metasploit::Concern.run(self)
+end

data/app/models/mdm/service.rb

@@ -0,0 +1,267 @@
+# A service, such as an ssh server or web server, running on a {#host}.
+class Mdm::Service < ApplicationRecord
+  include Metasploit::Model::Search
+
+  #
+  # CONSTANTS
+  #
+
+  # Valid values for {#proto}.
+  PROTOS = %w{tcp udp}
+
+  # Valid values for {#state}.
+  STATES = ['open', 'closed', 'filtered', 'unknown']
+
+  #
+  # Associations
+  #
+
+  # @!attribute creds
+  #   Credentials gathered from this service.
+  #
+  #   @return [ActiveRecord::Relation<Mdm::Cred>]
+  has_many :creds,
+           class_name: 'Mdm::Cred',
+           dependent: :destroy,
+           inverse_of: :service
+
+  # @!attribute exploit_attempts
+  #   Exploit attempts against this service.
+  #
+  #   @return [ActiveRecord::Relation<Mdm::ExploitAttempt>]
+  has_many :exploit_attempts,
+           class_name: 'Mdm::ExploitAttempt',
+           dependent: :destroy,
+           inverse_of: :service
+
+  # @!attribute exploited_hosts
+  #   @todo MSP-2732
+  #   @return [Array<Mdm::ExploitHost>]
+  has_many :exploited_hosts,
+           class_name: 'Mdm::ExploitedHost',
+           dependent: :destroy,
+           inverse_of: :service
+
+  # @!attribute host
+  #   The host on which this service runs.
+  #
+  #   @return [Mdm::Host]
+  belongs_to :host,
+             class_name: 'Mdm::Host',
+             counter_cache: :service_count,
+             inverse_of: :services
+
+  # @!attribute loots
+  #   Loot gathers from this service.
+  #
+  #   @return [ActiveRecord::Relation<Mdm::Loot>]
+  has_many :loots,
+           class_name: 'Mdm::Loot',
+           dependent: :destroy,
+           inverse_of: :service
+
+  # @!attribute notes
+  #   Notes about this service.
+  #
+  #   @return [ActiveRecord::Relation<Mdm::Note>]
+  has_many :notes,
+           class_name: 'Mdm::Note',
+           dependent: :destroy,
+           inverse_of: :service
+
+  # @!attribute [rw] task_services
+  #   Details about what Tasks touched this service
+  #
+  #   @return [Array<Mdm::TaskService>]
+  has_many :task_services,
+           class_name: 'Mdm::TaskService',
+           dependent: :destroy,
+           inverse_of: :service
+
+  # @!attribute vulns
+  #   Vulnerabilities found in this service.
+  #
+  #   @return [ActiveRecord::Relation<Mdm::Vuln>]
+  has_many :vulns,
+           class_name: 'Mdm::Vuln',
+           dependent: :destroy,
+           inverse_of: :service
+
+  # @!attribute web_sites
+  #   Web sites running on top of this service.
+  #
+  #   @return [ActiveRecord::Relation<Mdm::WebSite>]
+  has_many :web_sites,
+           class_name: 'Mdm::WebSite',
+           dependent: :destroy,
+           inverse_of: :service
+
+  #
+  # through: :task_services
+  #
+
+  # @!attribute [rw] tasks
+  #   Tasks that touched this service
+  #
+  #   @return [Array<Mdm::Task>]
+  has_many :tasks, :through => :task_services, :class_name => 'Mdm::Task'
+
+  #
+  # Through :web_sites
+  #
+
+  # @!attribute [r] web_pages
+  #   Web pages in the {#web_sites} on top of this service.
+  #
+  #   @return [Array<Mdm::WebPages>]
+  has_many :web_pages, :through => :web_sites, :class_name => 'Mdm::WebPage'
+
+  # @!attribute [r] web_forms
+  #   Form in the {#web_sites} on top of this service.
+  #
+  #   @return [Array<Mdm::WebForm>]
+  has_many :web_forms, :through => :web_sites, :class_name => 'Mdm::WebForm'
+
+  # @!attribute [r] web_vulns
+  #   Vulnerabilities found in the {#web_sites} on top of this service.
+  #
+  #   @return [Array<Mdm::WebVuln>]
+  has_many :web_vulns, :through => :web_sites, :class_name => 'Mdm::WebVuln'
+
+  #
+  # Attributes
+  #
+
+  # @!attribute [rw] info
+  #   Additional information about the service that does not fit in the {#name} or {#proto}.
+  #
+  #   @return [String]
+
+  # @!attribute [rw] port
+  #   The port on which this service runs on the {#host}.
+  #
+  #   @return [Integer]
+
+  # @!attribute [rw] name
+  #    The name of the service.
+  #
+  #    @return [String]
+
+  # @!attribute [rw] proto
+  #   The protocol used by this service
+  #
+  #   @return [String]
+
+  # @!attribute [rw] state
+  #   Whether this service is opened, closed, filtered, or in an unknown state.
+  #
+  #   @return [String] element of {STATES}.
+
+  #
+  # Callbacks
+  #
+
+  after_save :normalize_host_os
+
+  #
+  # Scopes
+  #
+
+  scope :inactive, -> { where("services.state != 'open'") }
+  scope :with_state, lambda { |a_state|  where("services.state = ?", a_state)}
+  scope :search, lambda { |*args|
+    joins(:host).
+      where(
+        'services.name ILIKE ? OR ' +
+          'services.info ILIKE ? OR ' +
+          'services.proto ILIKE ? OR ' +
+          'services.port = ? OR ' +
+          'COALESCE(hosts.name, CAST(hosts.address AS TEXT)) ILIKE ?',
+         "%#{args[0]}%", "%#{args[0]}%", "%#{args[0]}%", (args[0].to_i > 0) ? args[0].to_i : 99999, "%#{args[0]}%"
+      )
+  }
+
+  #
+  #
+  # Search
+  #
+  #
+
+  #
+  # Search Associations
+  #
+
+  search_associations host: :tags
+
+  #
+  # Search Attributes
+  #
+
+  search_attribute :info,
+                   type: :string
+  search_attribute :name,
+                   type: :string
+  search_attribute :proto,
+                   type: {
+                       set: :string
+                   }
+
+  #
+  # Search Withs
+  #
+
+  search_with MetasploitDataModels::Search::Operator::Port::List
+
+  #
+  # Validations
+  #
+  validates :port,
+            numericality: {
+                only_integer: true
+            },
+            inclusion: {
+                in: 1..65535
+            }
+  validates :port,
+            uniqueness: {
+              message: 'already exists on this host and protocol',
+              scope: [
+                :host_id,
+                :proto
+              ]
+            }
+  validates :proto,
+            inclusion: {
+                in: PROTOS
+            }
+
+
+  #
+  # Class Methods
+  #
+
+  # Set of searchable values for {#proto}.
+  #
+  # @return [Set<String>] {PROTOS} as a `Set`.
+  # @see Metasploit::Model::Search::Operation::Set#membership
+  # @see Metasploit::Model::Search::Operator::Attribute#attribute_set
+  def self.proto_set
+    @proto_set ||= Set.new(PROTOS)
+  end
+
+  #
+  # Instance Methods
+  #
+
+  # {Mdm::Host::OperatingSystemNormalization#normalize_os Normalizes the host operating system} whenever {#info} has
+  # changed.
+  #
+  # @return [void]
+  def normalize_host_os
+    if saved_change_to_info? && host.workspace.present? && !host.workspace.import_fingerprint
+      host.normalize_os
+    end
+  end
+
+  Metasploit::Concern.run(self)
+end