contrast-agent 6.7.0 → 6.8.0

data/lib/contrast/agent/protect/rule/base_service.rb

@@ -8,8 +8,7 @@ module Contrast
   module Agent
     module Protect
       module Rule
-        # Encapsulate common code for protect rules that do their
-        # input analysis on Speedracer rather in ruby code
+        # Encapsulate common code for protect rules that do their input analysis on agent-lib rather in ruby code
         class BaseService < Contrast::Agent::Protect::Rule::Base
           include Contrast::Components::Logger::InstanceMethods
 
@@ -21,12 +20,43 @@ module Contrast
             'Contrast Security Protect Rule Triggered. Response blocked.'
           end
 
+          def prefilter context
+            return unless prefilter?(context)
+
+            ia_results = gather_ia_results(context)
+
+            ia_results.each do |ia_result|
+              result = build_attack_result(context)
+              build_attack_without_match(context, ia_result, result)
+              append_to_activity(context, result)
+
+              cef_logging(result, :successful_attack)
+              raise(Contrast::SecurityException.new(self, block_message)) if blocked?
+            end
+          end
+
           # @param context [Contrast::Agent::RequestContext]
+          # @return [Boolean]
           def infilter? context
             return false unless enabled?
-            return false unless context&.speedracer_input_analysis&.results&.any? do |result|
-                                  result.rule_id == rule_name
-                                end
+            return false unless gather_ia_results(context).any?
+            return false if protect_excluded_by_code?
+            return false if protect_excluded_by_url?(context)
+
+            true
+          end
+
+          # Base method for prefilter check. Extend if rule needs more
+          # specific conditioning.
+          #
+          # @param context [Contrast::Agent::RequestContext]
+          # @return [Boolean]
+          def prefilter? context
+            return false unless context
+            return false unless enabled?
+            return false unless context.agent_input_analysis&.results&.any? do |result|
+              result.rule_id == rule_name && result.score_level != Contrast::Agent::Reporting::ScoreLevel::IGNORE
+            end
 
             return false if protect_excluded_by_code?
             return false if protect_excluded_by_url?(context)
@@ -41,11 +71,7 @@ module Contrast
           # @raise [Contrast::SecurityException]
           def postfilter context
             return unless enabled? && POSTFILTER_MODES.include?(mode)
-            if mode == Contrast::Api::Settings::ProtectionRule::Mode::NO_ACTION ||
-                  mode == Contrast::Api::Settings::ProtectionRule::Mode::PERMIT
-
-              return
-            end
+            return if mode == :NO_ACTION || mode == :PERMIT
 
             result = find_postfilter_attacker(context, nil)
             return unless result&.samples&.any?
@@ -60,28 +86,31 @@ module Contrast
           protected
 
           # @param context [Contrast::Agent::RequestContext]
-          # @return [Array<Contrast::Api::Settings::InputAnalysis>]
+          # @return [Array<Contrast::Agent::Reporting::InputAnalysis>]
           def gather_ia_results context
-            context.speedracer_input_analysis.results.select do |ia_result|
-              ia_result.rule_id == rule_name
+            return Contrast::Utils::ObjectShare::EMPTY_ARRAY unless context&.agent_input_analysis&.results
+
+            context.agent_input_analysis.results.select do |ia_result|
+              ia_result.rule_id == rule_name &&
+                  ia_result.score_level != Contrast::Agent::Reporting::ScoreLevel::IGNORE
             end
           end
 
           # @param context [Contrast::Agent::RequestContext]
           # @param potential_attack_string [String, nil]
           # @param **kwargs
-          # @return [Contrast::Api::Dtm::AttackResult]
+          # @return [Contrast::Agent::Reporting]
           def find_attacker context, potential_attack_string, **kwargs
             ia_results = gather_ia_results(context)
             find_attacker_with_results(context, potential_attack_string, ia_results, **kwargs)
           end
 
-          # Allows for the InputAnalysis from service to be extracted early
+          # Allows for the InputAnalysis from Agent Library to be extracted early
           # @param context [Contrast::Agent::RequestContext]
           # @param potential_attack_string [String, nil]
