contrast-agent 4.6.0 → 4.9.1

data/lib/contrast/components/app_context.rb

@@ -16,9 +16,7 @@ module Contrast
       # including the Client, Process, and Server information.
       class Interface
         include Contrast::Components::ComponentBase
-        include Contrast::Components::Interface
-
-        access_component :agent, :analysis, :config, :logging
+        include Contrast::Components::Logger::InstanceMethods
 
         DEFAULT_APP_NAME    = 'rails'
         DEFAULT_APP_PATH    = '/'
@@ -31,15 +29,15 @@ module Contrast
 
         def server_type
           @_server_type ||= begin
-            tmp = CONFIG.root.server.type
+            tmp = ::Contrast::CONFIG.root.server.type
             tmp = Contrast::Agent.framework_manager.server_type unless Contrast::Utils::StringUtils.present?(tmp)
             tmp
           end
         end
 
-        def name
-          @_name ||= begin
-            tmp = CONFIG.root.application.name
+        def app_name
+          @_app_name ||= begin
+            tmp = ::Contrast::CONFIG.root.application.name # rubocop:disable Security/Module/Name
             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)
@@ -50,7 +48,7 @@ module Contrast
 
         def path
           @_path ||= begin
-            tmp = CONFIG.root.application.path
+            tmp = ::Contrast::CONFIG.root.application.path
             Contrast::Utils::StringUtils.truncate(tmp, DEFAULT_APP_PATH)
           rescue StandardError
             DEFAULT_APP_PATH
@@ -59,7 +57,7 @@ module Contrast
 
         def server_name
           @_server_name ||= begin
-            tmp = CONFIG.root.server.name
+            tmp = ::Contrast::CONFIG.root.server.name # rubocop:disable Security/Module/Name
             tmp = Socket.gethostname unless Contrast::Utils::StringUtils.present?(tmp)
             tmp = Contrast::Utils::StringUtils.force_utf8(tmp)
             Contrast::Utils::StringUtils.truncate(tmp, DEFAULT_SERVER_NAME)
@@ -70,7 +68,7 @@ module Contrast
 
         def server_path
           @_server_path ||= begin
-            tmp = CONFIG.root.server.path
+            tmp = ::Contrast::CONFIG.root.server.path
             tmp = Dir.pwd unless Contrast::Utils::StringUtils.present?(tmp)
             Contrast::Utils::StringUtils.truncate(tmp, DEFAULT_SERVER_PATH)
           rescue StandardError
@@ -88,7 +86,7 @@ module Contrast
                       server_name: msg.server_name,
                       server_path: msg.server_path,
                       server_type: msg.server_type,
-                      application_name: name,
+                      application_name: app_name,
                       application_path: path,
                       application_language: Contrast::Utils::ObjectShare::RUBY)
 
@@ -108,7 +106,7 @@ module Contrast
         end
 
         def client_id
-          @_client_id ||= [name, pgid].join('-')
+          @_client_id ||= [app_name, pgid].join('-')
         end
 
         def instrument_middleware_stack?
@@ -116,7 +114,7 @@ module Contrast
         end
 
         def disabled_agent_rake_tasks
-          CONFIG.root.agent.ruby.disabled_agent_rake_tasks
+          ::Contrast::CONFIG.root.agent.ruby.disabled_agent_rake_tasks
         end
 
         # Determines if the Process we're currently in matches that of the
@@ -137,8 +135,6 @@ module Contrast
           @_original_pid ||= Process.pid
         end
       end
-
-      COMPONENT_INTERFACE = Interface.new
     end
   end
 end

data/lib/contrast/components/assess.rb

@@ -1,6 +1,11 @@
 # Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
+require 'contrast/components/base'
+require 'contrast/components/config'
+require 'contrast/components/settings'
+
+
 module Contrast
   module Components
     module Assess
@@ -10,24 +15,21 @@ module Contrast
       # Specifically, this allows for querying the state of the Assess product.
       class Interface
         include Contrast::Components::ComponentBase
-        include Contrast::Components::Interface
-
-        access_component :config, :settings
 
         def enabled?
           # config overrides if forcibly set
           return false if forcibly_disabled?
           return true  if forcibly_enabled?
 
-          SETTINGS.assess_state.enabled == true
+          ::Contrast::SETTINGS.assess_state.enabled == true
         end
 
         def tainted_columns
-          SETTINGS.tainted_columns
+          ::Contrast::SETTINGS.tainted_columns
         end
 
         def forcibly_disabled?
-          @_forcibly_disabled = false?(CONFIG.root.assess.enable) if @_forcibly_disabled.nil?
+          @_forcibly_disabled = false?(::Contrast::CONFIG.root.assess.enable) if @_forcibly_disabled.nil?
           @_forcibly_disabled
         end
 
@@ -39,9 +41,9 @@ module Contrast
         # faster comparisons when we use it. Anything not one of the known values of
         # 'NONE',  'SOME', or 'ALL' is treated as 'ALL'
         #
