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

data/app/models/mdm/task.rb

@@ -1,63 +1,42 @@
+# A task run by Metasploit Pro.
 class Mdm::Task < ActiveRecord::Base
   #
-  # Callbacks
   #
-
-  before_destroy :delete_file
-
+  # Associations
   #
-  # Relations
   #
 
-  # @!attribute listeners
-  #   Listeners spawned by this task
-  #
-  #   @return [ActiveRecord::Relation<Mdm::Listener>]
+  # Listeners spawned by this task
   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>]
+  # Joins this to {#creds}.
   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>]
+  # Joins this to {#hosts}.
   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>]
+  # Joins this to {#services}.
   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>]
+  # Joins this to {#sessions}.
   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]
+  # The Workspace the Task belongs to
   belongs_to :workspace,
              class_name: 'Mdm::Workspace',
              inverse_of: :tasks
@@ -66,53 +45,112 @@ class Mdm::Task < ActiveRecord::Base
   # through: :task_creds
   #
 
-  # @!attribute [rw] creds
-  #   Creds this task touched
-  #
-  #   @return [Array<Mdm::Cred>]
+  # Creds this task touched
   has_many :creds, :through => :task_creds, :class_name => 'Mdm::Cred'
 
   #
   # through: :task_hosts
   #
 
-  # @!attribute [rw] hosts
-  #   Hosts this task touched
-  #
-  #   @return [Array<Mdm::Host>
+  # Hosts this task touched
   has_many :hosts, :through => :task_hosts, :class_name => 'Mdm::Host'
 
   #
   # through: :task_services
   #
 
-  # @!attribute [rw] services
-  #   Services this task touched
-  #
-  #   @return [Array<Mdm::Service>
+  # Services this task touched
   has_many :services, :through => :task_services, :class_name => 'Mdm::Service'
 
   #
   # through: :task_sessions
   #
 
-  # @!attribute [rw] sessions
-  #   Session this task touched
-  #
-  #   @return [Array<Mdm::Session>
+  # Session this task touched
   has_many :sessions, :through => :task_sessions, :class_name => 'Mdm::Session'
-  
+
+
+
+
+  # @!attribute created_by
+  #   {Mdm::User#username Name of user} that created this task.
+  #
+  #   @return [String]
+
+  # @!attribute description
+  #   Description of what the this task does.
+  #
+  #   @return [String]
+
+  # @!attribute error
+  #   Error raised while task was running that caused this task to fail.
+  #
+  #   @return [String]
+
+  # @!attribute info
+  #   Information about the task's current status.  What the task is currently doing.
+  #
+  #   @return [String]
+
+  # @!attribute module
+  #   {Mdm::Module::Class#full_name Module full name} that was run for this task.
+  #
+  #   @return [String]
+
+  # @!attribute module_uuid
+  #   UUID of `#module` that was run by this task.
+  #
+  #   @return [String]
+
+  # @!attribute path
+  #   Path to the log for this task.
+  #
+  #   @return [String]
+
+  # @!attribute progress
+  #   Percentage complete.
+  #
+  #   @return [Integer]
+
+  # @!attribute updated_at
+  #   When this task was last updated.
+  #
+  #   @return [DateTime]
+
+  #
+  # Callbacks
+  #
+
+  before_destroy :delete_file
 
   #
   # Serializations
   #
 
+  # Options passed to `#module`.
+  #
+  # @return [Hash]
   serialize :options, MetasploitDataModels::Base64Serializer.new
+
+  # Result of task running.
+  #
+  # @return [Hash]
   serialize :result, MetasploitDataModels::Base64Serializer.new
+
+  # Settings used to configure this task outside of the {#options module options}.
+  #
+  # @return [Hash]
   serialize :settings, MetasploitDataModels::Base64Serializer.new
 
+  #
+  # Instance Methods
+  #
+
   private
 
