contrast-agent 4.7.0 → 4.10.0

data/lib/contrast/agent/request_handler.rb

@@ -1,20 +1,22 @@
 # 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

@@ -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

@@ -7,7 +7,8 @@ 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
@@ -19,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 '

data/lib/contrast/agent/rule_set.rb

@@ -1,13 +1,14 @@
 # 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) }

data/lib/contrast/agent/service_heartbeat.rb

@@ -1,7 +1,7 @@
 # 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/components/logger'
 require 'contrast/agent/worker_thread'
 
 module Contrast
@@ -9,8 +9,7 @@ module Contrast
     # The ServiceHeartbeat functions to keep the Contrast Service alive and
     # ensure that it maintains this Agent's ApplicationContext.
     class ServiceHeartbeat < WorkerThread
-      include Contrast::Components::Interface
-      access_component :logging
+      include Contrast::Components::Logger::InstanceMethods
 
       # Spec recommends 30 seconds, we're going with 15.
       REFRESH_INTERVAL_SEC = 15

data/lib/contrast/agent/static_analysis.rb

@@ -1,8 +1,8 @@
 # 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/inventory'
+require 'contrast/components/logger'
+require 'contrast/components/scope'
 require 'contrast/api/decorators/application_update'
 
 module Contrast
@@ -10,8 +10,9 @@ module Contrast
     # this module handles one time static analysis tasks
     class StaticAnalysis
       include Singleton
-      include Contrast::Components::Interface
-      access_component :logging, :analysis, :scope
+      include Contrast::Components::Logger::InstanceMethods
+      include Contrast::Components::Scope::InstanceMethods
+
       class << self
         # After the first request is complete, we do a one-time manual catchup to review and
         # report the already-loaded gems.
@@ -23,11 +24,11 @@ module Contrast
         end
 
         def send_inventory_message
-          return unless INVENTORY.enabled?
+          return unless ::Contrast::INVENTORY.enabled?
 
           app_update_msg = Contrast::Api::Dtm::ApplicationUpdate.build
 
-          Contrast::Utils::InventoryUtil.append_db_config(app_update_msg)
+          Contrast::Agent::Inventory::DatabaseConfig.append_db_config(app_update_msg)
           Contrast::Agent.messaging_queue.send_event_eventually(app_update_msg)
         end
 

data/lib/contrast/agent/thread.rb

@@ -1,15 +1,13 @@
 # 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/components/scope'
 
 module Contrast
   module Agent
     # Threads used by Contrast. Any long running thread should be created and managed by our ThreadWatcher class.
     class Thread < ::Thread
-      include Contrast::Components::Interface
-
-      access_component :scope
+      include Contrast::Components::Scope::InstanceMethods
 
       # Make our internal code run in Contrast scope.
       def initialize *args

data/lib/contrast/agent/thread_watcher.rb

@@ -1,7 +1,7 @@
 # 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/components/logger'
 require 'contrast/agent/service_heartbeat'
 require 'contrast/api/communication/messaging_queue'
 
@@ -13,8 +13,7 @@ module Contrast
     # @attr_reader heartbeat [Contrast::Agent::ServiceHeartbeat]
     # @attr_reader messaging_queue [Contrast::Api::Communication::MessagingQueue]
     class ThreadWatcher
-      include Contrast::Components::Interface
-      access_component :agent, :logging
+      include Contrast::Components::Logger::InstanceMethods
 
       attr_reader :heapdump_util, :heartbeat, :messaging_queue
 
@@ -26,7 +25,7 @@ module Contrast
       end
 
       def startup!
-        return unless AGENT.enabled?
+        return unless ::Contrast::AGENT.enabled?
 
         unless heartbeat.running?
           logger.debug('Attempting to start heartbeat thread')

data/lib/contrast/agent/tracepoint_hook.rb

@@ -1,15 +1,15 @@
 # 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/components/logger'
+require 'contrast/components/scope'
 
 module Contrast
   module Agent
     # This module is used to apply instrumentation to classes as they are required
     module TracePointHook
-      include Contrast::Components::Interface
-
-      access_component :logging, :scope
+      extend Contrast::Components::Logger::InstanceMethods
+      extend Contrast::Components::Scope::InstanceMethods
 
       class << self
         def enable!
@@ -35,10 +35,15 @@ module Contrast
             path = tracepoint_event.path
             return if path&.include?('contrast')
 
+            Contrast::Agent.framework_manager.register_late_framework(loaded_module)
             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) if RUBY_VERSION < '2.6.0' # TODO: RUBY-714 remove guard w/ EOL of 2.5
+            if RUBY_VERSION < '2.6.0' # TODO: RUBY-714 remove guard w/ EOL of 2.5
+              Contrast::Agent::Assess::Policy::RewriterPatch.rewrite_interpolation(loaded_module)
+            end
             Contrast::Agent::Assess::Policy::PolicyScanner.scan(tracepoint_event)
