metasploit_data_models 0.23.1 → 0.23.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e51d22eadaeed4e22c7baa124b8114e4da2eb18e
-  data.tar.gz: 85d923444c7ef5c77c992247f2bbc8ec3a3ba5a0
+  metadata.gz: 4779d55987df4d62d75eaad7b3f5e40b0b880510
+  data.tar.gz: a87a7b50dae2bc02d2ea544290eeae4c406047fe
 SHA512:
-  metadata.gz: 985147647109e0da1c592add750c845ee35e9e219b13c23f9ef9f21623b0597c9ca3156dac90068eabf2179341539f2500ec8ea2c9e70709087365a8b78221f0
-  data.tar.gz: 3d069e07db3b8ff62ea29690e1abad596c11cd16ba45639464c876612c0b0ca9d2d21fa9d8dad3c7082768d4e62551c30079a846013c8ec76be0a0544b79d221
+  metadata.gz: 8be1a0f211354eda1de426d22ba9b1ccb81627ab9f0abde742af2b4ce90defd4632650bf8f237c83495c7db9c5c0c4eec499eabf94c48882dcc03f4a9029252a
+  data.tar.gz: fc93045d392e8107af1b77619742fd1743f49df7fac46259e48a44e57a5df9d45461f87694b4889b15e73a8c7b38f2509d39dbdf678e875fc4e0e72b02d07047

data/app/models/mdm/host.rb

@@ -66,7 +66,7 @@ class Mdm::Host < ActiveRecord::Base
   # @!attribute [rw] clients
   #   Users connected to this host
   #
-  #   @return [Array<Mdm::Client>]
+  #   @return [ActiveRecord::Relation<Mdm::Client>]
   has_many :clients,
            class_name: 'Mdm::Client',
            dependent: :destroy,
@@ -84,7 +84,7 @@ class Mdm::Host < ActiveRecord::Base
   # @!attribute [rw] task_hosts
   #   Details about what Tasks touched this host
   #
-  #   @return [Array<Mdm::TaskHost>]
+  #   @return [ActiveRecord::Relation<Mdm::TaskHost>]
   has_many :task_hosts,
            class_name: 'Mdm::TaskHost',
            dependent: :destroy,
@@ -93,7 +93,7 @@ class Mdm::Host < ActiveRecord::Base
   # @!attribute [rw] exploit_attempts
   #   Attempts to run exploits against this host.
   #
-  #   @return [Array<Mdm::ExploitAttempt]
+  #   @return [ActiveRecord::Relation<Mdm::ExploitAttempt]
   has_many :exploit_attempts,
            class_name: 'Mdm::ExploitAttempt',
            dependent: :destroy,
@@ -108,7 +108,7 @@ class Mdm::Host < ActiveRecord::Base
            inverse_of: :host
 
   # @!attribute [rw] host_details
-  #   @return [Array<Mdm::HostDetail>]
+  #   @return [ActiveRecord::Relation<Mdm::HostDetail>]
   has_many :host_details,
            class_name: 'Mdm::HostDetail',
            dependent: :destroy,
@@ -138,7 +138,7 @@ class Mdm::Host < ActiveRecord::Base
   # @!attribute [rw] notes
   #   Notes about the host entered by a user with {Mdm::Note#created_at oldest notes} first.
   #
-  #   @return [Array<Mdm::Note>]
+  #   @return [ActiveRecord::Relation<Mdm::Note>]
   has_many :notes,
            class_name: 'Mdm::Note',
            inverse_of: :host,
@@ -149,7 +149,7 @@ class Mdm::Host < ActiveRecord::Base
   #   The services running on {Mdm::Service#port ports} on the host with services ordered by {Mdm::Service#port port}
   #   and {Mdm::Service#proto protocol}.
   #
-  #   @return [Array<Mdm::Service>]
+  #   @return [ActiveRecord::Relation<Mdm::Service>]
   has_many :services,
            class_name: 'Mdm::Service',
            dependent: :destroy,
