contrast-agent 4.9.1 → 4.10.0

data/lib/contrast/agent/assess/policy/propagator/split.rb

@@ -17,7 +17,6 @@ module Contrast
           class Split < Contrast::Agent::Assess::Policy::Propagator::Base
             extend Contrast::Components::Scope::InstanceMethods
             extend Contrast::Components::Logger::InstanceMethods
-            #cs__const_set('AGENT', Contrast::AGENT)
 
             SPLIT_TRACKER = Contrast::Utils::ThreadTracker.new
 
@@ -111,7 +110,9 @@ module Contrast
               # Load patch.
               def instrument_string_split
                 @_instrument_string_split ||= begin
-                  require 'cs__assess_yield_track/cs__assess_yield_track' if ::Contrast::AGENT.patch_yield? && Funchook.available?
+                  if ::Contrast::AGENT.patch_yield? && Funchook.available?
+                    require 'cs__assess_yield_track/cs__assess_yield_track'
+                  end
                   true
                 rescue StandardError => e
                   logger.error('Error loading split rb_yield patch', e)

data/lib/contrast/agent/assess/policy/propagator/substitution.rb

@@ -16,6 +16,7 @@ module Contrast
           # a 'get it right' state soon.
           class Substitution
             include Contrast::Components::Logger::InstanceMethods
+            extend Contrast::Components::Logger::InstanceMethods
 
             CAPTURE_GROUP_REGEXP = /\\[[:digit:]]/.cs__freeze
             CAPTURE_NAME_REGEXP = /\\k<[[:alpha:]]/.cs__freeze

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

@@ -22,7 +22,6 @@ module Contrast
         module RewriterPatch
           extend Contrast::Components::Logger::InstanceMethods
 
-
           class << self
             def rewrite_interpolations
               return unless agent_should_rewrite?

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

@@ -17,7 +17,6 @@ module Contrast
         module SourceMethod
           extend Contrast::Components::Logger::InstanceMethods
 
-
           PARAMETER_TYPE     = 'PARAMETER'
           PARAMETER_KEY_TYPE = 'PARAMETER_KEY'
           HEADER_TYPE        = 'HEADER'
@@ -26,8 +25,7 @@ module Contrast
           COOKIE_KEY_TYPE    = 'COOKIE_KEY'
 
           class << self
-            # This is called from within our woven proc. It will be called as if it were inline in the Rack
-            # application.
+            # This is called from within our woven proc. It will be called as if it were inline in the Rack application.
             #
             # @param method_policy [Contrast::Agent::Patching::Policy::MethodPolicy] the policy that applies to the
             #   method being called
@@ -37,29 +35,27 @@ module Contrast
             # @return [Object, nil] the tracked Return or nil if no changes were made
             def source_patchers method_policy, object, ret, args
               return unless analyze?(method_policy, object, ret, args)
+              return unless (source_node = method_policy.source_node)
+              return unless (target = determine_target(source_node, object, ret, args))
 
-              source_node = method_policy.source_node
-              target = determine_target(source_node, object, ret, args)
-              restore_frozen_state = false
+              return_val = nil
               if target.cs__frozen? && !Contrast::Agent::Assess::Tracker.trackable?(target)
                 return unless ::Contrast::ASSESS.track_frozen_sources?
                 return unless source_node.targets[0] == Contrast::Utils::ObjectShare::RETURN_KEY
+                return unless (dup = safe_dup(ret))
+                return unless Contrast::Agent::Assess::Tracker.trackable?(dup)
 
-                dup = safe_dup(ret)
-                return unless dup
-
-                restore_frozen_state = true
-                ret = dup
-                target = ret
-                Contrast::Agent::Assess::Tracker.pre_freeze(ret)
-                ret.cs__freeze
-                # double check that we were able to finalize the replaced return
-                return unless Contrast::Agent::Assess::Tracker.trackable?(target)
+                Contrast::Agent::Assess::Tracker.pre_freeze(dup)
+                return_val = dup.cs__freeze
+                target = dup
               end
+
               apply_source(Contrast::Agent::REQUEST_TRACKER.current, source_node, target, object, ret,
                            source_node.type, nil, *args)
-              restore_frozen_state ? ret : nil
+
+              return_val
             end
+            Contrast::Components::Logger.add_trace_log_timing_for(SourceMethod, :source_patchers)
 
             private
 

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

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

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

@@ -11,30 +11,28 @@ 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 the Service.
         module TriggerMethod
           extend Contrast::Components::Logger::InstanceMethods
 
-          # The level of TeamServer compliance our traces meet when in the
-          # abnormal condition of being dataflow rules without routes
+          # The level of TeamServer compliance our traces meet when in the abnormal condition of being dataflow rules
+          # without routes.
           MINIMUM_FINDING_VERSION = 3
-          # The level of TeamServer compliance our traces meet
+          # The level of TeamServer compliance our traces meet.
           CURRENT_FINDING_VERSION = 4
 
           class << self
-            # This is called from within our woven proc. It will be called as if it
-            # were inline in the Rack application.
+            # 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 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
+            # @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?
 
