contrast-agent 3.8.4 → 6.9.0

data/lib/contrast/agent/assess/policy/source_validation/cross_site_validator.rb

@@ -0,0 +1,32 @@
+# 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/policy/source_method'
+
+module Contrast
+  module Agent
+    module Assess
+      module Policy
+        module SourceValidation
+          # Validator used to assert a CROSS_SITE tag is actually applicable to the given method before applying the
+          # tag to its target
+          module CrossSiteValidator
+            # Prevent the application of a tag if it is from a source known to not apply a tag in a provided context.
+            # Note that for Rack, the Header will be HTTP_REFERER. Rails does some help in
+            # ActionDispatch::Http::Headers to convert keys like `referer` to `HTTP_REFERER` before they get to the
+            # Rack::Request#get_header method
+            # https://bitbucket.org/contrastsecurity/assess-specifications/src/master/rules/dataflow/reflected_xss.md
+            def self.valid? tag, source_type, source_name
+              return true unless tag == 'CROSS_SITE'
+              return false if source_type == Contrast::Agent::Assess::Policy::SourceMethod::HEADER_KEY_TYPE
+              return true unless source_type == Contrast::Agent::Assess::Policy::SourceMethod::HEADER_TYPE
+              return false unless source_name
+
+              source_name == 'HTTP_REFERER'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/contrast/agent/assess/policy/source_validation/source_validation.rb

@@ -0,0 +1,34 @@
+# 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/policy/source_validation/cross_site_validator'
+
+module Contrast
+  module Agent
+    module Assess
+      module Policy
+        # Some of our sources require validation to prevent them from applying
+        # certain tags in a given context. This provides a single place from
+        # which those validations can be called.
+        module SourceValidation
+          VALIDATORS = [Contrast::Agent::Assess::Policy::SourceValidation::CrossSiteValidator].cs__freeze
+
+          # Determines if the conditions in which this source was called are
+          # valid and should result in the application of a tag
+          #
+          # @param tag [String] the tag which the Source is attempting to apply
+          # @param source_type [String] the type of the source
+          # @param source_name [String] the name of the source
+          # @return [Boolean] if the conditions are valid for the application
+          #   of a tag
+          def self.valid? tag, source_type, source_name
+            VALIDATORS.each do |validator|
+              return false unless validator.valid?(tag, source_type, source_name)
+            end
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/contrast/agent/assess/policy/trigger/reflected_xss.rb

