contrast-agent 3.13.0 → 3.16.0

data/lib/contrast/agent.rb

@@ -1,50 +1,50 @@
 # Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
-cs__scoped_require 'English'
+require 'English'
 
 # This must precede other Contrast C extensions
-cs__scoped_require 'cs__common/cs__common'
+require 'cs__common/cs__common'
 # This must precede any patching we do as we log patches and we shouldn't cause
 # requires to happen during that process.
-cs__scoped_require 'contrast/components/logger'
+require 'contrast/components/logger'
 
 # defining instrumentation, this must precede core extensions
 # because they need to register their patches
-cs__scoped_require 'contrast/agent/patching/policy/patcher'
-cs__scoped_require 'contrast/agent/patching/policy/patch'
+require 'contrast/agent/patching/policy/patcher'
+require 'contrast/agent/patching/policy/patch'
 
 # core extensions
-cs__scoped_require 'contrast/extension/assess'
-cs__scoped_require 'contrast/extension/delegator'
-cs__scoped_require 'contrast/extension/inventory'
-cs__scoped_require 'contrast/extension/module'
-cs__scoped_require 'contrast/extension/protect'
-cs__scoped_require 'contrast/extension/protect/kernel'
+require 'contrast/extension/assess'
+require 'contrast/extension/delegator'
+require 'contrast/extension/inventory'
+require 'contrast/extension/module'
+require 'contrast/extension/protect'
+require 'contrast/extension/protect/kernel'
 
-cs__scoped_require 'contrast/utils/object_share'
-cs__scoped_require 'contrast/utils/boolean_util'
-cs__scoped_require 'contrast/utils/string_utils'
-cs__scoped_require 'contrast/utils/io_util'
-cs__scoped_require 'contrast/utils/os'
+require 'contrast/utils/object_share'
+require 'contrast/utils/boolean_util'
+require 'contrast/utils/string_utils'
+require 'contrast/utils/io_util'
+require 'contrast/utils/os'
 
-cs__scoped_require 'contrast/common_agent_configuration'
+require 'contrast/common_agent_configuration'
 
-cs__scoped_require 'contrast/utils/hash_digest'
-cs__scoped_require 'contrast/utils/invalid_configuration_util'
+require 'contrast/utils/hash_digest'
+require 'contrast/utils/invalid_configuration_util'
 
 # scoping
-cs__scoped_require 'contrast/agent/scope'
+require 'contrast/agent/scope'
 
-cs__scoped_require 'contrast/utils/thread_tracker'
+require 'contrast/utils/thread_tracker'
 
 # Framework support
-cs__scoped_require 'contrast/framework/manager'
+require 'contrast/framework/manager'
 
 # Communication to SR
-cs__scoped_require 'contrast/api/communication'
+require 'contrast/api/communication'
 
-cs__scoped_require 'contrast/agent/thread_watcher'
+require 'contrast/agent/thread_watcher'
 
 module Contrast
   # Top namespace of the Agent section. Holds tracking contexts that will be
@@ -67,39 +67,32 @@ module Contrast
   end
 end
 
-cs__scoped_require 'contrast/api'
+require 'contrast/api'
 
-cs__scoped_require 'contrast/utils/resource_loader'
-cs__scoped_require 'contrast/utils/duck_utils'
-cs__scoped_require 'contrast/agent/tracepoint_hook'
-cs__scoped_require 'contrast/agent/at_exit_hook'
+require 'contrast/utils/resource_loader'
+require 'contrast/utils/duck_utils'
+require 'contrast/agent/tracepoint_hook'
+require 'contrast/agent/at_exit_hook'
 
 # communication with contrast service
-cs__scoped_require 'contrast/agent/exclusion_matcher'
+require 'contrast/agent/exclusion_matcher'
 
 # threads that handle contrast scope
-cs__scoped_require 'contrast/agent/thread'
+require 'contrast/agent/thread'
 
 # keep track of attacks
-cs__scoped_require 'contrast/agent/request_context'
+require 'contrast/agent/request_context'
 
-cs__scoped_require 'contrast/agent/assess'
+require 'contrast/agent/assess'
 
 # protect rules
-cs__scoped_require 'contrast/agent/protect/rule'
+require 'contrast/agent/protect/rule'
 
 # application libraries
-cs__scoped_require 'contrast/utils/gemfile_reader'
+require 'contrast/utils/gemfile_reader'
 
 # rack event monitoring
