contrast-agent 4.14.0 → 5.2.0

data/lib/contrast/extension/module.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 'contrast/utils/object_share'

data/lib/contrast/extension/protect/psych.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
 
 if defined?(Psych)

data/lib/contrast/extension/protect.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/extension/thread.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
 
 # ensure that we're being loaded with an agent
@@ -10,22 +10,41 @@
 # exists mostly for reference.
 #
 # Scope HAS to exist per-fiber.
+# Check to see if Thread#initialize has been prepended. If it hasn't, then we should use the alias approach, so that
+# others can continue to alias it. If it has been, then we must use prepend ourselves.
+if Thread.instance_method(:initialize).owner == Thread
+  # Alias-chaining Thread#initialize.
+  class Thread
+    alias_method :cs__initialize, :initialize
 
-# Monkey-patching Thread#initialize.
-class Thread
-  alias_method :cs__initialize, :initialize
+    def initialize *args, &block
+      # Thread.current still references the original(callee) thread that is instantiating this new fiber during
+      # initialization.
+      Contrast::Components::Scope::MONITOR.synchronize do
+        if (current_context = Thread.current[:current_context])
+          self[:current_context] = current_context.dup
+        end
 
-  def initialize *args, &block
-    # Thread.current still references the original(callee) thread that is
-    # instantiating this new fiber during initialization
-    Contrast::Components::Scope::MONITOR.synchronize do
-      if (current_context = Thread.current[:current_context])
-        self[:current_context] = current_context.dup
+        Contrast::Components::Scope.sweep_dead_ecs
       end
 
-      Contrast::Components::Scope.sweep_dead_ecs
+      cs__initialize(*args, &block)
+    end
+  end
+else
+  # Prepending Thread#initialize.
+  module ContrastThread
+    def initialize *args, &block
+      # Thread.current still references the original(callee) thread that is instantiating this new fiber during
+      # initialization.
+      Contrast::Components::Scope::MONITOR.synchronize do
+        if (current_context = Thread.current[:current_context])
+          self[:current_context] = current_context.dup
+        end
+        Contrast::Components::Scope.sweep_dead_ecs
+      end
+      super
     end
-
-    cs__initialize(*args, &block)
   end
+  Thread.prepend(ContrastThread)
 end

data/lib/contrast/framework/base_support.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
@@ -30,6 +30,10 @@ module Contrast
         raise NoMethodError, 'Subclasses of BaseSupport should implement this method'
       end
 
+      def current_route_coverage
+        raise NoMethodError, 'Subclasses of BaseSupport should implement this method'
+      end
+
       def current_route
         raise NoMethodError, 'Subclasses of BaseSupport should implement this method'
       end

data/lib/contrast/framework/grape/support.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 'contrast/framework/base_support'
@@ -91,6 +91,30 @@ module Contrast
             Contrast::Api::Dtm::RouteCoverage.from_grape_controller(final_controller, method, route_pattern, full_route)
           end
 
+          # Given the current request - return a RouteCoverage object
+
+          # @param request [Contrast::Agent::Request] a contrast tracked request.
+          # @param controller [::Grape::API] optionally use this controller instead of global ::Grape::API.
+          # @return [Contrast::Agent::Reporting::RouteCoverage, nil] a Dtm describing the route
+          # matched to the request if a match was found.
+          def current_route_coverage request, controller = ::Grape::API, full_route = nil
+            return unless grape_controller?(controller)
+
+            method = request.env[::Rack::REQUEST_METHOD] # GET, PUT, POST, etc...
+
+            # Find final controller - actually we gotta match the route to the scanned application
+            # Initially Grape compiles all routes on startup, so we can use the url from the request
+            # and create the observed route
+            # Class < Grape::API, Grape::Router::Route
+            final_controller, route_pattern = _route_recurse(method, _cleaned_route(request), grape_controllers)
+            return unless final_controller
+
+            full_route ||= request.env[::Rack::PATH_INFO]
+
+            new_route_coverage = Contrast::Agent::Reporting::RouteCoverage.new
+            new_route_coverage.attach_rack_based_data final_controller, method, route_pattern, full_route
+          end
+
           # Search object space for grape controllers--any class that subclasses ::Grape::API.
           #
           # @return [Array<::Grape::API>] grape controllers

