contrast-agent 4.8.0 → 4.9.0

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

@@ -1,7 +1,6 @@
 # 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/utils/string_utils'
 
 module Contrast
@@ -11,9 +10,6 @@ module Contrast
       # model so it can own some of the data massaging required for AppUpdate
       # dtm.
       module ApplicationUpdate
-        include Contrast::Components::Interface
-        access_component :config
-
         def self.included klass
           klass.extend(ClassMethods)
         end

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

@@ -3,7 +3,7 @@
 
 require 'contrast/api/dtm.pb'
 require 'contrast/api/decorators/address'
-require 'contrast/components/interface'
+require 'contrast/components/scope'
 require 'contrast/utils/string_utils'
 require 'contrast/utils/timer'
 
@@ -14,9 +14,6 @@ module Contrast
       # so it can own some of the data massaging required for Request dtm. Only
       # works as an extension of that class.
       module HttpRequest
-        include Contrast::Components::Interface
-        access_component :agent
-
         OMITTED_BODY = '{{body-omitted-by-contrast}}'
 
         def self.included klass
@@ -93,7 +90,7 @@ module Contrast
         end
 
         def omit_body? request
-          return true if AGENT.omit_body?
+          return true if ::Contrast::AGENT.omit_body?
           return false if request.document_type != :NORMAL
 
           request.content_type&.include?('multipart/form-data')
@@ -111,8 +108,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 :scope
+          include Contrast::Components::Scope::InstanceMethods
 
           # Convert our Request into a DTM
           # @param request [Contrast::Agent::Request]

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

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require 'contrast/api/dtm.pb'
-require 'contrast/components/interface'
+require 'contrast/components/base'
 
 module Contrast
   module Api
@@ -10,8 +10,6 @@ module Contrast
       # Used to decorate the InstrumentationMode protobuf model to handle reporting Agent process start
       module InstrumentationMode
         include Contrast::Components::ComponentBase
-        include Contrast::Components::Interface
-        access_component :analysis
 
         def self.included klass
           klass.extend(ClassMethods)
@@ -24,8 +22,8 @@ module Contrast
           # @return [Contrast::Api::Dtm::InstrumentationMode]
           def build
             msg = new
-            msg.assess =  ASSESS.enabled?
-            msg.protect = PROTECT.enabled?
+            msg.assess =  ::Contrast::ASSESS.enabled?
+            msg.protect = ::Contrast::PROTECT.enabled?
             msg
           end
         end

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

@@ -3,6 +3,7 @@
 
 require 'contrast/utils/object_share'
 require 'contrast/utils/string_utils'
+require 'contrast/components/logger'
 
 module Contrast
   module Api
@@ -10,8 +11,7 @@ module Contrast
       # Used to decorate the {Contrast::Api::Dtm::Message} protobuf model so it
       # can handle instance data massaging.
       module Message
-        include Contrast::Components::Interface
-        access_component :app_context, :logging
+        include Contrast::Components::Logger::InstanceMethods
 
         def self.included klass
           klass.extend(ClassMethods)
@@ -58,13 +58,13 @@ module Contrast
 
           def build event
             msg = new
-            msg.app_name      = APP_CONTEXT.app_name
-            msg.app_path      = APP_CONTEXT.path
+            msg.app_name      = ::Contrast::APP_CONTEXT.app_name
+            msg.app_path      = ::Contrast::APP_CONTEXT.path
             msg.app_language  = Contrast::Utils::ObjectShare::RUBY
-            msg.client_id     = APP_CONTEXT.client_id
+            msg.client_id     = ::Contrast::APP_CONTEXT.client_id
             msg.message_count = message_count
-            msg.pid           = APP_CONTEXT.pid
-            msg.ppid          = APP_CONTEXT.ppid
+            msg.pid           = ::Contrast::APP_CONTEXT.pid
+            msg.ppid          = ::Contrast::APP_CONTEXT.ppid
             msg.append_event(event)
             msg
           end

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

@@ -4,7 +4,7 @@
 require 'contrast/utils/string_utils'
 require 'contrast/utils/assess/tracking_util'
 require 'base64'
