contrast-agent 4.2.0 → 4.4.1

data/lib/contrast/agent/protect/rule/cmd_injection.rb

@@ -23,10 +23,10 @@ module Contrast
           end
 
           def infilter context, classname, method, command
-            return nil unless infilter?(context)
+            return unless infilter?(context)
 
             ia_results = gather_ia_results(context)
-            return nil if ia_results.empty?
+            return if ia_results.empty?
 
             if APP_CONTEXT.in_new_process?
               logger.trace('Running cmd-injection infilter within new process - creating new context')
@@ -36,7 +36,7 @@ module Contrast
 
             result = find_attacker_with_results(context, command, ia_results, **{ classname: classname, method: method })
             result ||= report_command_execution(context, command, **{ classname: classname, method: method })
-            return nil unless result
+            return unless result
 
             append_to_activity(context, result)
             return unless blocked?

data/lib/contrast/agent/protect/rule/default_scanner.rb

@@ -123,10 +123,7 @@ class Contrast::Agent::Protect::Rule::DefaultScanner # rubocop:disable Style/Cla
     elsif start_block_comment?(char, index, query)
       boundaries << index
       :STATE_INSIDE_BLOCK_COMMENT
-    elsif operator?(char)
-      boundaries << index
-      :STATE_EXPECTING_TOKEN
-    elsif char.match?(Contrast::Utils::ObjectShare::WHITE_SPACE_REGEXP)
+    elsif operator?(char) || char.match?(Contrast::Utils::ObjectShare::WHITE_SPACE_REGEXP)
       boundaries << index
       :STATE_EXPECTING_TOKEN
     else

data/lib/contrast/agent/protect/rule/deserialization.rb

@@ -17,19 +17,22 @@ module Contrast
           BLOCK_MESSAGE = 'Untrusted Deserialization rule triggered. Deserialization blocked.'
 
           # Gadgets that map to ERB modules