data/lib/contrast/framework/manager.rb

@@ -1,15 +1,17 @@
-# 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/agent/reporting/reporting_events/application_update'
+require 'contrast/agent/reporting/reporting_events/application_inventory'
 require 'contrast/components/logger'
 require 'contrast/extension/module'
+require 'contrast/framework/grape/support'
+require 'contrast/framework/manager_extend'
 require 'contrast/framework/platform_version'
 require 'contrast/framework/rack/support'
 require 'contrast/framework/rails/support'
-require 'contrast/framework/grape/support'
 require 'contrast/framework/sinatra/support'
 require 'contrast/utils/class_util'
-require 'contrast/framework/manager_extend'
 
 module Contrast
   module Framework
@@ -126,12 +128,21 @@ module Contrast
             reject(&:nil?).first
       end
 
+      # Iterate through current frameworks and return the current request's route. This will be the first non-nil
+      # result.
+      #
+      # @param request [Contrast::Agent::Request] the current request.
+      # @return [Contrast::Agent::Reporting::RouteCoverage] the current route as a Dtm.
+      def get_route_information request
+        @_frameworks.lazy.map { |framework_support| framework_support.current_route_coverage(request) }.
+            reject(&:nil?).first
+      end
+
       # Sometimes the framework we want to instrument is loaded after our agent code. To catch that case, we'll detect
       # if the loaded_module is the marker class for any of our supported frameworks. If it is, and we don't already
       # have support enabled, we'll enable it now. We'll also need to catch up on any other startup actions that we've
       # missed. Most likely, this is only necessary for those applications which have applications mounted on them.
       #
-      # TODO: RUBY-1354
       # TODO: RUBY-1356
       #
       # @param mod [Module] the module or class that was just loaded
@@ -146,8 +157,18 @@ module Contrast
 
           @_frameworks << framework
           # Report the registered routes of that framework now that we know we need to find them
+          # TODO: RUBY-1438 -- remove and build ReportingEvent directly
           app_update_msg = Contrast::Api::Dtm::ApplicationUpdate.build
-          Contrast::Agent.messaging_queue.send_event_eventually(app_update_msg)
+          if Contrast::Agent.reporter
+            report = Contrast::Agent::Reporting::DtmMessage.dtm_to_event(app_update_msg)
+            Contrast::Agent.reporter.send_event(report)
+
+            # This is being reported separately because we extract the data from the same message
+            inventory_report = Contrast::Agent::Reporting::ApplicationInventory.convert(app_update_msg)
+            Contrast::Agent.reporter.send_event(inventory_report)
+          else
+            Contrast::Agent.messaging_queue.send_event_eventually(app_update_msg)
+          end
           logger.info('Framework detected after initialization. Enabling support.',
                       framework: framework.detection_class,
                       frameworks: @_frameworks)

data/lib/contrast/framework/manager_extend.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 'contrast/components/logger'

data/lib/contrast/framework/platform_version.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/framework/rack/patch/session_cookie.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 'contrast/components/logger'

data/lib/contrast/framework/rack/patch/support.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 'contrast/agent/patching/policy/after_load_patch'

data/lib/contrast/framework/rack/support.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 'contrast/framework/base_support'

data/lib/contrast/framework/rails/patch/action_controller_live_buffer.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/framework/rails/patch/assess_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 'contrast/utils/invalid_configuration_util'

data/lib/contrast/framework/rails/patch/rails_application_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 'contrast/framework/rails/patch/assess_configuration'

data/lib/contrast/framework/rails/patch/support.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 'contrast/framework/rails/patch/rails_application_configuration'

data/lib/contrast/framework/rails/railtie.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 'contrast/utils/job_servers_running'

data/lib/contrast/framework/rails/support.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 'contrast/api/dtm.pb'
@@ -10,7 +10,7 @@ module Contrast
   module Framework
     module Rails
       # Used when Rails is present to define framework specific behavior
-      class Support
+      class Support # rubocop:disable Metrics/ClassLength
         extend Contrast::Framework::BaseSupport
         extend Contrast::Framework::Rails::Patch::Support
         include Contrast::Components::Logger::InstanceMethods
@@ -78,6 +78,38 @@ module Contrast
             nil
           end
 