+  # Deletes {#path log} on-disk, so that disk is cleaned up when this task is deleted from the database.
+  #
+  # @return [void]
   def delete_file
     c = Pro::Client.get rescue nil
     if c
@@ -122,6 +160,7 @@ class Mdm::Task < ActiveRecord::Base
     end
   end
 
+  # Restore public for load hooks
   public
 
   Metasploit::Concern.run(self)

data/app/models/mdm/task_cred.rb

@@ -1,12 +1,41 @@
+# @deprecated {Mdm::Task} has and belongs to many `Metasploit::Credential::Cores` in `Mdm::Task#credential_cores` and
+#   has and belongs to many `Metasploit::Credential::Logins` in `Mdm::Task#credential_logins` when the
+#   `Metasploit::Credential::Engine` is installed.
+#
+# Join model between {Mdm::Cred} and {Mdm::Task} that signifies that the {#task} found the {#cred}.
 class Mdm::TaskCred < ActiveRecord::Base
+  #
+  # Associations
+  #
+
+  # The {Mdm::Cred} found by {#task}.
   belongs_to :cred,
              class_name: 'Mdm::Cred',
              inverse_of: :task_creds
 
+  # An {Mdm::Task} that found {#cred}.
   belongs_to :task,
              class_name: 'Mdm::Task',
              inverse_of: :task_creds
 
