contrast-agent 3.13.1 → 4.0.0

data/lib/contrast/components/config.rb

@@ -1,10 +1,8 @@
 # Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
-cs__scoped_require 'contrast/utils/boolean_util'
-cs__scoped_require 'contrast/utils/env_configuration_item'
-cs__scoped_require 'contrast/utils/object_share'
-cs__scoped_require 'contrast/configuration'
+require 'contrast/utils/env_configuration_item'
+require 'contrast/configuration'
 
 module Contrast
   module Components
@@ -34,47 +32,14 @@ module Contrast
         def build log: true
           @_valid = nil
           @config = Contrast::Configuration.new
-          defaults
-          overrides
+          env_overrides
           validate(log: log)
         end
         alias_method :rebuild, :build
 
-        # Prefer abstraction, but use #raw if you need.
-        # grep 'CONFIG.raw' for opportunities to refactor.
-        def raw
-          @config
-        end
-
+        # @return [Contrast::Config::RootConfiguration]
         def root
-          raw.root
-        end
-
-        def enabled?
-          @_enabled = !Contrast::Utils::BooleanUtil.false?(raw.enable) if @_enabled.nil?
-          @_enabled
-        end
-
-        def disabled?
-          !enabled?
-        end
-
-        def protect?
-          @_protect = Contrast::Utils::BooleanUtil.true?(raw.protect.enable) if @_protect.nil?
-          @_protect
-        end
-
-        def assess?
-          @_assess = Contrast::Utils::BooleanUtil.true?(raw.assess.enable) if @_assess.nil?
-          @_assess
-        end
-
-        def session_id
-          @_session_id ||= raw.application.session_id || Contrast::Utils::ObjectShare::EMPTY_STRING
-        end
-
-        def session_metadata
-          @_session_metadata ||= raw.application.session_metadata || Contrast::Utils::ObjectShare::EMPTY_STRING
+          @config.root
         end
 
         def valid?
@@ -85,6 +50,10 @@ module Contrast
           !valid?
         end
 
+        def loggable
+          @config.loggable
+        end
+
         private
 
         SESSION_VARIABLES = "Invalid configuration. Setting both application.session_id and application.session_metadata is not allowed.\n"
@@ -105,15 +74,6 @@ module Contrast
           true
         end
 
-        def defaults
-          raw.agent.service.host ||= Contrast::Configuration::DEFAULT_HOST
-          raw.agent.service.port ||= Contrast::Configuration::DEFAULT_PORT
-        end
-
-        def overrides
-          env_overrides
-        end
-
         def env_overrides
           # For env variables resembling CONTRAST__WHATEVER__NESTED_VALUE
           # override raw.whatever.nested_value
@@ -121,9 +81,31 @@ module Contrast
             next unless env_key.to_s.start_with?(CONTRAST_ENV_MARKER)
 
             config_item = Contrast::Utils::EnvConfigurationItem.new(env_key, env_value)
-            raw.assign_value_to_path_array(config_item.dot_path_array, config_item.value)
+            @config.assign_value_to_path_array(config_item.dot_path_array, config_item.value)
           end
         end
+
+        # Typically, this would be accessed through
+        # Contrast::Components::AppContext, but we're too early in the
+        # initialization of the Agent to use that mechanism, so we look it up
+        # directly for ourselves
+        #
+        # @return [String,nil] the value of the session id set in the
+        #   configuration, or nil if unset
+        def session_id
+          @config.application.session_id
+        end
+
+        # Typically, this would be accessed through
+        # Contrast::Components::AppContext, but we're too early in the
+        # initialization of the Agent to use that mechanism, so we look it up
+        # directly for ourselves
+        #
+        # @return [String,nil] the value of the session metadata set in the
+        #   configuration, or nil if unset
+        def session_metadata
+          @config.application.session_metadata
+        end
       end
 
       COMPONENT_INTERFACE = Interface.new

data/lib/contrast/components/contrast_service.rb

@@ -1,7 +1,7 @@
 # Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
-cs__scoped_require 'monitor'
+require 'monitor'
 
 module Contrast
   module Components
@@ -26,21 +26,21 @@ module Contrast
           # 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
+            # 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
-          @_host ||= (CONFIG.root.agent.service.host || Contrast::Configuration::DEFAULT_HOST).to_s
+          @_host ||= (CONFIG.root.agent.service.host || Contrast::Config::ServiceConfiguration::DEFAULT_HOST).to_s
         end
 
         def port
-          @_port ||= (CONFIG.root.agent.service.port || DEFAULT_PORT).to_i
+          @_port ||= (CONFIG.root.agent.service.port || Contrast::Config::ServiceConfiguration::DEFAULT_PORT).to_i
         end
 
         def socket_path

data/lib/contrast/components/interface.rb

@@ -1,9 +1,9 @@
 # Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
-cs__scoped_require 'delegate'
-cs__scoped_require 'contrast/extension/module'
-cs__scoped_require 'contrast/utils/boolean_util'
+require 'delegate'
+require 'contrast/extension/module'
+require 'contrast/utils/object_share'
 
 module Contrast
   # This is the base module for our components classes. It is intended to
