metasploit-model 0.24.1-java

data/lib/metasploit/model/module/path.rb

@@ -0,0 +1,165 @@
+module Metasploit
+  module Model
+    module Module
+      # Concern for sharing common code between `Mdm::Module::Path` and `Metasploit::Framework::Module::Path`.  Define
+      # {#gem}, {#name}, and {#real_path} by following the abstract instructions for each attribute.
+      module Path
+        extend ActiveModel::Naming
+        extend ActiveSupport::Concern
+
+        include Metasploit::Model::NilifyBlanks
+        include Metasploit::Model::Translation
+
+        included do
+          include ActiveModel::Dirty
+          include ActiveModel::MassAssignmentSecurity
+          include ActiveModel::Validations
+          include ActiveModel::Validations::Callbacks
+          include Metasploit::Model::RealPathname
+
+          #
+          # Callbacks
+          #
+
+          nilify_blank :gem,
+                       :name
+          before_validation :normalize_real_path
+
+          #
+          # Mass Assignment Security
+          #
+
+          attr_accessible :gem
+          attr_accessible :name
+          attr_accessible :real_path
+
+          #
+          # Validations
+          #
+
+          validate :directory
+          validate :gem_and_name
+        end
+
+        #
+        # Attributes
+        #
+
+        # @!attribute [rw] gem
+        #   @abstract In an ActiveModel, this should be an `attr_accessor :gem`.  In an ActiveRecord, this should be a
+        #     string gem column.
+        #
+        #   The name of the gem that is adding this module path to metasploit-framework.  For paths normally added by
+        #   metasploit-framework itself, this would be `'metasploit-framework'`, while for Metasploit Pro this would be
+        #   `'metasploit-pro'`.  The name used for `gem` does not have to be a gem on rubygems, it just functions as a
+        #   namespace for {#name} so that projects using metasploit-framework do not need to worry about collisions on
+        #   {#name} which could disrupt the cache behavior.
+        #
+        #   @return [String]
+
+        # @!attribute [rw] name
+        #   @abstract In an ActiveModel, this should be an `attr_accessor :name`.  In an ActiveRecord, this should be a
+        #     string name column.
+        #
+        #   The name of the module path scoped to {#gem}.  {#gem} and {#name} uniquely identify this path so that if
+        #   {#real_path} changes, the entire cache does not need to be invalidated because the change in {#real_path}
+        #   will still be tied to the same ({#gem}, {#name}) tuple.
+        #
+        #   @return [String]
+
+        # @!attribute [rw] real_path
+        #   @abstract In an ActiveModel, this should be an `attr_accesor :real_path`.  In an ActiveRecord, this should
+        #   be a text real_path column.
+        #
+        #   @note Non-real paths will be converted to real paths in a before validation callback, so take care to either
+        #     pass real paths or pay attention when setting {#real_path} and then changing directories before
+        #     validating.
+        #
+        #   The real (absolute) path to module path.
+        #
+        #   @return [String]
+
+        #
+        # Instance Methods
+        #
+
+        # Returns whether {#real_path} is a directory.
+        #
+        # @return [true] if {#real_path} is a directory.
+        # @return [false] if {#real_path} is not a directory.
+        def directory?
+          directory = false
+
+          if real_path and File.directory?(real_path)
+            directory = true
+          end
+
+          directory
+        end
+
+        # Returns whether is a named path.
+        #
+        # @return [false] if gem is blank or name is blank.
+        # @return [true] if gem is not blank and name is not blank.
+        def named?
+          named = false
+
+          if gem.present? and name.present?
+            named = true
+          end
+
+          named
+        end
+
+        # Returns whether was a named path.  This is the equivalent of {#named?}, but checks the old, pre-change
+        # values for {#gem} and {#name}.
+        #
+        # @return [false] is gem_was is blank or name_was is blank.
+        # @return [true] if gem_was is not blank and name_was is not blank.
+        def was_named?
+          was_named = false
+
+          if gem_was.present? and name_was.present?
+            was_named = true
+          end
+
+          was_named
+        end
+
+        private
+
+        # Validates that either {#directory?} is `true`.
+        #
+        # @return [void]
+        def directory
+          unless directory?
+            errors[:real_path] << 'must be a directory'
+          end
+        end
+
+        # Validates that either both {#gem} and {#name} are present or both are `nil`.
+        #
+        # @return [void]
+        def gem_and_name
+          if name.present? and gem.blank?
+            errors[:gem] << "can't be blank if name is present"
+          end
+
+          if gem.present? and name.blank?
+            errors[:name] << "can't be blank if gem is present"
+          end
+        end
+
+        # If {#real_path} is set and exists on disk, then converts it to a real path to eliminate any symlinks.
+        #
+        # @return [void]
+        # @see Metasploit::Model::File.realpath
+        def normalize_real_path
+          if real_path and File.exist?(real_path)
+            self.real_path = Metasploit::Model::File.realpath(real_path)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metasploit/model/module/platform.rb

