contrast-agent 3.10.1 → 3.12.2

data/lib/contrast/components/app_context.rb

@@ -16,32 +16,36 @@ module Contrast
         include Contrast::Components::ComponentBase
         include Contrast::Components::Interface
 
-        access_component :config
+        access_component :agent, :config
 
         DEFAULT_APP_NAME    = 'rails'
         DEFAULT_APP_PATH    = '/'
         DEFAULT_SERVER_NAME = 'localhost'
         DEFAULT_SERVER_PATH = '/'
 
-        def present? str
-          Contrast::Utils::EnvironmentUtil.present?(str)
+        def ready?
+          @_ready ||= AGENT.enabled? &&
+              Contrast::Utils::ServiceSenderUtil.connection_established? &&
+              Contrast::Utils::ServiceResponseUtil.update_received?
+        end
+
+        def initialize
+          original_pid
         end
 
         def server_type
           @_server_type ||= begin
                               tmp = CONFIG.root.server.type
-                              tmp = Contrast::Agent.framework_manager.server_type unless present?(tmp)
+                              tmp = Contrast::Agent.framework_manager.server_type unless Contrast::Utils::StringUtils.present?(tmp)
                               tmp
-                            rescue StandardError
-                              RACK_TYPE
                             end
         end
 
         def name
           @_name ||= begin
                        tmp = CONFIG.root.application.name
-                       tmp = Contrast::Agent.framework_manager.app_name unless present?(tmp)
-                       tmp = File.basename(Dir.pwd) unless present?(tmp)
+                       tmp = Contrast::Agent.framework_manager.app_name unless Contrast::Utils::StringUtils.present?(tmp)
+                       tmp = File.basename(Dir.pwd) unless Contrast::Utils::StringUtils.present?(tmp)
                        Contrast::Utils::StringUtils.truncate(tmp, DEFAULT_APP_NAME)
                      rescue StandardError
                        DEFAULT_APP_NAME
@@ -60,7 +64,7 @@ module Contrast
         def server_name
           @_server_name ||= begin
                               tmp = CONFIG.root.server.name
-                              tmp = Socket.gethostname unless present?(tmp)
+                              tmp = Socket.gethostname unless Contrast::Utils::StringUtils.present?(tmp)
                               tmp = Contrast::Utils::StringUtils.force_utf8(tmp)
                               Contrast::Utils::StringUtils.truncate(tmp, DEFAULT_SERVER_NAME)
                             rescue StandardError
@@ -71,7 +75,7 @@ module Contrast
         def server_path
           @_server_path ||= begin
                               tmp = CONFIG.root.server.path
-                              tmp = Dir.pwd unless present?(tmp)
+                              tmp = Dir.pwd unless Contrast::Utils::StringUtils.present?(tmp)
                               Contrast::Utils::StringUtils.truncate(tmp, DEFAULT_SERVER_PATH)
                             rescue StandardError
                               DEFAULT_SERVER_PATH
@@ -81,34 +85,27 @@ module Contrast
         def build_app_startup_message
           msg = Contrast::Api::Dtm::ApplicationCreate.new
 
-          app_ver = if CONFIG.root.application.version.to_s.empty?
-                      Contrast::Utils::EnvironmentUtil.determine_application_version
-                    else
-                      CONFIG.root.application.version
-                    end
-
-          msg.group            = protobuf_format CONFIG.root.application.group
-          msg.tags             = protobuf_format CONFIG.root.application.tags
-          msg.app_version      = protobuf_format app_ver
-          msg.code             = protobuf_format CONFIG.root.application.code
-          msg.metadata         = protobuf_format CONFIG.root.application.metadata
+          msg.group            = Contrast::Utils::StringUtils.protobuf_format CONFIG.root.application.group
+          msg.tags             = Contrast::Utils::StringUtils.protobuf_format CONFIG.root.application.tags
+          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.metadata         = Contrast::Utils::StringUtils.protobuf_format CONFIG.root.application.metadata
           # Other fields have limits in TeamServer, the rest don't.