@@ -0,0 +1,102 @@
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# frozen_string_literal: true
+
+module Contrast
+  module Agent
+    module Assess
+      module Policy
+        module Trigger
+          # This acts a trigger to handle the special cases of the Tilt
+          # library gem. Reflected XSS data may come into the trigger methods
+          # from these classes.
+          class ReflectedXss
+            class << self
+              NODE_HASH = {
+                  'class_name' => 'Tilt::Template',
+                  'instance_method' => true,
+                  'method_name' => 'render',
+                  'method_visibility' => 'public',
+                  'action' => 'CUSTOM',
+                  'source' => 'O,P0',
+                  'target' => 'R',
+                  'patch_class' => 'Contrast::Agent::Assess::Policy::Trigger::ReflectedXss',
+                  'patch_method' => 'xss_tilt_trigger'
+              }.cs__freeze
+              TEMPLATE_PROPAGATION_NODE = Contrast::Agent::Assess::Policy::PropagationNode.new(NODE_HASH)
+
+              def xss_tilt_trigger trigger_node, _source, object, ret, *args
+                return unless (properties = Contrast::Agent::Assess::Tracker.properties!(ret))
+
+                scope = args[0]
+                erb_template_prerender = object.instance_variable_get(:@data)
+                interpolated_inputs = []
+                handle_binding_variables(scope, erb_template_prerender, ret, properties, interpolated_inputs)
+                handle_local_variables(args, erb_template_prerender, ret, properties, interpolated_inputs)
+                event_data = Contrast::Agent::Assess::Events::EventData.new(TEMPLATE_PROPAGATION_NODE,
+                                                                            ret,
+                                                                            erb_template_prerender,
+                                                                            ret,
+                                                                            interpolated_inputs)
+                properties.build_event(event_data)
+                properties.copy_from(erb_template_prerender, ret, 0)
+                unless interpolated_inputs.empty?
+                  current_event = properties.event
+                  interpolated_inputs.each do |input|
+                    input_properties = Contrast::Agent::Assess::Tracker.properties(input)
+                    next unless input_properties&.event
+
+                    current_event.parent_events << input_properties.event
+                  end
+                end
+
+                if Contrast::Agent::Assess::Tracker.tracked?(ret)
+                  finding = Contrast::Agent::Assess::Policy::TriggerMethod.build_finding(trigger_node,
+                                                                                         ret,
+                                                                                         erb_template_prerender,
+                                                                                         ret,
+                                                                                         interpolated_inputs)
+                  Contrast::Agent::Assess::Policy::TriggerMethod.report_finding(finding) if finding
+                end
+
+                ret
+              end
+
+              private
+
+              def handle_binding_variables scope, erb_template_prerender, ret, properties, interpolated_inputs
+                binding_variables = scope.instance_variables
+
+                binding_variables.each do |bound_variable_sym|
+                  bound_variable_value = scope.instance_variable_get(bound_variable_sym)
+
+                  next unless Contrast::Agent::Assess::Tracker.tracked?(bound_variable_value)
+                  next unless erb_template_prerender.include?(bound_variable_sym.to_s)
+
+                  start_index = ret.index(bound_variable_value)
+                  next if start_index.nil?
+
+                  properties.copy_from(bound_variable_value, ret, start_index)
+                  interpolated_inputs << bound_variable_sym
+                end
+              end
+
+              def handle_local_variables args, erb_template_prerender, ret, properties, interpolated_inputs
+                locals = args[1]
+                locals.each do |local_name, local_value|
+                  next unless Contrast::Agent::Assess::Tracker.tracked?(local_value)
+                  next unless erb_template_prerender.include?(local_name.to_s)
+
+                  start_index = ret.index(local_value)
+                  next if start_index.nil?
+
+                  properties.copy_from(local_value, ret, start_index)
+                  interpolated_inputs << local_name
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/contrast/agent/assess/policy/trigger/xpath.rb

@@ -0,0 +1,57 @@
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# frozen_string_literal: true
+
+module Contrast
+  module Agent
+    module Assess
+      module Policy
+        module Trigger
+          # This acts a trigger to handle the special cases of the XPath
+          # library gem and the Oga gem. Untrusted data may come into the
+          # trigger methods from these classes as an array or hash,
+          # respectively. Since untrusted user input comes into these triggers
+          # as a splat argument or an options hash, we need to iterate through
+          # these objects to see if we were tracking on any of them and report
+          # a finding if so.
+          class Xpath
+            class << self
+              def xpath_expression_trigger trigger_node, _source, object, ret, *args
+                return ret unless args
+
+                process(trigger_node, object, ret, *args)
+              end
+
+              def xpath_oga_trigger trigger_node, _source, object, ret, *args
+                return ret unless args
+
+                # convert the options arg in Oga::XML::CharacterNode#initialize into an
+                # array of its values so we can check if any are unsafe
+                args = args.first.values if args.first.cs__is_a?(Hash)
+                process(trigger_node, object, ret, *args)
+              end
+
+              private
+
+              def process trigger_node, object, ret, *args
+                args.each do |arg|
+                  next unless arg.cs__is_a?(String) || arg.cs__is_a?(Symbol)
+                  next unless Contrast::Agent::Assess::Tracker.tracked?(arg)
+                  next unless trigger_node.violated?(arg)
+
+                  finding = Contrast::Agent::Assess::Policy::TriggerMethod.build_finding(trigger_node,
+                                                                                         arg,
+                                                                                         object,
+                                                                                         ret,
+                                                                                         *args)
+                  Contrast::Agent::Assess::Policy::TriggerMethod.report_finding(finding) if finding
+                end
+
+                ret
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/contrast/agent/assess/policy/trigger_method.rb