@@ -49,12 +49,34 @@ module Contrast
       end
 
       module Methods # :nodoc:
+        # use this to determine if the configuration value is literally boolean
+        # false or some form of the word `false`, regardless of case. It should
+        # be used for those values which default to `true` as they should only
+        # treat a value explicitly set to `false` as such.
+        #
+        # @param config_param [Boolean,String] the value to check
+        # @return [Boolean] should the value be treated as `false`
         def false? config_param
-          Contrast::Utils::BooleanUtil.false?(config_param)
+          return false if config_param == true
+          return true if config_param == false
+          return false unless config_param.cs__is_a?(String)
+
+          Contrast::Utils::ObjectShare::FALSE.casecmp?(config_param)
         end
 
+        # use this to determine if the configuration value is literally boolean
+        # true or some form of the word `true`, regardless of case. It should
+        # be used for those values which default to `false` as they should only
+        # treat a value explicitly set to `true` as such.
+        #
+        # @param config_param [Boolean,String] the value to check
+        # @return [Boolean] should the value be treated as `true`
         def true? config_param
-          Contrast::Utils::BooleanUtil.true?(config_param)
+          return false if config_param == false
+          return true if config_param == true
+          return false unless config_param.cs__is_a?(String)
+
+          Contrast::Utils::ObjectShare::TRUE.casecmp?(config_param)
         end
       end
     end
@@ -132,40 +154,40 @@ end
 # directed acyclic graph.
 
 # Scope shouldn't depend on anything.
-cs__scoped_require 'contrast/components/scope'
+require 'contrast/components/scope'
 Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:scope] = [Contrast::Components::Scope]
 
 # Config depends on Scope.
-cs__scoped_require 'contrast/components/config'
+require 'contrast/components/config'
 Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:config] = [Contrast::Components::Config]
 
 # Settings should not depend on anything but Config.
-cs__scoped_require 'contrast/components/settings'
+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'
+require 'contrast/components/assess'
+require 'contrast/components/protect'
+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'
+require 'contrast/components/logger'
 Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:logging] = [Contrast::Components::Logger]
 
-cs__scoped_require 'contrast/components/agent'
+require 'contrast/components/agent'
 Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:agent] = [Contrast::Components::Agent]
 
-cs__scoped_require 'contrast/components/contrast_service'
+require 'contrast/components/contrast_service'
 Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:contrast_service] = [Contrast::Components::ContrastService]
 
-cs__scoped_require 'contrast/components/app_context'
+require 'contrast/components/app_context'
 Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:app_context] = [Contrast::Components::AppContext]
 
-cs__scoped_require 'contrast/components/heap_dump'
+require 'contrast/components/heap_dump'
 Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:heap_dump] = [Contrast::Components::HeapDump]
 
-cs__scoped_require 'contrast/components/sampling'
+require 'contrast/components/sampling'
 Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:sampling] = [Contrast::Components::Sampling]
 
 Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP.cs__freeze

data/lib/contrast/components/inventory.rb

@@ -13,12 +13,17 @@ module Contrast
         include Contrast::Components::ComponentBase
         include Contrast::Components::Interface
 
-        access_component :config
+        access_component :config, :settings
 
         def enabled?
           @_enabled = !false?(CONFIG.root.inventory.enable) if @_enabled.nil?
           @_enabled
         end
+
+        def analyze_libraries?
+          @_analyze_libraries = !false?(CONFIG.root.inventory.analyze_libraries) if @_analyze_libraries.nil?
+          @_analyze_libraries
+        end
       end
 
       COMPONENT_INTERFACE = Interface.new

data/lib/contrast/components/logger.rb

@@ -1,7 +1,7 @@
 # Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
-cs__scoped_require 'contrast/logger/log'
+require 'contrast/logger/log'
 
 module Contrast
   module Components

data/lib/contrast/components/scope.rb

@@ -1,9 +1,9 @@
 # Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
-cs__scoped_require 'fiber'
-cs__scoped_require 'monitor'
-cs__scoped_require 'contrast/agent/scope'
+require 'fiber'
+require 'monitor'
+require 'contrast/agent/scope'
 
 # This is the Scope component.
 #

data/lib/contrast/components/settings.rb

@@ -55,23 +55,22 @@ module Contrast
         APPLICATION_STATE_ATTRS   = %i[modes_by_id exclusion_matchers disabled_assess_rules].cs__freeze
 
         # Meta-define an accessor for each state attribute.
-        begin
-          PROTECT_STATE_ATTRS.each do |attr|
-            define_method(attr) do
-              protect_state[attr]
-            end
+
+        PROTECT_STATE_ATTRS.each do |attr|
+          define_method(attr) do
+            protect_state[attr]
           end
+        end
 
-          ASSESS_STATE_ATTRS.each do |attr|
-            define_method(attr) do
-              assess_state[attr]
-            end
+        ASSESS_STATE_ATTRS.each do |attr|
+          define_method(attr) do
+            assess_state[attr]
           end
