contrast-agent 4.7.0 → 4.10.0

data/lib/contrast/components/settings.rb

@@ -22,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?
@@ -76,8 +74,6 @@ module Contrast
           Contrast::Agent::Protect::Rule::Xxe.new
         end
       end
-
-      COMPONENT_INTERFACE = Interface.new
     end
   end
 end

data/lib/contrast/config/base_configuration.rb

@@ -12,7 +12,7 @@ module Contrast
     class BaseConfiguration
       extend Forwardable
 
-      BOOLEANS = [true, false].cs__freeze
+      STRING_BOOLEANS = %w[false true].cs__freeze
 
       attr_reader :map
 
@@ -73,8 +73,18 @@ module Contrast
                           spec_value.new(user_provided_value)
                         elsif spec_value.is_a?(Contrast::Config::DefaultValue) && user_provided_value == EMPTY_VALUE
                           spec_value.value
-                        elsif BOOLEANS.include?(user_provided_value)
-                          user_provided_value.to_s
+                        elsif user_provided_value.cs__is_a?(String)
+                          value = user_provided_value.downcase
+                          # converts string values to 'true' => true or 'false' => false
+                          case value
+                          when STRING_BOOLEANS[1]
+                            true
+                          when STRING_BOOLEANS[0]
+                            false
+                          else
+                            # returns non boolean string values
+                            user_provided_value
+                          end
                         else
                           user_provided_value
                         end
@@ -95,9 +105,7 @@ module Contrast
 
       def define_setter str_key
         define_singleton_method "#{ str_key }=".to_sym do |new_value|
-          boolean_value = new_value == true
-          boolean_value ||= new_value == false
-          @map[str_key] = boolean_value ? new_value.to_s : new_value
+          @map[str_key] = new_value
         end
       end
     end

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
 
@@ -49,9 +48,7 @@ module Contrast
     # in an infinite loop on the to_sym method used later.
     def method_missing symbol, *args
       with_contrast_scope do
-        root.public_send(symbol, *args)
-      rescue NoMethodError => _e
-        super
+        root.public_send(symbol, *args) if root.cs__respond_to?(symbol)
       end
     end
 
@@ -102,8 +99,7 @@ module Contrast
       {}
     end
 
-    # We're updating properties loaded from the configuration
-    # files to match the new agreed upon standard configuration
+    # We're updating properties loaded from the configuration files to match the new agreed upon standard configuration
     # names, so that one file works for all agents
     def update_prop_keys config
       CONVERSION.each_pair do |old_method, new_method|
@@ -121,16 +117,7 @@ module Contrast
         # 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|
-          if index == end_idx
-            new_value[new_key] = old_value if new_value[new_key].nil?
-          else
-            new_value = {} if new_value.nil?
-            new_value[new_key] = {} if new_value[new_key].nil?
-            new_value = new_value[new_key]
-          end
-        end
+        replace_props(new_keys, new_value, old_value)
       end
 
       config
@@ -238,5 +225,21 @@ module Contrast
         convert
       end
     end
+
+    def replace_props new_keys, new_value, old_value
+      idx = 0
+      end_idx = new_keys.length - 1
+      while idx < new_keys.length
+        new_key = new_keys[idx]
+        if idx == end_idx
+          new_value[new_key] = old_value if new_value[new_key].nil?
+        else
+          new_value = {} if new_value.nil?
+          new_value[new_key] = {} if new_value[new_key].nil?
+          new_value = new_value[new_key]
+        end
+        idx += 1
+      end
+    end
   end
 end

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
@@ -11,10 +11,8 @@ module Contrast
       # This is our patch of the Array class required to handle propagation
       # 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
+      class ArrayPropagator # rubocop:disable Style/StaticClass
+        extend Contrast::Components::Scope::InstanceMethods
 
         ARRAY_JOIN_HASH = {
             'class_name' => 'Array',
@@ -61,16 +59,6 @@ module Contrast
               ret
             end
           end
-
-          def instrument_array_track
-            @_instrument_array_track ||= begin
-              require 'cs__assess_array/cs__assess_array'
-              true
-            end
-          rescue StandardError, LoadError => e
-            logger.error('Error loading assess track patch', e)
-            false
-          end
         end
       end
     end

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
@@ -35,26 +34,6 @@ module Contrast
                                                                               ret, source)
           end
 
