contrast-agent 4.4.1 → 4.9.0

data/lib/contrast/agent/protect/rule/xxe.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/protect/rule/base'
@@ -15,7 +15,7 @@ module Contrast
           BLOCK_MESSAGE = 'XXE rule triggered. Response blocked.'
           EXTERNAL_ENTITY_PATTERN = /<!ENTITY\s+[a-zA-Z0-f]+\s+(?:SYSTEM|PUBLIC)\s+(.*?)>/.cs__freeze
 
-          def name
+          def rule_name
             NAME
           end
 
@@ -59,12 +59,7 @@ module Contrast
             return unless xxe_details
 
             ia_result = build_evaluation(xxe_details.xml)
-            build_attack_with_match(
-                context,
-                ia_result,
-                nil,
-                nil,
-                details: xxe_details)
+            build_attack_with_match(context, ia_result, nil, nil, details: xxe_details)
           end
 
           # Given an XML determined to be unsafe, build out the details of the
@@ -118,7 +113,7 @@ module Contrast
           # supplied by the attacker.
           def build_evaluation xml
             ia_result = Contrast::Api::Settings::InputAnalysisResult.new
-            ia_result.rule_id = name
+            ia_result.rule_id = rule_name
             ia_result.input_type = :UNKNOWN
             ia_result.value = Contrast::Utils::StringUtils.protobuf_safe_string(xml)
             ia_result
@@ -133,10 +128,8 @@ module Contrast
 
           def build_wrapper entity_wrapper
             wrapper = Contrast::Api::Dtm::XxeWrapper.new
-            wrapper.system_id = Contrast::Utils::StringUtils.protobuf_safe_string(
-                entity_wrapper.system_id)
-            wrapper.public_id = Contrast::Utils::StringUtils.protobuf_safe_string(
-                entity_wrapper.public_id)
+            wrapper.system_id = Contrast::Utils::StringUtils.protobuf_safe_string(entity_wrapper.system_id)
+            wrapper.public_id = Contrast::Utils::StringUtils.protobuf_safe_string(entity_wrapper.public_id)
             wrapper
           end
         end

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/reaction_processor.rb

@@ -1,19 +1,16 @@
-# 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'
-require 'contrast/components/interface'
+require 'contrast/components/logger'
 
 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
+      extend Contrast::Components::Logger::InstanceMethods
 
       # Process the given Reactions from the application settings based on what
       # TeamServer has indicated. Each Reaction will result in a log message
@@ -25,8 +22,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 +37,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'
@@ -7,7 +7,8 @@ require 'timeout'
 require 'contrast/utils/object_share'
 require 'contrast/utils/string_utils'
 require 'contrast/utils/hash_digest'
-require 'contrast/components/interface'
+require 'contrast/components/logger'
+require 'contrast/components/scope'
 
 module Contrast
   module Agent
@@ -16,8 +17,8 @@ module Contrast
     # data in a format that the Agent expects, caching those transformations in
     # order to avoid repeatedly creating Strings & thrashing GC.
     class Request
-      include Contrast::Components::Interface
-      access_component :agent, :logging, :scope
+      include Contrast::Components::Logger::InstanceMethods
+      include Contrast::Components::Scope::InstanceMethods
 
       extend Forwardable
 
@@ -27,9 +28,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 +58,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 +88,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,11 +1,12 @@
-# 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'
 require 'contrast/agent/request'
 require 'contrast/agent/response'
 require 'contrast/utils/inventory_util'
-require 'contrast/components/interface'
+require 'contrast/components/logger'
+require 'contrast/components/scope'
 
 module Contrast
   module Agent
@@ -25,28 +26,19 @@ module Contrast
     # @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
+      include Contrast::Components::Logger::InstanceMethods
+      include Contrast::Components::Scope::InstanceMethods
 
       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)
@@ -71,9 +63,11 @@ module Contrast
 
           @sample = true
 
-          @sample_request, @sample_response = Contrast::Utils::Assess::SamplingUtil.instance.sample?(@request) if ASSESS.enabled?
+          if ::Contrast::ASSESS.enabled?
+            @sample_request, @sample_response = Contrast::Utils::Assess::SamplingUtil.instance.sample?(@request)
+          end
 
