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

data/app/models/mdm/mod_ref.rb

@@ -1,4 +1,24 @@
+# Joins a {Mdm::Module::Detail} and {Mdm::Ref} indirectly through the {Mdm::Module::Detail#refname} matching {#module},
+# {Mdm::Module::Detail#mtype} matching {#mtype}, and {Mdm::Ref#name} matching {#ref}.
 class Mdm::ModRef < ActiveRecord::Base
-  
+  #
+  # Attributes
+  #
+
+  # @!attribute module
+  #   An {Mdm::Module::Detail#refname}.
+  #
+  #   @return [String]
+
+  # @!attribute mtype
+  #   An {Mdm::Module::Detail#mtype}.
+  #
+  #   @return [String]
+
+  # @!attribute ref
+  #   An {Mdm::Ref#name}.
+  #
+  #   @return [String]
+
   Metasploit::Concern.run(self)
 end

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

@@ -1,3 +1,8 @@
+# Actions that auxiliary or post Metasploit Modules can perform.  Actions are used to select subcommand-like behavior
+# implemented by the same Metasploit Nodule.  The semantics of a given action are specific to a given
+# {Mdm::Module::Detail Metasploit Module}: if two {Mdm::Module::Detail Metasploit Modules} have
+# {Mdm::Module::Action actions} with the same {Mdm::Module::Action#name name}, no similarity should be assumed between
+# those two {Mdm::Module::Action actions} or {Mdm::Module::Detail Metasploit Modules}.
 class Mdm::Module::Action < ActiveRecord::Base
   self.table_name = 'module_actions'  
 
@@ -5,8 +10,18 @@ class Mdm::Module::Action < ActiveRecord::Base
   # Associations
   #
 
+  # The Metasploit Module with this action.
   belongs_to :detail, :class_name => 'Mdm::Module::Detail'
 
+  #
+  # Attributes
+  #
+
+  # @!attribute [rw] name
+  #   The name of this action.
+  #
+  #   @return [String]
+
   #
   # Validations
   #

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

@@ -1,3 +1,4 @@
+# A supported architecture for a given {Mdm::Module::Detail Metasploit Module}
 class Mdm::Module::Arch < ActiveRecord::Base
   self.table_name = 'module_archs'
 
@@ -7,6 +8,15 @@ class Mdm::Module::Arch < ActiveRecord::Base
 
   belongs_to :detail, :class_name => 'Mdm::Module::Detail'
 
+  #
+  # Attributes
+  #
+
+  # @!attribute name
+  #   The architecture abbreviation, such as `'x86'`
+  #
+  #   @return [String]
+
   #
   # Validations
   #

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

@@ -1,3 +1,4 @@
+# The {#email} and {#name} of an author of a {#detail Metasploit Module}.
 class Mdm::Module::Author < ActiveRecord::Base
   self.table_name = 'module_authors'
 
@@ -5,8 +6,23 @@ class Mdm::Module::Author < ActiveRecord::Base
   # Associations
   #
 
+  # The authored Metasploit Module.
   belongs_to :detail, :class_name => 'Mdm::Module::Detail'
-  
+
+  #
+  # Attributes
+  #
+
+  # @!attribute email
+  #   The email address of the author.
+  #
+  #   @return [String]
+
+  # @!attribute name
+  #   The name of the author.
+  #
+  #   @return [String]
+
   #
   # Validations
   #

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

@@ -1,3 +1,6 @@
+# @deprecated Never populated by metasploit-framework.
+#
+# Module mixed into a {#detail Metasploit Module}.
 class Mdm::Module::Mixin < ActiveRecord::Base
   self.table_name = 'module_mixins'
 
@@ -5,8 +8,18 @@ class Mdm::Module::Mixin < ActiveRecord::Base
   # Associations
   #
 
+  # Metasploit Module the {#name named} `Module` was mixed in.
   belongs_to :detail, :class_name => 'Mdm::Module::Detail'
 
+  #
+  # Attributes
+  #
+
+  # @!attribute name
+  #   The `Module#name` of the mixed in `Module`.
+  #
+  #   @return [String]
+
   #
   # Validation
   #

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

@@ -1,3 +1,4 @@
+# {#name Platform} on which the {#detail Metasploit Module} can run.
 class Mdm::Module::Platform < ActiveRecord::Base
   self.table_name = 'module_platforms'
 
@@ -5,8 +6,18 @@ class Mdm::Module::Platform < ActiveRecord::Base
   # Associations
   #
 
+  # The Metasploit Module that can run on the {#name named} platform.
   belongs_to :detail, :class_name => 'Mdm::Module::Detail'
 
+  #
+  # Attributes
+  #
+
+  # @!attribute name
+  #   The name of the platform.
+  #
+  #   @return [String]
+
   #
   # Validations
   #

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