-          def instrument_basic_object_track
-            @_instrument_basic_object_track ||= begin
-              require 'cs__assess_basic_object/cs__assess_basic_object'
-              true
-            end
-          rescue StandardError, LoadError => e
-            logger.error('Error loading basic object track patch', e)
-            false
-          end
-
-          def instrument_module_track
-            @_instrument_module_track ||= begin
-              require 'cs__assess_module/cs__assess_module'
-              true
-            end
-          rescue StandardError, LoadError => e
-            logger.error('Error loading module track patch', e)
-            false
-          end
-
           private
 
           def trigger_node clazz, method

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,8 @@ 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
-
-        access_component :analysis, :logging, :scope
+        extend Contrast::Components::Logger::InstanceMethods
+        extend Contrast::Components::Scope::InstanceMethods
 
         # we use funchook to patch rb_fiber_new the initialize method is not exposed by Ruby core
         FIBER_NEW_NODE_HASH = {
@@ -53,7 +53,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
@@ -72,7 +72,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,16 +85,6 @@ module Contrast
           rescue Exception => e # rubocop:disable Lint/RescueException
             logger.error('Unable to propagate during Fiber.new', e)
           end
-
-          def instrument_fiber_track
-            @_instrument_fiber_variables ||= begin
-              require 'cs__assess_fiber_track/cs__assess_fiber_track' if Funchook.available?
-              true
-            end
-          rescue StandardError, LoadError => e
-            logger.error('Error loading fiber track patch', e)
-            false
-          end
         end
       end
     end

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?
@@ -25,16 +25,6 @@ module Contrast
             # result in a seg fault
             object
           end
-
-          def instrument_hash_track
-            @_instrument_hash_track ||= begin
-              require 'cs__assess_hash/cs__assess_hash'
-              true
-            end
-          rescue StandardError, LoadError => e
-            logger.error('Error loading hash track patch', e)
-            false
-          end
         end
       end
     end

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

@@ -1,8 +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/interface'
 require 'contrast/extension/assess/exec_trigger'
+require 'contrast/components/logger'
 
 module Contrast
   module Extension
@@ -13,11 +13,10 @@ module Contrast
       # Kernel Module or exposing our methods there.
       module KernelPropagator
         class << self
-          include Contrast::Components::Interface
+          extend Contrast::Components::Logger::InstanceMethods
+          include Contrast::Components::Logger::InstanceMethods
           include Contrast::Extension::Assess::ExecTrigger
 
-          access_component :logging
-
           # We're 'tracking' sprintf now, meaning if anything is tracked on the way
           # in, the entire result will be tracked out. We're going to take this
           # approach for now b/c it's fast and easy. I don't super love it, and by
@@ -67,16 +66,6 @@ module Contrast
             logger.error('Unable to track dataflow through sprintf', e)
           end
 
-          def instrument_kernel_track
-            @_instrument_fiber_variables ||= begin
-              require 'cs__assess_kernel/cs__assess_kernel'
-              true
-            end
-          rescue StandardError, LoadError => e
-            logger.error('Error loading kernel track patch', e)
-            false
-          end
-
           private
 
           def handle_sprintf_value value, result, parent_events

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

@@ -1,7 +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/interface'
+require 'contrast/components/logger'
+require 'contrast/components/scope'
 
 module Contrast
   module Extension
@@ -11,11 +12,12 @@ module Contrast
       # Hopefully, we'll be in a 'get it right' state soon.
       # This module is used for our Marshal.load patches
       class MarshalPropagator
-        include Contrast::Components::Interface
-
-        access_component :logging, :scope
+        extend Contrast::Components::Scope::InstanceMethods
 
         class << self
+          extend Contrast::Components::Logger::InstanceMethods
+          include Contrast::Components::Logger::InstanceMethods
+
           def cs__load_protect arg
             return if in_contrast_scope?
 
@@ -44,16 +46,6 @@ module Contrast
             end
           end
 
-          def instrument_marshal_load
-            @_instrument_marshal_load ||= begin
-              require 'cs__assess_marshal_module/cs__assess_marshal_module'
-              true
-            end
-          rescue StandardError, LoadError => e
-            logger.error('Error loading marshal load patch', e)
-            false
-          end
-
           def trigger_node clazz, method
             triggers = Contrast::Agent::Assess::Policy::Policy.instance.triggers
             return unless triggers

data/lib/contrast/extension/assess/regexp.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'
 
 module Contrast
   module Extension
@@ -12,9 +13,8 @@ module Contrast
       # Contrast::Agent::Assess::Policy::Propagator molds without cluttering up the
       # Regexp Class or exposing our methods there.
       class RegexpPropagator
-        include Contrast::Components::Interface
-
-        access_component :analysis, :logging, :scope
+        extend Contrast::Components::Logger::InstanceMethods
+        extend Contrast::Components::Scope::InstanceMethods
 
         REGEXP_EQUAL_SQUIGGLE_HASH = {
             'id' => 'regexp_100',
@@ -34,7 +34,7 @@ module Contrast
 
         class << self
           def track_equal_squiggle info_hash
-            return unless ASSESS.enabled?
+            return unless ::Contrast::ASSESS.enabled?
 
             # Because we have a special case for this propagation,
             # it falls out of regular scoping. As such, any patch to the `=~` method
@@ -58,16 +58,6 @@ module Contrast
           rescue Exception => e # rubocop:disable Lint/RescueException
             logger.error('Unable to propagate during Regexp#=~', e)
           end
-
-          def instrument_regexp_track
-            @_instrument_regexp_track ||= begin
-              require 'cs__assess_regexp/cs__assess_regexp'
-              true
-            end
-          rescue StandardError, LoadError => e
-            logger.error('Error loading regexp track patch', e)
-            false
-          end
         end
       end
     end