contrast-agent 4.6.0 → 4.9.1

data/lib/contrast/components/sampling.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 Sampling
@@ -15,9 +17,6 @@ module Contrast
       module ClassMethods #:nodoc:
         include Contrast::Components::ComponentBase
         include Constants
-        include Contrast::Components::Interface
-
-        access_component :config, :settings
 
         def sampling_enabled?
           sampling_control[:enabled]
@@ -25,8 +24,8 @@ module Contrast
 
         def sampling_control
           @_sampling_control ||= begin
-            config_settings = CONFIG.root.assess&.sampling
-            settings = SETTINGS&.assess_state&.[](:sampling_settings)
+            config_settings = ::Contrast::CONFIG.root.assess&.sampling
+            settings = ::Contrast::SETTINGS&.assess_state&.[](:sampling_settings)
             {
                 enabled: enabled?(config_settings, settings),
                 baseline: baseline(config_settings, settings),
@@ -65,7 +64,10 @@ module Contrast
         # @param settings [Contrast::Api::Settings::Sampling] the Sampling settings as provided by TeamServer
         # @return [Integer] the resolution of the config_settings, settings, and default value
         def request_frequency config_settings, settings
-          [config_settings&.request_frequency, settings&.request_frequency, DEFAULT_SAMPLING_REQUEST_FREQUENCY].map(&:to_i).find(&:positive?)
+          [
+            config_settings&.request_frequency, settings&.request_frequency,
+            DEFAULT_SAMPLING_REQUEST_FREQUENCY
+          ].map(&:to_i).find(&:positive?)
         end
 
         # @param config_settings [Contrast::Config::SamplingConfiguration] the Sampling configuration as provided by
@@ -73,7 +75,10 @@ module Contrast
         # @param settings [Contrast::Api::Settings::Sampling] the Sampling settings as provided by TeamServer
         # @return [Integer] the resolution of the config_settings, settings, and default value
         def response_frequency config_settings, settings
-          [config_settings&.response_frequency, settings&.response_frequency, DEFAULT_SAMPLING_RESPONSE_FREQUENCY].map(&:to_i).find(&:positive?)
+          [
+            config_settings&.response_frequency, settings&.response_frequency,
+            DEFAULT_SAMPLING_RESPONSE_FREQUENCY
+          ].map(&:to_i).find(&:positive?)
         end
 
         # @param config_settings [Contrast::Config::SamplingConfiguration] the Sampling configuration as provided by
@@ -88,6 +93,7 @@ module Contrast
       module InstanceMethods #:nodoc:
         include Contrast::Components::ComponentBase
         include Constants
+        include ClassMethods
       end
     end
   end

data/lib/contrast/components/scope.rb

@@ -20,8 +20,6 @@ module Contrast
       EXECUTION_CONTEXT = {} # rubocop:disable Style/MutableConstant
 
       class Interface # :nodoc:
-        include Contrast::Components::ComponentBase
-
         def initialize
           # This is probably redundant with #scope_for_current_ec's nil check.
           EXECUTION_CONTEXT[Fiber.current] = Contrast::Agent::Scope.new
@@ -146,8 +144,6 @@ module Contrast
       end
 
       ClassMethods = InstanceMethods
-
-      COMPONENT_INTERFACE = Interface.new
     end
   end
 end

data/lib/contrast/components/settings.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/api/settings.pb'
+
 module Contrast
   module Components
     # This component encapsulates the statefulness of settings.
@@ -8,8 +10,8 @@ module Contrast
     # directives (likely provided by TeamServer) about product operation.
     # 'Settings' is not a generic term for 'configurable stuff'.
     module Settings
-      APPLICATION_STATE_BASE = Struct.new(:modes_by_id, :exclusion_matchers).new(
-          Hash.new { Contrast::Api::Settings::ProtectionRule::Mode::NO_ACTION }, [])
+      APPLICATION_STATE_BASE = Struct.new(:modes_by_id, :exclusion_matchers).
+          new(Hash.new(Contrast::Api::Settings::ProtectionRule::Mode::NO_ACTION), [])
       PROTECT_STATE_BASE = Struct.new(:enabled, :rules).new(false, {})
       ASSESS_STATE_BASE = Struct.new(:enabled, :sampling_settings, :disabled_assess_rules).new(false, nil, []) do
         def sampling_settings= new_val
@@ -20,9 +22,7 @@ module Contrast
 
       # This is a class.
       class Interface
-        include Contrast::Components::ComponentBase
-        include Contrast::Components::Interface
-        access_component :config
+        extend Contrast::Components::Config
 
         # tainted_columns are database columns that receive unsanitized input.
         attr_reader :tainted_columns # This can probably go into assess_state?
@@ -74,8 +74,6 @@ module Contrast
           Contrast::Agent::Protect::Rule::Xxe.new
         end
       end
-
-      COMPONENT_INTERFACE = Interface.new
     end
   end
 end

data/lib/contrast/config/assess_rules_configuration.rb

@@ -6,9 +6,7 @@ module Contrast
     # Common Configuration settings. Those in this section pertain to the
     # disabled assess rule functionality of the Agent.
     class AssessRulesConfiguration < BaseConfiguration
-      KEYS = {
-          disabled_rules: EMPTY_VALUE
-      }.cs__freeze
+      KEYS = { disabled_rules: EMPTY_VALUE }.cs__freeze
 
       def initialize hsh
         super(hsh, KEYS)

data/lib/contrast/config/base_configuration.rb

@@ -17,10 +17,7 @@ module Contrast
       attr_reader :map
 
       alias_method :to_hash, :map
-      def_delegators :@map, :empty?, :key?,
-                     :delete,
-                     :fetch, :[], :[]=,
-                     :each, :each_pair, :each_key, :each_value
+      def_delegators :@map, :empty?, :key?, :delete, :fetch, :[], :[]=, :each, :each_pair, :each_key, :each_value
 
       EMPTY_VALUE = :EMPTY_VALUE
 
@@ -35,7 +32,9 @@ module Contrast
           current_level = current_level.send(segment) if current_level.cs__respond_to?(segment)
         end
         last_entry = dot_path_array[-1]
-        current_level.send("#{ last_entry }=", value) if current_level.nil? == false && current_level.cs__respond_to?(last_entry)
+        if current_level.nil? == false && current_level.cs__respond_to?(last_entry)
+          current_level.send("#{ last_entry }=", value)
+        end
         nil
       end
 

data/lib/contrast/config/exception_configuration.rb

@@ -7,11 +7,7 @@ module Contrast
     # exception handling in Ruby, allowing for the override of Response Code
     # and Message when Security Exceptions are raised.
     class ExceptionConfiguration < BaseConfiguration
-      KEYS = {
-          capture: EMPTY_VALUE,
-          override_status: EMPTY_VALUE,
-          override_message: EMPTY_VALUE
-      }.cs__freeze
+      KEYS = { capture: EMPTY_VALUE, override_status: EMPTY_VALUE, override_message: EMPTY_VALUE }.cs__freeze
 
       def initialize hsh
         super(hsh, KEYS)

data/lib/contrast/config/heap_dump_configuration.rb

@@ -7,12 +7,18 @@ module Contrast
     # Heap Dump collection functionality of the Agent.
     class HeapDumpConfiguration < BaseConfiguration
       KEYS = {
-          enable: Contrast::Config::DefaultValue.new(Contrast::Utils::ObjectShare::FALSE), # should dumps be taken
-          path: Contrast::Config::DefaultValue.new('contrast_heap_dumps'),                 # dir to which dumps should be saved
-          delay_ms: Contrast::Config::DefaultValue.new(10_000),                            # time, in ms, after initialization to delay before taking dump
-          window_ms: Contrast::Config::DefaultValue.new(10_000),                           # ms between each dump
-          count: Contrast::Config::DefaultValue.new(5),                                    # number of dumps to take
-          clean: Contrast::Config::DefaultValue.new(Contrast::Utils::ObjectShare::FALSE)   # remove temporary objects
+          enable:                                                                   # should dumps be taken
+            Contrast::Config::DefaultValue.new(Contrast::Utils::ObjectShare::FALSE),
+          path:                                                                     # dir to which dumps should be
+            Contrast::Config::DefaultValue.new('contrast_heap_dumps'), #   saved
+          delay_ms:                                                                 # time, in ms, after initialization
+            Contrast::Config::DefaultValue.new(10_000), #   to delay before taking dump
+          window_ms:                                                                # ms between each dump
+            Contrast::Config::DefaultValue.new(10_000), #
+          count:                                                                    # number of dumps to take
+            Contrast::Config::DefaultValue.new(5), #
+          clean:                                                                    # remove temporary objects or not
+            Contrast::Config::DefaultValue.new(Contrast::Utils::ObjectShare::FALSE)  #
       }.cs__freeze
 
       def initialize hsh

data/lib/contrast/config/logger_configuration.rb

@@ -6,11 +6,7 @@ module Contrast
     # Common Configuration settings. Those in this section pertain to the
     # logging in the Agent.
     class LoggerConfiguration < BaseConfiguration
-      KEYS = {
-          path: EMPTY_VALUE,
-          level: EMPTY_VALUE,
-          progname: EMPTY_VALUE
-      }.cs__freeze
+      KEYS = { path: EMPTY_VALUE, level: EMPTY_VALUE, progname: EMPTY_VALUE }.cs__freeze
 
       def initialize hsh
         super(hsh, KEYS)

data/lib/contrast/configuration.rb

@@ -6,7 +6,7 @@ require 'fileutils'
 
 require 'contrast/config'
 require 'contrast/utils/object_share'
-require 'contrast/components/interface'
+require 'contrast/components/scope'
 
 module Contrast
   # This is how we read in the local settings for the Agent, both ENV/ CMD line
@@ -15,9 +15,8 @@ module Contrast
   class Configuration
     extend Forwardable
 
-    include Contrast::Components::Interface
-
-    access_component :scope
+    include Contrast::Components::Scope::InstanceMethods
+    extend Contrast::Components::Scope::InstanceMethods
 
     def_delegator :root, :assign_value_to_path_array
 
@@ -25,16 +24,8 @@ module Contrast
 
     DEFAULT_YAML_PATH  = 'contrast_security.yaml'
     MILLISECOND_MARKER = '_ms'
-    CONVERSION = {
-        'agent.service.enable' => 'agent.start_bundled_service'
-    }.cs__freeze
-    CONFIG_BASE_PATHS = [
-      '',
-      'config/',
-      '/etc/contrast/ruby/',
-      '/etc/contrast/',
-      '/etc/'
-    ].cs__freeze
+    CONVERSION = { 'agent.service.enable' => 'agent.start_bundled_service' }.cs__freeze
+    CONFIG_BASE_PATHS = ['', 'config/', '/etc/contrast/ruby/', '/etc/contrast/', '/etc/'].cs__freeze
 
     def initialize cli_options = nil, default_name = DEFAULT_YAML_PATH
       @default_name = default_name
@@ -189,10 +180,7 @@ module Contrast
     # 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
-      }
+      hash = { path: path, pwd: Dir.pwd }
       if exception.is_a?(Psych::SyntaxError)
         hash[:context] = exception.context
         hash[:column] = exception.column

