metasploit_data_models 0.7.0 → 0.11.2

data/app/models/mdm/vuln.rb

@@ -1,39 +1,125 @@
+# A vulnerability found on a {#host} or {#service}.
 class Mdm::Vuln < ActiveRecord::Base
   #
-  # Callbacks
+  # Associations
   #
 
-  after_update :save_refs
+  # @!attribute [rw] host
+  #   The host with this vulnerability.
+  #
+  #   @return [Mdm::Host]
+  belongs_to :host, :class_name => 'Mdm::Host', :counter_cache => :vuln_count
 
+  # @!attribute [rw] service
+  #   The service with the vulnerability.
   #
-  # Relations
+  #   @return [Mdm::Service]
+  belongs_to :service, :class_name => 'Mdm::Service'
+
+  # @!attribute [rw] vuln_attempts
+  #   Attempts to exploit this vulnerability.
   #
+  #   @return [Array<Mdm::VulnAttempt>]
+  has_many :vuln_attempts, :class_name => 'Mdm::VulnAttempt', :dependent => :destroy
 
-  belongs_to :host, :class_name => 'Mdm::Host', :counter_cache => :vuln_count
-  belongs_to :service, :class_name => 'Mdm::Service', :foreign_key => :service_id
-  has_many :vuln_attempts,  :dependent => :destroy, :class_name => 'Mdm::VulnAttempt'
-  has_many :vuln_details,  :dependent => :destroy, :class_name => 'Mdm::VulnDetail'
-  has_many :vulns_refs, :class_name => 'Mdm::VulnRef'
+  # @!attribute [rw] vuln_details
+  #   Additional information about this vulnerability.
+  #
+  #   @return [Array<Mdm::VulnDetail>]
+  has_many :vuln_details, :class_name => 'Mdm::VulnDetail', :dependent => :destroy
+
+  # @!attribute [rw] vulns_refs
+  #   Join model that joins this vuln to its {Mdm::Ref external references}.
+  #
+  #   @todo https://www.pivotaltracker.com/story/show/49004623
+  #   @return [Array<Mdm::VulnRef>]
+  has_many :vulns_refs, :class_name => 'Mdm::VulnRef', :dependent => :destroy
 
   #
   # Through :vuln_refs
   #
-  has_many :refs, :through => :vulns_refs, :class_name => 'Mdm::Ref'
+
+  # @!attribute [r] refs
+  #   External references to this vulnerability.
+  #
+  #   @todo https://www.pivotaltracker.com/story/show/49004623
+  #   @return [Array<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 [Array<Mdm::Module::Ref>]
+  has_many :module_refs, :class_name => 'Mdm::Module::Ref', :through => :refs
+
+  #
+  # Through module_refs
+  #
+
+  # @!attribute [r] module_details
+  #   {Mdm::Module::Detail Modules} that share the same external references as this vuln.
+  #
+  #   @return [Array<Mdm::Module::Detail>]
+  has_many :module_details,
+           :class_name => 'Mdm::Module::Detail',
+           :source => :detail,
+           :through => :module_refs,
+           :uniq => true
+
+  #
+  # 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 { |*args|
+  scope :search, lambda { |query|
+    formatted_query = "%#{query}%"
+
     where(
-        [
-            '(vulns.name ILIKE ? or vulns.info ILIKE ? or refs.name ILIKE ?)',
-            "%#{args[0]}%",
-            "%#{args[0]}%",
-            "%#{args[0]}%"
-        ]
-    ).joins(
-        'LEFT OUTER JOIN vulns_refs ON vulns_refs.vuln_id=vulns.id LEFT OUTER JOIN refs ON refs.id=vulns_refs.ref_id'
+        arel_table[:name].matches(formatted_query).or(
+            arel_table[:info].matches(formatted_query)
+        ).or(
+            Mdm::Ref.arel_table[:name].matches(formatted_query)
+        )
+    ).includes(
+        :refs
     )
   }
 
@@ -46,12 +132,6 @@ class Mdm::Vuln < ActiveRecord::Base
 
   private
 