-require 'contrast/components/interface'
+require 'contrast/components/scope'
 
 module Contrast
   module Api
@@ -18,8 +18,7 @@ module Contrast
 
         # Class methods for TraceEventObject
         module ClassMethods
-          include Contrast::Components::Interface
-          access_component :scope
+          include Contrast::Components::Scope::InstanceMethods
           # Build the event object. We were originally going to include taint on
           # each one, but TS doesn't accept / use that, so it is a waste of time.
           #

data/lib/contrast/components/agent.rb

@@ -12,12 +12,9 @@ module Contrast
       # Specifically, this allows for querying the state of the Agent.
       class Interface
         include Contrast::Components::ComponentBase
-        include Contrast::Components::Interface
-
-        access_component :analysis, :config, :settings
 
         def enabled?
-          @_enabled = !false?(CONFIG.root.enable) if @_enabled.nil?
+          @_enabled = !false?(::Contrast::CONFIG.root.enable) if @_enabled.nil?
           @_enabled
         end
 
@@ -52,34 +49,34 @@ module Contrast
         end
 
         def patch_yield?
-          @_patch_yield = !false?(CONFIG.root.agent.ruby.propagate_yield) if @_patch_yield.nil?
+          @_patch_yield = !false?(::Contrast::CONFIG.root.agent.ruby.propagate_yield) if @_patch_yield.nil?
           @_patch_yield
         end
 
         def interpolation_enabled?
-          @_interpolation_enabled = !false?(CONFIG.root.agent.ruby.interpolate) if @_interpolation_enabled.nil?
+          @_interpolation_enabled = !false?(::Contrast::CONFIG.root.agent.ruby.interpolate) if @_interpolation_enabled.nil?
           @_interpolation_enabled
         end
 
         def omit_body?
-          @_omit_body = true?(CONFIG.root.agent.omit_body) if @_omit_body.nil?
+          @_omit_body = true?(::Contrast::CONFIG.root.agent.omit_body) if @_omit_body.nil?
           @_omit_body
         end
 
         def exception_control
           @_exception_control ||= {
-              enable: true?(CONFIG.root.agent.ruby.exceptions.capture),
+              enable: true?(::Contrast::CONFIG.root.agent.ruby.exceptions.capture),
               status:
-                CONFIG.root.agent.ruby.exceptions.override_status || 403,
+                ::Contrast::CONFIG.root.agent.ruby.exceptions.override_status || 403,
               message:
-                CONFIG.root.agent.ruby.exceptions.override_message || Contrast::Utils::ObjectShare::OVERRIDE_MESSAGE
+                ::Contrast::CONFIG.root.agent.ruby.exceptions.override_message || Contrast::Utils::ObjectShare::OVERRIDE_MESSAGE
           }
         end
 
         def skip_instrumentation? loaded_module_name
           return true unless loaded_module_name
 
-          loaded_module_name.start_with?(*CONFIG.root.agent.ruby.uninstrument_namespace)
+          loaded_module_name.start_with?(*::Contrast::CONFIG.root.agent.ruby.uninstrument_namespace)
         end
 
         # Insert ourselves into the application, keeping our middleware at the outermost layer of the onion
@@ -104,13 +101,11 @@ module Contrast
         end
 
         def retrieve_protect_ruleset
-          return {} unless enabled? && PROTECT.enabled?
+          return {} unless enabled? && ::Contrast::PROTECT.enabled?
 
-          PROTECT.rules
+          ::Contrast::PROTECT.rules
         end
       end
-
-      COMPONENT_INTERFACE = Interface.new
     end
   end
 end

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,7 +29,7 @@ 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
@@ -39,7 +37,7 @@ module Contrast
 
         def app_name
           @_app_name ||= begin
-            tmp = CONFIG.root.application.name # rubocop:disable Security/Module/Name
+            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 # rubocop:disable Security/Module/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
@@ -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

@@ -108,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,37 +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
 
           # Requirement says "must be true" but that
           # should be "must not be false" -- oops.
-          @_use_bundled_service ||= !false?(CONFIG.root.agent.start_bundled_service) &&
+          @_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?
@@ -51,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