-          # @param ia_results [Array<Contrast::Api::Settings::InputAnalysis>]
+          # @param ia_results [Array<Contrast::Agent::Reporting::InputAnalysis>]
           # @param **kwargs
-          # @return [Contrast::Api::Dtm::AttackResult, nil]
+          # @return [Contrast::Agent::Reporting, nil]
           def find_attacker_with_results context, potential_attack_string, ia_results, **kwargs
             logger.trace('Checking vectors for attacks', rule: rule_name, input: potential_attack_string)
 
@@ -103,16 +132,11 @@ module Contrast
 
           # @param context [Contrast::Agent::RequestContext]
           # @param potential_attack_string [String, nil]
-          # @return [Contrast::Api::Dtm::AttackResult, nil]
+          # @return [Contrast::Agent::Reporting, nil]
           def find_postfilter_attacker context, potential_attack_string, **kwargs
             ia_results = gather_ia_results(context)
             ia_results.select! do |ia_result|
-              required_level = if ia_result.cs__is_a?(Contrast::Api::Settings::InputAnalysisResult)
-                                 Contrast::Api::Settings::InputAnalysisResult::ScoreLevel::DEFINITEATTACK
-                               else
-                                 Contrast::Agent::Reporting::ScoreLevel::DEFINITEATTACK
-                               end
-              ia_result.score_level == required_level
+              ia_result.score_level == Contrast::Agent::Reporting::ScoreLevel::DEFINITEATTACK
             end
             find_attacker_with_results(context, potential_attack_string, ia_results, **kwargs)
           end

data/lib/contrast/agent/protect/rule/bot_blocker/bot_blocker_input_classification.rb

@@ -0,0 +1,98 @@
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# frozen_string_literal: true
+
+require 'contrast/agent/reporting/input_analysis/input_type'
+require 'contrast/agent/reporting/input_analysis/score_level'
+require 'contrast/agent/reporting/input_analysis/details/bot_blocker_details'
+require 'contrast/utils/input_classification_base'
+require 'contrast/utils/object_share'
+
+module Contrast
+  module Agent
+    module Protect
+      module Rule
+        # This module will do the Input Classification stage of CMD Injection rule
+        # as a result input would be marked as WORTHWATCHING or IGNORE,
+        # to be analyzed at the sink level.
+        module BotBlockerInputClassification
+          USER_AGENT = 'USER_AGENT'
+          AGENT_LIB_HEADER_NAME = 'user-agent'
+          BOT_BLOCKER_MATCH = 'bot-blocker-input-tracing-v1'
+
+          class << self
+            include InputClassificationBase
+
+            # Input Classification stage is done to determine if an user input is
+            # DEFINITEATTACK or to be ignored.
+            #
+            # @param rule_id [String] Name of the protect rule.
+            # @param input_type [Contrast::Agent::Reporting::InputType] The type of the user input.
+            # @param value [Hash<String>] the value of the input.
+            # @param input_analysis [Contrast::Agent::Reporting::InputAnalysis] Holds all the results from the
+            #                                                       agent analysis from the current
+            #                                                       Request.
+            # @return ia [Contrast::Agent::Reporting::InputAnalysis, nil] with updated results.
+            def classify rule_id, input_type, value, input_analysis
+              return unless (rule = Contrast::PROTECT.rule(rule_id))
+              return unless rule.applicable_user_inputs.include?(input_type)
+              return unless input_analysis.request
+
+              value.each_value do |val|
+                result = create_new_input_result(input_analysis.request, rule.rule_name, input_type, val)
+                input_analysis.results << result if result
+              end
+
+              input_analysis
+            rescue StandardError => e
+              logger.debug("An Error was recorded in the input classification of the #{ rule_id }", error: e)
+            end
+
+            private
+
+            # This methods checks if input is tagged WORTHWATCHING or IGNORE matches value with it's
+            # key if needed and Creates new instance of InputAnalysisResult.
+            #
+            # @param request [Contrast::Agent::Request] the current request context.
+            # @param rule_id [String] The name of the Protect Rule.
+            # @param input_type [Contrast::Agent::Reporting::InputType] The type of the user input.
+            # @param value [String, Array<String>] the value of the input.
+            #
+            # @return res [Contrast::Agent::Reporting::InputAnalysisResult]
+            def create_new_input_result request, rule_id, input_type, value
+              return unless request.headers.key(value) == USER_AGENT
+              return unless Contrast::AGENT_LIB
+
+              # If there is no match this would return nil.
+              header_eval = Contrast::AGENT_LIB.eval_header(AGENT_LIB_HEADER_NAME,
+                                                            value,
+                                                            Contrast::AGENT_LIB.rule_set[rule_id],
+                                                            Contrast::AGENT_LIB.eval_option[:NONE])
+
+              ia_result = new_ia_result(rule_id, input_type, request.path, value)
+              score = header_eval&.score || 0
+              if score >= THRESHOLD
+                ia_result.score_level = DEFINITEATTACK
+                ia_result.ids << BOT_BLOCKER_MATCH
+                ia_result.details = Contrast::Agent::Reporting::BotBlockerDetails.new
+                # details:
+                add_details(ia_result, value)
+              else
+                ia_result.score_level = IGNORE
+              end
+              add_needed_key(request, ia_result, input_type, value)
+              ia_result
+            end
+
+            def add_details ia_result, value
+              ia_result.details.bot = value.downcase
+              if value.include?(Contrast::Utils::ObjectShare::CARROT)
+                ia_result.details.bot.delete!(Contrast::Utils::ObjectShare::CARROT)
+              end
+              ia_result.details.user_agent = value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/contrast/agent/protect/rule/bot_blocker.rb

