contrast-agent 4.14.0 → 5.2.0

data/lib/contrast/config/heap_dump_configuration.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast
@@ -6,23 +6,107 @@ module Contrast
     # Common Configuration settings. Those in this section pertain to the
     # Heap Dump collection functionality of the Agent.
     class HeapDumpConfiguration < BaseConfiguration
-      KEYS = {
-          enable:                                                                   # should dumps be taken
-            Contrast::Utils::ObjectShare::FALSE,
-          path:                                                                     # dir to which dumps should be
-            'contrast_heap_dumps', # saved
-          delay_ms:                                                                 # time, in ms, after initialization
-            10_000, # to delay before taking dump
-          window_ms:                                                                # ms between each dump
-            10_000, #
-          count:                                                                    # number of dumps to take
-            5, #
-          clean:                                                                    # remove temporary objects or not
-            Contrast::Utils::ObjectShare::FALSE #
-      }.cs__freeze
-
-      def initialize hsh
-        super(hsh, KEYS)
+      DEFAULT_PATH = 'contrast_heap_dumps' # saved
+      DEFAULT_MS = 10_000
+      DEFAULT_COUNT = 5
+
+      def initialize hsh = {}
+        @enable = traverse_config(hsh, :enable)
+        @path = traverse_config(hsh, :path)
+        @delay_ms = traverse_config(hsh, :delay_ms)
+        @window_ms = traverse_config(hsh, :window_ms)
+        @count = traverse_config(hsh, :count)
+        @clean = traverse_config(hsh, :clean)
+        @configuration_map = {}
+        build_configuration_map
+      end
+
+      # @return [Boolean, false] should dumps be taken
+      def enable
+        !!@enable
+      end
+
+      # @return [String, DEFAULT_PATH] dir to which dumps should be
+      def path
+        @path ||= DEFAULT_PATH
+      end
+
+      # @return [Integer, DEFAULT_MS] time, in ms, after initialization
+      def delay_ms
+        @delay_ms ||= DEFAULT_MS
+      end
+
+      # @return [Integer, DEFAULT_MS] ms between each dump
+      def window_ms
+        @window_ms ||= DEFAULT_MS
+      end
+
+      # @return [Integer, DEFAULT_MS] number of dumps to take
+      def count
+        @count ||= DEFAULT_COUNT
+      end
+
+      # @return [Boolean, false] remove temporary objects or not
+      def clean
+        !!@clean
+      end
+
+      def enable= value
+        self['enable'] = value
+      end
+
+      def path= value
+        self['path'] = value
+      end
+
+      def delay_ms= value
+        self['delay_ms'] = value
+      end
+
+      def window_ms= value
+        self['window_ms'] = value
+      end
+
+      def count= value
+        self['count'] = value
+      end
+
+      def clean= value
+        self['clean'] = value
+      end
+
+      # TODO: RUBY-1493 MOVE TO BASE CONFIG
+
+      def []= key, value
+        instance_variable_set("@#{ key }".to_sym, value)
+        @configuration_map[key] = value
+      end
+
+      def [] key
+        send(key.to_sym)
+      end
+
+      # Traverse the given entity to build out the configuration graph.
+      #
+      # The values will be either a hash, indicating internal nodes to
+      # traverse, or a value to set or the EMPTY_VALUE symbol, indicating a
+      # leaf node.
+      #
+      # The spec_key are the Contrast defined keys based on the instance variables of
+      # a given configuration.
+      def traverse_config values, spec_key
+        internal_nodes = values.cs__respond_to?(:has_key?)
+        val = internal_nodes ? value_from_key_config(spec_key, values) : nil
+        val == EMPTY_VALUE ? nil : val
+      end
+
+      def build_configuration_map
+        instance_variables.each do |key|
+          str_key = key.to_s.tr('@', '')
+          next if str_key == 'configuration_map'
+
+          @configuration_map[str_key] = send(str_key.to_sym)
+        end
       end
     end
   end

data/lib/contrast/config/inventory_configuration.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast
@@ -6,10 +6,71 @@ module Contrast
     # Common Configuration settings. Those in this section pertain to the
     # inventory functionality of the Agent.
     class InventoryConfiguration < BaseConfiguration
-      KEYS = { enable: true, analyze_libraries: true, tags: EMPTY_VALUE }.cs__freeze
+      # @return [Array, nil] tags
+      attr_reader :tags
 