+          rescue StandardError => e
+            logger.error('Unable to complete TracePoint analysis', e, module: loaded_module)
           end
         end
       end

data/lib/contrast/agent/version.rb

@@ -3,6 +3,6 @@
 
 module Contrast
   module Agent
-    VERSION = '4.7.0'
+    VERSION = '4.10.0'
   end
 end

data/lib/contrast/api/communication/messaging_queue.rb

@@ -1,7 +1,7 @@
 # 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/components/logger'
 require 'contrast/agent/worker_thread'
 
 module Contrast
@@ -9,29 +9,31 @@ module Contrast
     module Communication
       # Top level gateway to messaging with speedracer
       class MessagingQueue < Contrast::Agent::WorkerThread
-        include Contrast::Components::Interface
-        access_component :agent, :analysis, :logging, :settings
+        include Contrast::Components::Logger::InstanceMethods
 
-        attr_reader :queue, :speedracer
+        attr_reader :speedracer
 
         def initialize
-          @queue = Queue.new
           @speedracer = Contrast::Api::Communication::Speedracer.new
           super
         end
 
         # Use this to bypass the messaging queue and leave response processing to the caller
         def send_event_immediately event
-          if AGENT.disabled?
+          if ::Contrast::AGENT.disabled?
             logger.warn('Attempted to send event immediately with Agent disabled', caller: caller, event: event)
             return
           end
           speedracer.return_response(event)
         end
 
+        def queue
+          @_queue ||= Queue.new
+        end
+
         # Use this to add a message to the queue and process the response internally
         def send_event_eventually event
-          if AGENT.disabled?
+          if ::Contrast::AGENT.disabled?
             logger.warn('Attempted to queue event with Agent disabled', caller: caller, event: event)
             return
           end
@@ -43,7 +45,6 @@ module Contrast
           speedracer.ensure_startup!
           return if running?
 
-          @queue ||= Queue.new
           @_thread = Contrast::Agent::Thread.new do
             loop do
               event = queue.pop
@@ -59,13 +60,17 @@ module Contrast
           logger.debug('Started background sending thread.')
         end
 
+        def delete_queue!
+          @_queue&.clear
+          @_queue&.close
+          @_queue = nil
+        end
+
         def stop!
           return unless running?
 
           super
-          @queue&.clear
-          @queue&.close
-          @queue = nil
+          delete_queue!
         end
       end
     end

data/lib/contrast/api/communication/response_processor.rb

@@ -2,14 +2,14 @@
 # frozen_string_literal: true
 
 require 'contrast/agent/reaction_processor'
+require 'contrast/components/logger'
 
 module Contrast
   module Api
     module Communication
       # Handles processing deferred messages
       class ResponseProcessor
-        include Contrast::Components::Interface
-        access_component :agent, :analysis, :logging, :settings
+        include Contrast::Components::Logger::InstanceMethods
 
         # @param response [Contrast::Api::Settings::AgentSettings]
         def process response
@@ -24,8 +24,8 @@ module Contrast
 
           Contrast::Logger::Log.instance.update(server_features&.log_file, server_features&.log_level)
           update_features(server_features, app_settings)
-          logger.trace('Agent settings updated in response to Service', protect_on: PROTECT.enabled?,
-                                                                        assess_on: ASSESS.enabled?)
+          logger.trace('Agent settings updated in response to Service', protect_on: ::Contrast::PROTECT.enabled?,
+                                                                        assess_on: ::Contrast::ASSESS.enabled?)
         end
 
         private
@@ -40,7 +40,7 @@ module Contrast
 
           logger.trace('Agent: Received updated server features')
 
-          SETTINGS.update_from_server_features(server_features)
+          ::Contrast::SETTINGS.update_from_server_features(server_features)
 
           server_features
         end
@@ -55,7 +55,7 @@ module Contrast
 
           logger.debug('Agent: Received updated application settings')
 
-          SETTINGS.update_from_application_settings(app_settings)
+          ::Contrast::SETTINGS.update_from_application_settings(app_settings)
 
           app_settings
         end
@@ -64,16 +64,16 @@ module Contrast
         # I don't think it should go into contrast_service because that only handles connection specific data
         def update_features server_features, app_settings
           return unless !!(server_features || app_settings)
-          return unless AGENT.enabled?
+          return unless ::Contrast::AGENT.enabled?
 
           logger.trace_with_time('Rebuilding rule modes') do
-            SETTINGS.build_protect_rules if PROTECT.enabled?
-            AGENT.reset_ruleset
+            ::Contrast::SETTINGS.build_protect_rules if ::Contrast::PROTECT.enabled?
+            ::Contrast::AGENT.reset_ruleset
 
             logger.info('Current rule settings:')
 
-            PROTECT.rules.each { |k, v| logger.info('Protect Rule mode set', rule: k, mode: v.mode) }
-            logger.info('Disabled Assess Rules', rules: ASSESS.disabled_rules)
+            ::Contrast::PROTECT.rules.each { |k, v| logger.info('Protect Rule mode set', rule: k, mode: v.mode) }
+            logger.info('Disabled Assess Rules', rules: ::Contrast::ASSESS.disabled_rules)
           end
         end
       end