@@ -0,0 +1,81 @@
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# frozen_string_literal: true
+
+require 'contrast/agent/protect/rule/base_service'
+require 'contrast/components/logger'
+require 'contrast/agent/reporting/input_analysis/input_type'
+require 'contrast/agent/reporting/input_analysis/score_level'
+require 'contrast/agent_lib/interface'
+
+module Contrast
+  module Agent
+    module Protect
+      module Rule
+        # The Ruby implementation of the Protect BotBlocker rule.
+        class BotBlocker < Contrast::Agent::Protect::Rule::BaseService
+          include Contrast::Components::Logger::InstanceMethods
+          include Contrast::Agent::Reporting::InputType
+
+          NAME = 'bot-blocker'
+          APPLICABLE_USER_INPUTS = [HEADER].cs__freeze
+
+          def rule_name
+            NAME
+          end
+
+          def applicable_user_inputs
+            APPLICABLE_USER_INPUTS
+          end
+
+          # BotBlocker prefilter:
+          #
+          # @param context [Contrast::Agent::RequestContext] current request contest
+          # @raise [Contrast::SecurityException] if the rule mode ise set
+          # to BLOCK and valid bot is detected.
+          def prefilter context
+            return unless prefilter?(context)
+            # We expect only one result per request since the user-agent Header is one.
+            # And the IA analysis explicitly searches for the key match before starting
+            # the analysis.
+            return unless (ia_result = gather_ia_results(context)[0]) &&
+                ia_result.score_level == Contrast::Agent::Reporting::ScoreLevel::DEFINITEATTACK
+
+            result = build_attack_without_match(context, ia_result, nil)
+            append_to_activity(context, result) if result
+            cef_logging(result, :successful_attack) if result
+            return unless blocked?
+
+            # Raise BotBlocker error
+            exception_message = "#{ rule_name } rule triggered. Unsafe Bot blocked."
+            raise(Contrast::SecurityException.new(self, exception_message))
+          end
+
+          # @param context [Contrast::Agent::RequestContext]
+          # @return [Array<Contrast::Agent::Reporting::InputAnalysis>]
+          def gather_ia_results context
+            return Contrast::Utils::ObjectShare::EMPTY_ARRAY unless context&.agent_input_analysis&.results
+
+            context.agent_input_analysis.results.select do |ia_result|
+              ia_result.rule_id == rule_name
+            end
+          end
+
+          # Adding bot blocker details
+          #
+          # @param context [Contrast::Agent::RequestContext]
+          # @param ia_result [Contrast::Agent::Reporting::InputAnalysisResult]
+          # @param _candidate_string
+          # @param **_kwargs
+          # @return [Contrast::Api::Dtm::RaspRuleSample]
+          def build_sample context, ia_result, _candidate_string, **_kwargs
+            sample = build_base_sample(context, ia_result)
+            sample.details = Contrast::Agent::Reporting::BotBlockerDetails.new
+            sample.details.bot = ia_result.value
+            sample.details.user_agent = context&.request&.user_agent
+            sample
+          end
+        end
+      end
+    end
+  end
+end