+          # Find the current route, based on the provided Request wrapper
+          #
+          # @param request[Contrast::Agent::Request]
+          # @return [Contrast::Agent::Reporting::RouteCoverage, nil] a Dtm describing the route
+          # matched to the request if a match was found.
+          def current_route_coverage request
+            return unless ::Rails.cs__respond_to?(:application)
+
+            # ActionDispatch::Journey::Path::Pattern::MatchData, Hash, ActionDispatch::Journey::Route, Array<String>
+            match, _params, route, path = get_full_route(request.rack_request)
+            unless route
+              logger.warn('Unable to determine the current route of this request')
+              return
+            end
+
+            original_url = request.rack_request.path_info
+            mounted_app = route&.app&.app
+            # Route is either the final rails route, or a router that points to a Sinatra controller.
+            if mounted_app && Contrast::Framework::Sinatra::Support.sinatra_controller?(mounted_app)
+              return mounted_new_sinatra_route(request, match, path, route, original_url)
+            end
+            if mounted_app && Contrast::Framework::Grape::Support.grape_controller?(mounted_app)
+              return mounted_new_grape_route(request, match, path, route, original_url)
+            end
+
+            new_route_coverage = Contrast::Agent::Reporting::RouteCoverage.new
+            new_route_coverage.attach_rails_data route, original_url
+          rescue StandardError => e
+            logger.warn('Unable to determine the current route of this request', e)
+            nil
+          end
+
           # Copy a request for modification.
           #
           # @param env [::ActionDispatch::Request] original env.
@@ -155,6 +187,12 @@ module Contrast
             Contrast::Framework::Sinatra::Support.current_route(new_req, route.app.app, original_url)
           end
 
+          # @return [Contrast::Agent::Reporting::RouteCoverage, nil]
+          def mounted_new_sinatra_route request, match, path, route, original_url
+            new_req = unmounted_route(request, match, path)
+            Contrast::Framework::Sinatra::Support.current_route_coverage(new_req, route.app.app, original_url)
+          end
+
           # @param request[Contrast::Agent::Request]
           # @param match [ActionDispatch::Journey::Path::Pattern::MatchData]
           # @param path [Array<String>] the path of this request, built out from each nested
@@ -167,6 +205,12 @@ module Contrast
             Contrast::Framework::Grape::Support.current_route(new_req, route.app.app, original_url)
           end
 
+          # @return [Contrast::Agent::Reporting::RouteCoverage, nil]
+          def mounted_new_grape_route request, match, path, route, original_url
+            new_req = unmounted_route(request, match, path)
+            Contrast::Framework::Grape::Support.current_route_coverage(new_req, route.app.app, original_url)
+          end
+
           # Create a request copied from current request, but with the base path removed from path_info, as that's
           # the mount.
           #

data/lib/contrast/framework/sinatra/support.rb

@@ -1,7 +1,8 @@
-# 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/framework/base_support'
+require 'contrast/agent/reporting/report'
 
 module Contrast
   module Framework
@@ -82,6 +83,27 @@ module Contrast
             Contrast::Api::Dtm::RouteCoverage.from_sinatra_route(final_controller, method, route_pattern, full_route)
           end
 
+          # Given the current request - return a RouteCoverage object
+
+          # @param request [Contrast::Agent::Request] a contrast tracked request.
+          # @param controller [::Sinatra::Base] optionally use this controller instead of global ::Sinatra::Base.
+          # @return [Contrast::Agent::Reporting::RouteCoverage, nil] a Dtm describing the route
+          # matched to the request if a match was found.
+          def current_route_coverage request, controller = ::Sinatra::Base, full_route = nil
+            return unless sinatra_controller?(controller)
+
+            method = request.env[::Rack::REQUEST_METHOD] # GET, PUT, POST, etc...
+
+            # Find route match--checking superclasses if necessary.
+            final_controller, route_pattern = _route_recurse(controller, method, _cleaned_route(request))
+            return unless final_controller
+
+            full_route ||= request.env[::Rack::PATH_INFO]
+
+            new_route_coverage = Contrast::Agent::Reporting::RouteCoverage.new
+            new_route_coverage.attach_rack_based_data final_controller, method, route_pattern, full_route
+          end
+
           # Search object space for sinatra controllers--any class that subclasses ::Sinatra::Base.
           #
           # @return [Array<::Sinatra::Base>] sinatra controlelrs