-      def initialize hsh
-        super(hsh, KEYS)
+      def initialize hsh = {}
+        @enable = traverse_config(hsh, :enable)
+        @analyze_libraries = traverse_config(hsh, :analyze_libraries)
+        @tags = traverse_config(hsh, :tags)
+        @configuration_map = {}
+        build_configuration_map
+      end
+
+      # @return [Boolean, true]
+      def enable
+        @enable.nil? ? true : @enable
+      end
+
+      # @return [Boolean, true]
+      def analyze_libraries
+        @analyze_libraries.nil? ? true : @analyze_libraries
+      end
+
+      def enable= value
+        self['enable'] = value
+      end
+
+      def analyze_libraries= value
+        self['analyze_libraries'] = value
+      end
+
+      def tags= value
+        self['tags'] = value
+      end
+
+      # TODO: RUBY-1493 MOVE TO BASE CONFIG
+
+      def []= key, value
+        instance_variable_set("@#{ key }".to_sym, value)
+        @configuration_map[key] = value
+      end
+
+      def [] key
+        send(key.to_sym)
+      end
+
+      # Traverse the given entity to build out the configuration graph.
+      #
+      # The values will be either a hash, indicating internal nodes to
+      # traverse, or a value to set or the EMPTY_VALUE symbol, indicating a
+      # leaf node.
+      #
+      # The spec_key are the Contrast defined keys based on the instance variables of
+      # a given configuration.
+      def traverse_config values, spec_key
+        internal_nodes = values.cs__respond_to?(:has_key?)
+        val = internal_nodes ? value_from_key_config(spec_key, values) : nil
+        val == EMPTY_VALUE ? nil : val
+      end
+
+      def build_configuration_map
+        instance_variables.each do |key|
+          str_key = key.to_s.tr('@', '')
+          next if str_key == 'configuration_map'
+
+          @configuration_map[str_key] = send(str_key.to_sym)
+        end
       end
     end
   end

data/lib/contrast/config/logger_configuration.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast
@@ -6,10 +6,53 @@ 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
+      # @return [String, nil]
+      attr_accessor :path
+      # @return [String, nil]
+      attr_accessor :level
+      # @return [String, nil]
+      attr_accessor :progname
 
-      def initialize hsh
-        super(hsh, KEYS)
+      def initialize hsh = {}
+        @path = traverse_config(hsh, :path)
+        @level = traverse_config(hsh, :level)
+        @progname = traverse_config(hsh, :progname)
+        @configuration_map = {}
+        build_configuration_map
+      end
+
+      # TODO: RUBY-1493 MOVE TO BASE CONFIG
+
+      def []= key, value
+        instance_variable_set("@#{ key }".to_sym, value)
+        @configuration_map[key] = value
+      end
+
+      def [] key
+        send(key.to_sym)
+      end
+
+      # Traverse the given entity to build out the configuration graph.
+      #
+      # The values will be either a hash, indicating internal nodes to
+      # traverse, or a value to set or the EMPTY_VALUE symbol, indicating a
+      # leaf node.
+      #
+      # The spec_key are the Contrast defined keys based on the instance variables of
+      # a given configuration.
+      def traverse_config values, spec_key
+        internal_nodes = values.cs__respond_to?(:has_key?)
+        val = internal_nodes ? value_from_key_config(spec_key, values) : nil
+        val == EMPTY_VALUE ? nil : val
+      end
+
+      def build_configuration_map
+        instance_variables.each do |key|
+          str_key = key.to_s.tr('@', '')
+          next if str_key == 'configuration_map'
+
+          @configuration_map[str_key] = send(str_key.to_sym)
+        end
       end
     end
   end

data/lib/contrast/config/protect_configuration.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 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) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'set'
@@ -8,15 +8,15 @@ module Contrast
     # Common Configuration settings. Those in this section pertain to the
     # rule mode of a single protect rule in the Agent.
     class ProtectRuleConfiguration < BaseConfiguration
-      KEYS = {
-          enable: EMPTY_VALUE,
-          mode: EMPTY_VALUE,
-          disable_system_commands: EMPTY_VALUE,
-          detect_custom_code_accessing_system_files: true
-      }.cs__freeze
-
-      def initialize hsh
-        super(hsh, KEYS)
+      attr_accessor :enable, :mode, :disable_system_commands, :detect_custom_code_accessing_system_files
+
+      def initialize hsh = {}
+        @enable = traverse_config(hsh, :enable)
+        @mode = traverse_config(hsh, :mode)
+        @disable_system_commands = traverse_config(hsh, :disable_system_commands)
+        @detect_custom_code_accessing_system_files = traverse_config(hsh, :detect_custom_code_accessing_system_files)
+        @configuration_map = {}
+        build_configuration_map
       end
 
       # To convert the user input mode from config to a standard format used by TS & SR, we need to convert the given
@@ -40,6 +40,33 @@ module Contrast
           Contrast::Api::Settings::ProtectionRule::Mode::NO_ACTION
         end
       end