-          @sample_response &&= ASSESS.scan_response?
+          @sample_response &&= ::Contrast::ASSESS.scan_response?
 
           append_route_coverage(Contrast::Agent.framework_manager.get_route_dtm(@request))
         end
@@ -107,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
@@ -124,8 +120,8 @@ module Contrast
       end
 
       def service_extract_request
-        return false unless AGENT.enabled?
-        return false unless PROTECT.enabled?
+        return false unless ::Contrast::AGENT.enabled?
+        return false unless ::Contrast::PROTECT.enabled?
         return false if @do_not_track
 
         service_response = Contrast::Agent.messaging_queue.send_event_immediately(@activity.http_request)
@@ -205,7 +201,7 @@ module Contrast
         attack_results_by_rule = {}
         agent_settings.input_analysis.results.each do |ia_result|
           rule_id = ia_result.rule_id
-          rule = PROTECT.rule(rule_id)
+          rule = ::Contrast::PROTECT.rule(rule_id)
           next unless rule
 
           logger.debug('Building attack result from Contrast Service input analysis result', result: ia_result.inspect)
@@ -214,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,20 +1,22 @@
-# 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/logger'
+require 'contrast/components/scope'
+
 module Contrast
   module Agent
     # This class is instantiated when we receive a request and the agent is enabled to process
     # that request. It holds the ruleset that we perform filtering operations on (currently
     # prefilter and postfilter).
     class RequestHandler
-      include Contrast::Components::Interface
-      access_component :agent, :logging, :scope
+      include Contrast::Components::Logger::InstanceMethods
 
       attr_reader :ruleset, :context
 
       def initialize context
         @context = context
-        @ruleset = AGENT.ruleset
+        @ruleset = ::Contrast::AGENT.ruleset
       end
 
       def send_activity_messages

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'
@@ -7,7 +7,7 @@ require 'timeout'
 require 'contrast/utils/object_share'
 require 'contrast/utils/string_utils'
 require 'contrast/utils/hash_digest'
-require 'contrast/components/interface'
+require 'contrast/components/logger'
 
 module Contrast
   module Agent
@@ -16,8 +16,7 @@ module Contrast
     # data in a format that the Agent expects, caching those transformations in
     # order to avoid repeatedly creating Strings & thrashing GC.
     class Response
-      include Contrast::Components::Interface
-      access_component :logging
+      include Contrast::Components::Logger::InstanceMethods
 
       extend Forwardable
 

data/lib/contrast/agent/rewriter.rb

@@ -1,11 +1,14 @@
-# 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'
+require 'contrast/components/logger'
+require 'contrast/components/scope'
 require 'contrast/utils/ruby_ast_rewriter'
 
 module Contrast
@@ -17,8 +20,8 @@ module Contrast
     # @deprecated Changes to this class are discouraged as this approach is
     #   being phased out with support for those language versions.
     class Rewriter
-      include Contrast::Components::Interface
-      access_component :logging, :scope
+      extend Contrast::Components::Logger::InstanceMethods
+      extend Contrast::Components::Scope::InstanceMethods
 
       SELF_DEFINITION = 'def self.'
       DEFINITION = 'def '
@@ -57,13 +60,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 +241,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,13 +1,14 @@
-# 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/logger'
+
 module Contrast
   module Agent
     # This class is responsible for holding our ruleset and performing filtering operations on all
     # rules when asked by the middleware.
     class RuleSet < Set
-      include Contrast::Components::Interface
-      access_component :analysis, :logging
+      include Contrast::Components::Logger::InstanceMethods
 
       # The filtering that needs to happen before the application gets access to the request object.
       # The main action here is snapshotting the request as provided to the application from the
@@ -16,7 +17,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? || ::Contrast::PROTECT.enabled?
 
         logger.trace_with_time('Running prefilter...') do
           map { |rule| rule.prefilter(context) }
@@ -33,7 +34,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? || ::Contrast::PROTECT.enabled?
 
         logger.trace_with_time('Running postfilter...') do
           map { |rule| rule.postfilter(context) }