@@ -52,19 +50,16 @@ module Contrast
               apply_trigger(trigger_node, source, object, ret, *args)
             end
 
-            # This converts the source of the finding, and the events leading
-            # up to it into a Finding
+            # 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 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] the Return of the invoked method
-            # @param args [Array<Object>] the Arguments with which the method
-            #   was invoked
-            # @return [Contrast::Api::Dtm::Finding, nil] the
-            #   Contrast::Api::Dtm::Finding to send to TeamServer or nil if
-            #   conditions were not met
+            # @param args [Array<Object>] the Arguments with which the method was invoked
+            # @return [Contrast::Api::Dtm::Finding, nil] the Contrast::Api::Dtm::Finding to send to TeamServer or
+            #   nil if conditions were not met
             def build_finding trigger_node, source, object, ret, *args
               return unless Contrast::Agent::Assess::Policy::TriggerValidation.valid?(trigger_node, object, ret, args)
 
@@ -85,13 +80,12 @@ module Contrast
               logger.error('Unable to build a finding', e, rule: trigger_node.rule_id, node_id: trigger_node.id)
             end
 
-            # Given a finding, append it to an activity message and send it to
-            # the Service for processing.
+            # Given a finding, append it to an activity message and send it to the Service 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::Api::Dtm::Finding] the Finding to
-            #    report.
-            # @param request [Contrast::Agent::Request] our wrapper around the
-            #   Rack::Request.
+            # @param finding [Contrast::Api::Dtm::Finding] the Finding to report.
+            # @param request [Contrast::Agent::Request] our wrapper around the Rack::Request.
             def report_finding finding, request = nil
               context = Contrast::Agent::REQUEST_TRACKER.current
               if context
@@ -107,9 +101,8 @@ module Contrast
                 logger.debug('Attempted to report finding without request', finding: finding)
               end
 
-              # If we're out of request context, then we need to report this
-              # finding ourselves, so we'll send it in the one-off activity we
-              # created.
+              # If we're out of request context, then we need to report this finding ourselves, so we'll send it in the
+              # one-off activity we created.
               Contrast::Agent.messaging_queue.send_event_eventually(activity)
             end
 
@@ -125,15 +118,12 @@ module Contrast
                 env['action_controller.instance'].cs__class.included_modules.include?(ActionController::Live))
             end
 
-            # Find the request for this finding. This assumes, for now, that if
-            # there is an active request, then that is the request to report.
-            # Otherwise, we'll use the first request found in the events of the
+            # Find the request for this finding. This assumes, for now, that if there is an active request, then that
+            # is the request to report. Otherwise, we'll use the first request found in the events of the
             # source_object.
             #
-            # @param source [Object,nil] some Object used as the source of a
-            #   trigger event
-            # @return [Contrast::Agent::Request,nil] the request from which the
-            #   dataflow on the request originated.
+            # @param source [Object,nil] some Object used as the source of a trigger event
+            # @return [Contrast::Agent::Request,nil] the request from which the dataflow on the request originated.
             def find_request source
               return Contrast::Agent::REQUEST_TRACKER.current.request if Contrast::Agent::REQUEST_TRACKER.current
               return unless (properties = Contrast::Agent::Assess::Tracker.properties(source))
@@ -150,16 +140,14 @@ module Contrast
               Contrast::Agent::FeatureState.instance
             end
 
-            # This is our method that actually checks the taint on the object
-            # our trigger_node targets.
+            # This is our method that actually checks the taint on the object our trigger_node targets.
             #
-            # @param trigger_node [Contrast::Agent::Assess::Policy::TriggerNode]
-            #   the node to direct applying this trigger event
+            # @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] the Return of the invoked method
-            # @param args [Array<Object>] the Arguments with which the method
-            #   was invoked
+            # @param args [Array<Object>] the Arguments with which the method was invoked
             def apply_trigger trigger_node, source, object, ret, *args
               return unless trigger_node
               return if trigger_node.rule_disabled?
@@ -178,23 +166,17 @@ module Contrast
               logger.warn('Unable to apply trigger', e, node_id: trigger_node.id)
             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.
+            # 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.
+            # 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 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
+            # @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
@@ -217,16 +199,15 @@ module Contrast
               end
             end
 
-            # This is our method that actually checks the taint on the object
-            # our trigger_node targets for our Regexp based rules.
+            # This is our method that actually checks the taint on the object our trigger_node targets for our Regexp
+            # based rules.
             #
-            # @param trigger_node [Contrast::Agent::Assess::Policy::TriggerNode]
-            #   the node to direct applying this trigger event
+            # @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] the Return of the invoked method
-            # @param args [Array<Object>] the Arguments with which the method
-            #   was invoked
+            # @param args [Array<Object>] the Arguments with which the method was invoked
             def apply_regexp_rule trigger_node, source, object, ret, *args
               return unless source.is_a?(String)
               return if trigger_node.good_value && source.match?(trigger_node.good_value)
