contrast-agent 4.14.1 → 5.0.0

data/lib/contrast/agent/assess/property/evented.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/events/event_factory'
@@ -18,22 +18,15 @@ module Contrast
 
           # Create a new event and add it to the event set.
           #
-          # @param policy_node [Contrast::Agent::Assess::Policy::PolicyNode]
-          #   the node that governs this event.
-          # @param tagged [Object] the Target to which this event pertains.
-          # @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
+          # @param event_data [Contrast::Agent::Assess::Events::EventData]
           # @param source_type [String] the type of this source, from the
           #   source_node, or a KEY_TYPE if invoked for a map
           # @param source_name [String, nil] the name of this source, i.e.
           #   the key used to accessed if from a map or nil if a type like
           #   BODY
-          def build_event policy_node, tagged, object, ret, args, source_type = nil, source_name = nil
-            @event = Contrast::Agent::Assess::Events::EventFactory.build(policy_node, tagged, object, ret, args,
-                                                                         source_type, source_name)
-            report_sources(tagged, event)
+          def build_event event_data, source_type = nil, source_name = nil
+            @event = Contrast::Agent::Assess::Events::EventFactory.build(event_data, source_type, source_name)
+            report_sources(event_data.tagged, @event)
           end
 
           private
@@ -49,6 +42,11 @@ module Contrast
             return unless event.source_type
             return unless (current_request = Contrast::Agent::REQUEST_TRACKER.current)
 
+            append_to_dtm current_request, event
+            append_to_ruby_object current_request, event
+          end
+
+          def append_to_dtm current_request, event
             if current_request.observed_route.sources.any? do |source|
                  source.type == event.forced_source_type &&
                        source.name == event.forced_source_name # rubocop:disable Security/Module/Name
@@ -62,6 +60,21 @@ module Contrast
 
             current_request.observed_route.sources << event_source_dtm
           end
+
+          def append_to_ruby_object current_request, event
+            if current_request.new_observed_route.sources.any? do |source|
+              source.type == event.forced_source_type &&
+                    source.name == event.forced_source_name # rubocop:disable Security/Module/Name
+            end
+
+              return
+            end
+
+            event_source = event.build_event_source
+            return unless event_source
+
+            current_request.new_observed_route.sources << event_source
+          end
         end
       end
     end

data/lib/contrast/agent/assess/property/tagged.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/tag'

data/lib/contrast/agent/assess/property/updated.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/duck_utils'

data/lib/contrast/agent/assess/rule/provider/hardcoded_key.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
@@ -95,24 +95,6 @@ module Contrast
 
               children[1] == :bytes
             end
-
-            # TODO: RUBY-1014 remove `#value_type_passes?` and `#value_passes?`
-            # If the value is a byte array, or at least an array of numbers, it
-            # passes for this rule
-            def value_type_passes? value
-              return false unless value.is_a?(Array) && value.any?
-
-              value.each do |byte|
-                return false unless byte.is_a?(Integer)
-              end
-              true
-            end
-
-            # There isn't a filter for the byte value. The check is not evaluated
-            # for this rule
-            def value_passes? _value
-              true
-            end
           end
         end
       end

data/lib/contrast/agent/assess/rule/provider/hardcoded_password.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
@@ -71,18 +71,6 @@ module Contrast
             def redacted_marker
               REDACTED_MARKER
             end
-
-            # TODO: RUBY-1014 remove `#value_type_passes?` and `#value_passes?`
-            # If the value is a string, it passes for this rule
-            def value_type_passes? value
-              value.is_a?(String)
-            end
-
-            # If the value probably isn't a property name, it passes for this
-            # rule
-            def value_passes? value
-              !probably_property_name?(value)
-            end
           end
         end
       end

data/lib/contrast/agent/assess/rule/provider/hardcoded_value_rule.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/policy/trigger_method'
@@ -25,53 +25,6 @@ module Contrast
               !::Contrast::ASSESS.enabled? || ::Contrast::ASSESS.rule_disabled?(rule_id)
             end
 
-            # TODO: RUBY-1014 - remove `#analyze`
-            COMMON_CONSTANTS = %i[CONTRAST_ASSESS_POLICY_STATUS VERSION].cs__freeze
-            def analyze clazz
-              return if disabled?
-
-              # we only want the constants explicitly defined in this class, not
-              # those of its ancestor(s)
-              constants = clazz.cs__constants(false)
-
-              # if there are no constants, let's just leave
-              return unless constants&.any?
-
-              constants.each do |constant|
-                next if COMMON_CONSTANTS.include?(constant)
-
-                # if this class autoloads its constant, get the hell away from it
-                # I mean it! Don't even think about it.
-                #
-                # Autoload means this constant (usually [always?] a class or
-                # module) won't be required until something in the application
-                # tries to load it. We CANNOT be that thing. We'll just have to
-                # wait until it's loaded, at which point we'll be handed it
-                # again.
-                next if clazz.cs__autoload?(constant)
-
-                # constant comes to us as a symbol. that sucks. we need to do
-                # some string methods on it, so stringify it.
-                constant_string = constant.to_s
-
-                # if this is another class or a module, move on
-                next unless constant_name?(constant_string)
-
-                next unless name_passes?(constant_string)
-
-                value = clazz.cs__const_get(constant, false)
-
-                # if the constant isn't holding a string, skip it
-                next unless value_type_passes?(value)
-
-                # if it looks like a placeholder / pointer to a config, skip it
-                next unless value_passes?(value)
-
-                new_finding_and_reporting clazz, constant_string
-                build_finding clazz, constant_string
-              end
-            end
-
             # Parse the file pertaining to the given TracePoint to walk its AST
             # to determine if a Constant is hardcoded. For our purposes, this
             # hard coding means directly set rather than as an interpolated
