contrast-agent 5.3.0 → 6.1.1

data/lib/contrast/config/base_configuration.rb

@@ -6,25 +6,19 @@ require 'contrast/utils/object_share'
 
 module Contrast
   module Config
-    # This is the base for our configuration classes. It is intended to
-    # facilitate the translation of the Common Configuration settings to usable
-    # Ruby classes.
-    class BaseConfiguration
+    # This is the base for our configuration classes. It is intended to facilitate the translation of the Common
+    # Configuration settings to usable Ruby classes.
+    module BaseConfiguration
       extend Forwardable
 
-      attr_reader :configuration_map
-
-      alias_method :to_hash, :configuration_map
-      def_delegators :@configuration_map, :empty?, :key?, :delete, :fetch,
-                     :[], :[]=, :each, :each_pair, :each_key, :each_value
-
-      EMPTY_VALUE = :EMPTY_VALUE
-
-      def initialize hsh = {}, keys = {}
-        # holds configuration key value pairs
-        # each configuration class can contain nested BaseConfigurations
-        @configuration_map = {}
-        traverse_config(hsh, keys)
+      def to_hash
+        hsh = {}
+        instance_variables.each do |iv|
+          # strip the '@' to get the key
+          key = iv.to_s[1..]
+          hsh[key] = send(key.to_sym)
+        end
+        hsh
       end
 
       def assign_value_to_path_array dot_path_array, value
@@ -39,65 +33,6 @@ module Contrast
         end
         nil
       end
-
-      def nil?
-        @configuration_map.empty?
-      end
-
-      private
-
-      # 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_keys are the Contrast defined keys used to access a given
-      # configuration. Each child of this class maintains its own set of keys,
-      # as well as Objects to which those keys map.
-      def traverse_config values, spec_keys
-        internal_nodes = values.cs__respond_to?(:has_key?)
-        spec_keys.each_pair do |spec_key, spec_value|
-          user_provided_value = internal_nodes ? value_from_key_config(spec_key, values) : EMPTY_VALUE
-          define_methods(spec_key, spec_value, user_provided_value)
-        end
-      end
-
-      def define_methods spec_key, spec_value, user_provided_value
-        str_key = spec_key.to_s
-        assign_config_value(str_key, spec_value, user_provided_value)
-        define_getter(str_key)
-        define_setter(str_key)
-      end
-
-      def assign_config_value str_key, spec_value, user_provided_value
-        @configuration_map[str_key] = if spec_value.is_a?(Class) && spec_value <= Contrast::Config::BaseConfiguration
-                                        spec_value.new(user_provided_value)
-                                      elsif user_provided_value == EMPTY_VALUE
-                                        spec_value
-                                      else
-                                        user_provided_value
-                                      end
-      end
-
-      def value_from_key_config key, config_hash
-        return config_hash[key] if config_hash.key?(key)
-        return config_hash.fetch(key.to_sym, EMPTY_VALUE) if key.is_a?(String)
-
-        config_hash.fetch(key.to_s, EMPTY_VALUE)
-      end
-
-      def define_getter str_key
-        define_singleton_method str_key.to_sym do
-          @configuration_map[str_key] == EMPTY_VALUE ? nil : @configuration_map[str_key]
-        end
-      end
-
-      def define_setter str_key
-        define_singleton_method "#{ str_key }=".to_sym do |new_value|
-          @configuration_map[str_key] = new_value
-        end
-      end
     end
   end
 end

data/lib/contrast/config/certification_configuration.rb

@@ -4,82 +4,29 @@
 module Contrast
   module Config
     # Certificate Configuration
-    class CertificationConfiguration < BaseConfiguration
+    class CertificationConfiguration
+      include Contrast::Config::BaseConfiguration
+
       # @return [String] path to CA Cert file
-      attr_reader :ca_file
+      attr_accessor :ca_file
       # @return [String] path to Certification file
-      attr_reader :cert_file
+      attr_accessor :cert_file
       # @return [String] path to Certification Key file
-      attr_reader :key_file
+      attr_accessor :key_file
+      attr_writer :enable
 
       def initialize hsh = {}
-        @enable = traverse_config(hsh, :enable)
-        @ca_file = traverse_config(hsh, :ca_file)
-        @cert_file = traverse_config(hsh, :cert_file)
-        @key_file = traverse_config(hsh, :key_file)
-        @configuration_map = {}
-        build_configuration_map
-      end
-
-      # GETTERS
-
-      # @return [Boolean]
-      def enable
-        return false if @enable.nil?
-
-        @enable
-      end
-
-      # SETTERS
-
-      def enable= value
-        self['enable'] = value
-      end
-
-      def ca_file= value
-        self['ca_file'] = value
-      end
+        return unless hsh
 
