metasploit_data_models 0.17.0 → 0.17.1

data/app/models/mdm/loot.rb

@@ -16,23 +16,45 @@ class Mdm::Loot < ActiveRecord::Base
   # Associations
   #
 
+  # @!attribute exploit_attempt
+  #   Exploit attempt where this loot was gathered.
+  #
+  #   @return [Mdm::ExploitAttempt]
+  has_one :exploit_attempt,
+          class_name: 'Mdm::ExploitAttempt',
+          inverse_of: :loot
+
   # @!attribute [rw] host
   #   The host from which the loot was gathered.
   #
   #   @return [Mdm::Host]
-  belongs_to :host, :class_name => 'Mdm::Host'
+  belongs_to :host,
+             class_name: 'Mdm::Host',
+             inverse_of: :loots
 
   # @!attribute [rw] service
   #   The service running on the {#host} from which the loot was gathered.
   #
   #   @return [Mdm::Service]
-  belongs_to :service, :class_name => 'Mdm::Service'
+  belongs_to :service,
+             class_name: 'Mdm::Service',
+             inverse_of: :loots
+
+  # @!attribute vuln_attempt
+  #   Vuln attempt that gathered this loot.
+  #
+  #   @return [Mdm::VulnAttempt]
+  has_one :vuln_attempt,
+          class_name: 'Mdm::VulnAttempt',
+          inverse_of: :loot
 
   # @!attribute [rw] workspace
   #   The workspace in which the loot is stored and the {#host} exists.
   #
   #   @return [Mdm::Workspace]
-  belongs_to :workspace, :class_name => 'Mdm::Workspace'
+  belongs_to :workspace,
+             class_name: 'Mdm::Workspace',
+             inverse_of: :loots
 
   #
   # Attributes

data/app/models/mdm/nexpose_console.rb

@@ -1,4 +1,17 @@
 class Mdm::NexposeConsole < ActiveRecord::Base
+  #
+  # Associations
+  #
+
+  # @!attribute vuln_details
+  #   Details for vulnerabilities supplied by this Nexpose console.
+  #
+  #   @return [ActiveRecord::Relation<Mdm::VulnDetail>]
+  has_many :vuln_details,
+           class_name: 'Mdm::VulnDetail',
+           foreign_key: :nx_console_id,
+           inverse_of: :nexpose_console
+
   #
   # Serializations
   #

data/app/models/mdm/note.rb

@@ -9,20 +9,27 @@ class Mdm::Note < ActiveRecord::Base
   #
   #   @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
+  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'
+  belongs_to :service,
+             class_name: 'Mdm::Service',
+             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'
+  belongs_to :workspace,
+             class_name: 'Mdm::Workspace',
+             inverse_of: :notes
 
   #
   # Attributes

data/app/models/mdm/ref.rb

@@ -18,9 +18,11 @@ class Mdm::Ref < ActiveRecord::Base
   # @!attribute [rw] vulns_refs
   #   Join model to {Mdm::Vuln Mdm::Vulns}.  Use {#vulns} to get the actual {Mdm::Vuln Mdm::Vulns}.
   #
-	#   @todo https://www.pivotaltracker.com/story/show/48915453
+	#   @todo MSP-3066
   #   @return [Array<Mdm::VulnRef>]
-  has_many :vulns_refs, :class_name => 'Mdm::VulnRef'
+  has_many :vulns_refs,
+           :class_name => 'Mdm::VulnRef',
+           inverse_of: :ref
 
   #
   # Through :vuln_refs

data/app/models/mdm/route.rb

@@ -3,7 +3,13 @@ class Mdm::Route < ActiveRecord::Base
   # Relations
   #
 
-  belongs_to :session, :class_name => 'Mdm::Session'
+  # @!attribute [rw] session
+  #   The session over which this route traverses.
+  #
+  #   @return [Mdm::Session]
+  belongs_to :session,
+             class_name: 'Mdm::Session',
+             inverse_of: :routes
 
   ActiveSupport.run_load_hooks(:mdm_route, self)
 end

data/app/models/mdm/service.rb

@@ -11,52 +11,95 @@ class Mdm::Service < ActiveRecord::Base
   # Associations
   #
 
-  # @!attribute [rw] task_services
-  #   Details about what Tasks touched this service
-  #
-  #   @return [Array<Mdm::TaskService>]
-  has_many :task_services, :dependent => :destroy, :class_name => 'Mdm::TaskService'
-
-  # @!attribute [rw] tasks
-  #   Tasks that touched this service
+  # @!attribute creds
+  #   Credentials gathered from this service.
   #
-  #   @return [Array<Mdm::Task>]
-  has_many :tasks, :through => :task_services, :class_name => 'Mdm::Task'
+  #   @return [ActiveRecord::Relation<Mdm::Cred>]
+  has_many :creds,
+           class_name: 'Mdm::Cred',
+           dependent: :destroy,
+           inverse_of: :service
 
-  # @!attribute [rw] creds
-  #   Credentials gathered from this service.
+  # @!attribute exploit_attempts
+  #   Exploit attempts against this service.
   #