@@ -160,7 +160,7 @@ class Mdm::Host < ActiveRecord::Base
   #   Sessions that are open or previously were open on the host ordered by {Mdm::Session#opened_at when the session was
   #   opened}
   #
-  #   @return [Array<Mdm::Session]
+  #   @return [ActiveRecord::Relation<Mdm::Session]
   has_many :sessions,
            class_name: 'Mdm::Session',
            dependent: :destroy,
@@ -170,7 +170,7 @@ class Mdm::Host < ActiveRecord::Base
   # @!attribute [rw] vulns
   #   Vulnerabilities found on the host.
   #
-  #   @return [Array<Mdm::Vuln>]
+  #   @return [ActiveRecord::Relation<Mdm::Vuln>]
   has_many :vulns,
            class_name: 'Mdm::Vuln',
            dependent: :delete_all,
@@ -191,7 +191,7 @@ class Mdm::Host < ActiveRecord::Base
   # @!attribute [r] tags
   #   The tags on this host.  Tags are used to filter hosts.
   #
-  #   @return [Array<Mdm::Tag>]
+  #   @return [ActiveRecord::Relation<Mdm::Tag>]
   #   @see #hosts_tags
   has_many :tags, :class_name => 'Mdm::Tag', :through => :hosts_tags
 
@@ -202,14 +202,14 @@ class Mdm::Host < ActiveRecord::Base
   # @!attribute [r] creds
   #   Credentials captured from {#services}.
   #
-  #   @return [Array<Mdm::Cred>]
+  #   @return [ActiveRecord::Relation<Mdm::Cred>]
   #   @see #services
   has_many :creds, :class_name => 'Mdm::Cred', :through => :services
 
   # @!attribute [r] service_notes
   #   {Mdm::Note Notes} about {#services} running on this host.
   #
-  #   @return [Array<Mdm::Note>]
+  #   @return [ActiveRecord::Relation<Mdm::Note>]
   #   @see #services
   has_many :service_notes,
            class_name: 'Mdm::Note',
@@ -219,10 +219,20 @@ class Mdm::Host < ActiveRecord::Base
   # @!attribute [r] web_sites
   #   {Mdm::WebSite Web sites} running on top of {#services} on this host.
   #
-  #   @return [Array<Mdm::WebSite>]
+  #   @return [ActiveRecord::Relation<Mdm::WebSite>]
   #   @see services
   has_many :web_sites, :class_name => 'Mdm::WebSite', :through => :services
 
+  # @!attribute [r] module_runs
+  #   Records of Metasploit modules being run on/against this {Mdm::Host}
+  #
+  #   @return [ActiveRecord::Relation<MetasploitDataModels::ModuleRun>]
+  #   @see services
+  has_many :module_runs,
+           class_name: 'MetasploitDataModels::ModuleRun',
+           as: :trackable
+
+
   #
   # through: :task_hosts
   #
@@ -235,49 +245,49 @@ class Mdm::Host < ActiveRecord::Base
            class_name: 'Mdm::Task',
            through: :task_hosts
 
-	#
-	# Through vulns
-	#
+  #
+  # Through vulns
+  #
 
   # @!attribute [r] vuln_refs
   #   Join model between {#vulns} and {#refs}.  Use either of those asssociations instead of this join model.
   #
   #   @todo https://www.pivotaltracker.com/story/show/49004623
-  #   @return [Array<Mdm::VulnRef>]
+  #   @return [ActiveRecord::Relation<Mdm::VulnRef>]
   #   @see #refs
   #   @see #vulns
-	has_many :vuln_refs, :class_name => 'Mdm::VulnRef', :source => :vulns_refs, :through => :vulns
+  has_many :vuln_refs, :class_name => 'Mdm::VulnRef', :source => :vulns_refs, :through => :vulns
 
-	#
-	# Through vuln_refs
-	#
+  #
+  # Through vuln_refs
+  #
 
   # @!attribute [r] refs
   #   External references, such as CVE, to vulnerabilities found on this host.
   #