-      def cert_file= value
-        self['cert_file'] = value
+        @enable = hsh[:enable]
+        @ca_file = hsh[:ca_file]
+        @cert_file = hsh[:cert_file]
+        @key_file = hsh[:key_file]
       end
 
-      def key_file= value
-        self['key_file'] = 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
+      # @return [Boolean, false]
+      def enable
+        @enable.nil? ? false : @enable
       end
     end
   end

data/lib/contrast/config/exception_configuration.rb

@@ -3,72 +3,28 @@
 
 module Contrast
   module Config
-    # Common Configuration settings. Those in this section pertain to the
-    # exception handling in Ruby, allowing for the override of Response Code
-    # and Message when Security Exceptions are raised.
-    class ExceptionConfiguration < BaseConfiguration
+    # Common Configuration settings. Those in this section pertain to the exception handling in Ruby, allowing for the
+    # override of Response Code and Message when Security Exceptions are raised.
+    class ExceptionConfiguration
+      include Contrast::Config::BaseConfiguration
+
       # @return [Integer] the HTTP status code override
-      attr_reader :override_status
+      attr_accessor :override_status
       # @return [String] the message text override
-      attr_reader :override_message
+      attr_accessor :override_message
+      attr_writer :capture
 
       def initialize hsh = {}
-        @capture = traverse_config(hsh, :capture)
-        @override_status = traverse_config(hsh, :override_status)
-        @override_message = traverse_config(hsh, :override_message)
-        @configuration_map = {}
-        build_configuration_map
-      end
-
-      # @return [Boolean] default: false
-      def capture
-        @capture.nil? ? false : @capture
-      end
-
-      def capture= value
-        self['capture'] = value
-      end
-
-      def override_status= value
-        self['override_status'] = value
-      end
+        return unless hsh
 
-      def override_message= value
-        self['override_message'] = value
+        @capture = hsh[:capture]
+        @override_status = hsh[:override_status]
+        @override_message = hsh[:override_message]
       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
+      # @return [Boolean, false]
+      def capture
+        !!@capture
       end
     end
   end

data/lib/contrast/config/heap_dump_configuration.rb

@@ -3,27 +3,31 @@
 
 module Contrast
   module Config
-    # Common Configuration settings. Those in this section pertain to the
-    # Heap Dump collection functionality of the Agent.
-    class HeapDumpConfiguration < BaseConfiguration
+    # Common Configuration settings. Those in this section pertain to the Heap Dump collection functionality of the
+    # Agent.
+    class HeapDumpConfiguration
+      include Contrast::Config::BaseConfiguration
+
       DEFAULT_PATH = 'contrast_heap_dumps' # saved
       DEFAULT_MS = 10_000
       DEFAULT_COUNT = 5
 
+      attr_writer :enable, :path, :delay_ms, :window_ms, :count, :clean
+
       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
+        return unless hsh
+
+        @enable = hsh[:enable]
+        @path = hsh[:path]
+        @delay_ms = hsh[:delay_ms]
+        @window_ms = hsh[:window_ms]
+        @count = hsh[:count]
+        @clean = hsh[:clean]
       end
 
-      # @return [Boolean, false] should dumps be taken
+      # @return [Boolean, Contrast::Utils::ObjectShare::FALSE] should dumps be taken
       def enable
-        !!@enable
+        @enable.nil? ? Contrast::Utils::ObjectShare::FALSE : @enable
       end
 
       # @return [String, DEFAULT_PATH] dir to which dumps should be
@@ -46,67 +50,9 @@ module Contrast
         @count ||= DEFAULT_COUNT
       end
 
-      # @return [Boolean, false] remove temporary objects or not
+      # @return [Boolean, Contrast::Utils::ObjectShare::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
+        @clean.nil? ? Contrast::Utils::ObjectShare::FALSE : @clean
       end
     end
   end

data/lib/contrast/config/inventory_configuration.rb

@@ -3,18 +3,20 @@
 
 module Contrast
   module Config
-    # Common Configuration settings. Those in this section pertain to the
-    # inventory functionality of the Agent.
-    class InventoryConfiguration < BaseConfiguration
+    # Common Configuration settings. Those in this section pertain to the inventory functionality of the Agent.
+    class InventoryConfiguration
+      include Contrast::Config::BaseConfiguration
+
       # @return [Array, nil] tags
