contrast-agent 4.13.0 → 5.0.0

data/lib/contrast/agent/assess/rule/response/base_rule.rb

@@ -0,0 +1,117 @@
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# frozen_string_literal: true
+
+require 'rack'
+require 'contrast/agent/reporting/reporting_utilities/dtm_message'
+require 'contrast/utils/hash_digest'
+require 'contrast/utils/preflight_util'
+require 'contrast/utils/string_utils'
+
+module Contrast
+  module Agent
+    module Assess
+      module Rule
+        module Response
+          # These rules check the content of the HTTP Response to determine if something was set incorrectly or
+          # insecurely in it.
+          class BaseRule
+            # Analyze a given application response to determine if it violates the rule
+            #
+            # TODO: RUBY-999999 either extract the response's body or memoize it to some degree so that it's not
+            #   generated on every call of this method
+            # @param response [Contrast::Agent::Response] the response of the application
+            def analyze response
+              return unless analyze_response?(response)
+
+              violation = violated?(response)
+              return unless violation
+
+              finding = build_finding(violation)
+              return unless finding
+
+              if Contrast::Agent::Reporter.enabled?
+                report = Contrast::Agent::Reporting::DtmMessage.dtm_to_event(finding)
+                # TODO: RUBY-99999 preflight
+                Contrast::Agent.reporter.send_event(report)
+              else
+                Contrast::Agent::REQUEST_TRACKER.current.activity.findings << finding
+              end
+            end
+
+            protected
+
+            # Rules discern which responses they can/should analyze.
+            #
+            # @param response [Contrast::Agent::Response] the response of the application
+            def analyze_response? response
+              return false unless response
+              return false if disabled?
+              return false unless Contrast::Agent::REQUEST_TRACKER.current&.analyze_response_assess?
+              return false unless valid_response_code?(response.response_code)
+              return false unless valid_content_type?(response.content_type)
+
+              true
+            end
+
+            # Determine if the Response violates the Rule or not. If it does, return the evidence that proves it so.
+            #
+            # @param _response [Contrast::Agent::Response] the response of the application
+            # @return [Hash, nil] the evidence required to prove the violation of the rule
+            def violated? _response; end
+
+            # Convert the given evidence into a finding. The rule will populate this evidence with each of the
+            #
+            # @param evidence [Hash] the properties required to build this finding.
+            # @return [Contrast::Api::Dtm::Finding]
+            def build_finding evidence
+              finding = Contrast::Api::Dtm::Finding.new
+              finding.rule_id = rule_id
+              context = Contrast::Agent::REQUEST_TRACKER.current
+              finding.routes << context.route if context&.route
+              evidence.each_pair do |key, value|
+                finding.properties[key] = Contrast::Utils::StringUtils.force_utf8(value)
+              end
+              hash = Contrast::Utils::HashDigest.generate_config_hash(finding)
+              finding.hash_code = Contrast::Utils::StringUtils.force_utf8(hash)
+              finding.preflight = Contrast::Utils::PreflightUtil.create_preflight(finding)
+              finding
+            end
+
+            # A rule is disabled if assess is off or it is turned off by TeamServer or by configuration.
+            #
+            # @return [Boolean]
+            def disabled?
+              !::Contrast::ASSESS.enabled? || ::Contrast::ASSESS.rule_disabled?(rule_id)
+            end
+
+            # Rules discern which response codes to which they apply. If the response is of one that the rule should not
+            # examine, it can short circuit early. If the code is unknown, it must be examined.
+            #
+            # @param code [Integer,nil] the response code
+            # @return [Boolean]
+            def valid_response_code? code
+              !code || [301, 302, 307, 404, 410, 500].none?(code)
+            end
+
+            # Rules discern which Content-Type to which they apply. If the response is of one that the rule should not
+            # examine, it can short circuit early. If the type is unknown, it must be examined.
+            #
+            # @param type [String,nil] the value of the Content-Type header
+            # @return [Boolean]
+            def valid_content_type? type
+              !type || [/json/i, /xml/i].none? { |invalid_content| type =~ invalid_content }
+            end
+
+            # Determine if a response has a body or not.
+            #
+            # @param response [Contrast::Agent::Response] the response of the application
+            # @return [Boolean]
+            def body? response
+              Contrast::Utils::StringUtils.present?(response.body)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/contrast/agent/assess/tag.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast

data/lib/contrast/agent/assess/tracker.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/agent/assess/finalizers/hash'

data/lib/contrast/agent/assess.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast
@@ -10,7 +10,6 @@ module Contrast
     module Assess
       require 'contrast/agent/assess/tracker'
       require 'contrast/agent/module_data'