@@ -235,16 +216,15 @@ module Contrast
               build_finding(trigger_node, source, object, ret, *args)
             end
 
-            # This is our method that actually checks the taint on the object
-            # our trigger_node targets for our Dataflow based rules.
+            # This is our method that actually checks the taint on the object our trigger_node targets for our Dataflow
+            # based rules.
             #
-            # @param trigger_node [Contrast::Agent::Assess::Policy::TriggerNode]
-            #   the node to direct applying this trigger event
+            # @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] the Return of the invoked method
-            # @param args [Array<Object>] the Arguments with which the method
-            #   was invoked
+            # @param args [Array<Object>] the Arguments with which the method was invoked
             def apply_dataflow_rule trigger_node, source, object, ret, *args
               return unless source
 
@@ -287,8 +267,7 @@ module Contrast
 
               build_events finding, properties.event if properties.event
 
-              # Google::Protobuf::Map doesn't support merge!, so we have to do this
-              # long form
+              # Google::Protobuf::Map doesn't support merge!, so we have to do this long form
               source_props = properties.properties
               return unless source_props
 
@@ -304,8 +283,8 @@ module Contrast
               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
+              # 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
 
@@ -324,21 +303,18 @@ module Contrast
               finding.preflight = Contrast::Utils::PreflightUtil.create_preflight(finding)
             end
 
-            # Because our APIs are not versioned, TeamServer relies on a field,
-            # version, to tell it what, if any, validation it can preform on
-            # the findings we send it. Examine the finding and determine the
-            # level to which it conforms.
+            # Because our APIs are not versioned, TeamServer relies on a field, version, to tell it what, if any,
+            # validation it can preform on the findings we send it. Examine the finding and determine the level to
+            # which it conforms.
             #
             # @param finding [Contrast::Api::Dtm::Finding]
             # @return [int] the version of compliance
             def determine_compliance_version finding
               return MINIMUM_FINDING_VERSION unless finding
-              # as routes are the only variable between findings, in the case
-              # where we couldn't determine one, any finding with a route is at
-              # maximum compliance
+              # as routes are the only variable between findings, in the case where we couldn't determine one, any
+              # finding with a route is at maximum compliance
               return CURRENT_FINDING_VERSION if finding.routes.any?
-              # any finding without events is not of a dataflow type and
-              # therefore at maximum compliance
+              # any finding without events is not of a dataflow type and therefore at maximum compliance
               return CURRENT_FINDING_VERSION unless finding.events.any?
 
               MINIMUM_FINDING_VERSION

data/lib/contrast/agent/assess/property/evented.rb

@@ -50,7 +50,8 @@ module Contrast
             return unless (current_request = Contrast::Agent::REQUEST_TRACKER.current)
 
             if current_request.observed_route.sources.any? do |source|
-                 source.type == event.forced_source_type && source.name == event.forced_source_name
+                 source.type == event.forced_source_type &&
+                       source.name == event.forced_source_name # rubocop:disable Security/Module/Name
                end
 
               return

data/lib/contrast/agent/assess/rule/provider/hardcoded_value_rule.rb

@@ -20,7 +20,6 @@ module Contrast
           module HardcodedValueRule
             include Contrast::Components::Logger::InstanceMethods
 
-
             def disabled?
               !::Contrast::ASSESS.enabled? || ::Contrast::ASSESS.rule_disabled?(rule_id)
             end

data/lib/contrast/agent/disable_reaction.rb

@@ -8,7 +8,7 @@ module Contrast
     # A Reaction from TeamServer which indicates the Agent should be disabled,
     # typically because some configuration setting did not satisfy requirements
     # set by the Organization's Administrator
-    class DisableReaction
+    module DisableReaction
       extend Contrast::Components::Logger::InstanceMethods
 
       def self.run _reaction, level

data/lib/contrast/agent/exclusion_matcher.rb

@@ -94,10 +94,6 @@ module Contrast
         @exclusion.type == Contrast::Api::Settings::Exclusion::ExclusionType::CODE
       end
 
-      def exc_name
-        @exclusion.name # rubocop:disable Security/Module/Name -- part of the API.
-      end
-
       def match_all?
         @exclusion.urls.nil? || @exclusion.urls.empty?
       end

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

@@ -0,0 +1,117 @@
+# Copyright (c) 2021 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/components/logger'
+
+module Contrast
+  module Agent
+    module Inventory
+      # Methods used for parsing database connection configurations
+      # for getting inventory information from the application
+      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'
+        HOST = 'host'
+        PORT = 'port'
+        DATABASE = 'database'
+        DEFAULT = 'default'
+        LOCALHOST = 'localhost'
+
+        def self.active_record_config
+          return @_active_record_config if instance_variable_defined?(:@_active_record_config)
+
+          @_active_record_config = ActiveRecord::Base.connection_config rescue nil # rubocop:disable Style/RescueModifier
+        end
+
+        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?
+
+          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
+
+        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)
+          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
+
+        # 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
+          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)
+
+          [adapter, hosts, database]
+        end
+      end
+    end
+  end
+end