-          ERB_GADGETS = %w[
+          ERB_GADGETS = %W[
             object:ERB
+            o:\bERB
           ].cs__freeze
 
           # Gadgets that map to ActionDispatch modules
           ACTION_DISPATCH_GADGETS = %w[
             object:ActionDispatch::Routing::RouteSet::NamedRouteCollection
+            o:\bActionDispatch::Routing::RouteSet::NamedRouteCollection
           ].cs__freeze
 
           # Gadgets that map to Arel Modules
           AREL_GADGETS = %w[
             string:Arel::Nodes::SqlLiteral
             object:Arel::Nodes
+            o:\bArel::Nodes
           ].cs__freeze
 
           # Used to indicate to TeamServer the gadget is an ERB module

data/lib/contrast/agent/protect/rule/no_sqli.rb

@@ -21,10 +21,10 @@ module Contrast
           end
 
           def infilter context, database, query_string
-            return nil unless infilter?(context)
+            return unless infilter?(context)
 
             result = find_attacker(context, query_string, database: database)
-            return nil unless result
+            return unless result
 
             append_to_activity(context, result)
 
@@ -36,7 +36,7 @@ module Contrast
 
             attack_string = input_analysis_result.value
             regexp = Regexp.new(Regexp.escape(attack_string), Regexp::IGNORECASE)
-            return nil unless query_string.match?(regexp)
+            return unless query_string.match?(regexp)
 
             scanner = select_scanner
             ss = StringScanner.new(query_string)

data/lib/contrast/agent/protect/rule/sqli.rb

@@ -22,10 +22,10 @@ module Contrast
           end
 
           def infilter context, database, query_string
-            return nil unless infilter?(context)
+            return unless infilter?(context)
 
             result = find_attacker(context, query_string, database: database)
-            return nil unless result
+            return unless result
 
             append_to_activity(context, result)
 
@@ -36,7 +36,7 @@ module Contrast
             attack_string = input_analysis_result.value
             regexp = Regexp.new(Regexp.escape(attack_string), Regexp::IGNORECASE)
 
-            return nil unless query_string.match?(regexp)
+            return unless query_string.match?(regexp)
 
             database = kwargs[:database]
             scanner = select_scanner(database)
@@ -50,16 +50,9 @@ module Contrast
               last_boundary, boundary = scanner.crosses_boundary(query_string, idx, input_analysis_result.value)
               next unless last_boundary && boundary
 
-              input_analysis_result.attack_count = input_analysis_result.attack_count + 1
-
-              kwargs[:start_idx] = idx
-              kwargs[:end_idx] = idx + length
-              kwargs[:boundary_overrun_idx] = boundary
-              kwargs[:input_boundary_idx] = last_boundary
-
               result ||= build_attack_result(context)
-              update_successful_attack_response(context, input_analysis_result, result, query_string)
-              append_sample(context, input_analysis_result, result, query_string, **kwargs)
+              record_match(idx, length, boundary, last_boundary, kwargs)
+              append_match(context, input_analysis_result, result, query_string, kwargs)
             end
 
             result
@@ -75,13 +68,26 @@ module Contrast
             sample.sqli.query = Contrast::Utils::StringUtils.protobuf_safe_string(candidate_string)
             sample.sqli.start_idx = sample.sqli.query.index(input).to_i
             sample.sqli.end_idx = sample.sqli.start_idx + input.length
-            sample.sqli.boundary_overrun_idx = kwargs[:boundary].to_i
-            sample.sqli.input_boundary_idx = kwargs[:last_boundary].to_i
+            sample.sqli.boundary_overrun_idx = kwargs[:boundary_overrun_idx].to_i
+            sample.sqli.input_boundary_idx = kwargs[:input_boundary_idx].to_i
             sample
           end
 
           private
 
+          def record_match idx, length, boundary, last_boundary, kwargs
+            kwargs[:start_idx] = idx
+            kwargs[:end_idx] = idx + length
+            kwargs[:boundary_overrun_idx] = boundary
+            kwargs[:input_boundary_idx] = last_boundary
+          end
+
+          def append_match context, input_analysis_result, result, query_string, **kwargs
+            input_analysis_result.attack_count = input_analysis_result.attack_count + 1
+            update_successful_attack_response(context, input_analysis_result, result, query_string)
+            append_sample(context, input_analysis_result, result, query_string, **kwargs)
+          end
+
           def select_scanner database
             @sql_scanners ||= {
                 Contrast::Agent::Protect::Policy::AppliesSqliRule::DATABASE_MYSQL =>

data/lib/contrast/agent/protect/rule/xxe.rb

@@ -19,7 +19,9 @@ module Contrast
             NAME
           end
 
-          # Given an xml, evaluate it for an XXE attack.
+          # Given an xml, evaluate it for an XXE attack. There's no return here
+          # as this method handles appending the evaluation to the request
+          # context, connecting it to the reporting mechanism at request end.
           #
           # @param context [Contrast::Agent::RequestContext] the context of the
           #   request in which this input is evaluated.
@@ -29,7 +31,7 @@ module Contrast
           #   attack is found and the rule is in block mode.
           def infilter context, framework, xml
             result = find_attacker(context, xml, framework: framework)
-            return nil unless result
+            return unless result
 
             append_to_activity(context, result)
             return unless blocked?
@@ -39,16 +41,23 @@ module Contrast
 
           protected
 
+          # Given an XML, find any externally resolved entities and create an
+          # Attack Result for them
+          #
+          # @param context [Contrast::Agent::RequestContext] the context of the
+          #   request in which this input is evaluated.
+          # @param xml [String] the literal value of the XML being checked for
+          #   external entity resolution
+          # @param _kwargs [Hash]
+          # @return [Contrast::Api::Dtm::AttackResult, nil] the determination
+          #   as to whether or not this XML has an XXE attack in it.
           def find_attacker context, xml, **_kwargs
-            return nil unless xml
-            return nil if protect_excluded_by_code?
+            return unless xml
+            return if protect_excluded_by_code?
 
-            xxe_details, last_idx = build_details(xml)
-            return nil unless xxe_details
+            xxe_details = build_details(xml)
+            return unless xxe_details
 
-            # For our definition, the prolog goes from the start of the XML
-            # string to the end of the last entity declaration.
-            xxe_details.xml = Contrast::Utils::StringUtils.protobuf_safe_string(xml[0, last_idx])
             ia_result = build_evaluation(xxe_details.xml)
             build_attack_with_match(
                 context,
@@ -58,7 +67,15 @@ module Contrast
                 details: xxe_details)
           end
 
-          def build_details xml, _evaluation = nil
+          # Given an XML determined to be unsafe, build out the details of the
+          # attack. The details will include a substring of the given XML up to
+          # the end of the prolog, where the external entities are declared.
+          #
+          # @param xml [String] the literal value of the XML being checked for
+          #   external entity resolution
+          # @return [Contrast::Api::Dtm::XxeDetails] The details of
+          #   the XXE attack and the index of the last entity discovered
+          def build_details xml
             last_idx = 0
             ss = StringScanner.new(xml)
             while ss.scan_until(EXTERNAL_ENTITY_PATTERN)
@@ -70,7 +87,11 @@ module Contrast
               xxe_details.declared_entities << build_match(ss)
               xxe_details.entities_resolved << build_wrapper(entity_wrapper)
             end
-            [xxe_details, last_idx]
+            # For our definition, the prolog goes from the start of the XML
+            # string to the end of the last entity declaration.
+            xxe_details.xml = Contrast::Utils::StringUtils.protobuf_safe_string(xml[0, last_idx]) if xxe_details
+
+            xxe_details
           end
 
           def build_sample context, ia_result, _url, **kwargs

data/lib/contrast/agent/protect/rule/xxe/entity_wrapper.rb

@@ -18,12 +18,16 @@ module Contrast
             end
 
             def external_entity?
-              @_external_entity ||= begin
-                return external_id?(@system_id) if @system_id
-                return external_id?(@public_id) if @public_id
-
-                false
+              if @_external_entity.nil?
+                @_external_entity ||= if @system_id
+                                        external_id?(@system_id)
+                                      elsif @public_id
+                                        external_id?(@public_id)
+                                      else
+                                        false
+                                      end
               end
+              @_external_entity
             end
 
             # <!ENTITY name SYSTEM "URI">
@@ -48,7 +52,7 @@ module Contrast
             UP_DIR_LINUX = '../'
             UP_DIR_WIN =   '..\\'
             # we only use this against lowercase strings, removed A-Z for speed
-            FILE_PATTERN_WINDOWS = /^[\\\\]*[a-z]{1,3}:.*/.cs__freeze
+            FILE_PATTERN_WINDOWS = /^\\*[a-z]{1,3}:.*/.cs__freeze
             def external_id? entity_id
               return false unless entity_id
 

data/lib/contrast/agent/reaction_processor.rb

@@ -22,7 +22,7 @@ module Contrast
       # @param application_settings [Contrast::Api::Settings::ApplicationSettings]
       #   those settings which the Service has relayed from TeamServer.
       def self.process application_settings
-        return nil unless application_settings&.reactions&.any?
+        return unless application_settings&.reactions&.any?
 
         application_settings.reactions.each do |reaction|
           # the enums are all uppercase, we need to downcase them before attempting to log

data/lib/contrast/agent/request_context.rb

@@ -12,6 +12,18 @@ module Contrast
     # This class acts to encapsulate information about the currently executed
     # request, making it available to the Agent for the duration of the request
     # in a standardized and normalized format which the Agent understands.
+    #
+    # @attr_reader timer [Contrast::Utils::Timer] when the context was created
+    # @attr_reader logging_hash [Hash] context used to log the request
+    # @attr_reader speedracer_input_analysis [Contrast::Api::Settings::InputAnalysis] the protect input analysis of
+    #   sources on this request
+    # @attr_reader request [Contrast::Agent::Request] our wrapper around the Rack::Request for this context
+    # @attr_reader response [Contrast::Agent::Response] our wrapper aroudn the Rack::Response or Array for this context,
+    #   only available after the application has finished its processing
+    # @attr_reader activity [Contrast::Api::Dtm::Activity] the application activity found in this request
+    # @attr_reader server_activity [Contrast::Api::Dtm::ServerActivity] the server activity found in this request
+    # @attr_reader route [Contrast::Api::Dtm::RouteCoverage] the route, used for findings, of this request
+    # @attr_reader observed_route [Contrast::Api::Dtm::ObservedRoute] the route, used for coverage, of this request
     class RequestContext
       include Contrast::Components::Interface
       access_component :agent, :analysis, :logging, :scope

data/lib/contrast/agent/response.rb

@@ -118,16 +118,16 @@ module Contrast
       #   holds, wraps, or is the body of the Response
       # @return [nil, String] the content of the body
       def extract_body body
-        return nil unless body
+        return unless body
 
         if defined?(Rack::File) && body.is_a?(Rack::File)
           # not sure what to do in this situation, so don't do anything.
           nil
         elsif body.is_a?(Rack::BodyProxy)
           handle_rack_body_proxy(body)
-        elsif defined?(ActionDispatch::Response::RackBody) && body.is_a?(ActionDispatch::Response::RackBody)
-          extract_body(body.body)
-        elsif body.is_a?(Rack::Response)
+        elsif (defined?(ActionDispatch::Response::RackBody) && body.is_a?(ActionDispatch::Response::RackBody)) ||
+              body.is_a?(Rack::Response)
+
           extract_body(body.body)
         elsif Contrast::Utils::DuckUtils.quacks_to?(body, :each)
           acc = []
@@ -152,7 +152,7 @@ module Contrast
       end
 
       def read_or_string obj
-        return nil unless obj
+        return unless obj
 
         if Contrast::Utils::DuckUtils.quacks_to?(obj, :read)
           tmp = obj.read

data/lib/contrast/agent/rewriter.rb

@@ -96,11 +96,11 @@ module Contrast
           return unless method_exists?(clazz, method_name, type)
 
           method_instance = method_instance(clazz, method_name, type)
-          return nil if method_instance.nil?
+          return if method_instance.nil?
 
           location = method_instance.source_location
-          return nil unless location_available?(location)
-          return nil if opener.written_from_location?(location)
+          return unless location_available?(location)
+          return if opener.written_from_location?(location)
 
           opener.written_from_location!(location)
           opener.source_code(location, method_name)

data/lib/contrast/agent/scope.rb

@@ -15,29 +15,40 @@ module Contrast
     # Instead, we should say "If I'm already doing Contrast things, don't track
     # this"
     class Scope
-      SCOPE_LIST = %i[contrast deserialization].cs__freeze
+      SCOPE_LIST = %i[contrast deserialization split].cs__freeze
 
       def initialize
-        instance_variable_set(:@contrast_scope, 0)
-        instance_variable_set(:@deserialization_scope, 0)
+        @contrast_scope = 0
+        @deserialization_scope = 0
+        @split_scope = 0
       end
 
       def in_contrast_scope?
-        instance_variable_get(:@contrast_scope).positive?
+        @contrast_scope.positive?
       end
 
       def in_deserialization_scope?
-        instance_variable_get(:@deserialization_scope).positive?
+        @deserialization_scope.positive?
+      end
+
+      def in_split_scope?
+        @split_scope.positive?
       end
 
       def enter_contrast_scope!
-        level = instance_variable_get(:@contrast_scope)
-        instance_variable_set(:@contrast_scope, level + 1)
+        @contrast_scope += 1
       end
 
       def enter_deserialization_scope!
-        level = instance_variable_get(:@deserialization_scope)
-        instance_variable_set(:@deserialization_scope, level + 1)
+        @deserialization_scope += 1
+      end
+
+      def enter_split_scope!
+        @split_scope += 1
+      end
+
+      def split_scope_depth
+        @split_scope
       end
 
       # Scope Exits...
@@ -61,13 +72,15 @@ module Contrast
       #   exit  =  1
       #   scope =  1
       def exit_contrast_scope!
-        level = instance_variable_get(:@contrast_scope)
-        instance_variable_set(:@contrast_scope, level - 1)
+        @contrast_scope -= 1
       end
 
       def exit_deserialization_scope!
-        level = instance_variable_get(:@deserialization_scope)
-        instance_variable_set(:@deserialization_scope, level - 1)
+        @deserialization_scope -= 1
+      end
+
+      def exit_split_scope!
+        @split_scope -= 1
       end
 
       def with_contrast_scope
@@ -84,6 +97,13 @@ module Contrast
         exit_deserialization_scope!
       end
 
+      def with_split_scope
+        enter_split_scope!
+        yield
+      ensure
+        exit_split_scope!
+      end
+
       # Dynamic versions of the above.
       # These are equivalent, but they're slower and riskier.
       # Prefer the static methods if you know what scope you need at the call site.

data/lib/contrast/agent/static_analysis.rb

@@ -17,14 +17,9 @@ module Contrast
         # report the already-loaded gems.
         def catchup
           @_catchup ||= begin
-            with_contrast_scope do
-              Contrast::Agent::Inventory::DependencyUsageAnalysis.instance.catchup
-              send_inventory_message
-              true
-            end
+            threaded_analysis!
+            true
           end
-        rescue StandardError => e
-          logger.warn('Unable to run post-initialization static analysis', e)
         end
 
         def send_inventory_message
@@ -35,6 +30,17 @@ module Contrast
           Contrast::Utils::InventoryUtil.append_db_config(app_update_msg)
           Contrast::Agent.messaging_queue.send_event_eventually(app_update_msg)
         end
+
+        private
+
+        def threaded_analysis!
+          Contrast::Agent::Thread.new do
+            Contrast::Agent::Inventory::DependencyUsageAnalysis.instance.catchup
+            send_inventory_message
+          rescue StandardError => e
+            logger.warn('Unable to run post-initialization static analysis', e)
+          end
+        end
       end
     end
   end