wg-metasploit_data_models 4.1.4.01 → 4.1.4.02

data/app/models/mdm/user.rb

@@ -0,0 +1,230 @@
+# A user of metasploit-framework or metasploit-pro.
+class Mdm::User < ApplicationRecord
+  extend MetasploitDataModels::SerializedPrefs
+  
+  #
+  # Associations
+  #
+
+  # Automatic exploitation runs started by this user.
+  has_many :automatic_exploitation_runs,
+           class_name: 'MetasploitDataModels::AutomaticExploitation::Run',
+           inverse_of: :user
+
+  # Automatic exploitation match sets created by this user for {#automatic_exploitation_runs}.
+  has_many :automatic_exploitation_match_sets,
+           class_name: 'MetasploitDataModels::AutomaticExploitation::MatchSet',
+           inverse_of: :user
+
+  # {Mdm::Workspace Workspaces} owned by this user.  Owned workspaces allow user complete permissions without the need
+  # or the user to be an {#admin administrator}.
+  has_many :owned_workspaces,
+           class_name: 'Mdm::Workspace',
+           foreign_key: 'owner_id',
+           inverse_of: :owner
+
+  # Runs of Metasploit Modules by this user.
+  has_many :module_runs,
+           class_name: 'MetasploitDataModels::ModuleRun',
+           inverse_of: :user
+
+  # Tags created by the user.
+  has_many :tags,
+           class_name: 'Mdm::Tag',
+           inverse_of: :user
+
+  # {Mdm::Workspace Workspace} where this user has access.  If a user is an {#admin administrator} they have access
+  # to all workspaces even if they are not a member of that workspace.
+  has_and_belongs_to_many :workspaces,
+                          -> { distinct },
+                          class_name: 'Mdm::Workspace',
+                          join_table: 'workspace_members'
+
+  #
+  # Attributes
+  #
+
+  # @!attribute admin
+  #   Whether this user is an administrator.  Administrator permissions are only enforced in metasploit-pro through the
+  #   controllers.
+  #
+  #   @return [false] if this is a normal user that must be added to each workspace.
+  #   @return [true] if this user is an administrator and have access to all workspaces without being added to the
+  #     workspace explicitly.  User is also allowed to add other users to workspaces or make other users admins.
+
+  # @!attribute company
+  #   Company at which user works.
+  #
+  #   @return [String, nil]
+
+  # @!attribute created_at
+  #   When the user was created.
+  #
+  #   @return [DateTime]
+
+  # @!attribute crypted_password
+  #   Hashed password (salted with {#password_salt}) by Authlogic in metasploit-pro.
+  #
+  #   @return [String]
+
+  # @!attribute email
+  #   The user's email address.
+  #
+  #   @return [String, nil]
+
+  # @!attribute fullname
+  #   The user's normal human name.
+  #
+  #   @return [String, nil]
+
+  # @!attribute password_salt
+  #   Salt used when hashing password into {#crypted_password} by Authlogic in metasploit-pro.
+  #
+  #   @return [String]
+
+  # @!attribute persistence_token
+  #   Token used for session and cookie when user is logged using Authlogic in metasploit-pro.
+  #
+  #   @return [String]
+
+  # @!attribute phone
+  #   Phone number for user.
+  #
+  #   @return [String, nil]
+
+  # @!attribute updated_at
+  #   When the user was last updated.
+  #
+  #   @return [DateTime]
+
+  # @!attribute username
+  #   Username for this user.  Used to log into metasploit-pro.
+  #
+  #   @return [String]
+
+  #
+  # Serialziations
+  #
+
+  # Hash of user preferences
+  #
+  # @return [Hash]
+  serialize :prefs, MetasploitDataModels::Base64Serializer.new
+
+  # @!attribute time_zone
+  #   User's preferred time zone.
+  #
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :time_zone
+
+  #
+  #  @!group Duplicate Login Monitoring
+  #
+
+  # @!attribute last_login_address
+  #   @note specifically NOT last_login_ip to prevent confusion with AuthLogic magic columns (which dont work for
+  #     serialized fields)
+  #
+  #   Last IP address from which this user logged in.  Used to report currently active user session's IP when the user
+  #   is logged off because theire `session[:session_id]` does not match {#session_key}.
+  #
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :last_login_address
+
+  # @!attribute session_key
+  #   Holds `session[:session_id]` so user can only be logged in once.  Only enforced in metasploit-pro.
+  #
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :session_key
+
+  #
+  # @!endgroup
+  #
+
+  #
+  # @!group HTTP Proxy
+  #
+
+  # @!attribute http_proxy_host
+  #   Proxy host.
+  #
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :http_proxy_host
+
+  # @!attribute http_proxy_pass
+  #   Password used to login as {#http_proxy_user} to proxy.
+  #
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :http_proxy_pass
+
+  # @!attribute http_proxy_port
+  #   Port on which proxy run on {#http_proxy_host}.
+  #
+  #   @return [String, Integer, nil]
+  serialized_prefs_attr_accessor :http_proxy_port
+
+  # @!attribute http_proxy_user
+  #   User used to log into proxy.
+  #
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :http_proxy_user
+
+  #
+  # @!endgroup
+  #
+
+  #
+  # @!group Nexpose
+  #
+
+  # @!attribute nexpose_host
+  #   Host name for server running Nexpose.
+  #
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :nexpose_host
+
+  # @!attribute nexpose_pass
+  #   Password to log into Nexpose.
+  #
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :nexpose_pass
+
+  # @!attribute nexpose_port
+  #   Port on {#nexpose_host} on which Nexpose is running.
+  #
+  #   @return [String, Integer. nil]
+  serialized_prefs_attr_accessor :nexpose_port
+
+  # @!attribute nexpose_user
+  #   User used to log into Nexpose.
+  #
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :nexpose_user
+
+  #
+  # @!endgroup
+  #
+
+  #
+  # @!group Nexpose Authenticated Scan Credentials
+  #
+
+  # @!attribute nexpose_creds_pass
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :nexpose_creds_pass
+
+  # @!attribute nexpose_creds_type
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :nexpose_creds_type
+
+  # @!attribute nexpose_creds_user
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :nexpose_creds_user
+
+  #
+  # @!endgroup
+  #
+
+  Metasploit::Concern.run(self)
+end
+