-          msg.session_id       = protobuf_format CONFIG.root.application.session_id,        truncate: false
-          msg.session_metadata = protobuf_format CONFIG.root.application.session_metadata,  truncate: false
+          msg.session_id       = Contrast::Utils::StringUtils.protobuf_format CONFIG.root.application.session_id,        truncate: false
+          msg.session_metadata = Contrast::Utils::StringUtils.protobuf_format CONFIG.root.application.session_metadata,  truncate: false
 
           msg
         end
 
-        LOG_BUILD_STARTUP = 'build startup message'
         def build_agent_startup_message
           msg = Contrast::Api::Dtm::AgentStartup.new
-          msg.server_name    = protobuf_format server_name
-          msg.server_path    = protobuf_format server_path
-          msg.server_type    = protobuf_format server_type
+          msg.server_name    = Contrast::Utils::StringUtils.protobuf_format server_name
+          msg.server_path    = Contrast::Utils::StringUtils.protobuf_format server_path
+          msg.server_type    = Contrast::Utils::StringUtils.protobuf_format server_type
           msg.server_version = Contrast::Agent::VERSION
-          msg.version        = protobuf_format CONFIG.root.server.version
-          msg.environment    = protobuf_format CONFIG.root.server.environment
-          msg.tags           = protobuf_format CONFIG.root.server.tags
+          msg.version        = Contrast::Utils::StringUtils.protobuf_format CONFIG.root.server.version
+          msg.environment    = Contrast::Utils::StringUtils.protobuf_format CONFIG.root.server.environment
+          msg.tags           = Contrast::Utils::StringUtils.protobuf_format CONFIG.root.server.tags
           msg
         end
 
@@ -128,20 +125,30 @@ module Contrast
           @_client_id ||= [name, pgid].join('-')
         end
 
-        # TODO: RUBY-564: This responsibility should be extracted out of app_context and moved to
-        # the new component that handles one-time-whole-app initialization procedures.
         def instrument_middleware_stack?
           !Contrast::Utils::JobServersRunning.job_servers_running?
         end
 
+        def disabled_agent_rake_tasks
+          CONFIG.root.agent.ruby.disabled_agent_rake_tasks
+        end
+
+        # Determines if the Process we're currently in matches that of the
+        # Process in which the App Context instance was created.
+        # If it doesn't, that indicates the running context is in a new
+        # Process.
+        # @return [Boolean] if we're in the original Process in which the
+        #   App Context instance was initialized.
+        def in_new_process?
+          current_pid = Process.pid
+          original_pid = pid
+          current_pid != original_pid
+        end
+
         private
 
-        # TODO: RUBY-120, move this responsibility toward the protobuf object
-        def protobuf_format param, truncate: true
-          param = param&.to_s
-          param = Contrast::Utils::StringUtils.force_utf8(param)
-          param = Contrast::Utils::StringUtils.truncate(param) if truncate
-          param
+        def original_pid
+          @_original_pid ||= Process.pid
         end
       end
 

data/lib/contrast/components/assess.rb

@@ -12,12 +12,14 @@ module Contrast
         include Contrast::Components::ComponentBase
         include Contrast::Components::Interface
 
-        access_component :settings
+        access_component :config, :settings
 
         def enabled?
-          return false unless defined?(Contrast::Agent::FeatureState)
+          # config overrides if forcibly set
+          return false if forcibly_disabled?
+          return true  if forcibly_enabled?
 
-          state.assess_enabled?
+          SETTINGS.assess_enabled?
         end
 
         def tainted_columns
@@ -25,39 +27,47 @@ module Contrast
         end
 
         def forcibly_disabled?
-          state.assess_forcibly_disabled?
+          @_forcibly_disabled = false?(CONFIG.root.assess.enable) if @_forcibly_disabled.nil?
+          @_forcibly_disabled
         end
 
         def rule_disabled? name