+        end
 
-          APPLICATION_STATE_ATTRS.each do |attr|
-            define_method(attr) do
-              application_state[attr]
-            end
+        APPLICATION_STATE_ATTRS.each do |attr|
+          define_method(attr) do
+            application_state[attr]
           end
         end
 
@@ -95,18 +94,16 @@ module Contrast
 
         def update_from_server_features server_features
           # protect
-          begin
-            @_protect_enabled = nil
-            protect_state[:enabled] = server_features.protect_enabled?
-          end
+
+          @_protect_enabled = nil
+          protect_state[:enabled] = server_features.protect_enabled?
 
           # assess
-          begin
-            @_assess_enabled = nil
-            assess_state[:enabled] = server_features.assess_enabled?
-            assess_state[:sampling_settings] = server_features.assess.sampling
-            Contrast::Utils::Assess::SamplingUtil.instance.update
-          end
+
+          @_assess_enabled = nil
+          assess_state[:enabled] = server_features.assess_enabled?
+          assess_state[:sampling_settings] = server_features.assess.sampling
+          Contrast::Utils::Assess::SamplingUtil.instance.update
         end
 
         def update_from_application_settings application_settings

data/lib/contrast/config.rb

@@ -10,24 +10,24 @@ module Contrast
   end
 end
 
-cs__scoped_require 'contrast/config/base_configuration'
-cs__scoped_require 'contrast/config/default_value'
+require 'contrast/config/base_configuration'
+require 'contrast/config/default_value'
 
-cs__scoped_require 'contrast/config/logger_configuration'
+require 'contrast/config/logger_configuration'
 
-cs__scoped_require 'contrast/config/heap_dump_configuration'
-cs__scoped_require 'contrast/config/service_configuration'
-cs__scoped_require 'contrast/config/exception_configuration'
-cs__scoped_require 'contrast/config/assess_rules_configuration'
-cs__scoped_require 'contrast/config/protect_rule_configuration'
-cs__scoped_require 'contrast/config/protect_rules_configuration'
-cs__scoped_require 'contrast/config/sampling_configuration'
+require 'contrast/config/heap_dump_configuration'
+require 'contrast/config/service_configuration'
+require 'contrast/config/exception_configuration'
+require 'contrast/config/assess_rules_configuration'
+require 'contrast/config/protect_rule_configuration'
+require 'contrast/config/protect_rules_configuration'
+require 'contrast/config/sampling_configuration'
 
-cs__scoped_require 'contrast/config/ruby_configuration'
-cs__scoped_require 'contrast/config/agent_configuration'
-cs__scoped_require 'contrast/config/application_configuration'
-cs__scoped_require 'contrast/config/server_configuration'
-cs__scoped_require 'contrast/config/assess_configuration'
-cs__scoped_require 'contrast/config/inventory_configuration'
-cs__scoped_require 'contrast/config/protect_configuration'
-cs__scoped_require 'contrast/config/root_configuration'
+require 'contrast/config/ruby_configuration'
+require 'contrast/config/agent_configuration'
+require 'contrast/config/application_configuration'
+require 'contrast/config/server_configuration'
+require 'contrast/config/assess_configuration'
+require 'contrast/config/inventory_configuration'
+require 'contrast/config/protect_configuration'
+require 'contrast/config/root_configuration'

data/lib/contrast/config/application_configuration.rb

@@ -1,6 +1,9 @@
 # Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
+require 'contrast/config/default_value'
+require 'contrast/utils/object_share'
+
 module Contrast
   module Config
     # Common Configuration settings. Those in this section pertain to the
@@ -15,8 +18,8 @@ module Contrast
           tags: EMPTY_VALUE,
           code: EMPTY_VALUE,
           metadata: EMPTY_VALUE,
-          session_id: EMPTY_VALUE,
-          session_metadata: EMPTY_VALUE
+          session_id: Contrast::Config::DefaultValue.new(Contrast::Utils::ObjectShare::EMPTY_STRING),
+          session_metadata: Contrast::Config::DefaultValue.new(Contrast::Utils::ObjectShare::EMPTY_STRING)
       }.cs__freeze
 
       def initialize hsh

data/lib/contrast/config/base_configuration.rb

@@ -1,8 +1,8 @@
 # Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
-cs__scoped_require 'forwardable'
-cs__scoped_require 'contrast/utils/object_share'
+require 'forwardable'
+require 'contrast/utils/object_share'
 
 module Contrast
   module Config

data/lib/contrast/config/inventory_configuration.rb

@@ -7,8 +7,8 @@ module Contrast
     # inventory functionality of the Agent.
     class InventoryConfiguration < BaseConfiguration
       KEYS = {
-          enable: EMPTY_VALUE,
-          record_used_classes: EMPTY_VALUE,
+          enable: Contrast::Config::DefaultValue.new(true),
+          analyze_libraries: Contrast::Config::DefaultValue.new(true),
           tags: EMPTY_VALUE
       }.cs__freeze