-      require 'contrast/agent/rewriter' if RUBY_VERSION < '2.6.0' # TODO: RUBY-714 remove guard w/ EOL of 2.5
       require 'contrast/agent/assess/policy/preshift'
 
       # Dynamic Sources

data/lib/contrast/agent/at_exit_hook.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/components/logger'

data/lib/contrast/agent/deadzone/policy/deadzone_node.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/agent/patching/policy/policy_node'
@@ -7,10 +7,9 @@ module Contrast
   module Agent
     module Deadzone
       module Policy
-        # This class functions to translate our policy.json into an actionable
-        # Ruby object, allowing for dynamic patching over hardcoded patching,
-        # specifically for those methods in which other Contrast operations
-        # should not apply
+        # This class functions to translate our policy.json into an actionable Ruby object, allowing for dynamic
+        # patching over hardcoded patching, specifically for those methods in which other Contrast operations should
+        # not apply.
         class DeadzoneNode < Contrast::Agent::Patching::Policy::PolicyNode
           def node_class
             'Deadzone'
@@ -20,12 +19,18 @@ module Contrast
             'Deadzone'
           end
 
-          # Deadzone means place the code inside of the contrast scope so that
-          # none of our code executes. As such, all DeadZone nodes have that as
-          # their method scope
+          # Deadzone means place the code inside of the contrast scope so that none of our code executes. As such, all
+          # DeadZone nodes have that as their method scope.
           def method_scope
             :contrast
           end
+
+          # TODO: RUBY-99999 remove, used to clean up logs while debugging
+          # def validate
+          #   return if class_name
+          #
+          #   raise(ArgumentError, "#{ node_class } #{ id } did not have a proper class name. Unable to create.")
+          # end
         end
       end
     end

data/lib/contrast/agent/deadzone/policy/policy.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/agent/deadzone/policy/deadzone_node'

data/lib/contrast/agent/disable_reaction.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/components/logger'

data/lib/contrast/agent/exclusion_matcher.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/components/logger'

data/lib/contrast/agent/inventory/database_config.rb

@@ -1,9 +1,10 @@
-# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
-require 'contrast/utils/timer'
-require 'contrast/utils/object_share'
+require 'contrast/api/decorators/architecture_component'
 require 'contrast/components/logger'
+require 'contrast/utils/object_share'
+require 'contrast/utils/timer'
 
 module Contrast
   module Agent
@@ -13,9 +14,6 @@ module Contrast
       module DatabaseConfig
         extend Contrast::Components::Logger::InstanceMethods
 
-        # TeamServer only accepts certain values for ArchitectureComponents.
-        # DO NOT CHANGE THIS!
-        AC_TYPE_DB = 'db'
         # TeamServer only accepts certain values for FlowMap Services.
         # DO NOT CHANGE THIS
         ADAPTER = 'adapter'
@@ -25,91 +23,131 @@ module Contrast
         DEFAULT = 'default'
         LOCALHOST = 'localhost'
 
-        def self.active_record_config
-          return @_active_record_config if instance_variable_defined?(:@_active_record_config)
+        class << self
+          # Append the available database connection information to the message being sent to TeamServer. This message
+          # may be a Contrast::Api::Dtm::Activity or Contrast::Api::Dtm::ApplicationUpdate. Both report the same
+          # Contrast::Api::Dtm::ArchitectureComponent, but have different names for their fields.
+          #
+          # @param activity_or_update [Contrast::Api::Dtm::Activity, Contrast::Api::Dtm::ApplicationUpdate]
+          # @param hash_or_str [Hash, String] the database connection information
+          def append_db_config activity_or_update, hash_or_str = active_record_config
+            arr = build_from_db_config(hash_or_str)
+            return unless arr&.any?
+
+            arr.each do |a|
+              next unless a
+
+              if activity_or_update.is_a?(Contrast::Api::Dtm::Activity)
+                activity_or_update.architectures << a
+              else
+                activity_or_update.components << a
+              end
+            end
+          rescue StandardError => e
+            logger.error('Unable to append db config', e)
+            nil
+          end
 
-          @_active_record_config = ActiveRecord::Base.connection_config rescue nil # rubocop:disable Style/RescueModifier
-        end
+          private
 
-        def self.append_db_config(activity_or_update,
-                                  hash_or_str = Contrast::Agent::Inventory::DatabaseConfig.active_record_config)
-          arr = build_from_db_config(hash_or_str)
-          return unless arr&.any?
+          # We capture the active record configuration used by this application, as reported by
+          # ActiveRecord::Base.connection_config, so that we can record it once and report it as needed.
+          #
+          # @return [Hash]
+          def active_record_config
+            return @_active_record_config if instance_variable_defined?(:@_active_record_config)
 