-cs__scoped_require 'contrast/agent/middleware'
-
-# TODO: RUBY-919
-# Refactor to use Contrast::Framework::Manager
-# Contrast::Framework::Manager.before_load_patches!
-if defined?(::Rails)
-  cs__scoped_require 'contrast/framework/rails/patch/support'
-  cs__scoped_require 'contrast/framework/rails/patch/rails_application_configuration'
-  Contrast::Framework::Rails::Patch::RailsApplicationConfiguration.instrument
-  cs__scoped_require 'contrast/agent/railtie' if ::Rails::VERSION::MAJOR.to_i >= 3
-end
+require 'contrast/agent/middleware'
+
+# Install the patches we need before the application has a chance to initialize
+Contrast::Agent.framework_manager.before_load_patches!

data/lib/contrast/agent/assess.rb

@@ -8,27 +8,27 @@ module Contrast
     # class under this namespace should be required here, providing a single
     # point of require for this functionality.
     module Assess
-      cs__scoped_require 'contrast/agent/module_data'
-      cs__scoped_require 'contrast/agent/rewriter'
-      cs__scoped_require 'contrast/agent/assess/policy/preshift'
+      require 'contrast/agent/assess/tracker'
+      require 'contrast/agent/module_data'
+      require 'contrast/agent/rewriter'
+      require 'contrast/agent/assess/policy/preshift'
 
-      cs__scoped_require 'contrast/utils/prevent_serialization'
+      require 'contrast/utils/prevent_serialization'
 
       # Rules - generic
-      cs__scoped_require 'contrast/agent/assess/rule'
-      cs__scoped_require 'contrast/agent/assess/rule/base'
+      require 'contrast/agent/assess/rule'
+      require 'contrast/agent/assess/rule/base'
 
       # Dynamic Sources
-      cs__scoped_require 'contrast/agent/assess/policy/dynamic_source_factory'
+      require 'contrast/agent/assess/policy/dynamic_source_factory'
 
       # Rule: REDOS
-      cs__scoped_require 'contrast/agent/assess/rule/redos'
+      require 'contrast/agent/assess/rule/redos'
 
       # reporting / tracking
-      cs__scoped_require 'contrast/agent/assess/insulator'
-      cs__scoped_require 'contrast/agent/assess/properties'
-      cs__scoped_require 'contrast/agent/assess/tag'
-      cs__scoped_require 'contrast/agent/assess/events/event_factory'
+      require 'contrast/agent/assess/properties'
+      require 'contrast/agent/assess/tag'
+      require 'contrast/agent/assess/events/event_factory'
     end
   end
 end

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

@@ -1,14 +1,14 @@
 # Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
-cs__scoped_require 'contrast/utils/assess/tracking_util'
-cs__scoped_require 'contrast/utils/class_util'
-cs__scoped_require 'contrast/utils/duck_utils'
-cs__scoped_require 'contrast/utils/object_share'
-cs__scoped_require 'contrast/utils/prevent_serialization'
-cs__scoped_require 'contrast/utils/stack_trace_utils'
-cs__scoped_require 'contrast/utils/string_utils'
-cs__scoped_require 'contrast/utils/timer'
+require 'contrast/utils/assess/tracking_util'
+require 'contrast/utils/class_util'
+require 'contrast/utils/duck_utils'
+require 'contrast/utils/object_share'
+require 'contrast/utils/prevent_serialization'
+require 'contrast/utils/stack_trace_utils'
+require 'contrast/utils/string_utils'
+require 'contrast/utils/timer'
 
 module Contrast
   module Agent
@@ -16,10 +16,32 @@ module Contrast
       # This class holds the data about an event in the application
       # We'll use it to build an event that TeamServer can consume if
       # the object to which this event belongs ends in a trigger.
+      #
+      # @attr_reader event_id [Integer] the atomic id of this event
+      # @attr_reader policy_node [Contrast::Agent::Assess::Policy::PolicyNode]
+      #   the node that governs this event.
+      # @attr_reader stack_trace [Array<String>] the execution stack at the
+      #   time the method for this event was invoked
+      # @attr_reader time [Integer] the time, in epoch ms, when this event was
+      #   created
+      # @attr_reader thread [Integer] the object id of the thread on which this
+      #   event was generated
+      # @attr_reader object [String] the safe representation of the Object on
+      #   which the method was invoked
+      # @attr_reader ret [String] the safe representation of the Return of the
+      #   invoked method
+      # @attr_reader args [Array<Object>] the safe representation of the
+      #   Arguments with which the method was invoked
       class ContrastEvent
         include Contrast::Utils::PreventSerialization
 
         class << self