@@ -1,206 +1,193 @@
-# Copyright (c) 2020 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
 
-cs__scoped_require 'contrast/utils/object_share'
-cs__scoped_require 'contrast/utils/sha256_builder'
-cs__scoped_require 'contrast/agent/assess/policy/trigger_validation/trigger_validation'
-
-cs__scoped_require 'contrast/components/interface'
+require 'contrast/agent/assess/policy/trigger_validation/trigger_validation'
+require 'contrast/agent/excluder'
+require 'contrast/components/logger'
+require 'contrast/utils/object_share'
+require 'contrast/utils/sha256_builder'
+require 'contrast/utils/assess/trigger_method_utils'
+require 'contrast/agent/assess/events/event_data'
+require 'contrast/agent/reporting/reporting_events/preflight'
+require 'contrast/agent/reporting/reporting_events/application_activity'
+require 'contrast/agent/reporting/reporting_events/preflight_message'
+require 'contrast/agent/reporting/reporting_events/route_discovery'
+require 'contrast/agent/reporting/reporting_utilities/reporting_storage'
+require 'contrast/agent/reporting/reporting_utilities/build_preflight'
+require 'contrast/utils/assess/event_limit_utils'
 
 module Contrast
   module Agent
     module Assess
       module Policy
-        # A trigger method is one which can perform a dangerous action, as
-        # described by the Contrast::Agent::Assess::Policy::TriggerNode class.
-        # Each such method will call to this module just after invocation in
-        # order to determine if the call was done safely. In those cases where
-        # it was not, a Finding report is issued to the Service
+        # A trigger method is one which can perform a dangerous action, as described by the
+        # Contrast::Agent::Assess::Policy::TriggerNode class. Each such method will call to this module just after
+        # invocation in order to determine if the call was done safely. In those cases where it was not, a Finding
+        # report is issued to TeamServer.
         module TriggerMethod
-          include Contrast::Components::Interface
-          access_component :logging, :analysis
-
-          # The level of TeamServer compliance our traces meet
-          CURRENT_FINDING_VERSION = 2
-
-          def self.settings
-            Contrast::Agent::FeatureState.instance
-          end
-
-          def self.apply_trigger_rule trigger_node, object, ret, args
-            return if trigger_node.nil?
-
-            current_context = Contrast::Agent::REQUEST_TRACKER.current
-            return unless current_context&.analyze_request? && ASSESS.enabled?
-
-            if trigger_node.sources&.any?
-              trigger_node.sources.each do |marker|
-                source = determine_source(marker, object, ret, args)
-                TriggerMethod.cs__apply_trigger(current_context,
-                                                trigger_node,
-                                                source,
-                                                object,
-                                                ret,
-                                                1,
-                                                *args)
+          extend Contrast::Components::Logger::InstanceMethods
+          extend Contrast::Utils::Assess::TriggerMethodUtils
+          extend Contrast::Utils::Assess::EventLimitUtils
+
+          # Rules that always exists outside of Request Context
+          # @return [Array<String>]
+          NON_REQUEST_RULES = [
+            'hardcoded-password', # Contrast::Agent::Assess::Rule::Provider::HardcodedPassword.NAME,
+            'hardcoded-key' # Contrast::Agent::Assess::Rule::Provider::HardcodedKey.NAME
+          ].cs__freeze
+
+          class << self
+            # This is called from within our woven proc. It will be called as if it were inline in the Rack
+            # application.
+            #
+            # @param trigger_node [Contrast::Agent::Assess::Policy::TriggerNode] the node that applies to the method
+            #   being called
+            # @param object [Object] the Object on which the method was invoked
+            # @param ret [Object] the Return of the invoked method
+            # @param args [Array<Object>] the Arguments with which the method was invoked
+            def apply_trigger_rule trigger_node, object, ret, args
+              return if trigger_node.nil?
+              return if event_limit_for_rule?(trigger_node.rule_id)
+
+              context = Contrast::Agent::REQUEST_TRACKER.current
+              # return if there is no context and the flag is set to default => false
+              # we need to have request if the flag is default
+              # else proceed, if the flag is true we don't need to check for context we
+              # go as currently.
+              # When outside of a request, only track when the feature is enabled
+              return unless context ||
+                  Contrast::ASSESS.non_request_tracking? ||
+                  NON_REQUEST_RULES.include?(trigger_node.rule_id)
+
+              if trigger_node.sources&.any?
+                trigger_node.sources.each do |marker|
+                  source = determine_source(marker, object, ret, args)
+                  apply_trigger(trigger_node, source, object, ret, *args)
+                end
+              else
+                apply_trigger(trigger_node, nil, object, ret, *args)
               end
