metasploit_data_models 1.0.0.pre.rails.pre.4.0b → 1.0.0

data/app/models/mdm/vuln_attempt.rb

@@ -1,31 +1,29 @@
+# An attempt to exploit a {#vuln}.
 class Mdm::VulnAttempt < ActiveRecord::Base
   
   #
   # Associations
   #
 
-  # @!attribute loot
-  #   Loot gathered from this attempt.
+  # Loot gathered from this attempt.
   #
-  #   @return [Mdm::Loot] if {#exploited} is `true`.
-  #   @return [nil] if {#exploited} is `false`.
+  # @return [Mdm::Loot] if {#exploited} is `true`.
+  # @return [nil] if {#exploited} is `false`.
   belongs_to :loot,
              class_name: 'Mdm::Loot',
              inverse_of: :vuln_attempt
 
-  # @!attribute session
-  #   The session opened by this attempt.
+  # The session opened by this attempt.
   #
-  #   @return [Mdm::Session] if {#exploited} is `true`.
-  #   @return [nil] if {#exploited} is `false`.
+  # @return [Mdm::Session] if {#exploited} is `true`.
+  # @return [nil] if {#exploited} is `false`.
   belongs_to :session,
              class_name: 'Mdm::Session',
              inverse_of: :vuln_attempt
 
-  # @!attribute vuln
-  #   The {Mdm::Vuln vulnerability} that this attempt was exploiting.
+  # The {Mdm::Vuln vulnerability} that this attempt was exploiting.
   #
-  #   @return [Mdm::Vuln]
+  # @return [Mdm::Vuln]
   belongs_to :vuln,
              class_name: 'Mdm::Vuln',
              counter_cache: :vuln_attempt_count,
@@ -35,12 +33,39 @@ class Mdm::VulnAttempt < ActiveRecord::Base
   # Attributes
   #
 
-  # @!attribute [rw] exploited
+  # @!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
   #

data/app/models/mdm/vuln_detail.rb

@@ -1,17 +1,150 @@
+# {Mdm::Vuln Vulnerability details} supplied from an external source, such as Nexpose.
 class Mdm::VulnDetail < ActiveRecord::Base
-  
   #
   # 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
 
-  belongs_to :vuln,
-             class_name: 'Mdm::Vuln',
-             counter_cache: :vuln_detail_count,
-             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

data/app/models/mdm/vuln_ref.rb

@@ -1,3 +1,4 @@
+# Join model between {Mdm::Vuln} and {Mdm::Ref}.
 class Mdm::VulnRef < ActiveRecord::Base
   self.table_name = 'vulns_refs'
 
@@ -5,10 +6,12 @@ class Mdm::VulnRef < ActiveRecord::Base
   # 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

data/app/models/mdm/web_form.rb

@@ -1,17 +1,51 @@
+# A filled-in form on a {#web_site}.
 class Mdm::WebForm < ActiveRecord::Base
   
   #
   # Associations
   #
 
+  # {Mdm::WebSite Web site} on which this form is.
   belongs_to :web_site,
              class_name: 'Mdm::WebSite',
              inverse_of: :web_forms
 
+  #
+  # Attributes
+  #
+
+  # @!attribute created_at
+  #   When this web form was created.
+  #
+  #   @return [DateTime]
+
+  # @!attribute method
+  #   HTTP method (or verb) used to submitted this form, such as GET or POST.
+  #
+  #   @return [String]
+
+  # @!attribute path
+  #   Path portion of URL to which this form was submitted.
+  #
+  #   @return [String]
+
+  # @!attribute query
+  #   URL query that submitted for this form.
+  #
+  #   @return [String]
+
+  # @!attribute updated_at
+  #   The last time this web form was updated.
+  #
+  #   @return [DateTime]
+
   #
   # Serializations
   #
 
+  # Parameters submitted in this form.
+  #
+  # @return [Array<Array(String, String)>>]
   serialize :params, MetasploitDataModels::Base64Serializer.new
 
   Metasploit::Concern.run(self)

data/app/models/mdm/web_page.rb

@@ -1,17 +1,86 @@
+# Web page requested from a {#web_site}.
 class Mdm::WebPage < ActiveRecord::Base
   
   #
   # Associations
   #
 
+  # Mdm::WebSite Web site} from which this page was requested.
   belongs_to :web_site,
              class_name: 'Mdm::WebSite',
              inverse_of: :web_pages
 
