wg-metasploit_data_models 4.1.4.01 → 4.1.4.02

data/app/models/mdm/listener.rb

@@ -0,0 +1,82 @@
+# A listener spawned by a {#task} that is waiting for connection on {#address}:{#port}.
+class Mdm::Listener < ApplicationRecord
+  
+  #
+  # Associations
+  #
+
+  # Task that spawned this listener.
+  belongs_to :task,
+             class_name: 'Mdm::Task',
+             inverse_of: :listeners
+
+  # Workspace which controls this listener.
+  belongs_to :workspace,
+             class_name: 'Mdm::Workspace',
+             inverse_of: :listeners
+
+  #
+  # Attributes
+  #
+
+  # @!attribute address
+  #   The IP address to which the listener is bound.
+  #
+  #   @return [String]
+
+  # @!attribute created_at
+  #   When this listener was created.  Not necessarily when it started listening.
+  #
+  #   @return [DateTime]
+
+  # @!attribute enabled
+  #   Whether listener is listening on {#address}:{#port}.
+  #
+  #   @return [true] listener is listening.
+  #   @return [false] listener is not listening.
+
+  # @!attribute macro
+  #   {Mdm::Macro#name Name of macro} run when a connect is made to the listener.
+  #
+  #   @return [String]
+
+  # @!attribute owner
+  #   The name of the user that setup this listener.
+  #
+  #   @return [String]
+  #   @see Mdm::User#username
+
+  # @!attribute payload
+  #   Reference name of the payload module that is sent when a connection is made to the listener.
+  #
+  #   @return [String]
+
+  # @!attribute port
+  #   Port on {#address} that listener is listening.
+  #
+  #   @return [Integer]
+
+  # @!attribute updated_at
+  #   The last time this listener was updated.
+  #
+  #   @return [DateTime]
+
+  #
+  # Serializations
+  #
+
+  # Options used to spawn this listener.
+  #
+  # @return [Hash]
+  serialize :options, MetasploitDataModels::Base64Serializer.new
+
+  #
+  # Validations
+  #
+
+  validates :address, :ip_format => true, :presence => true
+  validates :port, :presence => true, :numericality => { :only_integer => true }, :inclusion => {:in => 1..65535}
+
+  Metasploit::Concern.run(self)
+end
+

data/app/models/mdm/loot.rb

@@ -0,0 +1,161 @@
+# Loot gathered from {#host} or {#service} such as files to prove you were on the system or to crack later to gain
+# sessions on other machines in the network.
+class Mdm::Loot < ApplicationRecord
+  
+  #
+  # CONSTANTS
+  #
+
+  RELATIVE_SEARCH_FIELDS = [
+      'ltype',
+      'name',
+      'info',
+      'data'
+  ]
+
+  #
+  # 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',
+             inverse_of: :loots
+
+  # @!attribute [rw] module_run
+  #   The run of Metasploit content that acquired the loot
+  #
+  #   @return [MetasploitDataModels::ModuleRun]
+  belongs_to :module_run,
+             class_name: 'MetasploitDataModels::ModuleRun',
+             foreign_key: :module_run_id,
+             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',
+             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',
+             inverse_of: :loots
+
+  #
+  # Attributes
+  #
+
+  # @!attribute [rw] content_type
+  #   The mime/content type of the file at {#path}.  Used to server the file correctly so browsers understand whether
+  #   to render or download the file.
+  #
+  #   @return [String]
+
+  # @!attribute [rw] created_at
+  #   When the loot was created.
+  #
+  #   @return [DateTime]
+
+  # @!attribute [rw] data
+  #   Loot data not stored in file at {#path}.
+  #
+  #   @return [String]
+
+  # @!attribute [rw] ltype
+  #   The type of loot
+  #
+  #   @return [String]
+
+  # @!attribute [rw] info
+  #   Information about the loot.
+  #
+  #   @return [String]
+
+  # @!attribute [rw] name
+  #   The name of the loot.
+  #
+  #   @return [String]
+
+  # @!attribute [rw] path
+  #   The on-disk path to the loot file.
+  #
+  #   @return [String]
+
+  # @!attribute [rw] updated_at
+  #   The last time the loot was updated.
+  #
+  #   @return [DateTime]
+
+  #
+  # Callbacks
+  #
+
+  before_destroy :delete_file
+
+  #
+  # Scopes
+  #
+
+  scope :search, lambda { |*args|
+    joins(:host).
+      where(
+        'loots.ltype ILIKE ? ' +
+          'OR loots.name ILIKE ? ' +
+          'OR loots.info ILIKE ? ' +
+          'OR loots.data ILIKE ? ' +
+          'OR COALESCE(hosts.name, CAST(hosts.address AS TEXT)) ILIKE ?',
+        "%#{args[0]}%", "%#{args[0]}%", "%#{args[0]}%", "%#{args[0]}%", "%#{args[0]}%"
+      )
+  }
+
+  #
+  # Serializations
+  #
+
+  serialize :data, MetasploitDataModels::Base64Serializer.new
+
+  private
+
+  # Deletes {#path} from disk.
+  #
+  # @todo https://www.pivotaltracker.com/story/show/49023795
+  # @return [void]
+  def delete_file
+    c = Pro::Client.get rescue nil
+    if c
+      c.loot_delete_file(self[:id])
+    else
+      ::File.unlink(self.path) rescue nil
+    end
+  end
+
+  public
+
+  Metasploit::Concern.run(self)
+end
+