-          state.assess_rule_disabled? name
-        end
-
-        def disabled_rules
-          state.assess_disabled_rules
+          disabled_rules.include?(name)
         end
 
         def scan_response?
-          state.scan_response?
+          @_scan_response = !false?(CONFIG.root.assess.enable_scan_response) if @_scan_response.nil?
+          @_scan_response
         end
 
         def track_frozen_sources?
-          state.assess_track_frozen_sources?
+          @_track_frozen_sources = !false?(CONFIG.root.agent.ruby.track_frozen_sources) if @_track_frozen_sources.nil?
+          @_track_frozen_sources
         end
 
         def require_scan?
-          state.require_scanning_enabled?
+          @_require_scan = !false?(CONFIG.root.agent.ruby.require_scan) if @_require_scan.nil?
+          @_require_scan
         end
 
         def tags
-          state.assess_tags
+          CONFIG.root.assess&.tags
         end
 
         def rules
           SETTINGS.assess_rules
         end
 
-        def rule name
-          SETTINGS.assess_rules[name]
+        private
+
+        def forcibly_enabled?
+          @_forcibly_enabled = true?(CONFIG.root.assess.enable) if @_forcibly_enabled.nil?
+          @_forcibly_enabled
+        end
+
+        def disabled_rules
+          # TODO: RUBY-903
+          CONFIG.root.assess&.rules&.disabled_rules || SETTINGS.disabled_assess_rules || []
         end
       end
 

data/lib/contrast/components/config.rb

@@ -23,8 +23,7 @@ module Contrast
     # it should break LOUDLY.  Better to waste half an hour of the sysadmin's
     # time than to silently fail to deliver functionality.
     module Config
-      LOG_CONFIGURATION_DISABLED = 'Contrast disabled by configuration. Continuing without instrumentation.'
-      CONTRAST_ENV_MARKER        = 'CONTRAST__'
+      CONTRAST_ENV_MARKER = 'CONTRAST__'
 
       class Interface # :nodoc:
         def initialize
@@ -51,7 +50,8 @@ module Contrast
         end
 
         def enabled?
-          Contrast::Utils::BooleanUtil.true?(raw.enable)
+          @_enabled = !Contrast::Utils::BooleanUtil.false?(raw.enable) if @_enabled.nil?
+          @_enabled
         end
 
         def disabled?
@@ -59,11 +59,13 @@ module Contrast
         end
 
         def protect?
-          Contrast::Utils::BooleanUtil.true?(raw.protect.enable)
+          @_protect = Contrast::Utils::BooleanUtil.true?(raw.protect.enable) if @_protect.nil?
+          @_protect
         end
 
         def assess?
-          Contrast::Utils::BooleanUtil.true?(raw.assess.enable)
+          @_assess = Contrast::Utils::BooleanUtil.true?(raw.assess.enable) if @_assess.nil?
+          @_assess
         end
 
         def session_id

data/lib/contrast/components/contrast_service.rb

@@ -15,22 +15,24 @@ module Contrast
         include Contrast::Components::ComponentBase
         include Contrast::Components::Interface
 
-        access_component :config, :agent
+        DEFAULT_SERVICE_LOG = 'contrast_service.log'
+        # The Rails ActionDispatch regexp for localhost IP + literal localhost
+        # https://github.com/rails/rails/blob/master/actionpack/lib/action_dispatch/http/request.rb#L32
+        LOCALHOST = Regexp.union [/^127\.\d{1,3}\.\d{1,3}\.\d{1,3}$/, /^::1$/, /^0:0:0:0:0:0:0:1(%.*)?$/, /^localhost$/]
 
-        def update_received?
-          state.update_received?
-        end
-
-        def enabled?
-          state.service_enabled?
-        end
-
-        def unavailable?
-          !enabled?
-        end
+        access_component :agent, :config
 