+          # Given an array of arguments, copy them into a safe, meaning String,
+          # format that we can use to send to SR and TS for rendering.
+          #
+          # @param args [Array<Object>] the arguments to translate
+          # @return [Array<String>] the String forms of those Objects, as
+          #   determined by Contrast::Utils::ClassUtil.to_contrast_string
           def safe_args_representation args
             return nil unless args
             return Contrast::Utils::ObjectShare::EMPTY_ARRAY if args.empty?
@@ -36,30 +58,31 @@ module Contrast
             rep
           end
 
-          def safe_arg_hash_representation hash
-            # since this is the named hash for arguments, only the value is
-            # suspect here
-            hash.transform_values { |v| Contrast::Utils::ClassUtil.to_contrast_string(v) }
-          end
-
           # if given an object that can be duped, duplicate it. otherwise just
           # return the original object. swallow all exceptions from
           # non-duplicable things.
           #
           # we can't just check respond_to? though b/c dup exists on the
           # base Object class
+          #
+          # @param original [Object, nil] the thing to duplicate
+          # @return [Object, nil] a copy of that thing
           def safe_dup original
             return nil unless original
 
-            begin
-              original.dup
-            rescue StandardError
-              original
-            end
+            Contrast::Agent::Assess::Tracker.duplicate(original)
+          end
+
+          private
+
+          def safe_arg_hash_representation hash
+            # since this is the named hash for arguments, only the value is
+            # suspect here
+            hash.transform_values { |v| Contrast::Utils::ClassUtil.to_contrast_string(v) }
           end
         end
 
-        attr_reader :event_id, :parent_ids, :policy_node, :stack_trace, :time, :thread, :object, :ret, :args
+        attr_reader :event_id, :policy_node, :stack_trace, :time, :thread, :object, :ret, :args
 
         # We need this to track the parent id's of events to build up a flow
         # chart of the finding
@@ -74,6 +97,13 @@ module Contrast
           end
         end
 
+        # @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
         def initialize policy_node, tagged, object, ret, args
           @policy_node = policy_node
           # so long as this event is built in a factory, we know Contrast Code
@@ -84,28 +114,110 @@ module Contrast
 
           # These methods rely on the above being set. Don't move them!
           @event_id = Contrast::Agent::Assess::ContrastEvent.next_atomic_id
-          @parent_ids = find_parent_ids(policy_node, object, ret, args)
-          snapshot(tagged, object, ret, args)
+          find_parent_events!(policy_node, object, ret, args)
+          snapshot!(tagged, object, ret, args)
+        end
+
+        def parent_events
+          @_parent_events ||= []
         end
 
-        # Parent IDs are the event ids of all the sources of this event which
-        # were tracked prior to this event occurring
-        def find_parent_ids policy_node, object, ret, args
-          mapped = policy_node.sources.map do |source|
-            value_of_source(source, object, ret, args)
+        # We have to do a little work to figure out what our TS appropriate
+        # target is. To break this down, the logic is as follows:
+        # 1) If my policy_node has a target, work on targets. Else, work on sources.
+        #    Per TS law, each policy_node must have at least a source or a target.
+        #    The only type of policy_node w/o targets is a Trigger, but that may
+        #    change.
+        # 2) If I have a highlight, it means that I have a P target that is
+        #    not in integer form (it was a named / keyword type for which I had
+        #    to find the index). I need to address this so that TS can process
+        #    it.
+        # 3) I'll set the event's source and target to TS values.
+        # 4) Return the highlight or the first source/target as the taint
+        #    target.
+        def determine_taint_target event_dtm
+          if @policy_node&.targets&.any?
+            event_dtm.source = @policy_node.source_string if @policy_node.source_string
+            event_dtm.target = @highlight ? "P#{ @highlight }" : @policy_node.target_string
+            @highlight || @policy_node.targets[0]
+          elsif policy_node&.sources&.any?
+            event_dtm.source = @highlight ? "P#{ @highlight }" : @policy_node.source_string
+            event_dtm.target = @policy_node.target_string if @policy_node.target_string
+            @highlight || @policy_node.sources[0]
           end