-  #   @return [Array<Mdm::Cred>]
-  has_many :creds, :dependent => :destroy, :class_name => 'Mdm::Cred'
+  #   @return [ActiveRecord::Relation<Mdm::ExploitAttempt>]
+  has_many :exploit_attempts,
+           class_name: 'Mdm::ExploitAttempt',
+           dependent: :destroy,
+           inverse_of: :service
 
-  # @!attribute [rw] exploited_hosts
-  #   @todo https://www.pivotaltracker.com/story/show/48993731
+  # @!attribute exploited_hosts
+  #   @todo MSP-2732
   #   @return [Array<Mdm::ExploitHost>]
-  has_many :exploited_hosts, :dependent => :destroy, :class_name => 'Mdm::ExploitedHost'
+  has_many :exploited_hosts,
+           class_name: 'Mdm::ExploitedHost',
+           dependent: :destroy,
+           inverse_of: :service
 
-  # @!attribute [rw] host
+  # @!attribute host
   #   The host on which this service runs.
   #
   #   @return [Mdm::Host]
-  belongs_to :host, :class_name => 'Mdm::Host', :counter_cache => :service_count
+  belongs_to :host,
+             class_name: 'Mdm::Host',
+             counter_cache: :service_count,
+             inverse_of: :services
 
-  # @!attribute [rw] notes
+  # @!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 [Array<Mdm::Note>]
-  has_many :notes, :dependent => :destroy, :class_name => 'Mdm::Note'
+  #   @return [ActiveRecord::Relation<Mdm::Note>]
+  has_many :notes,
+           class_name: 'Mdm::Note',
+           dependent: :destroy,
+           inverse_of: :service
 
-  # @!attribute [rw] vulns
+  # @!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 [Array<Mdm::Vuln>]
-  has_many :vulns, :dependent => :destroy, :class_name => 'Mdm::Vuln'
+  #   @return [ActiveRecord::Relation<Mdm::Vuln>]
+  has_many :vulns,
+           class_name: 'Mdm::Vuln',
+           dependent: :destroy,
+           inverse_of: :service
 
-  # @!attribute [rw] web_sites
+  # @!attribute web_sites
   #   Web sites running on top of this service.
   #
-  #   @return [Array<Mdm::WebSite>]
-  has_many :web_sites, :dependent => :destroy, :class_name => 'Mdm::WebSite'
+  #   @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

data/app/models/mdm/session.rb

@@ -9,19 +9,44 @@ class Mdm::Session < ActiveRecord::Base
   #   Events that occurred when this session was open.
   #
   #   @return [Array<Mdm::Event>]
-  has_many :events, :class_name => 'Mdm::SessionEvent', :order => 'created_at', :dependent => :delete_all
+  has_many :events,
+           class_name: 'Mdm::SessionEvent',
+           dependent: :delete_all,
+           inverse_of: :session,
+           order: 'created_at'
+
+  # @!attribute exploit_attempt
+  #   Exploit attempt that created this session.
+  #
+  #   @return [Mdm::ExploitAttempt]
+  has_one :exploit_attempt,
+          class_name: 'Mdm::ExploitAttempt',
+          inverse_of: :session
 
   # @!attribute [rw] host
   #   {Mdm::Host Host} on which this session was opened.
   #
   #   @return [Mdm::Host]
-  belongs_to :host, :class_name => 'Mdm::Host'
+  belongs_to :host,
+             class_name: 'Mdm::Host',
+             inverse_of: :sessions
 
   # @!attribute [rw] routes
   #   Routes tunneled throug this session.
   #
   #   @return [Array<Mdm::Route>]
-  has_many :routes, :class_name => 'Mdm::Route', :dependent => :delete_all
+  has_many :routes,
+           class_name: 'Mdm::Route',
+           dependent: :delete_all,
+           inverse_of: :session
+
+  # @!attribute vuln_attempt
+  #   Vulnerability attempt that created this session.
+  #
+  #   @return [Mdm::VulnAttempt]
+  has_one :vuln_attempt,
+          class_name: 'Mdm::VulnAttempt',
+          inverse_of: :session
 
   #
   # Through :host

data/app/models/mdm/session_event.rb

@@ -3,7 +3,9 @@ class Mdm::SessionEvent < ActiveRecord::Base
   # Relations
   #
 
-  belongs_to :session, :class_name => 'Mdm::Session'
+  belongs_to :session,
+             class_name: 'Mdm::Session',
+             inverse_of: :events
 
   ActiveSupport.run_load_hooks(:mdm_session_event, self)
 end

data/app/models/mdm/tag.rb

@@ -1,20 +1,29 @@
 class Mdm::Tag < ActiveRecord::Base
   #
-  # Callbacks
+  # Relations
   #
 
-  before_destroy :cleanup_hosts
-
-  #
-  # Relations
+  # @!attribute hosts_tags
+  #  Joins {#hosts} to this tag.
   #
+  #  @return [ActiveRecord::Relation<Mdm::HostTag>]
+  has_many :hosts_tags,
+           class_name: 'Mdm::HostTag',
+           dependent: :destroy,
+           inverse_of: :tag
 