-        def disabled?
-          state.service_forcibly_disabled?
+        def use_bundled_service?
+          # Validates the config to decide if it's suitable for starting
+          # the bundled service
+          @_use_bundled_service ||= begin
+                                      # Requirement says "must be true" but that
+                                      # should be "must not be false" -- oops.
+                                      !false?(CONFIG.root.agent.start_bundled_service) &&
+                                          # Either a valid host or a valid socket
+                                          # Path validity is the service's problem
+                                          (LOCALHOST.match?(host) || !!socket_path)
+                                    end
         end
 
         def host
@@ -38,76 +40,26 @@ module Contrast
         end
 
         def port
-          @_port ||= (CONFIG.root.agent.service.port || Contrast::Configuration::DEFAULT_PORT).to_i
+          @_port ||= (CONFIG.root.agent.service.port || DEFAULT_PORT).to_i
         end
 
         def socket_path
           @_socket_path ||= CONFIG.root.agent.service.socket
         end
 
-        def logger_path
-          @_logger_path ||= CONFIG.root.agent.service.logger.path || DEFAULT_LOG_FILENAME
-        end
-
         def use_tcp?
           socket_path.nil?
         end
 
-        def last_update
-          state.last_update
-        end
-
-        def use_bundled_service?
-          # Validates the config to decide if it's suitable for starting
-          # the bundled service
-          @_use_bundled_service ||= begin
-                                      # Requirement says "must be true" but that
-                                      # should be "must not be false" -- oops.
-                                      !false?(CONFIG.root.agent.start_bundled_service) &&
-                                          # Either a valid host or a valid socket
-                                          ((CONFIG.root.agent.service.host.nil? ||
-                                          CONFIG.root.agent.service.host == 'localhost' ||
-                                          CONFIG.root.agent.service.host == '127.0.0.1') ||
-                                          # Path validity is the service's problem
-                                          !!CONFIG.root.agent.service.socket)
-                                    end
-        end
-
-        # TODO: As part of RUBY-356. Add new handling for SQL analysis via RPC (SPEED-211)
-
-        # The API for Agent to Service communication. These methods abstract away implementation
-        # details, responsibilities of sending messages to the service, and requirements mandated
-        # within the Agent<>SpeedRacer contract.
-
-        # Pushes a message onto a queue to later be consumed when the service sender thread is ready to
-        # handle it. The service response is not returned; rather, it is processed by the service sender
-        # thread. All messages sent to SpeedRacer should be queued rather than sent unless the calling method
-        # explicitly needs to act on the response object with custom logic (i.e. RequestContext#service_extract_response)
-        #
-        # @param event [Contrast::Api::Dtm] One of the DTMs valid for the event
-        #  field of Contrast::Api::Dtm::Message
-        # TODO: rename method to queue_event
-        def queue_message event
-          return unless event
-
-          Contrast::Utils::ServiceSenderUtil.push_to_ready_queue(event)
+        def logger_path
+          @_logger_path ||= CONFIG.root.agent.service.logger.path || DEFAULT_SERVICE_LOG
         end
 
-        # TODO: RUBY-662. Add additional check before we queue/send a message to see if we were unable
-        # to connect to the service.
+        private
 
-        # Bypass the queue and send the message directly to SpeedRacer. This is the only way
-        # to receive the response object back from SpeedRacer. An invoking method that needs
-        # to process the response object with custom logic should use this method.
-        #
-        # @param event [Contrast::Api::Dtm] One of the DTMs valid for the event
-        #   field of Contrast::Api::Dtm::Message
-        # @return [Array<Contrast::Api::Dtm::AttackResult>] the response from SpeedRacer
-        # TODO: rename method to send_event
-        def send_message event
-          return unless event
-
-          state.client.send_to_speedracer(event)
+        def disabled?
+          @_disabled = false?(CONFIG.root.agent.start_bundled_service) if @_disabled.nil?
+          @_disabled
         end
       end
 

