contrast-agent 4.8.0 → 4.9.0

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

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),
@@ -94,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

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

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',

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

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

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?

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,9 @@ module Contrast
       # Kernel Module or exposing our methods there.
       module KernelPropagator
         class << self
-          include Contrast::Components::Interface
+          extend 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

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,9 +12,8 @@ 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::Logger::InstanceMethods
+        extend Contrast::Components::Scope::InstanceMethods
 
         class << self
           def cs__load_protect arg

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,9 @@ 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
+        extend Contrast::Components::Logger::InstanceMethods
+        extend Contrast::Components::Scope::InstanceMethods
 
-        access_component :analysis, :logging, :scope
 
         REGEXP_EQUAL_SQUIGGLE_HASH = {
             'id' => 'regexp_100',
@@ -34,7 +35,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

data/lib/contrast/extension/assess/string.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
       # String Class or exposing our methods there.
       class StringPropagator
-        include Contrast::Components::Interface
-
-        access_component :agent, :analysis, :logging, :scope
+        extend Contrast::Components::Logger::InstanceMethods
+        extend Contrast::Components::Scope::InstanceMethods
 
         NODE_HASH = {
             'class_name' => 'String',
@@ -31,7 +31,7 @@ module Contrast
 
         class << self
           def track_interpolation inputs, result
-            return unless AGENT.interpolation_enabled?
+            return unless ::Contrast::AGENT.interpolation_enabled?
             return if in_contrast_scope?
             return unless inputs.any? { |input| Contrast::Agent::Assess::Tracker.tracked?(input) }
 
@@ -66,7 +66,7 @@ module Contrast
           def instrument_string_interpolation
             if @_instrument_string_interpolation.nil?
               @_instrument_string_interpolation = begin
-                if AGENT.patch_interpolation? && Funchook.available?
+                if ::Contrast::AGENT.patch_interpolation? && Funchook.available?
                   require 'cs__assess_string_interpolation26/cs__assess_string_interpolation26'
                 end
                 true