contrast-agent 4.8.0 → 4.9.0

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,7 +24,7 @@ module Contrast
         end
 
         def send_inventory_message
-          return unless INVENTORY.enabled?
+          return unless ::Contrast::INVENTORY.enabled?
 
           app_update_msg = Contrast::Api::Dtm::ApplicationUpdate.build
 

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!

data/lib/contrast/agent/version.rb

@@ -3,6 +3,6 @@
 
 module Contrast
   module Agent
-    VERSION = '4.8.0'
+    VERSION = '4.9.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,8 +9,7 @@ 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
 
@@ -22,7 +21,7 @@ module Contrast
 
         # 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
@@ -31,7 +30,7 @@ module Contrast
 
         # 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

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,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 Api
     module Communication
       # Handles local service startup
       module ServiceLifecycle
-        include Contrast::Components::Interface
-        access_component :logging, :contrast_service
+        include Contrast::Components::Logger::InstanceMethods
 
         def attempt_local_service_startup
           zombie_check
@@ -33,8 +34,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.'

data/lib/contrast/api/communication/speedracer.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'
 
 module Contrast
   module Api
@@ -9,8 +9,7 @@ module Contrast
       # Wraps all connection data to speedracer
       class Speedracer
         include Contrast::Api::Communication::ServiceLifecycle
-        include Contrast::Components::Interface
-        access_component :contrast_service, :logging, :app_context
+        include Contrast::Components::Logger::InstanceMethods
 
         attr_reader :status, :response_processor, :socket_client, :ensure_running
 
@@ -25,7 +24,7 @@ module Contrast
           return if status.connected?
 
           ensure_running.synchronize do
-            if CONTRAST_SERVICE.use_bundled_service?
+            if ::Contrast::CONTRAST_SERVICE.use_bundled_service?
               logger.info('Attempting to start local service')
               unless attempt_local_service_startup
                 logger.error('Failed to start local service')
@@ -70,7 +69,7 @@ module Contrast
         end
 
         def send_initialization_messages
-          agent_startup_msg = APP_CONTEXT.build_agent_startup_message
+          agent_startup_msg = ::Contrast::APP_CONTEXT.build_agent_startup_message
 
           logger.debug('Preparing to send startup messages')
           # 1 initial attempt, + 3 potential retries.
@@ -80,7 +79,7 @@ module Contrast
             next unless (agent_response = socket_client.send_one(agent_startup_msg))
 
             # Connection was successful; send app create with the resolved features.
-            app_startup_msg = APP_CONTEXT.build_app_startup_message
+            app_startup_msg = ::Contrast::APP_CONTEXT.build_app_startup_message
             log_send_event(app_startup_msg)
             app_response = socket_client.send_one(app_startup_msg)
 

data/lib/contrast/api/decorators/address.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require 'contrast/api/dtm.pb'
-require 'contrast/components/interface'
+require 'contrast/components/logger'
 require 'contrast/utils/string_utils'
 require 'contrast/utils/timer'
 
@@ -19,8 +19,7 @@ module Contrast
 
         # Used to add class methods to the ApplicationUpdate class on inclusion of the decorator
         module ClassMethods
-          include Contrast::Components::Interface
-          access_component :logging
+          include Contrast::Components::Logger::InstanceMethods
           # receiver is memoized because it is the address/host/port of the server, once we
           # resolve this for the first time, it shouldn't change
           #

data/lib/contrast/api/decorators/agent_startup.rb

@@ -2,8 +2,8 @@
 # frozen_string_literal: true
 
 require 'contrast/api/dtm.pb'
-require 'contrast/components/interface'
 require 'contrast/utils/string_utils'
+require 'contrast/components/base'
 
 module Contrast
   module Api
@@ -11,8 +11,6 @@ module Contrast
       # Used to decorate the AgentStartup protobuf model to handle reporting Agent process start
       module AgentStartup
         include Contrast::Components::ComponentBase
-        include Contrast::Components::Interface
-        access_component :analysis, :config
 
         def self.included klass
           klass.extend(ClassMethods)
@@ -33,7 +31,7 @@ module Contrast
             msg.server_path      = Contrast::Utils::StringUtils.protobuf_format path
             msg.server_type      = Contrast::Utils::StringUtils.protobuf_format type
             config!(msg)