-        # @return [Symbol] the normalized value of CONFIG.root.assess.stacktraces
+        # @return [Symbol] the normalized value of ::Contrast::CONFIG.root.assess.stacktraces
         def capture_stacktrace_value
-          @_capture_stacktrace_value ||= case CONFIG.root.assess.stacktraces.upcase
+          @_capture_stacktrace_value ||= case ::Contrast::CONFIG.root.assess.stacktraces.upcase
                                          when 'NONE'
                                            :NONE
                                          when 'SOME'
@@ -71,38 +73,36 @@ module Contrast
         end
 
         def scan_response?
-          @_scan_response = !false?(CONFIG.root.assess.enable_scan_response) if @_scan_response.nil?
+          @_scan_response = !false?(::Contrast::CONFIG.root.assess.enable_scan_response) if @_scan_response.nil?
           @_scan_response
         end
 
         def track_frozen_sources?
-          @_track_frozen_sources = !false?(CONFIG.root.agent.ruby.track_frozen_sources) if @_track_frozen_sources.nil?
+          @_track_frozen_sources = !false?(::Contrast::CONFIG.root.agent.ruby.track_frozen_sources) if @_track_frozen_sources.nil?
           @_track_frozen_sources
         end
 
         def require_scan?
-          @_require_scan = !false?(CONFIG.root.agent.ruby.require_scan) if @_require_scan.nil?
+          @_require_scan = !false?(::Contrast::CONFIG.root.agent.ruby.require_scan) if @_require_scan.nil?
           @_require_scan
         end
 
         def tags
-          CONFIG.root.assess&.tags
+          ::Contrast::CONFIG.root.assess&.tags
         end
 
         def disabled_rules
           # TODO: RUBY-903
-          CONFIG.root.assess&.rules&.disabled_rules || SETTINGS.assess_state.disabled_assess_rules || []
+          ::Contrast::CONFIG.root.assess&.rules&.disabled_rules || ::Contrast::SETTINGS.assess_state.disabled_assess_rules || []
         end
 
         private
 
         def forcibly_enabled?
-          @_forcibly_enabled = true?(CONFIG.root.assess.enable) if @_forcibly_enabled.nil?
+          @_forcibly_enabled = true?(::Contrast::CONFIG.root.assess.enable) if @_forcibly_enabled.nil?
           @_forcibly_enabled
         end
       end
-
-      COMPONENT_INTERFACE = Interface.new
     end
   end
 end

data/lib/contrast/components/base.rb

@@ -0,0 +1,40 @@
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# frozen_string_literal: true
+
+module Contrast
+  module Components
+    # All components should inherit from this,
+    # whether Interfaces, InstanceMethods or ClassMethods.
+    module ComponentBase
+      # 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
+        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
+        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
+end

data/lib/contrast/components/config.rb

@@ -56,7 +56,8 @@ module Contrast
 
         private
 
-        SESSION_VARIABLES = "Invalid configuration. Setting both application.session_id and application.session_metadata is not allowed.\n"
+        SESSION_VARIABLES = 'Invalid configuration. '\
+                            "Setting both application.session_id and application.session_metadata is not allowed.\n"
         def validate log: false
           # The config has information about how to construct the logger.
           # If the config is invalid, and you want to know about it, then
@@ -107,8 +108,6 @@ module Contrast
           @config.application.session_metadata
         end
       end
-
-      COMPONENT_INTERFACE = Interface.new
     end
   end
 end

data/lib/contrast/components/contrast_service.rb

@@ -13,38 +13,34 @@ module Contrast
       # the Service, as well as sending a message to the Service.
       class Interface
         include Contrast::Components::ComponentBase
-        include Contrast::Components::Interface
 
         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$/]
 
-        access_component :agent, :config
-
         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