+
+      def [] key
+        send(key.to_sym)
+      end
+
+      # Traverse the given entity to build out the configuration graph.
+      #
+      # The values will be either a hash, indicating internal nodes to
+      # traverse, or a value to set or the EMPTY_VALUE symbol, indicating a
+      # leaf node.
+      #
+      # The spec_key are the Contrast defined keys based on the instance variables of
+      # a given configuration.
+      def traverse_config values, spec_key
+        internal_nodes = values.cs__respond_to?(:has_key?)
+        val = internal_nodes ? value_from_key_config(spec_key, values) : nil
+        val == EMPTY_VALUE ? nil : val
+      end
+
+      def build_configuration_map
+        instance_variables.each do |key|
+          str_key = key.to_s.tr('@', '')
+          next if str_key == 'configuration_map'
+
+          @configuration_map[str_key] = send(str_key.to_sym)
+        end
+      end
     end
   end
 end

data/lib/contrast/config/protect_rules_configuration.rb

@@ -1,28 +1,131 @@
-# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
+require 'contrast/config/protect_rule_configuration'
+
 module Contrast
   module Config
     # Common Configuration settings. Those in this section pertain to the
     # protect rule modes of the Agent.
     class ProtectRulesConfiguration < BaseConfiguration
-      KEYS = {
-          disabled_rules: EMPTY_VALUE,
-          'bot-blocker' => Contrast::Config::ProtectRuleConfiguration,
-          'cmd-injection' => Contrast::Config::ProtectRuleConfiguration,
-          'sql-injection' => Contrast::Config::ProtectRuleConfiguration,
-          'nosql-injection' => Contrast::Config::ProtectRuleConfiguration,
-          'untrusted-deserialization' => Contrast::Config::ProtectRuleConfiguration,
-          'method-tampering' => Contrast::Config::ProtectRuleConfiguration,
-          xxe: Contrast::Config::ProtectRuleConfiguration,
-          'path-traversal' => Contrast::Config::ProtectRuleConfiguration,
-          'reflected-xss' => Contrast::Config::ProtectRuleConfiguration,
-          'unsafe-file-upload' => Contrast::Config::ProtectRuleConfiguration,
-          'Contrast::Agent::Protect::Rule::Base' => Contrast::Config::ProtectRuleConfiguration
-      }.cs__freeze
-
-      def initialize hsh
-        super(hsh, KEYS)
+      attr_reader :disabled_rules
+
+      BASE_RULE = 'Contrast::Agent::Protect::Rule::Base'.cs__freeze
+
+      def initialize hsh = {}
+        @disabled_rules = traverse_config(hsh, :disabled_rules)
+        @bot_blocker = Contrast::Config::ProtectRuleConfiguration.new(traverse_config(hsh, 'bot-blocker'))
+        @cmd_injection = Contrast::Config::ProtectRuleConfiguration.new(traverse_config(hsh, 'cmd-injection'))
+        @sql_injection = Contrast::Config::ProtectRuleConfiguration.new(traverse_config(hsh, 'sql-injection'))
+        @nosql_injection = Contrast::Config::ProtectRuleConfiguration.new(traverse_config(hsh, 'nosql-injection'))
+        @untrusted_deserialization = Contrast::Config::ProtectRuleConfiguration.new(traverse_config(
+                                                                                        hsh,
+                                                                                        'untrusted-deserialization'))
+        @method_tampering = Contrast::Config::ProtectRuleConfiguration.new(traverse_config(hsh, 'method-tampering'))
+        @xxe = Contrast::Config::ProtectRuleConfiguration.new(traverse_config(hsh, :xxe))
+        @path_traversal = Contrast::Config::ProtectRuleConfiguration.new(traverse_config(hsh, 'path-traversal'))
+        @reflected_xss = Contrast::Config::ProtectRuleConfiguration.new(traverse_config(hsh, 'reflected-xss'))
+        @unsafe_file_upload = Contrast::Config::ProtectRuleConfiguration.new(traverse_config(hsh, 'unsafe-file-upload'))
+        @rule_base = Contrast::Config::ProtectRuleConfiguration.new(traverse_config(hsh, BASE_RULE))
+        @configuration_map = {}
+        build_configuration_map
+      end
+
+      def bot_blocker
+        @bot_blocker ||= Contrast::Config::ProtectRuleConfiguration.new
+      end
+
+      def cmd_injection
+        @cmd_injection ||= Contrast::Config::ProtectRuleConfiguration.new
+      end
+
+      def sql_injection
+        @sql_injection ||= Contrast::Config::ProtectRuleConfiguration.new
+      end
+
+      def nosql_injection
+        @nosql_injection ||= Contrast::Config::ProtectRuleConfiguration.new
+      end
+
+      def untrusted_deserialization
+        @untrusted_deserialization ||= Contrast::Config::ProtectRuleConfiguration.new
+      end
+
+      def method_tampering
+        @method_tampering ||= Contrast::Config::ProtectRuleConfiguration.new
+      end
+
+      def xxe
+        @xxe ||= Contrast::Config::ProtectRuleConfiguration.new
+      end
+
+      def path_traversal
+        @path_traversal ||= Contrast::Config::ProtectRuleConfiguration.new
+      end
+
+      def reflected_xss
+        @reflected_xss ||= Contrast::Config::ProtectRuleConfiguration.new
+      end
+
+      def unsafe_file_upload
+        @unsafe_file_upload ||= Contrast::Config::ProtectRuleConfiguration.new
+      end
+
+      def rule_base
+        @rule_base ||= Contrast::Config::ProtectRuleConfiguration.new
+      end
+
+      def [] key
+        send(return_proper_class(key).to_sym)
+      end
+
+      # Traverse the given entity to build out the configuration graph.
+      #
+      # The values will be either a hash, indicating internal nodes to
+      # traverse, or a value to set or the EMPTY_VALUE symbol, indicating a
+      # leaf node.
+      #
+      # The spec_key are the Contrast defined keys based on the instance variables of
+      # a given configuration.
+      def traverse_config values, spec_key
+        internal_nodes = values.cs__respond_to?(:has_key?)
+        val = internal_nodes ? value_from_key_config(spec_key, values) : nil
+        val == EMPTY_VALUE ? nil : val
+      end
+
+      def build_configuration_map
+        change_vals = { '@' => '', '-' => '_' }
+        regexp = Regexp.union(change_vals.keys)
+        instance_variables.each do |key|
+          str_key = key.to_s.gsub(regexp, change_vals)
+          next if str_key == 'configuration_map'
+
+          @configuration_map[return_proper_class(str_key)] = send(str_key.to_sym)
+        end
+      end
+
+      # This method is to handle the specific case of
+      # Contrast::Agent::Protect::Rule::Base from protect/base.rb#initialize
+      #
+      # @param str_key [String] the key we want to check form the config
+      # @return String
+      def return_proper_class str_key
+        return BASE_RULE if str_key == 'rule_base'
+        return 'rule_base' if str_key == BASE_RULE
+
+        str_key
+      end
+
+      # if method 'Contrast::Agent::Protect::Rule::Base' is being called from convert_to_hash
+      # handle missing method and call original getter
+      def method_missing name, *_args
+        return unless name.to_s.include?('Base') || name.to_s.start_with?('Contrast')
+
+        @rule_base
+      end
+
+      def respond_to_missing? method_name, include_private = false
+        (method_name.to_s.include?('Base') || method_name.to_s.start_with?('Contrast')) || super
       end
     end
   end