data/lib/contrast/extension/assess/array.rb

@@ -3,7 +3,7 @@
 
 require 'contrast/agent/patching/policy/patch'
 require 'contrast/agent/patching/policy/patcher'
-require 'contrast/components/interface'
+require 'contrast/components/scope'
 
 module Contrast
   module Extension
@@ -12,9 +12,7 @@ module Contrast
       # Disclaimer: there may be a better way, but we're in a 'get it work' state.
       # Hopefully, we'll be in a 'get it right' state soon.
       class ArrayPropagator
-        include Contrast::Components::Interface
-
-        access_component :scope
+        extend Contrast::Components::Scope::InstanceMethods
 
         ARRAY_JOIN_HASH = {
             'class_name' => 'Array',
@@ -56,12 +54,7 @@ module Contrast
               return ret unless Contrast::Agent::Assess::Tracker.tracked?(ret)
 
               properties.cleanup_tags
-              properties.build_event(
-                  ARRAY_JOIN_NODE,
-                  ret,
-                  ary,
-                  ret,
-                  [separator])
+              properties.build_event(ARRAY_JOIN_NODE, ret, ary, ret, [separator])
               properties.event.instance_variable_set(:@_parent_events, parent_events)
               ret
             end

data/lib/contrast/extension/assess/erb.rb

@@ -25,13 +25,7 @@ module ERBPropagator
         parent_event = Contrast::Agent::Assess::Tracker.properties(bound_variable_value)&.event
         parent_events << parent_event if parent_event
       end
-      properties.build_event(
-          patcher,
-          ret,
-          preshift.object,
-          ret,
-          preshift.args,
-          1)
+      properties.build_event(patcher, ret, preshift.object, ret, preshift.args, 1)
       properties.event.instance_variable_set(:@_parent_events, parent_events)
 
       ret

data/lib/contrast/extension/assess/eval_trigger.rb

@@ -1,7 +1,7 @@
 # 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/components/logger'
 
 module Contrast
   module Extension
@@ -11,8 +11,7 @@ module Contrast
       # apply the trigger in a custom patch over one of the generic triggers in
       # TriggerMethod.
       class EvalTrigger
-        include Contrast::Components::Interface
-        access_component :logging
+        include Contrast::Components::Logger::InstanceMethods
 
         class << self
           def instance_eval_trigger_check obj, source, ret
@@ -31,12 +30,8 @@ module Contrast
             # source might not be all the args passed in, but it is the one we care
             # about. we could pass in all the args in the last param here if it
             # becomes an issue in rendering on TS
-            Contrast::Agent::Assess::Policy::TriggerMethod.apply_eval_trigger(
-                trigger_node(clazz, method),
-                source,
-                obj,
-                ret,
-                source)
+            Contrast::Agent::Assess::Policy::TriggerMethod.apply_eval_trigger(trigger_node(clazz, method), source, obj,
+                                                                              ret, source)
           end
 
           def instrument_basic_object_track

data/lib/contrast/extension/assess/exec_trigger.rb

@@ -18,20 +18,14 @@ module Contrast
           # source might not be all the args passed in, but it is the one we care
           # about. we could pass in all the args in the last param here if it
           # becomes an issue in rendering on TS
-          Contrast::Agent::Assess::Policy::TriggerMethod.build_finding(
-              trigger_node,
-              source,
-              Kernel,
-              nil,
-              source)
+          Contrast::Agent::Assess::Policy::TriggerMethod.build_finding(trigger_node, source, Kernel, nil, source)
         end
 
         private
 
         def trigger_node
-          @_trigger_node ||= begin
-            Contrast::Agent::Assess::Policy::Policy.instance.find_node('cmd-injection', 'Kernel', :exec, false)
-          end
+          @_trigger_node ||= Contrast::Agent::Assess::Policy::Policy.instance.find_node('cmd-injection', 'Kernel',
+                                                                                        :exec, false)
         end
       end
     end

data/lib/contrast/extension/assess/fiber.rb

@@ -2,7 +2,8 @@
 # frozen_string_literal: true
 
 require 'contrast/agent/assess/policy/propagation_node'
-require 'contrast/components/interface'
+require 'contrast/components/logger'
+require 'contrast/components/scope'
 
 # In order to instrument some difficult methods like String#gsub, as it
 # returns an enumerator, we need to instrument methods on Fiber.
@@ -16,9 +17,9 @@ module Contrast
       # Contrast::Agent::Assess::Policy::Propagator molds without cluttering up the
       # Fiber Class or exposing our methods there.
       class FiberPropagator
-        include Contrast::Components::Interface
+        extend Contrast::Components::Logger::InstanceMethods
+        extend Contrast::Components::Scope::InstanceMethods
 
-        access_component :analysis, :logging, :scope
 
         # we use funchook to patch rb_fiber_new the initialize method is not exposed by Ruby core
         FIBER_NEW_NODE_HASH = {
@@ -53,7 +54,7 @@ module Contrast
 
         class << self
           def track_rb_fiber_yield fiber, _method, results
-            return unless ASSESS.enabled?
+            return unless ::Contrast::ASSESS.enabled?
 
             # results will be nil if StopIteration was raised,
             # otherwise an Array of the yielded arguments
@@ -64,12 +65,7 @@ module Contrast
                 next unless (result_properties = Contrast::Agent::Assess::Tracker.properties!(result))
 
                 result_properties.splat_from(fiber, result)
-                result_properties.build_event(
-                    FIBER_YIELD_NODE,
-                    result,
-                    fiber,
-                    result,
-                    [])
+                result_properties.build_event(FIBER_YIELD_NODE, result, fiber, result, [])
               end
             end
           rescue Exception => e # rubocop:disable Lint/RescueException
@@ -77,7 +73,7 @@ module Contrast
           end
 
           def track_rb_fiber_new fiber, _enum, _enum_method, underlying, _underlying_method
-            return unless ASSESS.enabled?
+            return unless ::Contrast::ASSESS.enabled?
             return unless underlying.is_a?(String) && !underlying.empty?
 
             with_contrast_scope do
@@ -85,12 +81,7 @@ module Contrast
               return unless properties
 
               properties.splat_from(underlying, fiber)
-              properties.build_event(
-                  FIBER_NEW_NODE,
-                  fiber,
-                  underlying,
-                  fiber,
-                  [])
+              properties.build_event(FIBER_NEW_NODE, fiber, underlying, fiber, [])
             end
           rescue Exception => e # rubocop:disable Lint/RescueException
             logger.error('Unable to propagate during Fiber.new', e)

data/lib/contrast/extension/assess/hash.rb

@@ -1,7 +1,7 @@
 # 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/components/logger'
 
 module Contrast
   module Extension
@@ -10,8 +10,8 @@ module Contrast
       # methods which are too complex to fit into one of the standard
       # Contrast::Agent::Assess::Policy::Propagator molds.
       class HashPropagator
-        include Contrast::Components::Interface
-        access_component :logging
+        include Contrast::Components::Logger::InstanceMethods
+
         class << self
           def cs__duplicate_and_freeze object
             return object unless object.is_a?(String) && !object.cs__frozen?