contrast-agent 4.4.1 → 4.9.0

data/lib/contrast/config.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast

data/lib/contrast/config/agent_configuration.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast

data/lib/contrast/config/application_configuration.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/config/default_value'

data/lib/contrast/config/assess_configuration.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast

data/lib/contrast/config/assess_rules_configuration.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast
@@ -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

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'forwardable'
@@ -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/default_value.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast

data/lib/contrast/config/exception_configuration.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast
@@ -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

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast
@@ -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/inventory_configuration.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast

data/lib/contrast/config/logger_configuration.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast
@@ -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/config/protect_configuration.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast

data/lib/contrast/config/protect_rule_configuration.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'set'
@@ -18,6 +18,28 @@ module Contrast
       def initialize hsh
         super(hsh, KEYS)
       end
+
+      # To convert the user input mode from config to a standard format used by TS & SR, we need to convert the given
+      # String to its Contrast::Api::Settings::ProtectionRule::Mode equivalent. If a nonsense value is provided, it'll
+      # be treated the same as disabling the rule.
+      #
+      # @return [Contrast::Api::Settings::ProtectionRule::Mode, nil]
+      def applicable_mode
+        return unless mode
+
+        case mode
+        when 'permit'
+          Contrast::Api::Settings::ProtectionRule::Mode::PERMIT
+        when 'block_at_perimeter'
+          Contrast::Api::Settings::ProtectionRule::Mode::BLOCK_AT_PERIMETER
+        when 'block'
+          Contrast::Api::Settings::ProtectionRule::Mode::BLOCK
+        when 'monitor'
+          Contrast::Api::Settings::ProtectionRule::Mode::MONITOR
+        else
+          Contrast::Api::Settings::ProtectionRule::Mode::NO_ACTION
+        end
+      end
     end
   end
 end

data/lib/contrast/config/protect_rules_configuration.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast

data/lib/contrast/config/root_configuration.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast

data/lib/contrast/config/ruby_configuration.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast

data/lib/contrast/config/sampling_configuration.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast

data/lib/contrast/config/server_configuration.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast

data/lib/contrast/config/service_configuration.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/config/default_value'

data/lib/contrast/configuration.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'yaml'
@@ -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.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast

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

@@ -1,9 +1,9 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 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

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 # This module is used to track propagation through ERB template rendering
@@ -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) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# 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
@@ -24,9 +23,6 @@ module Contrast
           end
 
           def apply_trigger obj, source, ret, clazz, method
-            current_context = Contrast::Agent::REQUEST_TRACKER.current
-            return unless current_context
-
             # Since we know this is the source of the trigger, we can do some
             # optimization here and return when it is not tracked
             return unless Contrast::Utils::Assess::TrackingUtil.tracked?(source)
@@ -34,13 +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(
-                current_context,
-                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

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/agent/at_exit_hook'
@@ -11,9 +11,6 @@ module Contrast
       # the trigger at the start in order to account for the process hand off.
       module ExecTrigger
         def apply_trigger source
-          current_context = Contrast::Agent::REQUEST_TRACKER.current
-          return unless current_context
-
           # Since we know this is the source of the trigger, we can do some
           # optimization here and return when it is not tracked
           return unless Contrast::Utils::Assess::TrackingUtil.tracked?(source)
@@ -21,21 +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(
-              current_context,
-              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