-          selected = mapped.select do |source|
-            source &&
-                Contrast::Utils::DuckUtils.quacks_to?(source, :cs__properties) &&
-                source.cs__properties.events &&
-                source.cs__properties.events.last
+        end
+
+        # Convert this event into a DTM that TeamServer can consume
+        def to_dtm_event
+          Contrast::Api::Dtm::TraceEvent.build(self)
+        end
+
+        private
+
+        # Parent events are the events of all the sources of this event which
+        # were tracked prior to this event occurring. Depending on which, if
+        # any of the sources were tracked, there may be more than one parent.
+        #
+        # All events except for [Contrast::Agent::Assess::Events::SourceEvent]
+        # will have at least one parent.
+        #
+        # We set those events to this event's instance variables.
+        #
+        # @param policy_node [Contrast::Agent::Assess::Policy::PolicyNode]
+        #   the node that governs this event.
+        # @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 find_parent_events! policy_node, object, ret, args
+          policy_node.sources.each do |source_marker|
+            source = value_of_source(source_marker, object, ret, args)
+            next unless source
+
+            event = Contrast::Agent::Assess::Tracker.properties(source)&.event
+            parent_events << event if event
           end
-          selected.map do |source|
-            source.cs__properties.events.last.event_id
+        end
+
+        # @param source [String] the marker for the source type
+        # @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,nil] the literal value of the source indicated by the
+        #   given marker
+        def value_of_source source, object, ret, args
+          case source
+          when Contrast::Utils::ObjectShare::OBJECT_KEY
+            object
+          when Contrast::Utils::ObjectShare::RETURN_KEY
+            ret
+          else
+            if source.is_a?(Integer)
+              args[source]
+            else
+              args.each do |search|
+                next unless search.is_a?(Hash)
+
+                s = search[source]
+                return s if s
+              end
+            end
           end
         end
 
-        def snapshot tagged, object, ret, args
+        # Everything* is mutable in Ruby. As such, to ensure we can accurately
+        # report the application state at the time of this method's invocation,
+        # we have to snapshot the given values, making safe representations of
+        # them for our later use. We set those safe values to this event's
+        # instance variables.
+        #
+        # @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
+        def snapshot! tagged, object, ret, args
           target = @policy_node.target
           case target
             # If the target is nil, this rule was violated simply by a method
@@ -139,6 +251,10 @@ module Contrast
         # I know we're creating an extra string here since we replace the safe
         # one w/ a dup, but good enough for now. Trying not to make this too
         # complicated. - HM 8/8/19
+        #
+        # @param target [String,Integer] the marker for the target index
+        # @param tagged [Object] the actual Object that we're acting on which
+        #   has tags
         def save_target_arg target, tagged
           return if @args.cs__frozen?
 
@@ -156,56 +272,6 @@ module Contrast
             break
           end
         end
-
-        # We have to do a little work to figure out what our TS appropriate
-        # target is. To break this down, the logic is as follows:
-        # 1) If my policy_node has a target, work on targets. Else, work on sources.
-        #    Per TS law, each policy_node must have at least a source or a target.
-        #    The only type of policy_node w/o targets is a Trigger, but that may
-        #    change.
-        # 2) If I have a highlight, it means that I have a P target that is
-        #    not in integer form (it was a named / keyword type for which I had
-        #    to find the index). I need to address this so that TS can process
-        #    it.
-        # 3) I'll set the event's source and target to TS values.
-        # 4) Return the highlight or the first source/target as the taint
-        #    target.
-        def determine_taint_target event_dtm
-          if @policy_node&.targets&.any?
-            event_dtm.source = @policy_node.source_string if @policy_node.source_string
-            event_dtm.target = @highlight ? "P#{ @highlight }" : @policy_node.target_string
-            @highlight || @policy_node.targets[0]
-          elsif policy_node&.sources&.any?
-            event_dtm.source = @highlight ? "P#{ @highlight }" : @policy_node.source_string
-            event_dtm.target = @policy_node.target_string if @policy_node.target_string
-            @highlight || @policy_node.sources[0]
-          end
-        end
-
-        def value_of_source source, object, ret, args
-          case source
-          when Contrast::Utils::ObjectShare::OBJECT_KEY
-            object
-          when Contrast::Utils::ObjectShare::RETURN_KEY
-            ret
-          else
-            if source.is_a?(Integer)
-              args[source]
-            else
-              args.each do |search|
-                next unless search.is_a?(Hash)
-
-                s = search[source]
-                return s if s
-              end
-            end
-          end
-        end
-
-        # Convert this event into a DTM that TeamServer can consume
-        def to_dtm_event
-          Contrast::Api::Dtm::TraceEvent.build(self)
-        end
       end
     end
   end