-  def before_destroy
-    Mdm::VulnRef.delete_all('vuln_id = ?', self.id)
-    Mdm::VulnDetail.delete_all('vuln_id = ?', self.id)
-    Mdm::VulnAttempt.delete_all('vuln_id = ?', self.id)
-  end
-
   def save_refs
     refs.each { |ref| ref.save(:validate => false) }
   end

data/db/migrate/20130228214900_change_required_columns_to_null_false_in_web_vulns.rb

@@ -1,6 +1,6 @@
 # Changes all the {COLUMNS} in the web_vulns table that are required for {Mdm::WebVuln}, but were previously
 # :null => true
-class ChangeRequiredColumnsToNullFalseInWebVulns < ActiveRecord::Migration
+class ChangeRequiredColumnsToNullFalseInWebVulns < MetasploitDataModels::ChangeRequiredColumnsToNullFalse
   # Columns that were previously :null => true, but are actually required to be non-null, so should be
   # :null => false
   COLUMNS = [
@@ -16,20 +16,4 @@ class ChangeRequiredColumnsToNullFalseInWebVulns < ActiveRecord::Migration
   ]
   # Table in which {COLUMNS} are.
   TABLE_NAME = :web_vulns
-
-  # Marks all the {COLUMNS} as :null => true
-  def down
-    COLUMNS.each do |column|
-      change_column_null(TABLE_NAME, column, true)
-    end
-  end
-
-  # Marks all the {COLUMNS} as :null => false
-  def up
-    COLUMNS.each do |column|
-      change_column_null(TABLE_NAME, column, false)
-    end
-  end
-
-
 end

data/db/migrate/20130412154159_change_foreign_key_in_module_actions.rb

@@ -0,0 +1,25 @@
+# Changes `module_actions.module_detail_id` to `module_actions.detail_id` so that foreign key matches the conventional
+# name when `Mdm::ModuleDetail` became {Mdm::Module::Detail}.
+class ChangeForeignKeyInModuleActions < ActiveRecord::Migration
+  #
+  # CONSTANTS
+  #
+
+  NEW_COLUMN_NAME= :detail_id
+  OLD_COLUMN_NAME = :module_detail_id
+  TABLE_NAME = :module_actions
+
+  # Renames `module_actions.detail_id` to `module_actions.module_detail_id`.
+  #
+  # @return [void]
+  def down
+    rename_column TABLE_NAME, NEW_COLUMN_NAME, OLD_COLUMN_NAME
+  end
+
+  # Rename `module_actions.module_detail_id` to `module_actions.detail_id`
+  #
+  # @return [void]
+  def up
+    rename_column TABLE_NAME, OLD_COLUMN_NAME, NEW_COLUMN_NAME
+  end
+end

data/db/migrate/20130412171844_change_foreign_key_in_module_archs.rb

@@ -0,0 +1,25 @@
+# Changes `module_archs.module_detail_id` to `module_archs.detail_id` so that foreign key matches the conventional
+# name when `Mdm::ModuleDetail` became {Mdm::Module::Detail}.
+class ChangeForeignKeyInModuleArchs < ActiveRecord::Migration
+  #
+  # CONSTANTS
+  #
+
+  NEW_COLUMN_NAME= :detail_id
+  OLD_COLUMN_NAME = :module_detail_id
+  TABLE_NAME = :module_archs
+
+  # Renames `module_archs.detail_id` to `module_archs.module_detail_id`.
+  #
+  # @return [void]
+  def down
+    rename_column TABLE_NAME, NEW_COLUMN_NAME, OLD_COLUMN_NAME
+  end
+
+  # Rename `module_archs.module_detail_id` to `module_archs.detail_id`
+  #
+  # @return [void]
+  def up
+    rename_column TABLE_NAME, OLD_COLUMN_NAME, NEW_COLUMN_NAME
+  end
+end

data/db/migrate/20130412173121_change_foreign_key_in_module_authors.rb