-  has_many :hosts_tags, :class_name => 'Mdm::HostTag'
-  belongs_to :user, :class_name => 'Mdm::User'
+  belongs_to :user,
+             class_name: 'Mdm::User',
+             inverse_of: :tags
 
   #
   # Through :hosts_tags
   #
+
+  # @!attribute [r] hosts
+  #   Host that are tagged with this tag.
+  #
+  #   @return [ActiveRecord::Relation<Mdm::Host>]
   has_many :hosts, :through => :hosts_tags, :class_name => 'Mdm::Host'
 
 
@@ -33,9 +42,19 @@ class Mdm::Tag < ActiveRecord::Base
             },
             :presence => true
 
-  def cleanup_hosts
-    # Clean up association table records
-    Mdm::HostTag.delete_all("tag_id = #{self.id}")
+  #
+  # Instance Methods
+  #
+
+  # Destroy this tag if it has no {#hosts_tags}
+  #
+  # @return [void]
+  def destroy_if_orphaned
+    self.class.transaction do
+      if hosts_tags.empty?
+        destroy
+      end
+    end
   end
 
   def to_s

data/app/models/mdm/task.rb

@@ -9,17 +9,62 @@ class Mdm::Task < ActiveRecord::Base
   # Relations
   #
 
+  # @!attribute listeners
+  #   Listeners spawned by this task
+  #
+  #   @return [ActiveRecord::Relation<Mdm::Listener>]
+  has_many :listeners,
+           class_name: 'Mdm::Listener',
+           dependent: :destroy,
+           inverse_of: :task
+
+  # @!attribute [rw] task_creds
+  #   Joins this to {#creds}.
+  #
+  #   @return [ActiveRecord::Relation<Mdm::TaskCred>]
+  has_many :task_creds,
+           class_name: 'Mdm::TaskCred',
+           dependent: :destroy,
+           inverse_of: :task
+
+  # @!attribute task_hosts
+  #   Joins this to {#hosts}.
+  #
+  #   @return [ActiveRecord::Relation<Mdm::TaskHost>]
+  has_many :task_hosts,
+           class_name: 'Mdm::TaskHost',
+           dependent: :destroy,
+           inverse_of: :task
+
+  # @!attribute task_services
+  #   Joins this to {#services}.
+  #
+  #   @return [ActiveRecord::Relation<Mdm::TaskService>]
+  has_many :task_services,
+           class_name: 'Mdm::TaskService',
+           dependent: :destroy,
+           inverse_of: :task
+
+  # @!attribute task_sessions
+  #   Joins this to {#sessions}.
+  #
+  #   @return [ActiveRecord::Relation<Mdm::TaskSession>]
+  has_many :task_sessions,
+           class_name: 'Mdm::TaskSession',
+           dependent: :destroy,
+           inverse_of: :task
+
   # @!attribute [rw] workspace
   #   The Workspace the Task belongs to
   #
   #   @return [Mdm::Workspace]
-  belongs_to :workspace,  :class_name => "Mdm::Workspace"
+  belongs_to :workspace,
+             class_name: 'Mdm::Workspace',
+             inverse_of: :tasks
 
-  # @!attribute [rw] task_creds
-  #   Details about creds this task touched
   #
-  #   @return [Array<Mdm::TaskCred>]
-  has_many :task_creds, :dependent => :destroy, :class_name => 'Mdm::TaskCred'
+  # through: :task_creds
+  #
 
   # @!attribute [rw] creds
   #   Creds this task touched
@@ -27,11 +72,9 @@ class Mdm::Task < ActiveRecord::Base
   #   @return [Array<Mdm::Cred>]
   has_many :creds, :through => :task_creds, :class_name => 'Mdm::Cred'
 
-  # @!attribute [rw] task_hosts
-  #   Details about hosts this task touched
   #
-  #   @return [Array<Mdm::TaskHost>]
-  has_many :task_hosts, :dependent => :destroy, :class_name => 'Mdm::TaskHost'
+  # through: :task_hosts
+  #
 
   # @!attribute [rw] hosts
   #   Hosts this task touched
@@ -39,11 +82,9 @@ class Mdm::Task < ActiveRecord::Base
   #   @return [Array<Mdm::Host>
   has_many :hosts, :through => :task_hosts, :class_name => 'Mdm::Host'
 
-  # @!attribute [rw] task_services
-  #   Details about services this task touched
   #
-  #   @return [Array<Mdm::TaskService>]
-  has_many :task_services, :dependent => :destroy, :class_name => 'Mdm::TaskService'
+  # through: :task_services
+  #
 
   # @!attribute [rw] services
   #   Services this task touched
@@ -51,11 +92,9 @@ class Mdm::Task < ActiveRecord::Base
   #   @return [Array<Mdm::Service>
   has_many :services, :through => :task_services, :class_name => 'Mdm::Service'
 
-  # @!attribute [rw] task_sessions
-  #   Details about sessions this task touched
   #
-  #   @return [Array<Mdm::TaskSession>]
-  has_many :task_sessions, :dependent => :destroy, :class_name => 'Mdm::TaskSession'
+  # through: :task_sessions
+  #
 
   # @!attribute [rw] sessions
   #   Session this task touched