data/app/models/mdm/macro.rb

@@ -0,0 +1,62 @@
+# Macro of {#actions} to run at once.
+class Mdm::Macro < ApplicationRecord
+  extend MetasploitDataModels::SerializedPrefs
+
+  #
+  # Attributes
+  #
+
+  # @!attribute created_at
+  #   When this macro was created.
+  #
+  #   @return [DateTime]
+
+  # @!attribute description
+  #   Long description of what the macro does.
+  #
+  #   @return [String]
+
+  # @!attribute  name
+  #   The name of this macro.
+  #
+  #   @return [String]
+
+  # @!attribute owner
+  #   {Mdm::User#username Name of user} that owns this macro.
+  #
+  #   @return [String]
+
+  # @!attribute updated_at
+  #   When this macro was last updated.
+  #
+  #   @return [DateTime]
+
+  #
+  # Serialization
+  #
+
+  # Actions run by this macro.
+  #
+  # @return [Array<Hash{Symbol=>Object}>] Array of action hashes.  Each action hash is have key :module with value
+  #   of an {Mdm::Module::Detail#fullname} and and key :options with value of options used to the run the module.
+  serialize :actions, MetasploitDataModels::Base64Serializer.new
+
+  # Preference for this macro, shared across all actions.
+  #
+  # @return [Hash]
+  serialize :prefs, MetasploitDataModels::Base64Serializer.new
+
+  # The maximum number of seconds that this macro is allowed to run.
+  #
+  # @return [Integer]
+  serialized_prefs_attr_accessor :max_time
+
+  #
+  # Validations
+  #
+
+  validates :name, :presence => true, :format => /\A[^'|"]+\z/
+
+  Metasploit::Concern.run(self)
+end
+

data/app/models/mdm/mod_ref.rb

@@ -0,0 +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 < ApplicationRecord
+  #
+  # 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

@@ -0,0 +1,33 @@
+# 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 < ApplicationRecord
+  self.table_name = 'module_actions'  
+
+  #
+  # 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
+  #
+
+  validates :detail, :presence => true
+  validates :name, :presence => true
+
+  Metasploit::Concern.run(self)
+end

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

@@ -0,0 +1,28 @@
+# A supported architecture for a given {Mdm::Module::Detail Metasploit Module}
+class Mdm::Module::Arch < ApplicationRecord
+  self.table_name = 'module_archs'
+
+  #
+  # Associations
+  #
+
+  belongs_to :detail, :class_name => 'Mdm::Module::Detail'
+
+  #
+  # Attributes
+  #
+
+  # @!attribute name
+  #   The architecture abbreviation, such as `'x86'`
+  #
+  #   @return [String]
+
+  #
+  # Validations
+  #
+
+  validates :detail, :presence => true
+  validates :name, :presence => true
+
+  Metasploit::Concern.run(self)
+end

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

@@ -0,0 +1,34 @@
+# The {#email} and {#name} of an author of a {#detail Metasploit Module}.
+class Mdm::Module::Author < ApplicationRecord
+  self.table_name = 'module_authors'
+
+  #
+  # 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
+  #
+
+  validates :detail, :presence => true
+  validates :name, :presence => true
+
+  Metasploit::Concern.run(self)
+end