@@ -0,0 +1,25 @@
+# Changes `module_authors.module_detail_id` to `module_authors.detail_id` so that foreign key matches the conventional
+# name when `Mdm::ModuleDetail` became {Mdm::Module::Detail}.
+class ChangeForeignKeyInModuleAuthors < ActiveRecord::Migration
+  #
+  # CONSTANTS
+  #
+
+  NEW_COLUMN_NAME= :detail_id
+  OLD_COLUMN_NAME = :module_detail_id
+  TABLE_NAME = :module_authors
+
+  # Renames `module_authors.detail_id` to `module_authors.module_detail_id`.
+  #
+  # @return [void]
+  def down
+    rename_column TABLE_NAME, NEW_COLUMN_NAME, OLD_COLUMN_NAME
+  end
+
+  # Rename `module_authors.module_detail_id` to `module_authors.detail_id`
+  #
+  # @return [void]
+  def up
+    rename_column TABLE_NAME, OLD_COLUMN_NAME, NEW_COLUMN_NAME
+  end
+end

data/db/migrate/20130412173640_change_foreign_key_in_module_mixins.rb

@@ -0,0 +1,25 @@
+# Changes `module_mixins.module_detail_id` to `module_mixins.detail_id` so that foreign key matches the conventional
+# name when `Mdm::ModuleDetail` became {Mdm::Module::Detail}.
+class ChangeForeignKeyInModuleMixins < ActiveRecord::Migration
+  #
+  # CONSTANTS
+  #
+
+  NEW_COLUMN_NAME= :detail_id
+  OLD_COLUMN_NAME = :module_detail_id
+  TABLE_NAME = :module_mixins
+
+  # Renames `module_mixins.detail_id` to `module_mixins.module_detail_id`.
+  #
+  # @return [void]
+  def down
+    rename_column TABLE_NAME, NEW_COLUMN_NAME, OLD_COLUMN_NAME
+  end
+
+  # Rename `module_mixins.module_detail_id` to `module_mixins.detail_id`
+  #
+  # @return [void]
+  def up
+    rename_column TABLE_NAME, OLD_COLUMN_NAME, NEW_COLUMN_NAME
+  end
+end

data/db/migrate/20130412174254_change_foreign_key_in_module_platforms.rb

@@ -0,0 +1,25 @@
+# Changes `module_platforms.module_detail_id` to `module_platforms.detail_id` so that foreign key matches the conventional
+# name when `Mdm::ModuleDetail` became {Mdm::Module::Detail}.
+class ChangeForeignKeyInModulePlatforms < ActiveRecord::Migration
+  #
+  # CONSTANTS
+  #
+
+  NEW_COLUMN_NAME= :detail_id
+  OLD_COLUMN_NAME = :module_detail_id
+  TABLE_NAME = :module_platforms
+
+  # Renames `module_platforms.detail_id` to `module_platforms.module_detail_id`.
+  #
+  # @return [void]
+  def down
+    rename_column TABLE_NAME, NEW_COLUMN_NAME, OLD_COLUMN_NAME
+  end
+
+  # Rename `module_platforms.module_detail_id` to `module_platforms.detail_id`
+  #
+  # @return [void]
+  def up
+    rename_column TABLE_NAME, OLD_COLUMN_NAME, NEW_COLUMN_NAME
+  end
+end

data/db/migrate/20130412174719_change_foreign_key_in_module_refs.rb

@@ -0,0 +1,25 @@
+# Changes `module_refs.module_detail_id` to `module_refs.detail_id` so that foreign key matches the conventional
+# name when `Mdm::ModuleDetail` became {Mdm::Module::Detail}.
+class ChangeForeignKeyInModuleRefs < ActiveRecord::Migration
+  #
+  # CONSTANTS
+  #
+
+  NEW_COLUMN_NAME= :detail_id
+  OLD_COLUMN_NAME = :module_detail_id
+  TABLE_NAME = :module_refs
+
+  # Renames `module_refs.detail_id` to `module_refs.module_detail_id`.
+  #
+  # @return [void]
+  def down
+    rename_column TABLE_NAME, NEW_COLUMN_NAME, OLD_COLUMN_NAME
+  end
+
+  # Rename `module_refs.module_detail_id` to `module_refs.detail_id`
+  #
+  # @return [void]
+  def up
+    rename_column TABLE_NAME, OLD_COLUMN_NAME, NEW_COLUMN_NAME
+  end
+end