@@ -1,3 +1,5 @@
+# A potential target for a {Mdm::Module::Detail exploit Metasploit Module}.  Targets can change options including
+# offsets for ROP chains to tune an exploit to work with different system libraries and versions.
 class Mdm::Module::Target < ActiveRecord::Base
   self.table_name = 'module_targets'
 
@@ -5,8 +7,24 @@ class Mdm::Module::Target < ActiveRecord::Base
   # Associations
   #
 
+  # Exploit Metasploit Module with the {#name named} target at the given {#index}.
   belongs_to :detail, :class_name => 'Mdm::Module::Detail'
 
+  #
+  # Attributes
+  #
+
+  # @!attribute index
+  #   The index of this target in the {#detail exploit Metasploit Module}'s list of targets. The index is used for
+  #   target selection.
+  #
+  #   @return [Integer]
+
+  # @!attribute name
+  #   The name of this target.
+  #
+  #   @return [String]
+
   #
   # Validators
   #

data/app/models/mdm/nexpose_console.rb

@@ -1,24 +1,95 @@
+# A connection to Nexpose from Metasploit.
 class Mdm::NexposeConsole < ActiveRecord::Base
   
   #
   # Associations
   #
 
-  # @!attribute vuln_details
-  #   Details for vulnerabilities supplied by this Nexpose console.
-  #
-  #   @return [ActiveRecord::Relation<Mdm::VulnDetail>]
+  # Details for vulnerabilities supplied by this Nexpose console.
   has_many :vuln_details,
            class_name: 'Mdm::VulnDetail',
            foreign_key: :nx_console_id,
            inverse_of: :nexpose_console
 
+  #
+  # Attributes
+  #
+
+  # @!attribute address
+  #   Address on which Nexpose is running.
+  #
+  #   @return [String]
+
+  # @!attribute cert
+  #   @return [String]
+
+  # @!attribute created_at
+  #   When this Nexpose console was created.
+  #
+  #   @return [DateTime]
+
+  # @!attribute enabled
+  #   Whether metasploit tried to connect to this Nexpose console.
+  #
+  #   @return [false] is not allowed to connect.
+  #   @return [true] is allowed to connect.
+
+  # @!attribute name
+  #   Name of this Nexpose console to differentiate from other Nexpose consoles.
+  #
+  #   @return [String]
+
+  # @!attribute owner
+  #   {Mdm::User#username Name of user} that setup this console.
+  #
+  #   @return [String]
+  #   @todo https://www.pivotaltracker.com/story/show/52413415
+
+  # @!attribute password
+  #   Password used to authenticate to Nexpose.
+  #
+  #   @return [String]
+  #   @todo https://www.pivotaltracker.com/story/show/52414551
+
+  # @!attribute port
+  #   Port on {#address} that Nexpose is running.
+  #
+  #   @return [Integer]
+
+  # @!attribute status
+  #   Status of the connection to Nexpose.
+  #
+  #   @return [String]
+
+  # @!attribute updated_at
+  #   The last time this Nexpose console was updated.
+  #
+  #   @return [DateTime]
+
+  # @!attribute username
+  #   Username used to authenticate to Nexpose.
+  #
+  #   @return [String]
+
+  # @!attribute version
+  #   The version of Nexpose.  Used to handle protocol difference in different versions of Nexpose.
+  #
+  #   @return [String]
+
+  #
+  # Callbacks
+  #
+
   before_save :strip_protocol
 
   #
   # Serializations
   #
 
+  # @!attribute [rw] cached_sites
+  #   List of sites known to Nexpose.
+  #
+  #   @return [Array<String>] Array of site names.
   serialize :cached_sites, MetasploitDataModels::Base64Serializer.new
 
   #
@@ -31,6 +102,13 @@ class Mdm::NexposeConsole < ActiveRecord::Base
   validates :port, :numericality => { :only_integer => true }, :inclusion => {:in => 1..65535}
   validates :username, :presence => true
 