-  #   @return [Array<Mdm::Ref>]
+  #   @return [ActiveRecord::Relation<Mdm::Ref>]
   #   @see #vuln_refs
-	has_many :refs, :class_name => 'Mdm::Ref', :through => :vuln_refs
+  has_many :refs, :class_name => 'Mdm::Ref', :through => :vuln_refs
 
-	#
-	# Through refs
-	#
+  #
+  # Through refs
+  #
 
   # @!attribute [r] module_refs
   #   {Mdm::Module::Ref References for modules} for {Mdm::Ref references for vulnerabilities}.
   #
-  #   @return [Array<Mdm::Module::Ref>]
-	has_many :module_refs, :class_name => 'Mdm::Module::Ref', :through => :refs
+  #   @return [ActiveRecord::Relation<Mdm::Module::Ref>]
+  has_many :module_refs, :class_name => 'Mdm::Module::Ref', :through => :refs
 
-	#
-	# Through module_refs
-	#
+  #
+  # Through module_refs
+  #
 
   # @!attribute [r] module_details
   #   {Mdm::Module::Detail Details about modules} that were used to find {#vulns vulnerabilities} on this host.
   #
-  #   @return [Array<Mdm::Module::Detail]
-	has_many :module_details,
+  #   @return [ActiveRecord::Relation<Mdm::Module::Detail]
+  has_many :module_details,
            :class_name => 'Mdm::Module::Detail',
            :source =>:detail,
            :through => :module_refs,
@@ -571,4 +581,3 @@ class Mdm::Host < ActiveRecord::Base
 
   Metasploit::Concern.run(self)
 end
-

data/app/models/mdm/loot.rb

@@ -32,6 +32,15 @@ class Mdm::Loot < ActiveRecord::Base
              class_name: 'Mdm::Host',
              inverse_of: :loots
 
+  # @!attribute [rw] module_run
+  #   The run of Metasploit content that acquired the loot
+  #
+  #   @return [MetasploitDataModels::ModuleRun]
+  belongs_to :module_run,
+             class_name: 'MetasploitDataModels::ModuleRun',
+             foreign_key: :module_run_id,
+             inverse_of: :loots
+
   # @!attribute [rw] service
   #   The service running on the {#host} from which the loot was gathered.
   #

data/app/models/mdm/module/detail.rb

@@ -49,44 +49,65 @@ class Mdm::Module::Detail < ActiveRecord::Base
   # @!attribute [rw] actions
   #   Auxiliary actions to perform when this running this module.
   #
-  #   @return [Array<Mdm::Module::Action>]
+  #   @return [ActiveRecord::Relation<Mdm::Module::Action>]
   has_many :actions,   :class_name => 'Mdm::Module::Action',   :dependent => :destroy
 
   # @!attribute [rw] archs
   #   Architectures supported by this module.
   #
-  #   @return [Array<Mdm::Module::Arch>]
+  #   @return [ActiveRecord::Relation<Mdm::Module::Arch>]
   has_many :archs,     :class_name => 'Mdm::Module::Arch',     :dependent => :destroy
 
   # @!attribute [rw] authors
   #   Authors (and their emails) of this module.  Usually includes the original discoverer who wrote the
   #   proof-of-concept and then the people that ported the proof-of-concept to metasploit-framework.
   #
-  #   @return [Array<Mdm::Module::Mixin>]
+  #   @return [ActiveRecord::Relation<Mdm::Module::Mixin>]
   has_many :authors,   :class_name => 'Mdm::Module::Author',   :dependent => :destroy
 
+  # @!attribute [rw] matches
+  #   Matches for this module
+  #
+  #   @return [ActiveRecord::Relation<MetasploitDataModels::AutomaticExploitation::Match>]
+  has_many :matches,
+           :class_name => 'MetasploitDataModels::AutomaticExploitation::Match',
+           :dependent => :destroy,
+           :primary_key => :fullname,
+           :foreign_key => :module_fullname,
+           :inverse_of => :module_detail
+
   # @!attribute [rw] mixins
   #   Mixins used by this module.
   #