data/lib/contrast/agent/protect/rule/cmd_injection.rb

@@ -6,6 +6,9 @@ require 'contrast/utils/stack_trace_utils'
 require 'contrast/utils/object_share'
 require 'contrast/components/logger'
 require 'contrast/agent/reporting/input_analysis/input_type'
+require 'contrast/agent_lib/interface'
+require 'contrast/agent/protect/rule/cmdi/cmdi_chained_command'
+require 'contrast/agent/protect/rule/cmdi/cmdi_dangerous_path'
 require 'contrast/agent/protect/rule/cmdi/cmdi_base_rule'
 require 'contrast/agent/protect/rule/cmdi/cmdi_backdoors'
 
@@ -18,7 +21,17 @@ module Contrast
           include Contrast::Components::Logger::InstanceMethods
           include Contrast::Agent::Reporting::InputType
           NAME = 'cmd-injection'
-          SUB_RULES = [Contrast::Agent::Protect::Rule::CmdiBackdoors.new].cs__freeze
+
+          APPLICABLE_USER_INPUTS = [
+            BODY, COOKIE_VALUE, HEADER, PARAMETER_NAME,
+            PARAMETER_VALUE, JSON_VALUE, MULTIPART_VALUE,
+            MULTIPART_FIELD_NAME, XML_VALUE, DWR_VALUE
+          ].cs__freeze
+          SUB_RULES = [
+            Contrast::Agent::Protect::Rule::CmdiBackdoors.new,
+            Contrast::Agent::Protect::Rule::CmdiChainedCommand.new,
+            Contrast::Agent::Protect::Rule::CmdiDangerousPath.new
+          ].cs__freeze
 
           def rule_name
             NAME
@@ -28,6 +41,10 @@ module Contrast
             SUB_RULES
           end
 
+          def applicable_user_inputs
+            APPLICABLE_USER_INPUTS
+          end
+
           # CMDI infilter:
           #
           # @param context [Contrast::Agent::RequestContext] current request context

data/lib/contrast/agent/protect/rule/cmdi/cmdi_backdoors.rb

@@ -52,7 +52,7 @@ module Contrast
             return false unless enabled?
             # This rule does not have input tracing stage so we need to check the results of
             # the main rule instead.
-            return false unless context&.speedracer_input_analysis&.results&.any? do |result|
+            return false unless context&.agent_input_analysis&.results&.any? do |result|
               result.rule_id == Contrast::Agent::Protect::Rule::CmdInjection::NAME
             end
 
@@ -103,9 +103,9 @@ module Contrast
           # the applicable input type is already checked before input
           # classification. Only thing left is the match check.
           #
-          # @param ia_results [Contrast::Api::Settings::InputAnalysisResult] gathered results
+          # @param ia_results [Contrast::Agent::Reporting::Settings::InputAnalysisResult] gathered results
           # @param cmd [String] potential attack vector
-          # @return [Contrast::Api::Settings::InputAnalysisResult, nil] matched input_type
+          # @return [Contrast::Agent::Reporting::Settings::InputAnalysisResult, nil] matched input_type
           def match_applicable_input_type ia_results, cmd
             ia_results.each do |ia_result|
               return ia_result if ia_result.value == cmd
@@ -118,8 +118,11 @@ module Contrast
           #
           # @param context [Contrast::Agent::RequestContext]
           def gather_ia_results context
-            context.speedracer_input_analysis.results.select do |ia_result|
-              ia_result.rule_id == Contrast::Agent::Protect::Rule::CmdInjection::NAME
+            return Contrast::Utils::ObjectShare::EMPTY_ARRAY unless context&.agent_input_analysis&.results
+
+            context.agent_input_analysis.results.select do |ia_result|
+              ia_result.rule_id == Contrast::Agent::Protect::Rule::CmdInjection::NAME &&
+                  ia_result.score_level != Contrast::Agent::Reporting::ScoreLevel::IGNORE
             end
           end
         end