data/db/migrate/20130412175040_change_foreign_key_in_module_targets.rb

@@ -0,0 +1,25 @@
+# Changes `module_targets.module_detail_id` to `module_targets.detail_id` so that foreign key matches the conventional
+# name when `Mdm::ModuleDetail` became {Mdm::Module::Detail}.
+class ChangeForeignKeyInModuleTargets < ActiveRecord::Migration
+  #
+  # CONSTANTS
+  #
+
+  NEW_COLUMN_NAME= :detail_id
+  OLD_COLUMN_NAME = :module_detail_id
+  TABLE_NAME = :module_targets
+
+  # Renames `module_targets.detail_id` to `module_targets.module_detail_id`.
+  #
+  # @return [void]
+  def down
+    rename_column TABLE_NAME, NEW_COLUMN_NAME, OLD_COLUMN_NAME
+  end
+
+  # Rename `module_targets.module_detail_id` to `module_targets.detail_id`
+  #
+  # @return [void]
+  def up
+    rename_column TABLE_NAME, OLD_COLUMN_NAME, NEW_COLUMN_NAME
+  end
+end

data/db/migrate/20130430151353_change_required_columns_to_null_false_in_hosts.rb

@@ -0,0 +1,11 @@
+# Changes all the {COLUMNS} in the hosts table that are required for {Mdm::Host}, but were previously `:null => true`.
+class ChangeRequiredColumnsToNullFalseInHosts < MetasploitDataModels::ChangeRequiredColumnsToNullFalse
+  # Columns that were previously `:null => true`, but are actually required to be non-null, so should be
+  # `:null => false`
+  COLUMNS = [
+      :address,
+      :workspace_id
+  ]
+  # Table in which {COLUMNS} are.
+  TABLE_NAME = :hosts
+end

data/db/migrate/20130430162145_enforce_address_uniqueness_in_workspace_in_hosts.rb

@@ -0,0 +1,23 @@
+# Changes index on address so it scoped to workspace_id and is unique to match the validation in {Mdm::Host} on
+# {Mdm::Host#address}.
+class EnforceAddressUniquenessInWorkspaceInHosts < ActiveRecord::Migration
+  TABLE_NAME = :hosts
+
+  # Restores old index on address
+  def down
+    change_table TABLE_NAME do |t|
+      t.remove_index [:workspace_id, :address]
+
+      t.index :address
+    end
+  end
+
+  # Make index on address scope to workspace_id and be unique
+  def up
+    change_table TABLE_NAME do |t|
+      t.remove_index :address
+
+      t.index [:workspace_id, :address], :unique => true
+    end
+  end
+end

data/lib/mdm/module.rb

@@ -0,0 +1,4 @@
+# Namespace for all models dealing with module caching.
+module Mdm::Module
+
+end

data/lib/metasploit_data_models.rb

@@ -15,6 +15,7 @@ require 'active_support/dependencies'
 # Project
 #
 require 'mdm'
+require 'mdm/module'
 require 'metasploit_data_models/version'
 require 'metasploit_data_models/serialized_prefs'
 require 'metasploit_data_models/base64_serializer'

data/lib/metasploit_data_models/change_required_columns_to_null_false.rb

@@ -0,0 +1,23 @@
+module MetasploitDataModels
+  # Changes all the COLUMNS in the table with TABLE_NAME that are required from the table's mode, but were previously
+  # `:null => true`, to `:null => false`.
+  #
+  #  @abstract Subclass and define COLUMNS as Array<Symbol> and TABLE_NAME as Symbol.
+  class ChangeRequiredColumnsToNullFalse < ActiveRecord::Migration
+    # Marks all the COLUMNS as `:null => true`
+    def down
+      # Use self.class:: so constants are resolved in subclasses instead of this class.
+      self.class::COLUMNS.each do |column|
+        change_column_null(self.class::TABLE_NAME, column, true)
+      end
+    end
+
+    # Marks all the COLUMNS as `:null => false`
+    def up
+      # Use self.class:: so constants are resolved in subclasses instead of this class.
+      self.class::COLUMNS.each do |column|
+        change_column_null(self.class::TABLE_NAME, column, false)
+      end
+    end
+  end
+end