contrast-agent 5.3.0 → 6.1.1

data/lib/contrast/config/protect_rules_configuration.rb

@@ -5,30 +5,31 @@ 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
-      attr_reader :disabled_rules
+    # Common Configuration settings. Those in this section pertain to the protect rule modes of the Agent.
+    class ProtectRulesConfiguration
+      include Contrast::Config::BaseConfiguration
+
+      attr_accessor :disabled_rules
+      attr_writer :bot_blocker, :cmd_injection, :sql_injection, :nosql_injection, :untrusted_deserialization,
+                  :xxe, :path_traversal, :reflected_xss, :unsafe_file_upload, :rule_base
 
       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
+        return unless hsh
+
+        @disabled_rules = hsh[:disabled_rules]
+        @rule_base = Contrast::Config::ProtectRuleConfiguration.new(hsh[BASE_RULE.to_sym])
+        @bot_blocker = Contrast::Config::ProtectRuleConfiguration.new(hsh[:'bot-blocker'])
+        @cmd_injection = Contrast::Config::ProtectRuleConfiguration.new(hsh[:'cmd-injection'])
+        @method_tampering = Contrast::Config::ProtectRuleConfiguration.new(hsh[:'method-tampering'])
+        @nosql_injection = Contrast::Config::ProtectRuleConfiguration.new(hsh[:'nosql-injection'])
+        @path_traversal = Contrast::Config::ProtectRuleConfiguration.new(hsh[:'path-traversal'])
+        @reflected_xss = Contrast::Config::ProtectRuleConfiguration.new(hsh[:'reflected-xss'])
+        @sql_injection = Contrast::Config::ProtectRuleConfiguration.new(hsh[:'sql-injection'])
+        @unsafe_file_upload = Contrast::Config::ProtectRuleConfiguration.new(hsh[:'unsafe-file-upload'])
+        @untrusted_deserialization = Contrast::Config::ProtectRuleConfiguration.new(hsh[:'untrusted-deserialization'])
+        @xxe = Contrast::Config::ProtectRuleConfiguration.new(hsh[:xxe])
       end
 
       def bot_blocker
@@ -75,33 +76,28 @@ module Contrast
         @rule_base ||= Contrast::Config::ProtectRuleConfiguration.new
       end
 
+      def []= key, value
+        instance_variable_set("@#{ convert_key(key) }".to_sym, value)
+      end
+
       def [] key