+  #
+  # Attributes
+  #
+
+  # @!attribute [rw] created_at
+  #   When this task cred was created.
+  #
+  #   @return [DateTime]
+
+  # @!attribute [rw] updated_at
+  #   The last time this task cred was updated.
+  #
+  #   @return [DateTime]
+
+  #
+  # Validations
+  #
+
   validates :cred_id,
             :uniqueness => {
                 :scope => :task_id

data/app/models/mdm/task_host.rb

@@ -1,12 +1,37 @@
+# Join model between {Mdm::Host} and {Mdm::Task} that signifies that the {#task} found the {#host}.
 class Mdm::TaskHost < ActiveRecord::Base
+  #
+  # Associations
+  #
+
+  # The {Mdm::Host} found by {#task}.
   belongs_to :host,
              class_name: 'Mdm::Host',
              inverse_of: :task_hosts
 
+  # An {Mdm::Task} that found {#host}.
   belongs_to :task,
              class_name: 'Mdm::Task',
              inverse_of: :task_hosts
 
+  #
+  # Attributes
+  #
+
+  # @!attribute created_at
+  #   When this task host was created.
+  #
+  #   @return [DateTime]
+
+  # @!attribute updated_at
+  #   The last time this task host was updated.
+  #
+  #   @return [DateTime]
+
+  #
+  # Validations
+  #
+
   validates :host_id,
             :uniqueness => {
                 :scope => :task_id

data/app/models/mdm/task_service.rb

@@ -1,12 +1,37 @@
+# Join model between {Mdm::Service} and {Mdm::Task} that signifies that the {#task} found the {#service}.
 class Mdm::TaskService < ActiveRecord::Base
+  #
+  # Associations
+  #
+
+  # The {Mdm::Service} found by {#task}.
   belongs_to :service,
              class_name: 'Mdm::Service',
              inverse_of: :task_services
 
+  # An {Mdm::Task} that found {#service}.
   belongs_to :task,
              class_name: 'Mdm::Task',
              inverse_of: :task_services
 
+  #
+  # Attributes
+  #
+
+  # @!attribute created_at
+  #   When this task service was created.
+  #
+  #   @return [DateTime]
+
+  # @!attribute updated_at
+  #   The last time this task service was updated.
+  #
+  #   @return [DateTime]
+
+  #
+  # Validations
+  #
+
   validates :service_id,
             :uniqueness => {
                 :scope => :task_id

data/app/models/mdm/task_session.rb

@@ -1,12 +1,37 @@
+# Join model between {Mdm::Session} and {Mdm::Task} that signifies that the {#task} spawned the {#session}.
 class Mdm::TaskSession < ActiveRecord::Base
+  #
+  # Associations
+  #
+
+  # The {Mdm::Session} found by {#task}.
   belongs_to :session,
              class_name: 'Mdm::Session',
              inverse_of: :task_sessions
 
+  # An {Mdm::Task} that found {#session}
   belongs_to :task,
              class_name: 'Mdm::Task',
              inverse_of: :task_sessions
 
+  #
+  # Attributes
+  #
+
+  # @!attribute created_at
+  #   When this task session was created.
+  #
+  #   @return [DateTime]
+
+  # @!attribute updated_at
+  #   The last time this task session was updated.
+  #
+  #   @return [DateTime]
+
+  #
+  # Validations
+  #
+
   validates :session_id,
             :uniqueness => {
                 :scope => :task_id

data/app/models/mdm/user.rb

@@ -1,3 +1,4 @@
+# A user of metasploit-framework or metasploit-pro.
 class Mdm::User < ActiveRecord::Base
   extend MetasploitDataModels::SerializedPrefs
   
@@ -5,40 +6,225 @@ class Mdm::User < ActiveRecord::Base
   # Associations
   #
 
+  # Automatic exploitation runs started by this user.
   has_many :automatic_exploitation_runs,
            class_name: 'MetasploitDataModels::AutomaticExploitation::Run',
            inverse_of: :user
 
+  # Automatic exploitation match sets created by this user for {#automatic_exploitation_runs}.
   has_many :automatic_exploitation_match_sets,
            class_name: 'MetasploitDataModels::AutomaticExploitation::MatchSet',
            inverse_of: :user
 
+  # {Mdm::Workspace Workspaces} owned by this user.  Owned workspaces allow user complete permissions without the need
+  # or the user to be an {#admin administrator}.
   has_many :owned_workspaces,
            class_name: 'Mdm::Workspace',
            foreign_key: 'owner_id',
            inverse_of: :owner
 
+  # Runs of Metasploit Modules by this user.
   has_many :module_runs,
            class_name: 'MetasploitDataModels::ModuleRun',
            inverse_of: :user
 
+  # Tags created by the user.
   has_many :tags,
            class_name: 'Mdm::Tag',
            inverse_of: :user
 
-  has_and_belongs_to_many :workspaces, -> { uniq }, :join_table => 'workspace_members', :class_name => 'Mdm::Workspace'
+  # {Mdm::Workspace Workspace} where this user has access.  If a user is an {#admin administrator} they have access
+  # to all workspaces even if they are not a member of that workspace.
+  has_and_belongs_to_many :workspaces,
+                          -> { uniq },
+                          class_name: 'Mdm::Workspace',
+                          join_table: 'workspace_members'
+
+  #
+  # Attributes
+  #
+
+  # @!attribute admin
+  #   Whether this user is an administrator.  Administrator permissions are only enforced in metasploit-pro through the
+  #   controllers.
+  #
+  #   @return [false] if this is a normal user that must be added to each workspace.
+  #   @return [true] if this user is an administrator and have access to all workspaces without being added to the
+  #     workspace explicitly.  User is also allowed to add other users to workspaces or make other users admins.
+
+  # @!attribute company
+  #   Company at which user works.
+  #
+  #   @return [String, nil]
+
+  # @!attribute created_at
+  #   When the user was created.
+  #
+  #   @return [DateTime]
+
+  # @!attribute crypted_password
+  #   Hashed password (salted with {#password_salt}) by Authlogic in metasploit-pro.
+  #
+  #   @return [String]
+
+  # @!attribute email
+  #   The user's email address.
+  #
+  #   @return [String, nil]
+
+  # @!attribute fullname
+  #   The user's normal human name.
+  #
+  #   @return [String, nil]
+
+  # @!attribute password_salt
+  #   Salt used when hashing password into {#crypted_password} by Authlogic in metasploit-pro.
+  #
+  #   @return [String]
+
+  # @!attribute persistence_token
+  #   Token used for session and cookie when user is logged using Authlogic in metasploit-pro.
+  #
+  #   @return [String]
+
+  # @!attribute phone
+  #   Phone number for user.
+  #
+  #   @return [String, nil]
+
+  # @!attribute updated_at
+  #   When the user was last updated.
+  #
+  #   @return [DateTime]
+
+  # @!attribute username
+  #   Username for this user.  Used to log into metasploit-pro.
+  #
+  #   @return [String]
 
   #
   # Serialziations
   #
 
+  # Hash of user preferences
+  #
+  # @return [Hash]
   serialize :prefs, MetasploitDataModels::Base64Serializer.new
 
-  serialized_prefs_attr_accessor :nexpose_host, :nexpose_port, :nexpose_user, :nexpose_pass, :nexpose_creds_type, :nexpose_creds_user, :nexpose_creds_pass
-  serialized_prefs_attr_accessor :http_proxy_host, :http_proxy_port, :http_proxy_user, :http_proxy_pass
-  serialized_prefs_attr_accessor :time_zone, :session_key
-  serialized_prefs_attr_accessor :last_login_address # specifically NOT last_login_ip to prevent confusion with AuthLogic magic columns (which dont work for serialized fields)
-  
+  # @!attribute time_zone
+  #   User's preferred time zone.
+  #
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :time_zone
+
+  #
+  #  @!group Duplicate Login Monitoring
+  #
+
+  # @!attribute last_login_address
+  #   @note specifically NOT last_login_ip to prevent confusion with AuthLogic magic columns (which dont work for
+  #     serialized fields)
+  #
+  #   Last IP address from which this user logged in.  Used to report currently active user session's IP when the user
+  #   is logged off because theire `session[:session_id]` does not match {#session_key}.
+  #
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :last_login_address
+
+  # @!attribute session_key
+  #   Holds `session[:session_id]` so user can only be logged in once.  Only enforced in metasploit-pro.
+  #
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :session_key
+
+  #
+  # @!endgroup
+  #
+
+  #
+  # @!group HTTP Proxy
+  #
+
+  # @!attribute http_proxy_host
+  #   Proxy host.
+  #
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :http_proxy_host
+
+  # @!attribute http_proxy_pass
+  #   Password used to login as {#http_proxy_user} to proxy.
+  #
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :http_proxy_pass
+
+  # @!attribute http_proxy_port
+  #   Port on which proxy run on {#http_proxy_host}.
+  #
+  #   @return [String, Integer, nil]
+  serialized_prefs_attr_accessor :http_proxy_port
+
+  # @!attribute http_proxy_user
+  #   User used to log into proxy.
+  #
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :http_proxy_user
+
+  #
+  # @!endgroup
+  #
+
+  #
+  # @!group Nexpose
+  #
+
+  # @!attribute nexpose_host
+  #   Host name for server running Nexpose.
+  #
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :nexpose_host
+
+  # @!attribute nexpose_pass
+  #   Password to log into Nexpose.
+  #
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :nexpose_pass
+
+  # @!attribute nexpose_port
+  #   Port on {#nexpose_host} on which Nexpose is running.
+  #
+  #   @return [String, Integer. nil]
+  serialized_prefs_attr_accessor :nexpose_port
+
+  # @!attribute nexpose_user
+  #   User used to log into Nexpose.
+  #
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :nexpose_user
+
+  #
+  # @!endgroup
+  #
+
+  #
+  # @!group Nexpose Authenticated Scan Credentials
+  #
+
+  # @!attribute nexpose_creds_pass
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :nexpose_creds_pass
+
+  # @!attribute nexpose_creds_type
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :nexpose_creds_type
+
+  # @!attribute nexpose_creds_user
+  #   @return [String, nil]
+  serialized_prefs_attr_accessor :nexpose_creds_user
+
+  #
+  # @!endgroup
+  #
+
   Metasploit::Concern.run(self)
 end