-            msg.finding_tags = Contrast::Utils::StringUtils.protobuf_format ASSESS.tags
+            msg.finding_tags = Contrast::Utils::StringUtils.protobuf_format ::Contrast::ASSESS.tags
             msg
           end
 
@@ -43,11 +41,11 @@ module Contrast
           #
           # @param msg [Contrast::Api::Dtm::AgentStartup]
           def config! msg
-            msg.version          = Contrast::Utils::StringUtils.protobuf_format CONFIG.root.server.version
-            msg.environment      = Contrast::Utils::StringUtils.protobuf_format CONFIG.root.server.environment
-            msg.server_tags      = Contrast::Utils::StringUtils.protobuf_format CONFIG.root.server.tags
-            msg.application_tags = Contrast::Utils::StringUtils.protobuf_format CONFIG.root.application.tags
-            msg.library_tags     = Contrast::Utils::StringUtils.protobuf_format CONFIG.root.inventory.tags
+            msg.version          = Contrast::Utils::StringUtils.protobuf_format ::Contrast::CONFIG.root.server.version
+            msg.environment      = Contrast::Utils::StringUtils.protobuf_format ::Contrast::CONFIG.root.server.environment
+            msg.server_tags      = Contrast::Utils::StringUtils.protobuf_format ::Contrast::CONFIG.root.server.tags
+            msg.application_tags = Contrast::Utils::StringUtils.protobuf_format ::Contrast::CONFIG.root.application.tags
+            msg.library_tags     = Contrast::Utils::StringUtils.protobuf_format ::Contrast::CONFIG.root.inventory.tags
           end
         end
       end

data/lib/contrast/api/decorators/application_startup.rb

@@ -3,7 +3,7 @@
 
 require 'contrast/api/dtm.pb'
 require 'contrast/api/decorators/instrumentation_mode'
-require 'contrast/components/interface'
+require 'contrast/components/base'
 require 'contrast/utils/string_utils'
 
 module Contrast
@@ -12,8 +12,6 @@ module Contrast
       # Used to decorate the ApplicationCreate protobuf model to handle reporting Agent process start
       module ApplicationStartup
         include Contrast::Components::ComponentBase
-        include Contrast::Components::Interface
-        access_component :config
 
         def self.included klass
           klass.extend(ClassMethods)
@@ -26,11 +24,11 @@ module Contrast
           # @return [Contrast::Api::Dtm::ApplicationCreate]
           def build
             msg = new
-            msg.app_version      = Contrast::Utils::StringUtils.protobuf_format CONFIG.root.application.version.to_s
-            msg.code             = Contrast::Utils::StringUtils.protobuf_format CONFIG.root.application.code
-            msg.group            = Contrast::Utils::StringUtils.protobuf_format CONFIG.root.application.group
-            msg.metadata         = Contrast::Utils::StringUtils.protobuf_format CONFIG.root.application.metadata
-            msg.mode             = Contrast::Api::Dtm::InstrumentationMode.build
+            msg.app_version = Contrast::Utils::StringUtils.protobuf_format ::Contrast::CONFIG.root.application.version.to_s
+            msg.code        = Contrast::Utils::StringUtils.protobuf_format ::Contrast::CONFIG.root.application.code
+            msg.group       = Contrast::Utils::StringUtils.protobuf_format ::Contrast::CONFIG.root.application.group
+            msg.metadata    = Contrast::Utils::StringUtils.protobuf_format ::Contrast::CONFIG.root.application.metadata
+            msg.mode        = Contrast::Api::Dtm::InstrumentationMode.build
             session!(msg)
             msg
           end
@@ -42,10 +40,10 @@ module Contrast
           # @param msg [Contrast::Api::Dtm::ApplicationCreate]
           def session! msg
             msg.session_id = Contrast::Utils::StringUtils.protobuf_format(
-                CONFIG.root.application.session_id,
+                ::Contrast::CONFIG.root.application.session_id,
                 truncate: false)
             msg.session_metadata = Contrast::Utils::StringUtils.protobuf_format(
-                CONFIG.root.application.session_metadata,
+                ::Contrast::CONFIG.root.application.session_metadata,
                 truncate: false)
           end
         end