@@ -93,14 +46,6 @@ module Contrast
               logger.error('Unable to parse AST for hardcoded keys', e, module: trace_point.self)
             end
 
-            # Constants can be variable or classes defined in the given
-            # class. We ONLY want the variables, which should be defined in
-            # the MACRO_CASE (upper case & underscore format)
-            CONSTANT_NAME_PATTERN = /^[A-Z_]+$/.cs__freeze
-            def constant_name? constant
-              constant.match?(CONSTANT_NAME_PATTERN)
-            end
-
             # The name of the field
             CONSTANT_NAME_KEY = 'name'
             # The code line, recreated, with the password obfuscated
@@ -140,8 +85,11 @@ module Contrast
               # sort. We leave it to each rule to properly handle these nodes.
               return unless value_node_passes?(value)
 
-              new_finding_and_reporting mod, name
-              build_finding mod, name
+              if Contrast::Agent::Reporter.enabled?
+                new_finding_and_reporting mod, name
+              else # TODO: RUBY-1438 -- remove
+                build_finding mod, name
+              end
             end
 
             # Constants can be set as frozen directly. We need to account for
@@ -210,7 +158,7 @@ module Contrast
 
             def save_and_report_finding ruby_finding, new_preflight
               Contrast::Agent::Reporting::ReportingStorage[hash] = ruby_finding
-              Contrast::Agent.reporter_queue.send_event_immediately(new_preflight)
+              Contrast::Agent.reporter&.send_event_immediately(new_preflight)
             end
           end
         end

data/lib/contrast/agent/assess/rule/provider.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/rule/response/autocomplete_rule.rb

@@ -0,0 +1,130 @@
+# 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/rule/response/base_rule'
+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 the body contains a form which
+          # incorrectly sets the autocomplete attribute.
+          class Autocomplete < BaseRule
+            def rule_id
+              'autocomplete-missing'
+            end
+
+            protected
+
+            HTML_PROP = 'html'.cs__freeze
+            START_PROP = 'start'.cs__freeze
+            END_PROP = 'end'.cs__freeze
+
+            # Rules discern which responses they can/should analyze.
+            #
+            # @param response [Contrast::Agent::Response] the response of the application
+            def analyze_response? response
+              super && body?(response)
+            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
+              body = response.body
+              forms = forms(body)
+              forms.each do |form|
+                # Because TeamServer will reject any subsequent form on the same page due to deduplication, we can
+                # skip out on the first violation.
+                return form if autocomplete?(form[HTML_PROP])
+              end
+              nil
+            end
+
+            # Find the forms in this body, if any, so as to determine if they violate this rule.
+            #
+            # @param body [String]
+            # @return [Array<Hash>] the forms of this body, as well as their start and end indexes.
+            def forms body
+              forms = []
+              body_start = 0
+              # The instance of "<form" in the body may be a form. Turn them into chunks to check.
+              potential_forms = body.split(form_start)
+              potential_forms.each do |potential_form|
+                # We can consider this a form if the next character is one of whitespace of form tag closing
+                # characters.
+                next unless potential_form
+                next unless form_openings.any? { |opening| potential_form.start_with?(opening) }
+
+                body_start = body.index(form_start, body_start)
+                next unless body_start
+
+                form_stop = potential_form.index('>').to_i
+                next unless form_stop
+
+                body_close = body_start + 6 + form_stop
+                forms << capture(body, body_start, body_close, form_stop)
+                body_start = body_close
+              end
+              forms
+            end
+
+            def form_start
+              /<form/i
+            end
+
+            def form_openings
+              [' ', "\n", "\r", "\t", '>']
+            end
+
+            def off_values
+              [/"off"/, /'off'/, /off /, /off>/]
+            end
+
+            # Determine if the given form does not have a valid autocomplete tag. Because autocompletion is on by
+            # default, the form must both have the value and set it to being disabled to not autocomplete.
+            #
+            # @param form [String] the form tag
+            # @return [Boolean]
+            def autocomplete? form
+              idx = form =~ /autocomplete=/i
+              return true unless idx
+
+              # Adjust for the length of 'autocomplete='
+              idx += 13
+              off_values.each do |off_value|
+                return false if (form =~ off_value) == idx
+              end
+              true
+            end
+
+            # Capture the information needed to build the properties of this finding by parsing out from the body
+            #
+            # @param body [String] the entire HTTP Response body
+            # @param body_start [Integer] the start of the range to take from the body
+            # @param body_close [Integer] the end of the range to take from the body
+            # @param form_stop [Integer] the index of the end of the form from its start
+            # @return [Hash]
+            def capture body, body_start, body_close, form_stop
+              form = {}
+              # Capture the 50 characters in front of the form, or up to the start if the form starts before 50.
+              capture_start = body_start < 50 ? 0 : body_start - 50
+              # Start is where the '<form' is in the body
+              # 6 accounts for the characters in the form and the opening char
+              # potential_form.index('>') accounts for finding the rest of the form
+              # 50 accounts for the context to capture beyond
+              capture_close = body_close + 50
+              form[HTML_PROP] = body[capture_start...capture_close]
+              form[START_PROP] = body_start < 50 ? body_start : 50
+              form[END_PROP] = form[START_PROP] + 6 + form_stop
+              form
+            end
+          end
+        end
+      end
+    end
+  end
+end

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'