data/lib/contrast/agent/protect/rule/cmdi/cmdi_base_rule.rb

@@ -21,18 +21,6 @@ module Contrast
             MULTIPART_FIELD_NAME, XML_VALUE, DWR_VALUE
           ].cs__freeze
 
-          class << self
-            # @param attack_sample [Contrast::Api::Dtm::RaspRuleSample]
-            # @return [Hash] the details for this specific rule
-            def extract_details attack_sample
-              {
-                  command: attack_sample.cmdi.command,
-                  startIndex: attack_sample.cmdi.start_idx,
-                  endIndex: attack_sample.cmdi.end_idx
-              }
-            end
-          end
-
           # CMDI infilter:
           #
           # @param context [Contrast::Agent::RequestContext] current request contest
@@ -65,11 +53,7 @@ module Contrast
                                       result,
                                       candidate_string,
                                       **kwargs)
-            if mode == Contrast::Api::Settings::ProtectionRule::Mode::NO_ACTION ||
-                  mode == Contrast::Api::Settings::ProtectionRule::Mode::PERMIT
-
-              return result
-            end
+            return result if mode == :NO_ACTION || mode == :PERMIT
 
             result ||= build_attack_result(context)
             update_successful_attack_response(context, input_analysis_result, result, candidate_string)
@@ -96,9 +80,9 @@ module Contrast
           #
           # @param context [Contrast::Agent::RequestContext]
           # @param potential_attack_string [String, nil]
-          # @param ia_results [Array<Contrast::Api::Settings::InputAnalysis>]
+          # @param ia_results [Array<Contrast::Agent::Reporting::InputAnalysis>]
           # @param **kwargs
-          # @return [Contrast::Api::Dtm::AttackResult, nil]
+          # @return [Contrast::Agent::Reporting, nil]
           def find_attacker_with_results context, potential_attack_string, ia_results, **kwargs
             logger.trace('Checking vectors for attacks', rule: rule_name, input: potential_attack_string)
             result = super(context, potential_attack_string, ia_results, **kwargs) if ia_results
@@ -110,14 +94,15 @@ module Contrast
 
           # Build a subclass of the RaspRuleSample using the query string and the
           # evaluation
-          def build_sample context, input_analysis_result, candidate_string, **_kwargs
+          def build_sample context, input_analysis_result, candidate_string, **kwargs
             sample = build_base_sample(context, input_analysis_result)
             sample.details = Contrast::Agent::Reporting::Details::CmdInjectionDetails.new
 
+            # extract data from kwargs for the agent_lib check
+            agent_lib_result_struct = kwargs[:result_struct]
             command = candidate_string || input_analysis_result.value
             command = Contrast::Utils::StringUtils.protobuf_safe_string(command)
-            sample.details.cmd = command
-            sample.details.end_idx = command.length
+            handle_with_agent_lib(sample, agent_lib_result_struct, command)
 
             # This is a special case where the user input is UNKNOWN_USER_INPUT but
             # we want to send the attack value
@@ -162,6 +147,21 @@ module Contrast
           def report_any_command_execution?
             ::Contrast::PROTECT.report_any_command_execution?
           end
+
+          # handle agent_lib data being attached
+          def handle_with_agent_lib sample, agent_lib_result_struct, command
+            sample.details.cmd = command
+            if agent_lib_result_struct&.cs__is_a?(Hash)
+              sample.details.start_idx = agent_lib_result_struct[:start_index]
+              sample.details.end_idx = if (agent_lib_result_struct[:end_index]).zero?
+                                         command.length
+                                       else
+                                         agent_lib_result_struct[:end_index]
+                                       end
+            else
+              sample.details.end_idx = command.length
+            end
+          end
         end
       end
     end

data/lib/contrast/agent/protect/rule/cmdi/cmdi_chained_command.rb