@@ -0,0 +1,38 @@
+module Metasploit
+  module Model
+    module Module
+      # Joins {Metasploit::Model::Module::Instance} and {Metasploit::Model::Platform.}
+      module Platform
+        extend ActiveModel::Naming
+        extend ActiveSupport::Concern
+
+        include Metasploit::Model::Translation
+
+        included do
+          include ActiveModel::Validations
+
+          #
+          # Validations
+          #
+
+          validates :module_instance, :presence => true
+          validates :platform, :presence => true
+        end
+
+        #
+        # Associations
+        #
+
+        # @!attribute [rw] module_instance
+        #   Module that supports {#platform}.
+        #
+        #   @return [Metasploit::Model::Module::Instance]
+
+        # @!attribute [rw] platform
+        #  Platform supported by {#module_instance}.
+        #
+        #  @return [Metasploit::Model::Platform]
+      end
+    end
+  end
+end

data/lib/metasploit/model/module/rank.rb

@@ -0,0 +1,91 @@
+module Metasploit
+  module Model
+    module Module
+      # Code shared between `Mdm::Module::Rank` and `Metasploit::Framework::Module::Rank`.
+      module Rank
+        extend ActiveModel::Naming
+        extend ActiveSupport::Concern
+
+        include Metasploit::Model::Translation
+
+        #
+        # CONSTANTS
+        #
+
+        # Regular expression to ensure that {#name} is a word starting with a capital letter
+        NAME_REGEXP = /\A[A-Z][a-z]+\Z/
+
+        # Converts {#name} to {#number}.  Used for seeding.  Seeds exist so that reports can use module_ranks to get the
+        # name of a rank without having to duplicate this constant.
+        NUMBER_BY_NAME = {
+            'Manual' => 0,
+            'Low' => 100,
+            'Average' => 200,
+            'Normal' => 300,
+            'Good' => 400,
+            'Great' => 500,
+            'Excellent' => 600
+        }
+        # Converts {#number} to {#name}.  Used to convert *Ranking constants used in `Msf::Modules` back to Strings.
+        NAME_BY_NUMBER = NUMBER_BY_NAME.invert
+
+        included do
+          include ActiveModel::MassAssignmentSecurity
+          include ActiveModel::Validations
+          include Metasploit::Model::Search
+
+          #
+          # Mass Assignment Security
+          #
+
+          attr_accessible :name
+          attr_accessible :number
+
+          #
+          # Search Attributes
+          #
+
+          search_attribute :name, :type => :string
+          search_attribute :number, :type => :integer
+
+          #
+          # Validations
+          #
+
+          validates :name,
+                    # To ensure NUMBER_BY_NAME and seeds stay in sync.
+                    :inclusion => {
+                        :in => NUMBER_BY_NAME.keys
+                    },
+                    # To ensure new seeds follow pattern.
+                    :format => {
+                        :with => NAME_REGEXP
+                    }
+          validates :number,
+                    # to ensure NUMBER_BY_NAME and seeds stay in sync.
+                    :inclusion => {
+                        :in => NUMBER_BY_NAME.values
+                    },
+                    # To ensure new seeds follow pattern.
+                    :numericality => {
+                        :only_integer => true
+                    }
+        end
+
+        #
+        # Attributes
+        #
+
+        # @!attribute [rw] name
+        #   The name of the rank.
+        #
+        #   @return [String]
+
+        # @!attribute [rw] number
+        #   The numerical value of the rank.  Higher numbers are better.
+        #
+        #   @return [Integer]
+      end
+    end
+  end
+end

data/lib/metasploit/model/module/reference.rb

@@ -0,0 +1,38 @@
+module Metasploit
+  module Model
+    module Module
+      # Joins {Metasploit::Model::Module::Instance} and {Metasploit::Model::Reference}.
+      module Reference
+        extend ActiveModel::Naming
+        extend ActiveSupport::Concern
+
+        include Metasploit::Model::Translation
+
+        included do
+          include ActiveModel::Validations
+
+          #
+          # Validations
+          #
+
+          validates :module_instance, :presence => true
+          validates :reference, :presence => true
+        end
+
+        #
+        # Associations
+        #
+
+        # @!attribute [rw] module_instance
+        #   {Metasploit::Model::Module::Instance Module} with {#reference}.
+        #
+        #   @return [Metasploit::Model::Module::Instance]
+
+        # @!attribute [rw] reference
+        #   {Metasploit::Model::Reference reference} to exploit or proof-of-concept (PoC) code for {#module_instance}.
+        #
+        #   @return [Metasploit::Model::Reference]
+      end
+    end
+  end
+end