+
+          # Requirement says "must be true" but that
+          # should be "must not be false" -- oops.
+          @_use_bundled_service ||= !false?(::Contrast::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
 
         def host
-          @_host ||= (CONFIG.root.agent.service.host || Contrast::Config::ServiceConfiguration::DEFAULT_HOST).to_s
+          @_host ||= (::Contrast::CONFIG.root.agent.service.host || Contrast::Config::ServiceConfiguration::DEFAULT_HOST).to_s
         end
 
         def port
-          @_port ||= (CONFIG.root.agent.service.port || Contrast::Config::ServiceConfiguration::DEFAULT_PORT).to_i
+          @_port ||= (::Contrast::CONFIG.root.agent.service.port || Contrast::Config::ServiceConfiguration::DEFAULT_PORT).to_i
         end
 
         def socket_path
-          @_socket_path ||= CONFIG.root.agent.service.socket
+          @_socket_path ||= ::Contrast::CONFIG.root.agent.service.socket
         end
 
         def use_tcp?
@@ -52,18 +48,16 @@ module Contrast
         end
 
         def logger_path
-          @_logger_path ||= CONFIG.root.agent.service.logger.path || DEFAULT_SERVICE_LOG
+          @_logger_path ||= ::Contrast::CONFIG.root.agent.service.logger.path || DEFAULT_SERVICE_LOG
         end
 
         private
 
         def disabled?
-          @_disabled = false?(CONFIG.root.agent.start_bundled_service) if @_disabled.nil?
+          @_disabled = false?(::Contrast::CONFIG.root.agent.start_bundled_service) if @_disabled.nil?
           @_disabled
         end
       end
-
-      COMPONENT_INTERFACE = Interface.new
     end
   end
 end

data/lib/contrast/components/heap_dump.rb

@@ -1,6 +1,9 @@
 # Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
+require 'contrast/components/base'
+require 'contrast/components/heap_dump'
+
 module Contrast
   module Components
     module HeapDump
@@ -11,9 +14,6 @@ module Contrast
       # utility.
       module ClassMethods
         include Contrast::Components::ComponentBase
-        include Contrast::Components::Interface
-
-        access_component :config
 
         def heap_dump_enabled?
           heap_dump_control[:enabled]
@@ -21,7 +21,7 @@ module Contrast
 
         def heap_dump_control
           @_heap_dump_control ||= begin
-            config = CONFIG.root&.agent&.heap_dump
+            config = ::Contrast::CONFIG.root&.agent&.heap_dump
             {
                 enabled: true?(config&.enable),
                 path: File.absolute_path(config&.path),
@@ -33,6 +33,7 @@ module Contrast
           end
         end
       end
+      InstanceMethods = ClassMethods
     end
   end
 end

data/lib/contrast/components/inventory.rb

@@ -11,22 +11,17 @@ module Contrast
       # product.
       class Interface
         include Contrast::Components::ComponentBase
-        include Contrast::Components::Interface
-
-        access_component :config, :settings
 
         def enabled?
-          @_enabled = !false?(CONFIG.root.inventory.enable) if @_enabled.nil?
+          @_enabled = !false?(::Contrast::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 = !false?(::Contrast::CONFIG.root.inventory.analyze_libraries) if @_analyze_libraries.nil?
           @_analyze_libraries
         end
       end
-
-      COMPONENT_INTERFACE = Interface.new
     end
   end
 end

data/lib/contrast/components/logger.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require 'contrast/logger/log'
+require 'contrast/components/base'
 
 module Contrast
   module Components
@@ -20,8 +21,6 @@ module Contrast
       class Interface
         include Contrast::Components::ComponentBase
       end
-
-      COMPONENT_INTERFACE = Interface.new
     end
   end
 end

data/lib/contrast/components/protect.rb

@@ -1,6 +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/base'
+
 module Contrast
   module Components
     module Protect
@@ -8,34 +10,31 @@ module Contrast
       # its parent_configuration_spec.yaml.  Specifically, this allows for querying the state of the Protect product.
       class Interface
         include Contrast::Components::ComponentBase
-        include Contrast::Components::Interface
-
-        access_component :config, :settings
 
         def enabled?
           # config overrides if forcibly set
           return false if forcibly_disabled?
           return true  if forcibly_enabled?
 
-          SETTINGS.protect_state.enabled == true
+          ::Contrast::SETTINGS.protect_state.enabled == true
         end
 
         def rule_config
-          CONFIG.root.protect.rules
+          ::Contrast::CONFIG.root.protect.rules
         end
 
         def rules
-          SETTINGS.protect_state.rules
+          ::Contrast::SETTINGS.protect_state.rules
         end
 
         def rule_mode rule_id
-          CONFIG.root.protect.rules[rule_id]&.applicable_mode ||
-              SETTINGS.application_state.modes_by_id[rule_id] ||
+          ::Contrast::CONFIG.root.protect.rules[rule_id]&.applicable_mode ||
+              ::Contrast::SETTINGS.application_state.modes_by_id[rule_id] ||
               Contrast::Api::Settings::ProtectionRule::Mode::NO_ACTION
         end
 
         def rule name
-          SETTINGS.protect_state.rules[name]
+          ::Contrast::SETTINGS.protect_state.rules[name]
         end
 
         def report_any_command_execution?
@@ -55,17 +54,15 @@ module Contrast
         end
 
         def forcibly_disabled?
-          @_forcibly_disabled ||= false?(CONFIG.root.protect.enable)
+          @_forcibly_disabled ||= false?(::Contrast::CONFIG.root.protect.enable)
         end
 
         private
 
         def forcibly_enabled?
-          @_forcibly_enabled ||= true?(CONFIG.root.protect.enable)
+          @_forcibly_enabled ||= true?(::Contrast::CONFIG.root.protect.enable)
         end
       end
-
-      COMPONENT_INTERFACE = Interface.new
     end
   end
 end