data/app/models/mdm/vuln.rb

@@ -0,0 +1,204 @@
+# A vulnerability found on a {#host} or {#service}.
+class Mdm::Vuln < ApplicationRecord
+
+  #
+  # Associations
+  #
+
+  # @!attribute exploit_attempts
+  #   Attempts to exploit this vulnerability.
+  #
+  #   @return [ActiveRecord::Relation<Mdm::ExploitAttempt>]
+  has_many :exploit_attempts,
+           class_name: 'Mdm::ExploitAttempt',
+           inverse_of: :vuln
+
+  # @!attribute [rw] host
+  #   The host with this vulnerability.
+  #
+  #   @return [Mdm::Host]
+  belongs_to :host,
+             class_name: 'Mdm::Host',
+             counter_cache: :vuln_count,
+             inverse_of: :vulns
+
+  # @!attribute [rw] matches
+  #   The matches for this vuln
+  #
+  #   @return [ActiveRecord::Relation<MetasploitDataModels::AutomaticExploitation::Match>]
+  has_many :matches, class_name: "MetasploitDataModels::AutomaticExploitation::Match",
+           as: :matchable,
+           dependent: :destroy
+
+  # @!attribute [rw] service
+  #   The service with the vulnerability.
+  #
+  #   @return [Mdm::Service]
+  belongs_to :service,
+             class_name: 'Mdm::Service',
+             inverse_of: :vulns
+
+  # @!attribute [rw] origin
+  #   A polymorphic association to the origin that found
+  #   the vulnerability.
+  #
+  #   @return [ActiveRecord::Relation<origin>]
+  belongs_to :origin,
+             polymorphic: true
+
+  # @!attribute [rw] vuln_attempts
+  #   Attempts to exploit this vulnerability.
+  #
+  #   @return [ActiveRecord::Relation<Mdm::VulnAttempt>]
+  has_many :vuln_attempts,
+           class_name: 'Mdm::VulnAttempt',
+           dependent: :destroy,
+           inverse_of: :vuln
+
+  # @!attribute [rw] vuln_details
+  #   Additional information about this vulnerability.
+  #
+  #   @return [ActiveRecord::Relation<Mdm::VulnDetail>]
+  has_many :vuln_details,
+           class_name: 'Mdm::VulnDetail',
+           dependent: :destroy,
+           inverse_of: :vuln
+
+  # @!attribute [rw] vulns_refs
+  #   Join model that joins this vuln to its {Mdm::Ref external references}.
+  #
+  #   @return [ActiveRecord::Relation<Mdm::VulnRef>]
+  has_many :vulns_refs,
+           class_name: 'Mdm::VulnRef',
+           dependent: :destroy,
+           inverse_of: :vuln
+
+  # @!attribute [rw] notes
+  #   Notes about the vuln entered by a user with {Mdm::Note#created_at oldest notes} first.
+  #
+  #   @return [<ActiveRecord::RelationMdm::Note>]
+  has_many :notes,
+           -> { order('notes.created_at') },
+           class_name: 'Mdm::Note',
+           inverse_of: :vuln,
+           dependent: :delete_all
+
+
+  #
+  # Through :vuln_refs
+  #
+
+  # @!attribute [r] refs
+  #   External references to this vulnerability.
+  #
+  #   @return [ActiveRecord::Relation<Mdm::Ref>]
+  has_many :refs, :class_name => 'Mdm::Ref', :through => :vulns_refs
+
+  #
+  #  Through refs
+  #
+
+  # @!attribute [r] module_refs
+  #   References in module that match {Mdm::Ref#name names} in {#refs}.
+  #
+  #   @return [ActiveRecord::Relation<Mdm::Module::Ref>]
+  has_many :module_refs, :class_name => 'Mdm::Module::Ref', :through => :refs
+
+
+  # @!attribute [r] module_runs
+  #   References to times that a module has been run to exercise this vuln
+  #
+  #   @return [ActiveRecord::Relation<MetasploitDataModels::ModuleRun>]
+  has_many :module_runs,
+           class_name: 'MetasploitDataModels::ModuleRun',
+           as: :trackable
+
+  #
+  # Through module_refs
+  #
+
+  # @!attribute [r] module_details
+  #   {Mdm::Module::Detail Modules} that share the same external references as this vuln.
+  #
+  #   @return [ActiveRecord::Relation<Mdm::Module::Detail>]
+  has_many :module_details,
+            -> { distinct },
+            :class_name => 'Mdm::Module::Detail',
+            :source => :detail,
+            :through => :module_refs
+
+
+  #
+  # Attributes
+  #
+
+  # @!attribute [rw] exploited_at
+  #   When the vulnerability was exploited
+  #
+  #   @return [DateTime]
+
+  # @!attribute [rw] name
+  #   The name of the vulnerability in metasploit-framework or from the import source.
+  #
+  #   @return [String]
+
+  # @!attribute [rw] info
+  #   Additional information about the vulnerability
+  #
+  #   @return [String]
+
+  # @!attribute [rw] vuln_attempt_count
+  #   Counter cache for number of {#vuln_attempts}.
+  #
+  #   @return [Integer]
+
+  # @!attribute [rw] vuln_detail_count
+  #   Counter cache for number of {#vuln_details}.
+  #
+  #   @return [Integer]
+
+  #
+  # Callbacks
+  #
+
+  after_update :save_refs
+
+  #
+  # Scopes
+  #
+
+  scope :search, lambda { |query|
+    formatted_query = "%#{query}%"
+    where(
+      arel_table[:name].matches(formatted_query).or(
+        arel_table[:info].matches(formatted_query)
+      ).or(
+        Mdm::Ref.arel_table[:name].matches(formatted_query)
+      ).or(
+        Arel::Nodes::NamedFunction.new('CAST', [Mdm::Host.arel_table[:address].as('TEXT')]).matches(formatted_query)
+      ).or(
+        Mdm::Host.arel_table[:name].matches(formatted_query)
+      )
+    ).includes(
+      :refs, :host
+    ).references(:refs,:host)
+  }
+
+  #
+  # Validations
+  #
+
+  validates :name, :presence => true
+  validates :name, length: {maximum: 255}
+  validates_associated :refs
+
+  private
+
+  def save_refs
+    refs.each { |ref| ref.save(:validate => false) }
+  end
+
+  public
+
+  Metasploit::Concern.run(self)
+end