-            else
-              TriggerMethod.cs__apply_trigger(current_context,
-                                              trigger_node,
-                                              nil,
-                                              object,
-                                              ret,
-                                              1,
-                                              *args)
             end
-          end
 
-          def self.cs__apply_trigger context, trigger_node, source, object, ret, invoked, *args
-            return unless context && trigger_node
-            return if trigger_node.rule_disabled?
-            return if trigger_node.dataflow? && source.nil?
-
-            invoked += 1
-            if trigger_node.regexp_rule?
-              apply_regexp_rule(context, trigger_node, source, object, ret, invoked, *args)
-            elsif trigger_node.custom_trigger?
-              trigger_node.apply_custom_trigger(context, trigger_node, source, object, ret, invoked, *args)
-            elsif trigger_node.dataflow?
-              apply_dataflow_rule(context, trigger_node, source, object, ret, invoked, *args)
-            else # trigger rule - just calling the method is dangerous
-              build_finding(context, trigger_node, source, object, ret, invoked, *args)
+            def apply_eval_trigger trigger_node, source, object, ret, *args
+              apply_trigger(trigger_node, source, object, ret, *args)
             end
-          rescue StandardError => e
-            logger.warn(e, 'Unable to apply trigger.')
-          end
-
-          # Given the marker from the trigger_node (the pointer indicating the entity
-          # from which the taint originated), return the entity on which this
-          # trigger needs to operate.
-          #
-          # In an effort to speed up this lookup, we've changed the marker for
-          # parameters to be implicit - if it is not a return or an object, it
-          # must be a parameter, which we can reference either by index or by
-          # name.
-          def self.determine_source marker, object, ret, args
-            case marker
-            when Contrast::Utils::ObjectShare::RETURN_KEY
-              ret
-            when Contrast::Utils::ObjectShare::OBJECT_KEY
-              object
-            else # 'P'
-              if marker.is_a?(Integer)
-                args[marker]
-              else
-                arg = nil
-                args.each do |search|
-                  next unless search.is_a?(Hash)
 
-                  arg = search[marker]
-                  break if arg
-                end
-                arg
+            # This converts the source of the finding, and the events leading up to it into a Finding
+            #
+            # @param trigger_node [Contrast::Agent::Assess::Policy::TriggerNode] the node to direct applying this
+            #   trigger event
+            # @param source [Object] the source of the Trigger Event
+            # @param object [Object] the Object on which the method was invoked
+            # @param ret [Object, nil] the Return of the invoked method, or nil if void method
+            # @param args [Array<Object>] the Arguments with which the method was invoked
+            # @return [Contrast::Agent::Reporting::Finding, nil] the finding to send to TeamServer if found
+            def build_finding trigger_node, source, object, ret, *args
+              content_type = Contrast::Agent::REQUEST_TRACKER.current&.response&.content_type
+              if content_type.nil? && trigger_node.collectable?
+                Contrast::Agent::FINDINGS.collect_finding(trigger_node, source, object, ret, *args)
+                return
               end
-            end
-          end
+              return unless Contrast::Agent::Assess::Policy::TriggerValidation.valid?(trigger_node, object, ret, args)
 