data/lib/contrast/api/communication/service_lifecycle.rb

@@ -1,13 +1,17 @@
 # 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 Api
     module Communication
-      # Handles local service startup
+      # Handles local service startup. As this should only ever be invoked by the Speedracer class, which includes
+      # this, all methods here are private.
       module ServiceLifecycle
-        include Contrast::Components::Interface
-        access_component :logging, :contrast_service
+        include Contrast::Components::Logger::InstanceMethods
+
+        private
 
         def attempt_local_service_startup
           zombie_check
@@ -33,8 +37,8 @@ module Contrast
         end
 
         def determine_startup_options
-          return { out: :out, err: :out } if CONTRAST_SERVICE.logger_path == 'STDOUT'
-          return { out: :err, err: :err } if CONTRAST_SERVICE.logger_path == 'STDERR'
+          return { out: :out, err: :out } if ::Contrast::CONTRAST_SERVICE.logger_path == 'STDOUT'
+          return { out: :err, err: :err } if ::Contrast::CONTRAST_SERVICE.logger_path == 'STDERR'
 
           { out: File::NULL, err: File::NULL }
         end

data/lib/contrast/api/communication/socket_client.rb

@@ -6,7 +6,7 @@ require 'uri'
 
 require 'contrast/api/communication/tcp_socket'
 require 'contrast/api/communication/unix_socket'
-require 'contrast/components/interface'
+require 'contrast/components/logger'
 
 module Contrast
   module Api
@@ -14,8 +14,7 @@ module Contrast
       # SocketClient acts as a interface between the agent and the service. It instantiates a
       # service proxy and tracks the state of that proxy.
       class SocketClient
-        include Contrast::Components::Interface
-        access_component :config, :contrast_service, :logging
+        include Contrast::Components::Logger::InstanceMethods
 
         def initialize
           @socket = init_connection
@@ -36,29 +35,34 @@ module Contrast
 
         def init_connection
           log_connection
-          if CONTRAST_SERVICE.use_tcp?
-            Contrast::Api::Communication::TcpSocket.new(CONTRAST_SERVICE.host, CONTRAST_SERVICE.port)
+          if ::Contrast::CONTRAST_SERVICE.use_tcp?
+            Contrast::Api::Communication::TcpSocket.new(
+                ::Contrast::CONTRAST_SERVICE.host, ::Contrast::CONTRAST_SERVICE.port)
           else
-            Contrast::Api::Communication::UnixSocket.new(CONTRAST_SERVICE.socket_path)
+            Contrast::Api::Communication::UnixSocket.new(::Contrast::CONTRAST_SERVICE.socket_path)
           end
         end
 
         def log_connection
           # The socket is set,
-          if CONFIG.root.agent.service.socket
+          if ::Contrast::CONFIG.root.agent.service.socket
             logger.info('Connecting to the Contrast Service using a UnixSocket socket',
-                        socket: CONTRAST_SERVICE.socket_path)
+                        socket: ::Contrast::CONTRAST_SERVICE.socket_path)
             return
           end
           # The host & port are set,
-          if CONFIG.root.agent.service.host && CONFIG.root.agent.service.port
-            logger.info('Connecting to the Contrast Service using a TCP socket', host: CONTRAST_SERVICE.host,
-                                                                                 port: CONTRAST_SERVICE.port)
+          if ::Contrast::CONFIG.root.agent.service.host && ::Contrast::CONFIG.root.agent.service.port
+            logger.info('Connecting to the Contrast Service using a TCP socket',
+                        host: ::Contrast::CONTRAST_SERVICE.host,
+                        port: ::Contrast::CONTRAST_SERVICE.port)
             return
           end
 
           # Or something is not set.
-          logger.warn(log_connection_error_msg, host: CONTRAST_SERVICE.host, port: CONTRAST_SERVICE.port)
+          logger.warn(
+              log_connection_error_msg,
+              host: ::Contrast::CONTRAST_SERVICE.host,
+              port: ::Contrast::CONTRAST_SERVICE.port)
         end
 
         # If our connection isn't built properly, we need to warn the user. This builds out the context specific
@@ -66,11 +70,11 @@ module Contrast
         #
         # @return [String]
         def log_connection_error_msg
-          if CONFIG.root.agent.service.host
+          if ::Contrast::CONFIG.root.agent.service.host
             'Missing a required connection value to the Contrast Service. ' \
             '`agent.service.port` is not set. ' \
             'Falling back to default TCP socket port.'
-          elsif CONFIG.root.agent.service.port
+          elsif ::Contrast::CONFIG.root.agent.service.port
             'Missing a required connection value to the Contrast Service. ' \
             '`agent.service.host` is not set. ' \
             'Falling back to default TCP socket host.'