-        send(return_proper_class(key).to_sym)
+        send(convert_key(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)
+      def convert_key key
+        return_proper_class(key).to_s.tr('-', '_')
+      end
+
+      # Convert instance variable names to format expected by TS
+      # for adding to the hash
+      def to_hash
+        hsh = {}
+        instance_variables.each do |iv|
+          # strip the '@' to get the key
+          key = return_proper_class(iv.to_s.delete('@'))
+          hsh[key.tr('_', '-')] = send(key.to_sym)
         end
+        hsh
       end
 
       # This method is to handle the specific case of

data/lib/contrast/config/request_audit_configuration.rb

@@ -3,81 +3,42 @@
 
 module Contrast
   module Config
-    # This class holds the Common Settings for the
-    # hidden functionality of the TS
-    class RequestAuditConfiguration < BaseConfiguration
+    # This class holds the Common Settings for the hidden functionality of the TS
+    class RequestAuditConfiguration
+      include Contrast::Config::BaseConfiguration
+
       DEFAULT_PATH = './messages'
 
+      attr_writer :enable, :requests, :responses, :path
+
       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
+        return unless hsh
+
+        @enable = hsh[:enable]
+        @requests = hsh[:requests]
+        @responses = hsh[:responses]
+        @path = hsh[:path]
       end
 
+      # @return [Boolean, false]
       def enable
         @enable.nil? ? false : @enable
       end
 
+      # @return [Boolean, false]
       def requests
         @requests.nil? ? false : @requests
       end
 
+      # @return [Boolean, false]
       def responses
         @responses.nil? ? false : @responses
       end
 
+      # @return [String, ::DEFAULT_PATH]
       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'
-
-          @configuration_map[str_key] = send(str_key.to_sym)
-        end
-      end
     end
   end
 end

data/lib/contrast/config/root_configuration.rb

@@ -4,23 +4,80 @@
 module Contrast
   module Config
     # The base of the Common Configuration settings.
-    class RootConfiguration < BaseConfiguration
-      KEYS = {
-          api: Contrast::Config::ApiConfiguration,
-          enable: BaseConfiguration::EMPTY_VALUE,
-          agent: Contrast::Config::AgentConfiguration,
-          application: Contrast::Config::ApplicationConfiguration,
-          server: Contrast::Config::ServerConfiguration,
-          assess: Contrast::Config::AssessConfiguration,
-          inventory: Contrast::Config::InventoryConfiguration,
-          protect: Contrast::Config::ProtectConfiguration,
-          service: Contrast::Config::ServiceConfiguration
-      }.cs__freeze
+    class RootConfiguration
+      include Contrast::Config::BaseConfiguration
+
+      # @return [Contrast::Config::ApiConfiguration]
+      attr_writer :api
+      # @return [Contrast::Config::AgentConfiguration]
+      attr_writer :agent
+      # @return [Contrast::Config::ApplicationConfiguration]
+      attr_writer :application
+      # @return [Contrast::Config::ServerConfiguration]
+      attr_writer :server
+      # @return [Contrast::Config::AssessConfiguration]
+      attr_writer :assess
+      # @return [Contrast::Config::InventoryConfiguration]
+      attr_writer :inventory
+      # @return [Contrast::Config::ProtectConfiguration]
+      attr_writer :protect
+      # @return [Contrast::Config::ServiceConfiguration]
+      attr_writer :service
+      # @return [Boolean, nil]
+      attr_accessor :enable
 
       def initialize hsh = {}
-        raise ArgumentError, 'Expected a hash' unless hsh.is_a?(Hash)
+        raise(ArgumentError, 'Expected a hash') unless hsh.is_a?(Hash)
+
+        @api = Contrast::Config::ApiConfiguration.new(hsh[:api])
+        @enable = hsh[:enable]
+        @agent = Contrast::Config::AgentConfiguration.new(hsh[:agent])
+        @application = Contrast::Config::ApplicationConfiguration.new(hsh[:application])
+        @server = Contrast::Config::ServerConfiguration.new(hsh[:server])
+        @assess = Contrast::Config::AssessConfiguration.new(hsh[:assess])
+        @inventory = Contrast::Config::InventoryConfiguration.new(hsh[:inventory])
+        @protect = Contrast::Config::ProtectConfiguration.new(hsh[:protect])
+        @service = Contrast::Config::ServiceConfiguration.new(hsh[:service])
+      end
+
+      # @return [Contrast::Config::ApiConfiguration]
+      def api
+        @api ||= Contrast::Config::ApiConfiguration.new
+      end
+
+      # @return [Contrast::Config::AgentConfiguration]
+      def agent
+        @agent ||= Contrast::Config::AgentConfiguration.new
+      end
+
+      # @return [Contrast::Config::ApplicationConfiguration]
+      def application
+        @application ||= Contrast::Config::ApplicationConfiguration.new
+      end
+
+      # @return [Contrast::Config::ServerConfiguration]
+      def server
+        @server ||= Contrast::Config::ServerConfiguration.new
+      end
+
+      # @return [Contrast::Config::AssessConfiguration]
+      def assess
+        @assess ||= Contrast::Config::AssessConfiguration.new
+      end
+
+      # @return [Contrast::Config::InventoryConfiguration]
+      def inventory
+        @inventory ||= Contrast::Config::InventoryConfiguration.new
+      end
+
+      # @return [Contrast::Config::ProtectConfiguration]
+      def protect
+        @protect ||= Contrast::Config::ProtectConfiguration.new
+      end
 
-        super(hsh, KEYS)
+      # @return [Contrast::Config::ServiceConfiguration]
+      def service
+        @service ||= Contrast::Config::ServiceConfiguration.new
       end
     end
   end

data/lib/contrast/config/ruby_configuration.rb

@@ -3,9 +3,10 @@
 
 module Contrast
   module Config
-    # Common Configuration settings. Those in this section pertain to the
-    # specific settings that apply to Ruby
-    class RubyConfiguration < BaseConfiguration
+    # Common Configuration settings. Those in this section pertain to the specific settings that apply to Ruby
+    class RubyConfiguration
+      include Contrast::Config::BaseConfiguration
+
       DISABLED_RAKE_TASK_LIST = %w[
         about assets:clean assets:clobber assets:environment
         assets:precompile assets:precompile:all db:create db:drop db:fixtures:load db:migrate
@@ -23,16 +24,16 @@ module Contrast
                   :track_frozen_sources, :non_request_tracking, :uninstrument_namespace
 
       def initialize hsh = {}
-        @disabled_agent_rake_tasks = traverse_config(hsh, :disabled_agent_rake_tasks)
-        @exceptions = Contrast::Config::ExceptionConfiguration.new(traverse_config(hsh, :exceptions))
-        @interpolate = traverse_config(hsh, :interpolate)
-        @propagate_yield = traverse_config(hsh, :propagate_yield)
-        @require_scan = traverse_config(hsh, :require_scan)
-        @track_frozen_sources = traverse_config(hsh, :track_frozen_sources)
-        @non_request_tracking = traverse_config(hsh, :non_request_tracking)
-        @uninstrument_namespace = traverse_config(hsh, :uninstrument_namespace)
-        @configuration_map = {}
-        build_configuration_map
+        return unless hsh
+
+        @disabled_agent_rake_tasks = hsh[:disabled_agent_rake_tasks]
+        @exceptions = Contrast::Config::ExceptionConfiguration.new(hsh[:exceptions])
+        @interpolate = hsh[:interpolate]
+        @propagate_yield = hsh[:propagate_yield]
+        @require_scan = hsh[:require_scan]
+        @track_frozen_sources = hsh[:track_frozen_sources]
+        @non_request_tracking = hsh[:non_request_tracking]
+        @uninstrument_namespace = hsh[:uninstrument_namespace]
       end
 
       # These commands being detected will result the agent disabling instrumentation, generally any command
@@ -82,40 +83,6 @@ module Contrast
       def uninstrument_namespace
         @uninstrument_namespace.nil? ? DEFAULT_UNINSTRUMENTED_NAMESPACES : @uninstrument_namespace
       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/sampling_configuration.rb

@@ -3,9 +3,10 @@
 
 module Contrast
   module Config
-    # Common Configuration settings. Those in this section pertain to the
-    # sampling functionality of the Agent.
-    class SamplingConfiguration < BaseConfiguration
+    # Common Configuration settings. Those in this section pertain to the sampling functionality of the Agent.
+    class SamplingConfiguration
+      include Contrast::Config::BaseConfiguration
+
       # @return [Integer, nil]
       attr_reader :baseline
       # @return [Integer, nil]
@@ -16,72 +17,18 @@ module Contrast
       attr_reader :window_ms
 
       def initialize hsh = {}
-        @enable = traverse_config(hsh, :enable)
-        @baseline = traverse_config(hsh, :baseline)
-        @request_frequency = traverse_config(hsh, :request_frequency)
-        @response_frequency = traverse_config(hsh, :response_frequency)
-        @window_ms = traverse_config(hsh, :window_ms)
-        @configuration_map = {}
-        build_configuration_map
+        return unless hsh
+
+        @enable = hsh[:enable]
+        @baseline = hsh[:baseline]
+        @request_frequency = hsh[:request_frequency]
+        @response_frequency = hsh[:response_frequency]
+        @window_ms = hsh[:window_ms]
       end
 
       # @return [Boolean, false]
       def enable
-        @enable.nil? ? false : @enable
-      end
-
-      def enable= value
-        self['enable'] = value
-      end
-
-      def baseline= value
-        self['baseline'] = value
-      end
-
-      def request_frequency= value
-        self['request_frequency'] = value
-      end
-
-      def response_frequency= value
-        self['response_frequency'] = value
-      end
-
-      def window_ms= value
-        self['window_ms'] = 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
+        !!@enable
       end
     end
   end

data/lib/contrast/config/server_configuration.rb

@@ -3,9 +3,11 @@
 
 module Contrast
   module Config
-    # Common Configuration settings. Those in this section pertain to the
-    # server identification functionality of the Agent.
-    class ServerConfiguration < BaseConfiguration
+    # Common Configuration settings. Those in this section pertain to the server identification functionality of the
+    # Agent.
+    class ServerConfiguration
+      include Contrast::Config::BaseConfiguration
+
       # @return [String, nil]
       attr_accessor :name
       # @return [String, nil]
@@ -20,48 +22,14 @@ module Contrast
       attr_accessor :version
 
       def initialize hsh = {}
-        @path = traverse_config(hsh, :path)
-        @name = traverse_config(hsh, :name)
-        @type = traverse_config(hsh, :type)
-        @tags = traverse_config(hsh, :tags)
-        @environment = traverse_config(hsh, :environment)
-        @version = traverse_config(hsh, :version)
-        @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
+        return unless hsh
+
+        @path = hsh[:path]
+        @name = hsh[:name]
+        @type = hsh[:type]
+        @tags = hsh[:tags]
+        @environment = hsh[:environment]
+        @version = hsh[:version]
       end
     end
   end

data/lib/contrast/config/service_configuration.rb

@@ -5,36 +5,34 @@ require 'contrast/config/logger_configuration'
 
 module Contrast
   module Config
-    # Common Configuration settings. Those in this section pertain to the
-    # communication between the Agent & the Service.
-    class ServiceConfiguration < BaseConfiguration
-      # We don't set these b/c we've been asked to handle the default values of
-      # these settings differently, logging when we have to use them.
-      DEFAULT_HOST       = '127.0.0.1'
+    # Common Configuration settings. Those in this section pertain to the communication between the Agent & the Service
+    class ServiceConfiguration
+      include Contrast::Config::BaseConfiguration
+
+      # We don't set these b/c we've been asked to handle the default values of these settings differently, logging
+      # when we have to use them.
+      DEFAULT_HOST       = '127.0.0.1' # rubocop:disable Style/IpAddresses
       DEFAULT_PORT       = '30555'
 
-      attr_writer :enable, :logger, :bypass
+      attr_writer :logger, :bypass
       # @return [String, nil]
       attr_accessor :socket
       # @return [String, nil]
       attr_accessor :port
       # @return [String, nil]
       attr_accessor :host
+      # @return [Boolean, nil]
+      attr_accessor :enable
 
       def initialize hsh = {}
-        @enable = traverse_config(hsh, :enable)
-        @host = traverse_config(hsh, :host)
-        @port = traverse_config(hsh, :port)
-        @socket = traverse_config(hsh, :socket)
-        @logger = Contrast::Config::LoggerConfiguration.new(traverse_config(hsh, :logger))
-        @bypass = traverse_config(hsh, :bypass)
-        @configuration_map = {}
-        build_configuration_map
-      end
+        return unless hsh
 
-      # @return [Boolean, false]
-      def enable
-        !!@enable
+        @enable = hsh[:enable]
+        @host = hsh[:host]
+        @port = hsh[:port]
+        @socket = hsh[:socket]
+        @logger = Contrast::Config::LoggerConfiguration.new(hsh[:logger])
+        @bypass = hsh[:bypass]
       end
 
       # @return [Contrast::Config::LoggerConfiguration]
@@ -44,41 +42,7 @@ module Contrast
 
       # @return [Boolean, false]
       def bypass
-        !!@bypass
-      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
+        @bypass.nil? ? false : @bypass
       end
     end
   end