-          arr.each do |a|
-            next unless a
+            @_active_record_config = ActiveRecord::Base.connection_config rescue nil # rubocop:disable Style/RescueModifier
+          end
 
-            if activity_or_update.is_a?(Contrast::Api::Dtm::Activity)
-              activity_or_update.architectures << a
+          # The classes we instrument in order to determine which, if any, database(s) an application connects to take
+          # either a Hash or a String as a parameter. We install this one patch into all of those methods, letting our
+          # code here, rather than at the patch level, make the determination of which path to call. We'll make that
+          # decision and then parse the given configuration to create a Contrast::Api::Dtm::ArchitectureComponent for
+          # reporting.
+          #
+          # @param hash_or_str [Hash, String]
+          # @return [Contrast::Api::Dtm::ArchitectureComponent]
+          def build_from_db_config hash_or_str
+            return unless hash_or_str
+
+            if hash_or_str.is_a?(Hash)
+              build_from_db_hash(hash_or_str)
             else
-              activity_or_update.components << a
+              build_from_db_string(hash_or_str.to_s)
             end
           end
-        rescue StandardError => e
-          logger.error('Unable to append db config', e)
-          nil
-        end
 
-        def self.build_from_db_config hash_or_str
-          return unless hash_or_str
-
-          if hash_or_str.is_a?(Hash)
-            build_from_db_hash(hash_or_str)
-          else
-            build_from_db_string(hash_or_str.to_s)
+          # Convert the Hash used to create a database connection into an Contrast::Api::Dtm::ArchitectureComponent
+          # understandable by TeamServer.
+          #
+          # @param hash [Hash] the information used to open a database connection
+          # @return [Contrast::Api::Dtm::ArchitectureComponent]
+          def build_from_db_hash hash
+            ac = Contrast::Api::Dtm::ArchitectureComponent.build_database
+            ac.vendor = hash[:adapter] || hash[ADAPTER] || Contrast::Utils::ObjectShare::EMPTY_STRING
+            ac.remote_host = host_from_hash(hash)
+            ac.remote_port = port_from_hash(hash)
+            ac.url = hash[:database] || hash[DATABASE] || DEFAULT
+            [ac]
           end
-        end
 
-        def self.build_from_db_hash hash
-          ac = Contrast::Api::Dtm::ArchitectureComponent.new
-          ac.vendor = hash[:adapter] || hash[ADAPTER] || Contrast::Utils::ObjectShare::EMPTY_STRING
-          ac.remote_host = host_from_hash(hash)
-          ac.remote_port = port_from_hash(hash)
-          ac.type = AC_TYPE_DB
-          ac.url = hash[:database] || hash[DATABASE] || DEFAULT
-          [ac]
-        end
-
-        def self.host_from_hash hash
-          hash[:host] || hash[HOST] || Contrast::Utils::ObjectShare::EMPTY_STRING
-        end
-
-        def self.port_from_hash hash
-          p = hash[:port] || hash[PORT] || Contrast::Utils::ObjectShare::EMPTY_STRING
-          p.to_i
-        end
+          # Retrieve the host from the given connection Hash
+          #
+          # @param hash [Hash]
+          # @return [String]
+          def host_from_hash hash
+            hash[:host] || hash[HOST] || Contrast::Utils::ObjectShare::EMPTY_STRING
+          end
 
-        # Examples:
-        # mongodb://[user:pass@]host1[:port1][,host2[:port2],[,hostN[:portN]]][/[database][?options]]
-        # postgresql://scott:tiger@localhost/mydatabase
-        # mysql+mysqlconnector://scott:tiger@localhost/foo
-        def self.build_from_db_string str
-          adapter, hosts, database = split_connection_str(str)
-          acs = []
-          hosts.split(Contrast::Utils::ObjectShare::COMMA).map do |s|
-            host, port = s.split(Contrast::Utils::ObjectShare::COLON)
-
-            ac = Contrast::Api::Dtm::ArchitectureComponent.new
-            ac.vendor = Contrast::Utils::StringUtils.force_utf8(adapter)
-            ac.remote_host = Contrast::Utils::StringUtils.force_utf8(host)
-            ac.remote_port = port.to_i
-            ac.type = AC_TYPE_DB
-            ac.url = Contrast::Utils::StringUtils.force_utf8(database)
-            acs << ac
+          # Retrieve the port from the given connection Hash
+          #
+          # @param hash [Hash]
+          # @return [integer]
+          def port_from_hash hash
+            p = hash[:port] || hash[PORT] || Contrast::Utils::ObjectShare::EMPTY_STRING
+            p.to_i
           end
-          acs
-        end
 