data/lib/contrast/config/request_audit_configuration.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast
@@ -8,10 +8,75 @@ module Contrast
     class RequestAuditConfiguration < BaseConfiguration
       DEFAULT_PATH = './messages'
 
-      KEYS = { enable: false, requests: false, responses: false, path: DEFAULT_PATH }.cs__freeze
+      def initialize hsh = {}
+        @enable = traverse_config(hsh, :enable)
+        @requests = traverse_config(hsh, :requests)
+        @responses = traverse_config(hsh, :responses)
+        @path = traverse_config(hsh, :path)
+        @configuration_map = {}
+        build_configuration_map
+      end
+
+      def enable
+        @enable.nil? ? false : @enable
+      end
+
+      def requests
+        @requests.nil? ? false : @requests
+      end
+
+      def responses
+        @responses.nil? ? false : @responses
+      end
+
+      def path
+        @path.nil? ? DEFAULT_PATH : @path
+      end
+
+      def enable= value
+        self['enable'] = value
+      end
+
+      def requests= value
+        self['requests'] = value
+      end
+
+      def responses= value
+        self['responses'] = value
+      end
+
+      def path= value
+        self['path'] = value
+      end
+
+      # TODO: RUBY-1493 MOVE TO BASE CONFIG
+
+      def []= key, value
+        instance_variable_set("@#{ key }".to_sym, value)
+        @configuration_map[key] = value
+      end
+
+      # Traverse the given entity to build out the configuration graph.
+      #
+      # The values will be either a hash, indicating internal nodes to
+      # traverse, or a value to set or the EMPTY_VALUE symbol, indicating a
+      # leaf node.
+      #
+      # The spec_key are the Contrast defined keys based on the instance variables of
+      # a given configuration.
+      def traverse_config values, spec_key
+        internal_nodes = values.cs__respond_to?(:has_key?)
+        val = internal_nodes ? value_from_key_config(spec_key, values) : nil
+        val == EMPTY_VALUE ? nil : val
+      end
+
+      def build_configuration_map
+        instance_variables.each do |key|
+          str_key = key.to_s.tr('@', '')
+          next if str_key == 'configuration_map'
 
-      def initialize hsh
-        super(hsh, KEYS)
+          @configuration_map[str_key] = send(str_key.to_sym)
+        end
       end
     end
   end

data/lib/contrast/config/root_configuration.rb

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