data/lib/contrast/components/heap_dump.rb

@@ -16,17 +16,21 @@ module Contrast
         access_component :config
 
         def heap_dump_enabled?
-          state.heap_dump_enabled?
+          heap_dump_control[:enabled]
         end
 
         def heap_dump_control
-          {
-              path: File.absolute_path(CONFIG.root.agent.heap_dump.path),
-              count: CONFIG.root.agent.heap_dump.count.to_i,
-              window: CONFIG.root.agent.heap_dump.window_ms.to_f / 1000,
-              delay: CONFIG.root.agent.heap_dump.delay_ms.to_f / 1000,
-              clean: true?(CONFIG.root.agent.heap_dump.clean)
-          }
+          @_heap_dump_control ||= begin
+            config = CONFIG.root&.agent&.heap_dump
+            {
+                enabled: true?(config&.enable),
+                path: File.absolute_path(config&.path),
+                count: config&.count.to_i || 0,
+                window: (config&.window_ms.to_f || 0) / 1000,
+                delay: (config&.delay_ms.to_f || 0) / 1000,
+                clean: true?(config&.clean)
+            }
+          end
         end
       end
     end

data/lib/contrast/components/interface.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 cs__scoped_require 'delegate'
-cs__scoped_require 'contrast/extensions/ruby_core/module'
+cs__scoped_require 'contrast/extension/module'
 cs__scoped_require 'contrast/utils/boolean_util'
 
 module Contrast
@@ -56,14 +56,6 @@ module Contrast
         def true? config_param
           Contrast::Utils::BooleanUtil.true?(config_param)
         end
-
-        # TODO: RUBY-536
-        private
-
-        def _state_shim
-          Contrast::Agent::FeatureState.instance
-        end
-        alias_method :state, :_state_shim
       end
     end
 
@@ -97,7 +89,7 @@ module Contrast
       #
       # class Abc
       #   include Contrast::Components::Interface
-      #   access_component :logger, :agent
+      #   access_component :logging, :agent
       #
       #   def function
       #     if AGENT.disabled?
@@ -151,27 +143,28 @@ Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:config] =
 cs__scoped_require 'contrast/components/settings'
 Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:settings] = [Contrast::Components::Settings]
 
+cs__scoped_require 'contrast/components/assess'
+cs__scoped_require 'contrast/components/protect'
+cs__scoped_require 'contrast/components/inventory'
+Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:analysis] = [Contrast::Components::Protect,
+                                                                                   Contrast::Components::Assess,
+                                                                                   Contrast::Components::Inventory]
+
+cs__scoped_require 'contrast/components/logger'
+Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:logging] = [Contrast::Components::Logger]
+
 cs__scoped_require 'contrast/components/agent'
 Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:agent] = [Contrast::Components::Agent]
 
-cs__scoped_require 'contrast/components/app_context'
-Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:app_context] = [Contrast::Components::AppContext]
-
 cs__scoped_require 'contrast/components/contrast_service'
 Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:contrast_service] = [Contrast::Components::ContrastService]
 
+cs__scoped_require 'contrast/components/app_context'
+Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:app_context] = [Contrast::Components::AppContext]
+
 cs__scoped_require 'contrast/components/heap_dump'
 Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:heap_dump] = [Contrast::Components::HeapDump]
 
-cs__scoped_require 'contrast/components/logger'
-Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:logging] = [Contrast::Components::Logger]
-
-cs__scoped_require 'contrast/components/assess'
-cs__scoped_require 'contrast/components/protect'
-cs__scoped_require 'contrast/components/inventory'
-Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:analysis] = [Contrast::Components::Protect,
-                                                                                   Contrast::Components::Assess,
-                                                                                   Contrast::Components::Inventory]
 cs__scoped_require 'contrast/components/sampling'
 Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:sampling] = [Contrast::Components::Sampling]