data/app/models/mdm/vuln_attempt.rb

@@ -0,0 +1,76 @@
+# An attempt to exploit a {#vuln}.
+class Mdm::VulnAttempt < ApplicationRecord
+  
+  #
+  # Associations
+  #
+
+  # Loot gathered from this attempt.
+  #
+  # @return [Mdm::Loot] if {#exploited} is `true`.
+  # @return [nil] if {#exploited} is `false`.
+  belongs_to :loot,
+             class_name: 'Mdm::Loot',
+             inverse_of: :vuln_attempt
+
+  # The session opened by this attempt.
+  #
+  # @return [Mdm::Session] if {#exploited} is `true`.
+  # @return [nil] if {#exploited} is `false`.
+  belongs_to :session,
+             class_name: 'Mdm::Session',
+             inverse_of: :vuln_attempt
+
+  # The {Mdm::Vuln vulnerability} that this attempt was exploiting.
+  #
+  # @return [Mdm::Vuln]
+  belongs_to :vuln,
+             class_name: 'Mdm::Vuln',
+             counter_cache: :vuln_attempt_count,
+             inverse_of: :vuln_attempts
+
+  #
+  # Attributes
+  #
+
+  # @!attribute attempted_at
+  #   When this attempt was made.
+  #
+  #   @return [DateTime]
+
+  # @!attribute exploited
+  #   Whether this attempt was successful.
+  #
+  #   @return [true] if {#vuln} was exploited.
+  #   @return [false] if {#vuln} was not exploited.
+
+  # @!attribute fail_detail
+  #   Long details about why this attempt failed.
+  #
+  #   @return [String] if {#exploited} is `false`.
+  #   @return [nil] if {#exploited} is `true`.
+
+  # @!attribute fail_reason
+  #   Short reason why this attempt failed.
+  #
+  #   @return [String] if {#exploited} is `false`.
+  #   @return [nil] if {#exploited} is `true`
+
+  # @!attribute module
+  #   {Mdm::Module::Detail#fullname Full name of exploit Metasploit Module} that was used in this attempt.
+  #
+  #   @return [String]
+
+  # @!attribute username
+  #   The {Mdm::User#username name of the user} that made this attempt.
+  #
+  #   @return [String]
+
+  #
+  # Validations
+  #
+
+  validates :vuln_id, :presence => true
+
+  Metasploit::Concern.run(self)
+end