@@ -100,7 +122,7 @@ module Contrast
           #
           # @param controller [Sinatra::Base, #routes] a Sinatra application.
           # @param method [::Rack::REQUEST_METHOD] GET, POST, PUT, etc...
-          # @param method [String] the relative route passed from Rack.
+          # @param route [String] the relative route passed from Rack.
           # @return [Array[Sinatra::Base, Mustermann::Sinatra], nil] Either the controller that
           # will handle the route along with the route pattern or nil if no match.
           def _route_recurse controller, method, route

data/lib/contrast/funchook/funchook.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 'contrast/components/logger'
@@ -17,26 +17,29 @@ module Funchook
 
   AGENT_ROOT = File.join(__dir__, '..', '..', '..')
 
-  def self.resolve_path!
-    actual_path_segments = SEARCH_DIRS.product(ACCEPTABLE_FILES).find do |potential_funchook_path|
-      load_path = absolute_path(potential_funchook_path)
-      File.exist?(load_path)
+  class << self
+    def resolve_path!
+      actual_path_segments = SEARCH_DIRS.product(ACCEPTABLE_FILES).find do |potential_funchook_path|
+        load_path = absolute_path(potential_funchook_path)
+        File.exist?(load_path)
+      end
+
+      if actual_path_segments.nil?
+        logger.warn('Unable to find funchook')
+      else
+        @path = absolute_path(actual_path_segments)
+        logger.info('Funchook found', path: @path)
+      end
+      @path
     end
 
-    if actual_path_segments.nil?
-      logger.warn('Unable to find funchook')
-    else
-      @path = absolute_path(actual_path_segments)
-      logger.info('Funchook found', path: @path)
+    def absolute_path path_array
+      File.absolute_path(File.join(AGENT_ROOT, *path_array))
     end
-    @path
-  end
-
-  def self.absolute_path path_array
-    File.absolute_path(File.join(AGENT_ROOT, *path_array))
-  end
 
-  def self.available?
-    @_available ||= !!resolve_path!
+    def available?
+      @_available = !!resolve_path! if @_available.nil?
+      @_available
+    end
   end
 end

data/lib/contrast/logger/application.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 'contrast/utils/exclude_key'

data/lib/contrast/logger/cef_log.rb