-  #   @return [Array<Mdm::Module::Mixin>]
+  #   @return [ActiveRecord::Relation<Mdm::Module::Mixin>]
   has_many :mixins,    :class_name => 'Mdm::Module::Mixin',    :dependent => :destroy
 
+  # @!attribute [rw] module_runs
+  #   Records of times when this module has been used
+  #
+  #   @return [ActiveRecord::Relation<MetasploitDataModels::ModuleRun>]
+  has_many :module_runs,
+           :class_name => 'MetasploitDataModels::ModuleRun',
+           :primary_key => :fullname,
+           :foreign_key => :module_fullname,
+           :inverse_of => :module_detail
+
   # @!attribute [rw] platforms
   #   Platforms supported by this module.
   #
-  #   @return [Array<Mdm::Module::Platform>]
+  #   @return [ActiveRecord::Relation<Mdm::Module::Platform>]
   has_many :platforms, :class_name => 'Mdm::Module::Platform', :dependent => :destroy
 
   # @!attribute [rw] refs
   #   External references to the vulnerabilities this module exploits.
   #
-  #   @return [Array<Mdm::Module::Ref>]
+  #   @return [ActiveRecord::Relation<Mdm::Module::Ref>]
   has_many :refs,      :class_name => 'Mdm::Module::Ref',      :dependent => :destroy
 
   # @!attribute [rw] targets
   #   Names of targets with different configurations that can be exploited by this module.
   #
-  #   @return [Array<Mdm::Module::Target>]
+  #   @return [ActiveRecord::Relation<Mdm::Module::Target>]
   has_many :targets,   :class_name => 'Mdm::Module::Target',   :dependent => :destroy
 
   #

data/app/models/mdm/module/ref.rb

@@ -16,10 +16,10 @@ class Mdm::Module::Ref < ActiveRecord::Base
   #   References with the same name attached to {Mdm::Vuln Mdm::Vulns}.
   #
   #   @return [Array<Mdm::Ref>]
-	has_many :refs,
-					 :class_name => 'Mdm::Ref',
-					 :foreign_key => :name,
-					 :primary_key => :name
+  has_many :refs,
+           :class_name => 'Mdm::Ref',
+           :foreign_key => :name,
+           :primary_key => :name
 
   #
   # Attributes

data/app/models/mdm/ref.rb

@@ -10,15 +10,15 @@ class Mdm::Ref < ActiveRecord::Base
   #   {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
+  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
+  #   @todo MSP-3066
   #   @return [Array<Mdm::VulnRef>]
   has_many :vulns_refs,
            :class_name => 'Mdm::VulnRef',

data/app/models/mdm/session.rb

@@ -34,12 +34,29 @@ class Mdm::Session < ActiveRecord::Base
   # @!attribute [rw] routes
   #   Routes tunneled throug this session.
   #
-  #   @return [Array<Mdm::Route>]
+  #   @return [ActiveRecord::Relation<Mdm::Route>]
   has_many :routes,
            class_name: 'Mdm::Route',
            dependent: :delete_all,
            inverse_of: :session
 
+  # @!attribute [rw] originating_module_run
+  #   Records the Metasploit modules run that created this session
+  #
+  #   @return [MetasploitDataModels::ModuleRun]
+  belongs_to :originating_module_run,
+           class_name: 'MetasploitDataModels::ModuleRun',
+           foreign_key: :module_run_id,
+           inverse_of: :spawned_session
+
+  # @!attribute [rw] target_module_runs
+  #   Records the Metasploit modules run on this session
+  #
+  #   @return [ActiveRecord::Relation<MetasploitDataModels::ModuleRun>]
+  has_many :target_module_runs,
+           class_name: 'MetasploitDataModels::ModuleRun',
+           inverse_of: :target_session
+
   # @!attribute vuln_attempt
   #   Vulnerability attempt that created this session.
   #

data/app/models/mdm/user.rb