data/app/models/mdm/vuln_detail.rb

@@ -0,0 +1,156 @@
+# {Mdm::Vuln Vulnerability details} supplied from an external source, such as Nexpose.
+class Mdm::VulnDetail < ApplicationRecord
+  #
+  # Associations
+  #
+
+  # The vulnerability this detail is about.
+  belongs_to :vuln, class_name: 'Mdm::Vuln', counter_cache: :vuln_detail_count, inverse_of: :vuln_details
+
+  #
+  #
+  # Attributes
+  #
+  #
+
+  # @!attribute description
+  #   Long description of this vulnerability.
+  #
+  #   @return [String]
+
+  # @!attribute src
+  #   Source of this vulnerability detail.
+  #
+  #   @return [String]
+
+  # @!attribute title
+  #   Title of this vulnerability.
+  #
+  #   @return [String]
+
+  # @!attribute proof
+  #   Proof of this vulnerability existing on the target.
+  #
+  #   @return [String]
+
+  # @!attribute solution
+  #   Solution to fix this vulnerability.
+  #
+  #   @return [String]
+
+  #
+  # @!group Common Vulnerability Scoring System
+  #
+
+  # @!attribute cvss_score
+  #   Composite Common Vulnerability Scoring System (CVSS) Score
+  #
+  #   @return [Float]
+
+  # @!attribute cvss_vector
+  #   {#cvss_score} broken down into its encoded components
+  #
+  #   @return [String]
+  #   @see http://nvd.nist.gov/cvss.cfm?vectorinfo
+
+  #
+  # @!endgroup
+  #
+
+  #
+  # @!group Nexpose
+  #
+
+  # association is declared here so it can be in Nexpose group
+
+  # The Nexpose console that supplied this information.
+  belongs_to :nexpose_console,
+             class_name: 'Mdm::NexposeConsole',
+             foreign_key: :nx_console_id,
+             inverse_of: :vuln_details
+
+  # @!attribute nx_added
+  #   When this vulnerability was added in Nexpose.
+  #
+  #   @return [DateTime]
+
+  # @!attribute nx_device_id
+  #   ID of target device in Nexpose.
+  #
+  #   @return [Integer]
+
+  # @!attribute nx_modified
+  #   The last time this vulnerability was modified in Nexpose.
+  #
+  #   @return [DateTime]
+
+  # @!attribute nx_proof_key
+  #   Key to {#proof} in Nexpose.
+  #
+  #   @return [String]
+
+  # @!attribute nx_published
+  #   When this vulnerability was published according to Nexpose.
+  #
+  #   @return [DateTime]
+
+  # @!attribute nx_scan_id
+  #   ID of scan that found this vulnerability in Nexpose.
+  #
+  #   @return [Integer]
+
+  # @!attribute nx_tags
+  #   Tags on this vulnerability in Nexpose.
+  #
+  #   @return [String]
+
+  # @!attribute nx_vuln_id
+  #   ID of this vulnerability in Nexpose.
+  #
+  #   @return [String]
+
+  # @!attribute nx_vuln_status
+  #   Status of this vulnerability in Nexpose.
+  #
+  #   @return [String]
+
+  # @!attribute nx_vulnerable_since
+  #   When this vulnerability was first identified for the target in Nexpose.
+  #
+  #   @return [DateTime]
+
+  # @!attribute nx_severity
+  #   Severity of this vulnerability according to Nexpose.
+  #
+  #   @return [Float]
+
+  #
+  # @!endgroup
+  #
+
+  #
+  # @!group Nexpose PCI
+  #
+
+  # @!attribute nx_pci_compliance_status
+  #   Status of PCI compliance with regards to this vulnerability according to Nexpose.
+  #
+  #   @return [String]
+
+  # @!attribute nx_pci_severity
+  #   The severity for the vulnerability under PCI according to Nexpose.
+  #
+  #   @return [Float]
+
+  #
+  # @!endgroup
+  #
+  
+  #
+  # Validations
+  #
+
+  validates :vuln_id, :presence => true
+
+  Metasploit::Concern.run(self)
+end

data/app/models/mdm/vuln_ref.rb

@@ -0,0 +1,21 @@
+# Join model between {Mdm::Vuln} and {Mdm::Ref}.
+class Mdm::VulnRef < ApplicationRecord
+  self.table_name = 'vulns_refs'
+
+  #
+  # Associations
+  #
+
+  # {Mdm::Ref Reference} to {#vuln}.
+  belongs_to :ref,
+             class_name: 'Mdm::Ref',
+             inverse_of: :vulns_refs
+
+  # {Mdm::Vuln Vulnerability} imported or discovered by metasploit.
+  belongs_to :vuln,
+             class_name: 'Mdm::Vuln',
+             inverse_of: :vulns_refs
+
+  Metasploit::Concern.run(self)
+end
+