data/lib/metasploit/model/module/stance.rb

@@ -0,0 +1,22 @@
+module Metasploit
+  module Model
+    module Module
+      # The types of stances a module can take, such as {PASSIVE} or {AGGRESSIVE}.  Stances indicate whether or not the
+      # module triggers the vulnerability without waiting for one or more conditions to be met ({AGGRESSIVE}) or whether
+      # it must wait for certain conditions to be satisfied before the exploit can be initiated ({PASSIVE}).
+      module Stance
+        # The module does actively tries to trigger a vulnerability.
+        AGGRESSIVE = 'aggressive'
+        # The module doesn't actively attack and waits for interaction from the client or other entity before attempting
+        # to trigger a vulnerability
+        PASSIVE = 'passive'
+
+        # All stances.
+        ALL = [
+            AGGRESSIVE,
+            PASSIVE
+        ]
+      end
+    end
+  end
+end

data/lib/metasploit/model/module/target.rb

@@ -0,0 +1,80 @@
+module Metasploit
+  module Model
+    module Module
+      # Code shared between `Mdm::Module::Target` and `Metasploit::Framework::Module::Target`.
+      module Target
+        extend ActiveModel::Naming
+        extend ActiveSupport::Concern
+
+        include Metasploit::Model::Translation
+
+        included do
+          include ActiveModel::MassAssignmentSecurity
+          include ActiveModel::Validations
+          include Metasploit::Model::Search
+
+          #
+          # Mass Assignment Security
+          #
+
+          attr_accessible :name
+
+          #
+          # Search Attributes
+          #
+
+          search_attribute :name, :type => :string
+
+          #
+          # Validators
+          #
+
+          validates :module_instance, :presence => true
+          validates :name, :presence => true
+          validates :target_architectures, presence: true
+          validates :target_platforms, presence: true
+        end
+
+        #
+        # Associations
+        #
+
+        # @!attribute [r] architectures
+        #   Architectures that this target supports, either by being declared specifically for this target or because
+        #   this target did not override architectures and so inheritted the architecture set from the class.
+        #
+        #   @return [Array<Metasploit::Model::Architecture>]
+
+        # @!attribute [rw] module_instance
+        #   Module where this target was declared.
+        #
+        #   @return [Metasploit::Model::Module::Instance]
+
+        # @!attribute [r] platforms
+        #   Platforms that this target supports, either by being declared specifically for this target or because this
+        #   target did not override platforms and so inheritted the platform set from the class.
+        #
+        #   @return [Array<Metasploit::Model::Platform>]
+
+        # @!attribute [rw] target_architectures
+        #   Joins this target to its {#architectures}
+        #
+        #   @return [Array<Metasploit::Model::Module::Target::Architecture]
+
+        # @!attribute [rw] target_platforms
+        #   Joins this target to its {#platforms}
+        #
+        #   @return [Array<Metasploit::Model::Module::Target::Platform>]
+
+        #
+        # Attributes
+        #
+
+        # @!attribute [rw] name
+        #   The name of this target.
+        #
+        #   @return [String]
+      end
+    end
+  end
+end

data/lib/metasploit/model/module/target/architecture.rb

@@ -0,0 +1,42 @@
+module Metasploit
+  module Model
+    module Module
+      module Target
+        # Model that joins {Metasploit::Model::Architecture} and {Metasploit::Model::Module::Target}.
+        module Architecture
+          extend ActiveModel::Naming
+          extend ActiveSupport::Concern
+
+          include Metasploit::Model::Translation
+
+          included do
+            include ActiveModel::Validations
+
+            #
+            # Validations
+            #
+
+            validates :architecture,
+                      presence: true
+            validates :module_target,
+                      presence: true
+          end
+
+          #
+          # Associations
+          #
+
+          # @!attribute [rw] architecture
+          #   The architecture supported by the {#module_target}.
+          #
+          #   @return [Metasploit::Model::Architecture]
+
+          # @!attribute [rw] module_target
+          #   The module target that supports {#architecture}.
+          #
+          #   @return [Metasploit::Model::Module::Target]
+        end
+      end
+    end
+  end
+end