-          def self.apply_regexp_rule context, trigger_node, source, object, ret, invoked, *args
-            return unless source.is_a?(String)
-            return if trigger_node.good_value && source.match?(trigger_node.good_value)
-            return if trigger_node.bad_value && source !~ trigger_node.bad_value
+              request = find_request(source)
+              return unless reportable?(request&.env)
+              return if excluded_by_url_and_rule?(request, trigger_node.rule_id)
 
-            invoked += 1
-            build_finding(context, trigger_node, source, object, ret, invoked, *args)
-          end
+              finding = Contrast::Agent::Reporting::Finding.new(trigger_node.rule_id)
+              finding.attach_data(trigger_node, source, object, ret, request, *args)
+              return if excluded_by_input_and_rule?(request, finding, trigger_node.rule_id)
+
+              finding.hash_code = Contrast::Utils::HashDigest.generate_event_hash(finding, source, request)
+              finding
+            rescue StandardError => e
+              logger.error('Unable to build a finding', e, rule: trigger_node.rule_id, node_id: trigger_node.id)
+              nil
+            end
 
-          def self.apply_dataflow_rule context, trigger_node, source, object, ret, invoked, *args
-            return unless source
+            # Given a finding, append it to an activity message and send it to the TeamServer for processing. If an
+            # activity message does not exist, b/c we're invoked outside of a request context, build an activity and
+            # immediately report it with the finding.
+            #
+            # @param finding [Contrast::Agent::Reporting::Finding] the Finding to report.
+            def report_finding finding
+              return unless finding
 
-            invoked += 1
-            if Contrast::Utils::DuckUtils.quacks_to?(source, :cs__properties)
-              return unless source.cs__tracked?
-              return unless trigger_node.violated?(source)
+              preflight = Contrast::Agent::Reporting::BuildPreflight.generate(finding)
+              return unless preflight
 
-              build_finding(context, trigger_node, source, object, ret, invoked, *args)
-            elsif Contrast::Utils::DuckUtils.quacks_like_tracked_hash?(source)
-              invoked += 2 # the each & the block
-              source.each_pair do |key, value|
-                apply_dataflow_rule(context, trigger_node, key, object, ret, invoked, *args)
-                apply_dataflow_rule(context, trigger_node, value, object, ret, invoked, *args)
-              end
-            elsif Contrast::Utils::DuckUtils.quacks_like_tracked_enumerable?(source)
-              invoked += 2 # the each & the block
-              source.each do |value|
-                apply_dataflow_rule(context, trigger_node, value, object, ret, invoked, *args)
+              preflight_data = preflight.messages[0].data
+              return if Contrast::Agent::REQUEST_TRACKER.current&.reported_findings&.include?(preflight_data)
+
+              Contrast::Agent::Reporting::ReportingStorage[preflight.messages[0].data] = finding
+              if Contrast::Agent::REQUEST_TRACKER.current
+                Contrast::Agent::REQUEST_TRACKER.current.reported_findings << preflight_data
               end
-            else
-              logger.warn(
-                  nil,
-                  "Target is a #{ source.cs__class.name } -- not sure how to inspect: #{ trigger_node.inspect }")
-              logger.debug(nil, source.to_s[0..99])
+              Contrast::Agent.reporter&.send_event(preflight)
             end
-          end
 
-          def self.build_finding context, trigger_node, source, object, ret, invoked, *args
-            return unless Contrast::Agent::Assess::Policy::TriggerValidation.valid?(trigger_node, object, ret, args)
-
-            request = context.request
-            env = request.env
-            return if defined?(ActionController::Live) &&
-                env &&
-                env['action_controller.instance'].cs__class.included_modules.include?(ActionController::Live)
-
-            finding = Contrast::Api::Dtm::Finding.new
-            finding.rule_id = Contrast::Utils::StringUtils.protobuf_safe_string(trigger_node.rule_id)
-            finding.session_id = Contrast::Agent::FeatureState.instance.current_session_id
-            finding.version = CURRENT_FINDING_VERSION
-
-            build_from_source(finding, source)
-            trigger_event = Contrast::Agent::Assess::ContrastEvent.new(trigger_node, source, object, ret, args, invoked + 1).to_dtm_event
-            finding.events << trigger_event
-            build_hash(finding, source)
-            build_tags(context)
-            finding.routes << context.route if context.route
-            context.activity.findings << finding
-            logger.debug(nil, "Trigger #{ trigger_node.id } detected: #{ source.__id__ } triggered #{ trigger_node.rule_id }")
-          rescue StandardError => e
-            logger.error(e, "Unable to build a finding for #{ trigger_node.id }")
-          end
+            private
 