+  #
+  # Attributes
+  #
+
+  # @!attribute auth
+  #   Credentials sent to server to authenticate to web site to allow access to this web page.
+  #
+  #   @return [String]
+
+  # @!attribute body
+  #   Body of response from server.
+  #
+  #   @return [String]
+
+  # @!attribute code
+  #   HTTP Status code return from {#web_site} when requesting this web page.
+  #
+  #   @return [Integer]
+
+  # @!attribute cookie
+  #   Cookies derived from {#headers}.
+  #
+  #   @return [String]
+
+  # @!attribute created_at
+  #   When this web page was created.
+  #
+  #   @return [DateTime]
+
+  # @!attribute ctype
+  #   The content type derived from the {#headers} of the returned web page.
+  #
+  #   @return [String]
+
+  # @!attribute location
+  #   Location derived from {#headers}.
+  #
+  #   @return [String]
+
+  # @!attribute mtime
+  #   The last modified time of the web page derived from the {#headers}.
+  #
+  #   @return [DateTime]
+
+  # @!attribute path
+  #   Path portion of URL that was used to access this web page.
+  #
+  #   @return [String]
+
+  # @!attribute query
+  #   Query portion of URLthat was used to access this web page.
+  #
+  #   @return [String]
+
+  # @!attribute request
+  #   Request sent to server to cause this web page to be returned.
+  #
+  #   @return [String]
+
+  # @!attribute updated_at
+  #   The last time this web page was updated.
+  #
+  #   @return [DateTime]
+
   #
   # Serializations
   #
 
+  # Headers sent from server.
+  #
+  # @return [Hash{String => String}]
   serialize :headers, MetasploitDataModels::Base64Serializer.new
     
   Metasploit::Concern.run(self)

data/app/models/mdm/web_site.rb

@@ -1,43 +1,90 @@
+# A Web Site running on a {#service}.
 class Mdm::WebSite < ActiveRecord::Base
   
   #
   # Associations
   #
 
+  # The service on which this web site is running.
   belongs_to :service,
              class_name: 'Mdm::Service',
              foreign_key: 'service_id',
              inverse_of: :web_sites
 
+  # Filled-in forms within this web site.
   has_many :web_forms,
            class_name: 'Mdm::WebForm',
            dependent: :destroy,
            inverse_of: :web_site
 
+  # Web pages found on this web site.
   has_many :web_pages,
            class_name: 'Mdm::WebPage',
            dependent: :destroy,
            inverse_of: :web_site
 
+  # Vulnerabilities found on this web site.
   has_many :web_vulns,
            class_name: 'Mdm::WebVuln',
            dependent: :destroy,
            inverse_of: :web_site
 
+  #
+  # Attributes
+  #
+
+  # @!attribute [rw] comments
+  #   User entered comments about this web site.
+  #
+  #   @return [String]
+
+  # @!attribute [rw] created_at
+  #   When this web site was created.
+  #
+  #   @return [DateTime]
+
+  # @!attribute [rw] updated_at
+  #   The last time this web site was updated.
+  #
+  #   @return [DateTime]
+
+  # @!attribute [rw] vhost
+  #   The virtual host for the web site in case `service.host.name` or `service.host.address` is no the host for this
+  #   web site.
+  #
+  #   @return [String]
+
   #
   # Serializations
   #
 
+  # @!attribute [rw] options
+  #   @todo Determine format and purpose of Mdm::WebSite#options.
   serialize :options, ::MetasploitDataModels::Base64Serializer.new
 
+  #
+  # Instance Methods
+  #
+
+  # Number of {#web_forms}.
+  #
+  # @return [Integer]
   def form_count
     web_forms.size
   end
 
+  # Number of {#web_pages}.
+  #
+  # @return [Integer]
   def page_count
     web_pages.size
   end
 
+  # Converts this web site to its URL, including scheme, host and port.
+  #
+  # @param ignore_vhost [Boolean] if `false` use {#vhost} for host portion of URL.  If `true` use {Mdm::Host#address} of
+  #   {Mdm::Service#host} of {#service} for host portion of URL.
+  # @return [String] <scheme>://<host>[:<port>]
   def to_url(ignore_vhost=false)
     proto = self.service.name == "https" ? "https" : "http"
     host = ignore_vhost ? self.service.host.address.to_s : self.vhost
@@ -54,6 +101,9 @@ class Mdm::WebSite < ActiveRecord::Base
     url
   end
 
+  # Number of {#web_vulns}.
+  #
+  # @return [Integer]
   def vuln_count
     web_vulns.size
   end