contrast-agent 4.3.2 → 4.7.0

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

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast
@@ -65,8 +65,7 @@ module Contrast
               return true if http && !tmp_id.end_with?(DTD_MARKER)
 
               # external if using external protocol
-              return true if tmp_id.start_with?(FTP_START, FILE_START,
-                                                JAR_START, GOPHER_START)
+              return true if tmp_id.start_with?(FTP_START, FILE_START, JAR_START, GOPHER_START)
 
               # external if start with path marker (/ or .)
               return true if tmp_id.start_with?(Contrast::Utils::ObjectShare::SLASH,

data/lib/contrast/agent/railtie.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/utils/job_servers_running'

data/lib/contrast/agent/reaction_processor.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/agent/disable_reaction'
@@ -6,11 +6,9 @@ require 'contrast/components/interface'
 
 module Contrast
   module Agent
-    # Because communication between the Agent/Service and TeamServer can only
-    # be initiated by outbound connections from the Agent/Service, we must
-    # provide a mechanism for the TeamServer to direct the Agent to take a
-    # specific action. This action is referred to as a Reaction. This class is
-    # how we handle those Reaction messages.
+    # Because communication between the Agent/Service and TeamServer can only be initiated by outbound connections
+    # from the Agent/Service, we must provide a mechanism for the TeamServer to direct the Agent to take a specific
+    # action. This action is referred to as a Reaction. This class is how we handle those Reaction messages.
     class ReactionProcessor
       include Contrast::Components::Interface
       access_component :logging
@@ -25,8 +23,12 @@ module Contrast
         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
-          level = reaction.log_level.nil? ? :error : reaction.log_level.name.downcase
+          # The enums are all uppercase, we need to downcase them before attempting to log.
+          level = if reaction.log_level.nil?
+                    :error
+                  else
+                    reaction.log_level.name.downcase # rubocop:disable Security/Module/Name -- ruby logger builtin.
+                  end
 
           logger.with_level(level, reaction.message) if reaction.message
 
@@ -36,9 +38,8 @@ module Contrast
           when Contrast::Api::Settings::Reaction::Operation::NOOP
             # NOOP
           else
-            logger.warn(
-                'ReactionProcessor received a reaction with an unknown operation',
-                operation: reaction.operation)
+            logger.warn('ReactionProcessor received a reaction with an unknown operation',
+                        operation: reaction.operation)
           end
         end
       end

data/lib/contrast/agent/request.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'resolv'
@@ -27,9 +27,11 @@ module Contrast
       LAST_NUMBER_MARKER = '/{n}'
 
       attr_reader :rack_request
+      attr_accessor :route, :observed_route
 
       # Delegate calls to the following methods to the attribute @rack_request
-      def_delegators :@rack_request, :base_url, :content_type, :cookies, :env, :ip, :path, :port, :query_string, :request_method, :scheme, :url, :user_agent
+      def_delegators :@rack_request, :base_url, :content_type, :cookies, :env, :ip, :path, :port, :query_string,
+                     :request_method, :scheme, :url, :user_agent
 
       def initialize rack_request
         @rack_request = rack_request
@@ -55,32 +57,28 @@ module Contrast
       end
 
       def document_type
-        @_document_type ||= begin
-          if /xml/i.match?(content_type) || body&.start_with?('<?xml')
-            :XML
-          elsif /json/i.match?(content_type) || body&.match?(/\s*[{\[]/)
-            :JSON
-          else
-            :NORMAL
-          end
-        end
+        @_document_type ||= if /xml/i.match?(content_type) || body&.start_with?('<?xml')
+                              :XML
+                            elsif /json/i.match?(content_type) || body&.match?(/\s*[{\[]/)
+                              :JSON
+                            else
+                              :NORMAL
+                            end
       end
 
       # Header keys upcased and any underscores replaced with dashes
       def headers
-        @_headers ||= begin
-          with_contrast_scope do
-            hash = {}
-            env.each do |key, value|
-              next unless key
-
-              name = key.to_s
-              next unless name.start_with?(Contrast::Utils::ObjectShare::HTTP_SCORE)
-
-              hash[Contrast::Utils::StringUtils.normalized_key(name)] = value
-            end
-            hash
+        @_headers ||= with_contrast_scope do
+          hash = {}
+          env.each do |key, value|
+            next unless key
+
+            name = key.to_s
+            next unless name.start_with?(Contrast::Utils::ObjectShare::HTTP_SCORE)
+
+            hash[Contrast::Utils::StringUtils.normalized_key(name)] = value
           end
+          hash
         end
       end
 
@@ -89,7 +87,10 @@ module Contrast
         # (can't use body because it might be nil)
         @_body_read ||= begin
           body = rack_request.body
-          if defined?(Rack::Multipart) && defined?(Rack::Multipart::UploadedFile) && body.is_a?(Rack::Multipart::UploadedFile)
+          if defined?(Rack::Multipart) &&
+                defined?(Rack::Multipart::UploadedFile) &&
+                body.is_a?(Rack::Multipart::UploadedFile)
+
             logger.trace("not parsing uploaded file body :: #{ body.original_filename }::#{ body.content_type }")
             @_body = nil
           else

data/lib/contrast/agent/request_context.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# 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'
@@ -6,35 +6,39 @@ require 'contrast/agent/request'
 require 'contrast/agent/response'
 require 'contrast/utils/inventory_util'
 require 'contrast/components/interface'
+require 'contrast/delegators/input_analysis'
 
 module Contrast
   module Agent
     # 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
 
       EMPTY_INPUT_ANALYSIS_PB = Contrast::Api::Settings::InputAnalysis.new
 
-      attr_reader :timer,
-                  :logging_hash,
-                  :speedracer_input_analysis,
-                  :request,
-                  :response,
-                  :activity,
-                  :server_activity,
-                  :route,
-                  :observed_route
+      attr_reader :activity, :logging_hash, :observed_route, :request, :response, :route, :speedracer_input_analysis,
+                  :server_activity, :timer
 
       def initialize rack_request, app_loaded = true
         with_contrast_scope do
           # all requests get a timer and hash
           @timer = Contrast::Utils::Timer.new
-          @logging_hash = {
-              request_id: __id__
-          }
+          @logging_hash = { request_id: __id__ }
 
           # instantiate helper for request and response
           @request = Contrast::Agent::Request.new(rack_request)
@@ -59,7 +63,9 @@ module Contrast
 
           @sample = true
 
-          @sample_request, @sample_response = Contrast::Utils::Assess::SamplingUtil.instance.sample?(@request) if ASSESS.enabled?
+          if ASSESS.enabled?
+            @sample_request, @sample_response = Contrast::Utils::Assess::SamplingUtil.instance.sample?(@request)
+          end
 
           @sample_response &&= ASSESS.scan_response?
 
@@ -95,6 +101,8 @@ module Contrast
         @observed_route.signature  = route.route
         @observed_route.verb       = route.verb
         @observed_route.url        = route.url if route.url
+        @request.route = route
+        @request.observed_route = @observed_route
       end
 
       # Collect the results for the given rule with the given action
@@ -202,16 +210,10 @@ module Contrast
                             # special case for rules (like reflected xss)
                             # that used to have an infilter / block
                             # mode but now are just block at perimeter
-                            rule.build_attack_with_match(
-                                self,
-                                ia_result,
-                                attack_results_by_rule[rule_id],
-                                ia_result.value)
+                            rule.build_attack_with_match(self, ia_result, attack_results_by_rule[rule_id],
+                                                         ia_result.value)
                           else
-                            rule.build_attack_without_match(
-                                self,
-                                ia_result,
-                                attack_results_by_rule[rule_id])
+                            rule.build_attack_without_match(self, ia_result, attack_results_by_rule[rule_id])
                           end
           attack_results_by_rule[rule_id] = attack_result
         end

data/lib/contrast/agent/request_handler.rb

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

data/lib/contrast/agent/response.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'resolv'

data/lib/contrast/agent/rewriter.rb

@@ -1,8 +1,10 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 # intentional -- we're using a << operator here
 
+return unless RUBY_VERSION < '2.6.0' # TODO: RUBY-714 remove guard w/ EOL of 2.5
+
 require 'contrast/agent/class_reopener'
 require 'contrast/agent/patching/policy/patch_status'
 require 'contrast/components/interface'
@@ -57,13 +59,13 @@ module Contrast
         rescue SyntaxError, StandardError => e
           opener = nil
           mod ||= module_data.mod
-          logger.debug('Reopening threw a handled exception - skipping rewriting', e, module: module_data.name)
+          logger.debug('Reopening threw a handled exception - skipping rewriting', e, module: module_data.mod_name)
           status ||= Contrast::Agent::Patching::Policy::PatchStatus.get_status(mod)
           status.failed_rewrite!
         ensure
           opener&.commit_patches
           logger.trace('Rewriting complete',
-                       module: module_data.name,
+                       module: module_data.mod_name,
                        result: Contrast::Agent::Patching::Policy::PatchStatus.get_status(
                            module_data.mod).rewrite_status)
         end
@@ -238,7 +240,7 @@ module Contrast
         ].cs__freeze
         def should_rewrite? module_data
           clazz = module_data.mod
-          name = module_data.name
+          name = module_data.mod_name
           return false unless clazz
 
           # Name can be nil for anonymous modules. We won't work on them.

data/lib/contrast/agent/rule_set.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast
@@ -16,7 +16,7 @@ module Contrast
       def prefilter
         context = Contrast::Agent::REQUEST_TRACKER.current
         # TODO: RUBY-801 We shouldn't be responsible for knowing what modes are enabled
-        return unless context.analyze_request? || PROTECT.enabled?
+        return unless context&.analyze_request? || PROTECT.enabled?
 
         logger.trace_with_time('Running prefilter...') do
           map { |rule| rule.prefilter(context) }
@@ -33,7 +33,7 @@ module Contrast
       def postfilter
         context = Contrast::Agent::REQUEST_TRACKER.current
         # TODO: RUBY-801 We shouldn't be responsible for knowing what modes are enabled
-        return unless context.analyze_response? || PROTECT.enabled?
+        return unless context&.analyze_response? || PROTECT.enabled?
 
         logger.trace_with_time('Running postfilter...') do
           map { |rule| rule.postfilter(context) }

data/lib/contrast/agent/scope.rb

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

data/lib/contrast/agent/service_heartbeat.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/components/interface'
@@ -21,9 +21,8 @@ module Contrast
         @_thread = Contrast::Agent::Thread.new do
           logger.info('Starting heartbeat thread.')
           loop do
-            begin
-              Contrast::Agent.messaging_queue.send_event_eventually(poll_message)
-            end
+            Contrast::Agent.messaging_queue.send_event_eventually(poll_message)
+
             sleep REFRESH_INTERVAL_SEC
           end
         end

data/lib/contrast/agent/static_analysis.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/components/interface'

data/lib/contrast/agent/thread.rb

@@ -1,11 +1,11 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/components/interface'
 
 module Contrast
   module Agent
-    # Threads used by Contrast.
+    # Threads used by Contrast. Any long running thread should be created and managed by our ThreadWatcher class.
     class Thread < ::Thread
       include Contrast::Components::Interface
 

data/lib/contrast/agent/thread_watcher.rb

@@ -1,24 +1,33 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/components/interface'
 require 'contrast/agent/service_heartbeat'
+require 'contrast/api/communication/messaging_queue'
 
 module Contrast
   module Agent
     # This class used to ensure that our worker threads are running in multi-process environments
+    #
+    # @attr_reader heapdump_util [Contrast::Utils::HeapDumpUtil]
+    # @attr_reader heartbeat [Contrast::Agent::ServiceHeartbeat]
+    # @attr_reader messaging_queue [Contrast::Api::Communication::MessagingQueue]
     class ThreadWatcher
       include Contrast::Components::Interface
-      access_component :logging
+      access_component :agent, :logging
 
-      attr_reader :heartbeat
+      attr_reader :heapdump_util, :heartbeat, :messaging_queue
 
       def initialize
         @pids = {}
+        @heapdump_util = Contrast::Utils::HeapDumpUtil.new
         @heartbeat = Contrast::Agent::ServiceHeartbeat.new
+        @messaging_queue = Contrast::Api::Communication::MessagingQueue.new
       end
 
       def startup!
+        return unless AGENT.enabled?
+
         unless heartbeat.running?
           logger.debug('Attempting to start heartbeat thread')
           heartbeat.start_thread!
@@ -26,11 +35,11 @@ module Contrast
         heartbeat_result = heartbeat.running?
         logger.debug('Heartbeat thread status', alive: heartbeat_result)
 
-        unless Contrast::Agent.messaging_queue.running?
+        unless messaging_queue.running?
           logger.debug('Attempting to start messaging queue thread')
-          Contrast::Agent.messaging_queue.start_thread!
+          messaging_queue.start_thread!
         end
-        messaging_result = Contrast::Agent.messaging_queue.running?
+        messaging_result = messaging_queue.running?
         logger.debug('Messaging thread status', alive: messaging_result)
 
         logger.debug('ThreadWatcher started threads')
@@ -44,6 +53,12 @@ module Contrast
         logger.debug('ThreadWatcher - threads not running')
         startup!
       end
+
+      def shutdown!
+        heartbeat.stop!
+        messaging_queue.stop!
+        heapdump_util.stop!
+      end
     end
   end
 end

data/lib/contrast/agent/tracepoint_hook.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/components/interface'
@@ -37,7 +37,7 @@ module Contrast
 
             Contrast::Agent::Inventory::DependencyUsageAnalysis.instance.associate_file(path) if path
             Contrast::Agent::Patching::Policy::Patcher.patch_specific_module(loaded_module)
-            Contrast::Agent::Assess::Policy::RewriterPatch.rewrite_interpolation(loaded_module)
+            Contrast::Agent::Assess::Policy::RewriterPatch.rewrite_interpolation(loaded_module) if RUBY_VERSION < '2.6.0' # TODO: RUBY-714 remove guard w/ EOL of 2.5
             Contrast::Agent::Assess::Policy::PolicyScanner.scan(tracepoint_event)
           end
         end