-          def self.build_from_source finding, source
-            return unless source
-            return unless Contrast::Utils::DuckUtils.quacks_to?(
-                source,
-                :cs__properties)
-            return unless source.cs__properties
+            def settings
+              Contrast::Agent::FeatureState.instance
+            end
 
-            # events could technically be nil, but we would have failed
-            # the rule check before getting here. not worth the nil check
-            source.cs__properties.events.each do |event|
-              finding.events << event.to_dtm_event
+            # Given the marker from the trigger_node (the pointer indicating the entity from which the taint
+            # originated), return the entity on which this trigger needs to operate.
+            #
+            # In an effort to speed up this lookup, we've changed the marker for parameters to be implicit - if it is
+            # not a return or an object, it must be a parameter, which we can reference by index.
+            #
+            # @param marker [String] the source marker that indicates which Object
+            # @param object [Object] the Object on which the method was invoked
+            # @param ret [Object] the Return of the invoked method
+            # @param args [Array<Object>] the Arguments with which the method was invoked
+            # @return [Object] the literal object that this Trigger Event verifies
+            def determine_source marker, object, ret, args
+              case marker
+              when Contrast::Utils::ObjectShare::RETURN_KEY
+                ret
+              when Contrast::Utils::ObjectShare::OBJECT_KEY
+                object
+              else # 'P'
+                if marker.is_a?(Integer)
+                  args[marker]
+                else
+                  arg = nil
+                  args.each do |search|
+                    next unless search.is_a?(Hash)
+
+                    arg = search[marker]
+                    break if arg
+                  end
+                  arg
+                end
+              end
             end
 
-            # Google::Protobuf::Map doesn't support merge!, so we have to do this
-            # long form
-            source_props = source.cs__properties.properties
-            return unless source_props
+            def build_events finding, event
+              return unless event
 
-            source_props.each_pair do |key, value|
-              key = Contrast::Utils::StringUtils.force_utf8(key)
-              finding.properties[key] = Contrast::Utils::StringUtils.force_utf8(value)
+              event.parent_events&.each do |parent_event|
+                build_events(finding, parent_event)
+              end
+              # events could technically be nil, but we would have failed the rule check before getting here. not
+              # worth the nil check
+              finding.events << event.to_dtm_event
             end
-          end
 
-          def self.build_hash finding, source
-            hash_code = Contrast::Utils::HashDigest.generate_event_hash(finding, source)
-            finding.hash_code = Contrast::Utils::StringUtils.force_utf8(hash_code)
-            finding.preflight = Contrast::Utils::PreflightUtil.create_preflight(finding)
-          end
-
-          def self.build_tags context
-            return unless ASSESS.tags
+            # Check if the finding should be excluded due to the assess exclusion rules.
+            #
+            # @param request [Contrast::Agent::Request] a wrapper around the Rack::Request for the current request
+            # @param rule_id [String]
+            # return [Boolean]
+            def excluded_by_url_and_rule? request, rule_id
+              Contrast::SETTINGS.excluder.assess_excluded_by_url_and_rule?(request, rule_id)
+            end
 
-            context.activity.finding_tags = Contrast::Utils::StringUtils.force_utf8(ASSESS.tags)
+            def excluded_by_input_and_rule? request, finding, rule_id
+              Contrast::SETTINGS.excluder.assess_excluded_by_input_and_rule?(request, finding, rule_id)
+            end
           end
         end
       end