contrast-agent 3.14.0 → 4.2.0

data/lib/contrast/components/config.rb

@@ -1,9 +1,7 @@
 # Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
-require 'contrast/utils/boolean_util'
 require 'contrast/utils/env_configuration_item'
-require 'contrast/utils/object_share'
 require 'contrast/configuration'
 
 module Contrast
@@ -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

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

@@ -3,7 +3,7 @@
 
 require 'delegate'
 require 'contrast/extension/module'
-require 'contrast/utils/boolean_util'
+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

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

@@ -42,18 +42,61 @@ module Contrast
         # For each instance method on a scope, define a forwarder
         # to the scope on the current execution context's scope.
 
-        Contrast::Agent::Scope.public_instance_methods(false).each do |method_sym|
-          define_method(method_sym) do |*args, &block|
-            scope_for_current_ec.send(method_sym, *args, &block)
-          end
-        end
-
         def scope_for_current_ec
           MONITOR.synchronize do
             return EXECUTION_CONTEXT[Fiber.current] ||= Contrast::Agent::Scope.new
           end
         end
 
+        def enter_contrast_scope!
+          scope_for_current_ec.enter_contrast_scope!
+        end
+
+        def enter_deserialization_scope!
+          scope_for_current_ec.enter_deserialization_scope!
+        end
+
+        def enter_scope! name
+          scope_for_current_ec.enter_scope! name
+        end
+
+        def exit_contrast_scope!
+          scope_for_current_ec.exit_contrast_scope!
+        end
+
+        def exit_deserialization_scope!
+          scope_for_current_ec.exit_deserialization_scope!
+        end
+
+        def exit_scope! name
+          scope_for_current_ec.exit_scope! name
+        end
+
+        def in_contrast_scope?
+          scope_for_current_ec.in_contrast_scope?
+        end
+
+        def in_deserialization_scope?
+          scope_for_current_ec.in_deserialization_scope?
+        end
+
+        def in_scope? name
+          scope_for_current_ec.in_scope? name
+        end
+
+        def with_contrast_scope
+          scope_for_current_ec.enter_contrast_scope!
+          yield
+        ensure
+          scope_for_current_ec.exit_contrast_scope!
+        end
+
+        def with_deserialization_scope
+          scope_for_current_ec.enter_deserialization_scope!
+        ensure
+          scope_for_current_ec.exit_deserialization_scope!
+        end
+
         # TODO: RUBY-572
         #
         # Current behavior is to no-op if we're not "in a request context".

data/lib/contrast/components/settings.rb

@@ -55,23 +55,25 @@ 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|
+          # TODO: RUBY-1052
+          define_method(attr) do # rubocop:disable Kernel/DefineMethod
+            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|
+          # TODO: RUBY-1052
+          define_method(attr) do # rubocop:disable Kernel/DefineMethod
+            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|
+          # TODO: RUBY-1052
+          define_method(attr) do # rubocop:disable Kernel/DefineMethod
+            application_state[attr]
           end
         end
 
@@ -95,18 +97,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/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/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
 

data/lib/contrast/config/service_configuration.rb

@@ -1,11 +1,19 @@
 # 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/config/logger_configuration'
+
 module Contrast
   module Config
     # Common Configuration settings. Those in this section pertain to the
     # communication between the Agent & the Service.
     class ServiceConfiguration < BaseConfiguration