@@ -0,0 +1,151 @@
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# frozen_string_literal: true
+
+require 'logger'
+require 'singleton'
+
+require 'contrast/extension/module'
+require 'contrast/logger/application'
+require 'contrast/logger/format'
+require 'contrast/logger/request'
+require 'contrast/logger/time'
+require 'contrast/logger/log'
+require 'contrast/components/config'
+require 'contrast/utils/log_utils'
+
+module Contrast
+  # Used as a wrapper around our logging. The module option specifically adds in a new method for error that raises the
+  # logged exception, used in testing so that we can see if anything unexpected happens without it being swallowed
+  # while still providing safe options for customers.
+  module Logger
+    # For development set following env var to raise logged exceptions instead of just logging.
+    if ENV['CONTRAST__AGENT__RUBY_MORE_COWBELL']
+      ::Logger.class_eval do
+        alias_method :cs__error, :error
+        alias_method :cs__warn, :warn
+
+        def error *args, **kwargs
+          if kwargs.empty?
+            cs__error(*args)
+          else
+            cs__error(*args, **kwargs)
+          end
+          args.each { |arg| raise arg if arg && arg.cs__class < Exception }
+        end
+      end
+    end
+
+    # This is the CEF Logger implementation. It uses the default ::Logger.
+    class CEFLog
+      include Singleton
+      include ::Contrast::Utils::LogUtils
+      include ::Contrast::Utils::CEFLogUtils
+
+      attr_reader :previous_path, :previous_level
+
+      def initialize
+        build_logger
+      end
+
+      # Given new settings from TeamServer, update our logging to use the new file and level, assuming they weren't
+      # set by local configuration.
+      #
+      # @param log_level [String] the level at which to log, as provided by TeamServer settings
+      def build_logger log_level = nil
+        current_level_const = find_valid_level(log_level)
+        level_change = current_level_const != previous_level
+
+        # don't needlessly recreate logger
+        return if @cef_logger && !level_change
+
+        @previous_level = current_level_const
+
+        @_cef_logger = build(path: DEFAULT_CEF_NAME, level_const: current_level_const)
+        # If we're logging to a new path, then let's start it w/ our helpful
+        # data gathering messages
+        # log_update if path_change
+      rescue StandardError => e
+        # rubocop:disable Rails/Output
+        if @_cef_logger
+          @_cef_logger.error('Unable to process update to LoggerManager.', e)
+        else
+          puts 'Unable to process update to LoggerManager.'
+          raise e if ENV['CONTRAST__AGENT__RUBY_MORE_COWBELL']
+
+          puts e.message
+          puts e.backtrace.join("\n")
+        end
+        # rubocop:enable Rails/Output
+      end
+
+      def cef_logger
+        @_cef_logger
+      end
+
+      def log msg, level = @_cef_logger.level
+        case level
+        when ::Logger::Severity::INFO
+          @_cef_logger.info(msg)
+        when ::Logger::Severity::ERROR
+          @_cef_logger.error(msg)
+        when ::Logger::Severity::WARN
+          @_cef_logger.warn(msg)
+        when ::Logger::Severity::FATAL
+          @_cef_logger.fatal(msg)
+        else
+          @_cef_logger.debug(msg)
+        end
+      end
+
+      def virtual_patch_message patch, outcome
+        message = "Virtual Patch #{ patch.fetch(:name, '') } - #{ patch[:uuid] } was triggered by this request."
+        log [message, patch, outcome], ::Logger::Severity::DEBUG
+      end
+
+      def bot_blocking_message matching_bot, outcome
+        message = "User agent #{ matching_bot[:user_agent] } matched the disallowed value #{ matching_bot[:bot] }"
+        log [message, matching_bot, outcome], ::Logger::Severity::DEBUG
+      end
+
+      def ip_denylisted_message remote_ip, block_entry, outcome
+        message = "IP Address #{ remote_ip } matched the disallowed value" \
+                  "#{ block_entry[:ip] } in the IP Blacklist #{ block_entry[:uuid] }"
+        log [message, block_entry, outcome], ::Logger::Severity::DEBUG
+      end
+
+      def successful_attack rule_id, outcome, input_type = nil, input_value = nil
+        if input_type.present? && input_value.present?
+          successful_attack_with_input = "#{ input_type } had a value that successfully exploited" \
+                                         "#{ rule_id } - #{ input_value }"
+          log [successful_attack_with_input, rule_id, outcome], ::Logger::Severity::WARN
+        else
+          successful_attack_wo_input = "An effective attack was detected against #{ rule_id }"
+          log [successful_attack_wo_input, rule_id, outcome], ::Logger::Severity::WARN
+        end
+      end
+
+      def ineffective_attack rule_id, outcome, input_type = nil, input_value = nil
+        if input_type.present? && input_value.present?
+          ineffective_attack_with_input = "#{ input_type } had a value that matched a signature for, " \
+                                          "but did not successfully exploit #{ rule_id } - #{ input_value }"
+          log [ineffective_attack_with_input, rule_id, outcome], ::Logger::Severity::WARN
+        else
+          ineffective_attack_wo_input = "An unsuccessful attack was detected against #{ rule_id }"
+          log [ineffective_attack_wo_input, rule_id, outcome], ::Logger::Severity::WARN
+        end
+      end
+
+      # newer - currently not in the agent, currently is a probe for us
+      def suspicious_attack rule_id, outcome, input_type = nil, input_value = nil
+        if input_type.present? && input_value.present?
+          suspicious_attack_with = "#{ input_type } included a potential attack value that was detected" \
+                                   "as suspicious using #{ rule_id } - #{ input_value }"
+          log [suspicious_attack_with, rule_id, outcome], ::Logger::WARN
+        elsif input_value.present?
+          suspicious_attack_without = 'Suspicious activity indicates a potential attack using ' + rule_id.to_s
+          log [suspicious_attack_without, rule_id, outcome], ::Logger::WARN
+        end
+      end
+    end
+  end
+end

data/lib/contrast/logger/format.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 'ougai'

data/lib/contrast/logger/log.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 'logger'

data/lib/contrast/logger/request.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 'contrast/utils/timer'

data/lib/contrast/logger/time.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/security_exception.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