-      attr_reader :tags
+      attr_accessor :tags
+      attr_writer :enable, :analyze_libraries
 
       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
+        return unless hsh
+
+        @enable = hsh[:enable]
+        @analyze_libraries = hsh[:analyze_libraries]
+        @tags = hsh[:tags]
       end
 
       # @return [Boolean, true]
@@ -26,52 +28,6 @@ module Contrast
       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
 end

data/lib/contrast/config/logger_configuration.rb

@@ -3,9 +3,10 @@
 
 module Contrast
   module Config
-    # Common Configuration settings. Those in this section pertain to the
-    # logging in the Agent.
-    class LoggerConfiguration < BaseConfiguration
+    # Common Configuration settings. Those in this section pertain to the logging in the Agent.
+    class LoggerConfiguration
+      include Contrast::Config::BaseConfiguration
+
       # @return [String, nil]
       attr_accessor :path
       # @return [String, nil]
@@ -14,45 +15,11 @@ module Contrast
       attr_accessor :progname
 
       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'
+        return unless hsh
 
-          @configuration_map[str_key] = send(str_key.to_sym)
-        end
+        @path = hsh[:path]
+        @level = hsh[:level]
+        @progname = hsh[:progname]
       end
     end
   end

data/lib/contrast/config/protect_configuration.rb

@@ -3,17 +3,30 @@
 
 module Contrast
   module Config
-    # Common Configuration settings. Those in this section pertain to the
-    # protect functionality of the Agent.
-    class ProtectConfiguration < BaseConfiguration
-      KEYS = {
-          exceptions: Contrast::Config::ExceptionConfiguration,
-          rules: Contrast::Config::ProtectRulesConfiguration,
-          enable: EMPTY_VALUE
-      }.cs__freeze
+    # Common Configuration settings. Those in this section pertain to the protect functionality of the Agent.
+    class ProtectConfiguration
+      include Contrast::Config::BaseConfiguration
 
-      def initialize hsh
-        super(hsh, KEYS)
+      # @return [Boolean, nil]
+      attr_accessor :enable
+      attr_writer :exceptions, :rules
+
+      def initialize hsh = {}
+        return unless hsh
+
+        @exceptions = Contrast::Config::ExceptionConfiguration.new(hsh[:exceptions])
+        @rules = Contrast::Config::ProtectRulesConfiguration.new(hsh[:rules])
+        @enable = hsh[:enable]
+      end
+
+      # @return [Contrast::Config::ExceptionConfiguration]
+      def exceptions
+        @exceptions ||= Contrast::Config::ExceptionConfiguration.new
+      end
+
+      # @return [Contrast::Config::ProtectRulesConfiguration]
+      def rules
+        @rules ||= Contrast::Config::ProtectRulesConfiguration.new
       end
     end
   end

data/lib/contrast/config/protect_rule_configuration.rb

@@ -5,18 +5,31 @@ require 'set'
 
 module Contrast
   module Config
-    # Common Configuration settings. Those in this section pertain to the
-    # rule mode of a single protect rule in the Agent.
-    class ProtectRuleConfiguration < BaseConfiguration
-      attr_accessor :enable, :mode, :disable_system_commands, :detect_custom_code_accessing_system_files
+    # Common Configuration settings. Those in this section pertain to the rule mode of a single protect rule in the
+    # Agent.
+    class ProtectRuleConfiguration
+      include Contrast::Config::BaseConfiguration
+
+      # @return [Boolean, nil]
+      attr_accessor :enable
+      # @return [String, nil]
+      attr_accessor :mode
+      # @return [Boolean, nil]
+      attr_accessor :disable_system_commands
+      attr_writer :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
+        return unless hsh
+
+        @enable = hsh[:enable]
+        @mode = hsh[:mode]
+        @disable_system_commands = hsh[:disable_system_commands]
+        @detect_custom_code_accessing_system_files = hsh[:detect_custom_code_accessing_system_files]
+      end
+
+      # @return [Boolean, true]
+      def detect_custom_code_accessing_system_files
+        @detect_custom_code_accessing_system_files.nil? ? true : @detect_custom_code_accessing_system_files
       end
 
       # To convert the user input mode from config to a standard format used by TS & SR, we need to convert the given
@@ -40,33 +53,6 @@ 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