@@ -0,0 +1,69 @@
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# frozen_string_literal: true
+
+require 'contrast/agent/protect/rule/base_service'
+require 'contrast/agent/request_context'
+require 'contrast/utils/object_share'
+require 'contrast/agent/protect/rule/cmdi/cmdi_base_rule'
+
+module Contrast
+  module Agent
+    module Protect
+      module Rule
+        # The Ruby implementation of the Protect Command Injection Semantic
+        # Chained Command sub-rule. This rule should report
+        class CmdiChainedCommand < Contrast::Agent::Protect::Rule::CmdiBaseRule
+          NAME = 'cmd-injection-semantic-chained-commands'
+
+          def initialize
+            super
+            @mode = :MONITOR
+          end
+
+          def rule_name
+            NAME
+          end
+
+          def sub_rules
+            Contrast::Utils::ObjectShare::EMPTY_ARRAY
+          end
+
+          protected
+
+          # Used to customize the raised error message.
+          #
+          # @param classname [String] Name of the class
+          # @param method [String] name of the method triggering the rule
+          # @raise [Contrast::SecurityException]
+          def raise_error classname, method
+            raise(Contrast::SecurityException.new(self,
+                                                  'Command Injection Semantic Chained Commands rule triggered. '\
+                                                  "Call to #{ classname }.#{ method } blocked."))
+          end
+
+          private
+
+          def find_probable_attacker context, potential_attack_string, _ia_results, **kwargs
+            chained = chained_command?(potential_attack_string)
+            return unless chained
+
+            build_attack_with_match(context, nil, nil, potential_attack_string, **kwargs)
+          end
+
+          # Check if potential chained attack is detected in user input.
+          #
+          # @param command [String] command to check.
+          # @return index[Boolean Returns the index of the command chaining if found.
+          # If the chaining index is >= 0, an injection is detected. Returns -1 when no
+          # command chaining is found.
+          def chained_command? command
+            return false unless (agent_lib = Contrast::AGENT_LIB) && command
+            return false if agent_lib.chained_cmdi_index(command).negative?
+
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/contrast/agent/protect/rule/cmdi/cmdi_dangerous_path.rb

@@ -0,0 +1,68 @@
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# frozen_string_literal: true
+
+require 'contrast/agent/protect/rule/base_service'
+require 'contrast/agent/request_context'
+require 'contrast/utils/object_share'
+require 'contrast/agent/protect/rule/cmdi/cmdi_base_rule'
+
+module Contrast
+  module Agent
+    module Protect
+      module Rule
+        # The Ruby implementation of the Protect Command Injection Semantic
+        # Dangerous Path sub-rule. This rule should report
+        class CmdiDangerousPath < Contrast::Agent::Protect::Rule::CmdiBaseRule
+          NAME = 'cmd-injection-semantic-dangerous-paths'
+
+          def initialize
+            super
+            @mode = :MONITOR
+          end
+
+          def rule_name
+            NAME
+          end
+
+          def sub_rules
+            Contrast::Utils::ObjectShare::EMPTY_ARRAY
+          end
+
+          protected
+
+          # Used to customize the raised error message.
+          #
+          # @param classname [String] Name of the class
+          # @param method [String] name of the method triggering the rule
+          # @raise [Contrast::SecurityException]
+          def raise_error classname, method
+            raise(Contrast::SecurityException.new(self,
+                                                  'Command Injection Dangerous Path rule triggered. '\
+                                                  "Call to #{ classname }.#{ method } blocked."))
+          end
+
+          private
+
+          def find_probable_attacker context, potential_attack_string, _ia_results, **kwargs
+            dangerous_path = dangerous_path?(potential_attack_string)
+            return unless dangerous_path
+
+            build_attack_with_match(context, nil, nil, potential_attack_string, **kwargs)
+          end
+
+          # Checks if a given shell command is trying to access a dangerous path.
+          # This is used for the cmd-injection-semantic-dangerous-paths rule.
+          #
+          # @param path [String] path to check.
+          # @return index[Boolean] Returns true if a dangerous path is found.
+          # Returns false if no dangerous paths are found.
+          def dangerous_path? path
+            return false unless (agent_lib = Contrast::AGENT_LIB) && path
+
+            agent_lib.dangerous_path?(path)
+          end
+        end
+      end
+    end
+  end
+end