@@ -5,15 +5,28 @@ class Mdm::User < ActiveRecord::Base
   # Relations
   #
 
+  has_many :automatic_exploitation_runs,
+           class_name: 'MetasploitDataModels::AutomaticExploitation::Run',
+           inverse_of: :user
+
+  has_many :automatic_exploitation_match_sets,
+           class_name: 'MetasploitDataModels::AutomaticExploitation::MatchSet',
+           inverse_of: :user
+
   has_many :owned_workspaces,
            class_name: 'Mdm::Workspace',
            foreign_key: 'owner_id',
            inverse_of: :owner
 
+  has_many :module_runs,
+           class_name: 'MetasploitDataModels::ModuleRun',
+           inverse_of: :user
+
   has_many :tags,
            class_name: 'Mdm::Tag',
            inverse_of: :user
 
+
   has_and_belongs_to_many :workspaces, :join_table => 'workspace_members', :uniq => true, :class_name => 'Mdm::Workspace'
 
   #

data/app/models/mdm/vuln.rb

@@ -32,7 +32,7 @@ class Mdm::Vuln < ActiveRecord::Base
   # @!attribute [rw] vuln_attempts
   #   Attempts to exploit this vulnerability.
   #
-  #   @return [Array<Mdm::VulnAttempt>]
+  #   @return [ActiveRecord::Relation<Mdm::VulnAttempt>]
   has_many :vuln_attempts,
            class_name: 'Mdm::VulnAttempt',
            dependent: :destroy,
@@ -41,7 +41,7 @@ class Mdm::Vuln < ActiveRecord::Base
   # @!attribute [rw] vuln_details
   #   Additional information about this vulnerability.
   #
-  #   @return [Array<Mdm::VulnDetail>]
+  #   @return [ActiveRecord::Relation<Mdm::VulnDetail>]
   has_many :vuln_details,
            class_name: 'Mdm::VulnDetail',
            dependent: :destroy,
@@ -50,7 +50,7 @@ class Mdm::Vuln < ActiveRecord::Base
   # @!attribute [rw] vulns_refs
   #   Join model that joins this vuln to its {Mdm::Ref external references}.
   #
-  #   @return [Array<Mdm::VulnRef>]
+  #   @return [ActiveRecord::Relation<Mdm::VulnRef>]
   has_many :vulns_refs,
            class_name: 'Mdm::VulnRef',
            dependent: :destroy,
@@ -59,7 +59,7 @@ class Mdm::Vuln < ActiveRecord::Base
   # @!attribute [rw] notes
   #   Notes about the vuln entered by a user with {Mdm::Note#created_at oldest notes} first.
   #
-  #   @return [Array<Mdm::Note>]
+  #   @return [<ActiveRecord::RelationMdm::Note>]
   has_many :notes,
            class_name: 'Mdm::Note',
            inverse_of: :vuln,
@@ -73,7 +73,7 @@ class Mdm::Vuln < ActiveRecord::Base
   # @!attribute [r] refs
   #   External references to this vulnerability.
   #
-  #   @return [Array<Mdm::Ref>]
+  #   @return [ActiveRecord::Relation<Mdm::Ref>]
   has_many :refs, :class_name => 'Mdm::Ref', :through => :vulns_refs
 
   #
@@ -83,9 +83,18 @@ class Mdm::Vuln < ActiveRecord::Base
   # @!attribute [r] module_refs
   #   References in module that match {Mdm::Ref#name names} in {#refs}.
   #
-  #   @return [Array<Mdm::Module::Ref>]
+  #   @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
   #
@@ -93,7 +102,7 @@ class Mdm::Vuln < ActiveRecord::Base
   # @!attribute [r] module_details
   #   {Mdm::Module::Detail Modules} that share the same external references as this vuln.
   #
-  #   @return [Array<Mdm::Module::Detail>]
+  #   @return [ActiveRecord::Relation<Mdm::Module::Detail>]
   has_many :module_details,
            :class_name => 'Mdm::Module::Detail',
            :source => :detail,