-        def self.split_connection_str str
-          adapter, str = str.split(Contrast::Utils::ObjectShare::COLON_SLASH_SLASH)
-          _auth, str = str.split(Contrast::Utils::ObjectShare::AT)
-          # Not currently used
-          # user, pass = auth.split(Contrast::Utils::ObjectShare::COLON)
-          hosts, db_and_options = str.split(Contrast::Utils::ObjectShare::SLASH)
-          hosts << LOCALHOST if hosts.empty?
-          database, _options = db_and_options.split(Contrast::Utils::ObjectShare::QUESTION_MARK)
+          # Examples:
+          # mongodb://[user:pass@]host1[:port1][,host2[:port2],[,hostN[:portN]]][/[database][?options]]
+          # postgresql://scott:tiger@localhost/mydatabase # pragma: allowlist secret
+          # mysql+mysqlconnector://scott:tiger@localhost/foo # pragma: allowlist secret
+          #
+          # @param str [String] the DB connection string
+          # @return [Contrast::Api::Dtm::ArchitectureComponent]
+          def build_from_db_string str
+            adapter, hosts, database = split_connection_str(str)
+            acs = []
+            hosts.split(Contrast::Utils::ObjectShare::COMMA).map do |s|
+              host, port = s.split(Contrast::Utils::ObjectShare::COLON)
+
+              ac = Contrast::Api::Dtm::ArchitectureComponent.build_database
+              ac.vendor = Contrast::Utils::StringUtils.force_utf8(adapter)
+              ac.remote_host = Contrast::Utils::StringUtils.force_utf8(host)
+              ac.remote_port = port.to_i
+              ac.url = Contrast::Utils::StringUtils.force_utf8(database)
+              acs << ac
+            end
+            acs
+          end
 
-          [adapter, hosts, database]
+          # Parse the given string used to connect to a database into its composite components, allowing for the
+          # generation of a Contrast::Api::Dtm::ArchitectureComponent
+          #
+          # @param str [String] the DB connection string
+          # @return [Array<String>] the adapter, hosts, and database
+          def split_connection_str str
+            adapter, str = str.split(Contrast::Utils::ObjectShare::COLON_SLASH_SLASH)
+            _auth, str = str.split(Contrast::Utils::ObjectShare::AT)
+            # Not currently used
+            # user, pass = auth.split(Contrast::Utils::ObjectShare::COLON)
+            hosts, db_and_options = str.split(Contrast::Utils::ObjectShare::SLASH)
+            hosts << LOCALHOST if hosts.empty?
+            database, _options = db_and_options.split(Contrast::Utils::ObjectShare::QUESTION_MARK)
+
+            [adapter, hosts, database]
+          end
         end
       end
     end

data/lib/contrast/agent/inventory/dependencies.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast

data/lib/contrast/agent/inventory/dependency_analysis.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/agent/inventory/dependencies'

data/lib/contrast/agent/inventory/dependency_usage_analysis.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/agent/inventory/dependencies'
@@ -72,6 +72,7 @@ module Contrast
         # Populate the library_usages field of the Activity message using the data stored in the @gemdigest_cache.
         #
         # TODO: RUBY-1355
+        # TODO: RUBY-1438 -- change to just use EventMessage
         # @param activity [Contrast::Api::Dtm::Activity] the message to which to append the usage data
         def generate_library_usage activity
           return unless enabled?
@@ -84,7 +85,6 @@ module Contrast
             @gemdigest_cache = Hash.new { |hash, key| hash[key] = Set.new }
             hold
           end
-
           gem_spec_digest_to_files.each_pair do |digest, files|
             usage = Contrast::Api::Dtm::LibraryUsageUpdate.build(digest, files)
             activity.library_usages[usage.hash_code] = usage
@@ -97,7 +97,7 @@ module Contrast
 
         def adjust_path_for_spec_lookup path
           idx = path.index('/lib/')
-          path = path[(idx + 4)..-1] if idx
+          path = path[(idx + 4)..] if idx
           path
         end
 

data/lib/contrast/agent/inventory/policy/datastores.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/components/logger'

data/lib/contrast/agent/inventory/policy/policy.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/agent/inventory/policy/trigger_node'

data/lib/contrast/agent/inventory/policy/trigger_node.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/agent/patching/policy/trigger_node'

data/lib/contrast/agent/inventory.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast

data/lib/contrast/agent/metric_telemetry_event.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/utils/metrics_hash'
@@ -15,10 +15,10 @@ module Contrast
       def initialize
         super
         @fields = MetricsHash.new(Numeric)
-        @fields['_filter'] = 0
+        @fields['_filler'] = 0
       end
 
-      def to_json **_args
+      def to_hash **_args
         super.merge!({ fields: @fields })
       end
     end