+      # We don't set these b/c we've been asked to handle the default values of
+      # these settings differently, logging when we have to use them.
+      DEFAULT_HOST       = '127.0.0.1'
+      DEFAULT_PORT       = '30555'
+
       KEYS = {
           enable: EMPTY_VALUE,
           host: EMPTY_VALUE,

data/lib/contrast/configuration.rb

@@ -24,8 +24,6 @@ module Contrast
     attr_reader :default_name, :root
 
     DEFAULT_YAML_PATH  = 'contrast_security.yaml'
-    DEFAULT_HOST       = '127.0.0.1'
-    DEFAULT_PORT       = '30555'
     MILLISECOND_MARKER = '_ms'
     CONVERSION = {
         'agent.service.enable' => 'agent.start_bundled_service'
@@ -37,9 +35,6 @@ module Contrast
       '/etc/contrast/',
       '/etc/'
     ].cs__freeze
-    REMOVE_FIELDS = [
-      'contrast'
-    ].cs__freeze
 
     def initialize cli_options = nil, default_name = DEFAULT_YAML_PATH
       @default_name = default_name
@@ -53,7 +48,6 @@ module Contrast
 
       # Some in-flight rewrites to maintain backwards compatibility
       config_kv = update_prop_keys(config_kv)
-      config_kv = deprecate_fields(config_kv)
 
       @root = Contrast::Config::RootConfiguration.new(config_kv)
     end
@@ -73,6 +67,13 @@ module Contrast
       root&.cs__respond_to?(method_name) || super
     end
 
+    # Get a loggable YAML format of this configuration
+    # @return [String] the current active configuration of the Agent,
+    #   represented as a YAML string
+    def loggable
+      convert_to_hash.to_yaml
+    end
+
     protected
 
     # TODO: RUBY-546 move utility methods to auxiliary classes
@@ -80,26 +81,16 @@ module Contrast
     def load_config
       config = {}
       configuration_paths.find do |path|
-        found = File.exist?(path)
-        next unless found
+        next unless File.exist?(path)
 
-        readable = File.readable?(path)
-        unless readable
-          puts "!!! Contrast - Configuration file at #{ path } is not readable by current user"
+        unless File.readable?(path)
+          log_file_read_error(path)
           next
         end
         config = yaml_to_hash(path) || {}
         break
       end
 
-      if config.empty?
-        puts "!!! Contrast - working directory: #{ Dir.pwd }"
-        puts '!!! Contrast - valid configuration file could not be found at any of the search paths'
-        puts 'Valid configuration paths are: '
-        configuration_paths.each do |path|
-          puts(path)
-        end
-      end
       config
     end
 
@@ -109,9 +100,10 @@ module Contrast
           yaml = IO.read(path)
           yaml = ERB.new(yaml).result if defined?(ERB)
           return YAML.safe_load(yaml)
+        rescue Psych::Exception => e
+          log_yaml_parse_error(path, e)
         rescue RuntimeError => e
-          puts "ERROR: unable to load configuration from path due to #{ e }"
-          puts "ERROR: path=#{ path } pwd=#{ Dir.pwd }"
+          puts "WARN: Unable to load configuration. #{ e }; path: #{ path }, pwd: #{ Dir.pwd }"
         end
       end
 
@@ -122,29 +114,20 @@ module Contrast
     # files to match the new agreed upon standard configuration
     # names, so that one file works for all agents
     def update_prop_keys config
-      converted = false
       CONVERSION.each_pair do |old_method, new_method|
         # See if the old value was set and needs to be translated
         deprecated_keys = old_method.split('.')
-
         old_value = config
         deprecated_keys.each do |key|
           old_value = old_value[key]
           break if old_value.nil?
         end
+        next if old_value.nil? # have to account for literal false
 
-        next if old_value.nil?
-
-        converted = true
-
-        puts "The deprecated property #{ old_method } is being set."
-        puts "Please update your config to use the property #{ new_method } instead."
-
+        log_deprecated_property(old_method, new_method)
         new_keys = new_method.split('.')
-
         # We changed the seconds values into ms values. Multiply them accordingly
         old_value = old_value.to_i * 1000 if new_method.end_with?(MILLISECOND_MARKER)
-
         new_value = config
         end_idx = new_keys.length - 1
         new_keys.each_with_index do |new_key, index|
@@ -161,21 +144,6 @@ module Contrast
       config
     end
 
-    def deprecate_fields hash
-      REMOVE_FIELDS.each do |field|
-        path = field.split('.')
-        active_path = hash
-        path.each_with_index do |delete_path, index|
-          if index == path.length - 1 && active_path
-            active_path.delete(delete_path)
-          elsif active_path
-            active_path = active_path[delete_path]
-          end
-        end
-      end
-      hash
-    end
-
     # Base paths to check for the contrast configuration file, sorted by
     # reverse order of precedence (first is most important).
     def configuration_paths
@@ -208,5 +176,78 @@ module Contrast
       end
       new_hash
     end
+
+    private
+
+    # We cannot use all access components at this point, unfortunately, as they
+    # may not have been initialized. Instead, we need to access the logger
+    # directly.
+    def logger
+      @_logger ||= (Contrast::Logger::Log.instance.logger if defined?(Contrast::Logger::Log))
+    end
+
+    # When we fail to parse a configuration because it is misformatted, log an
+    # appropriate message based on the Agent Onboarding specification
+    def log_yaml_parse_error path, exception
+      hash = {
+          path: path,
+          pwd: Dir.pwd
+      }
+      if exception.is_a?(Psych::SyntaxError)
+        hash[:context] = exception.context
+        hash[:column] = exception.column
+        hash[:line] = exception.line
+        hash[:offset] = exception.offset
+        hash[:problem] = exception.problem
+      end
+
+      if logger
+        logger.warn('YAML validator found an error', hash)
+      else
+        puts "CONTRAST - WARN: YAML validator found an error. #{ hash.inspect }"
+      end
+    end
+
+    def log_file_read_error path
+      if logger
+        logger.warn('Configuration file is not readable by current user', path: path)
+      else
+        puts "CONTRAST - WARN: Configuration file is not readable by current user; path: #{ path }"
+      end
+    end
+
+    def log_deprecated_property old_method, new_method
+      if logger
+        logger.warn('Deprecated property in use', old_method: old_method, new_method: new_method)
+      else
+        puts "CONTRAST - WARN: Deprecated property in use; old_method: #{ old_method }, new_method: #{ new_method }"
+      end
+    end
+
+    # Convert this entire configuration into a hash, walking down the entries
+    # in the thing to convert and setting them in the given hash. For now, this
+    # logs every possible key, whether set or not. If we want to change that
+    # behavior, we can skip adding keys to the hash if the value is nil, blank,
+    # or Contrast::Config::DefaultValue depending on desired behavior
+    #
+    # @param hash [Hash] the hash to populate
+    # @param convert [Contrast::Config::BaseConfiguration, Object] the level of
+    #   configuration from which to convert. Note that at least one top level
+    #   Contrast::Config::BaseConfiguration is required for anything to be set
+    #   in the hash
+    # @return [Hash, Object] the leaf of each
+    #   Contrast::Config::BaseConfiguration will be returned in the N > 0 steps
+    #   the Hash will be returned at the end of the 0 level
+    def convert_to_hash convert = root, hash = {}
+      case convert
+      when Contrast::Config::BaseConfiguration
+        convert.cs__class::KEYS.each_key do |key|
+          hash[key] = convert_to_hash(convert.send(key), {})
+        end
+        hash
+      else
+        convert
+      end
+    end
   end
 end