+  #
+  # Instance Methdos
+  #
+
+  # Strips '`http://`' or `'https://'` from {#address}.
+  #
+  # @return [void]
   def strip_protocol
     self.address.gsub!(/^http(s)*:\/\//i,'')
   end

data/app/models/mdm/profile.rb

@@ -1,7 +1,43 @@
+# User settings.
 class Mdm::Profile < ActiveRecord::Base
+  #
+  # Attributes
+  #
+
+  # @!attribute active
+  #   Whether this is the currently active profile.
+  #
+  #   @return [true] if this is the active profile.
+  #   @return [false] if this profile is inactive and another profile is active.
+
+  # @!attribute created_at
+  #   When this profile was created.
+  #
+  #   @return [DateTime]
+
+  # @!attribute name
+  #   Name of this profile to distinguish it from other profiles.
+  #
+  #   @return [String]
+
+  # @!attribute owner
+  #   Owner of this profile.
+  #
+  #   @return ['<system>'] System-wide profile for all users.
+  #   @return [String] Name of user that uses this profile.
+
+  # @!attribute updated_at
+  #   The last time this profile was updated.
+  #
+  #   @return [DateTime]
+
   #
   # Serializations
   #
+
+  # Global settings.
+  #
+  # @return [Hash]
   serialize :settings, MetasploitDataModels::Base64Serializer.new
 
   Metasploit::Concern.run(self)

data/app/models/mdm/route.rb

@@ -1,16 +1,28 @@
+# Network route that goes through a {#session} to allow accessing IPs on the remote end of the session.
 class Mdm::Route < ActiveRecord::Base
   
   #
   # Associations
   #
 
-  # @!attribute [rw] session
-  #   The session over which this route traverses.
-  #
-  #   @return [Mdm::Session]
+  # The session over which this route traverses.
   belongs_to :session,
              class_name: 'Mdm::Session',
              inverse_of: :routes
 
+  #
+  # Attributes
+  #
+
+  # @!attribute netmask
+  #   The netmask for this route.
+  #
+  #   @return [String]
+
+  # @!attribute subnet
+  #   The subnet for this route.
+  #
+  #   @return [String]
+
   Metasploit::Concern.run(self)
 end

data/app/models/mdm/session_event.rb

@@ -1,12 +1,44 @@
+# Events that occurred when using a {#session}.
 class Mdm::SessionEvent < ActiveRecord::Base
   
   #
   # Associations
   #
 
+  # The session in which the event occurred.
   belongs_to :session,
              class_name: 'Mdm::Session',
              inverse_of: :events
 
+  # @!attribute command
+  #   The command that was run through the session that triggered this event.
+  #
+  #   @return [String]
+
+  # @!attribute created_at
+  #   When this event occurred.
+  #
+  #   @return [DateTime]
+
+  # @!attribute etype
+  #   The type of the event.
+  #
+  #   @return [String]
+
+  # @!attribute local_path
+  #   The current local directory when {#command} was run.
+  #
+  #   @return [String]
+
+  # @!attribute output
+  #   The {#output} of running {#command}.
+  #
+  #   @return [String]
+
+  # @!attribute remote_path
+  #   The current remote directory when {#command} was run.
+  #
+  #   @return [String]
+
   Metasploit::Concern.run(self)
 end

data/app/models/mdm/tag.rb

@@ -1,3 +1,4 @@
+# Tag {#hosts_tags assigned} to {#hosts}.  Tags can be used to group together hosts for targeting and reporting.
 class Mdm::Tag < ActiveRecord::Base
   include Metasploit::Model::Search
 
@@ -5,29 +6,66 @@ class Mdm::Tag < ActiveRecord::Base
   # Associations
   #
 
-  # @!attribute hosts_tags
-  #  Joins {#hosts} to this tag.
-  #
-  #  @return [ActiveRecord::Relation<Mdm::HostTag>]
+  # Joins {#hosts} to this tag.
   has_many :hosts_tags,
            class_name: 'Mdm::HostTag',
            dependent: :destroy,
            inverse_of: :tag
 
+  # User that created this tag.
   belongs_to :user,
              class_name: 'Mdm::User',
              inverse_of: :tags
 
   #
-  # Through :hosts_tags
+  # through: :hosts_tags
   #
 
-  # @!attribute [r] hosts
-  #   Host that are tagged with this tag.
-  #
-  #   @return [ActiveRecord::Relation<Mdm::Host>]
+  # Hosts that are tagged with this tag.
   has_many :hosts, :through => :hosts_tags, :class_name => 'Mdm::Host'
 
+  #
+  # Attributes
+  #
+
+  # @!attribute created_at
+  #   When this tag was created by {#user}.
+  #
+  #   @return [DateTime]
+
+  # @!attribute critical
+  #   Whether this tag represents a critical finding about the {#hosts}.
+  #
+  #   @return [true] this tag is critical.
+  #   @return [false] this tag is non-critical.
+
+  # @!attribute desc
+  #   Longer description of what this tag should be used for or means when applied to a {#hosts host}.
+  #
+  #   @return [String]
+
+  # @!attribute name
+  #   The name of the tag.  The name is what a user actually enters to tag a {#hosts host}.
+  #
+  #   @return [String]
+
+  # @!attribute report_detail
+  #   Whether to include this tag in a report details section.
+  #
+  #   @return [true] include this tag in the report details section.
+  #   @return [false] do not include this tag in the report details section.
+
+  # @!attribute report_summary
+  #   Whether to include this tag in a report summary section.
+  #
+  #   @return [true] include this tag in the report summary section.
+  #   @return [false] do not include this tag in the report summary section.
+
+  # @!attribute updated_at
+  #   The last time this tag was updated.
+  #
+  #   @return [DateTime]
+
   #
   # Search
   #
@@ -67,6 +105,7 @@ class Mdm::Tag < ActiveRecord::Base
     end
   end
 
+  # (see #name)
   def to_s
     name
   end