contrast-agent 5.2.0 → 6.1.0

data/lib/contrast/agent/reporting/reporting_events/application_activity.rb

@@ -0,0 +1,53 @@
+# 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'
+require 'contrast/agent/reporting/reporting_events/application_reporting_event'
+require 'contrast/agent/reporting/reporting_events/application_defend_activity'
+require 'contrast/agent/reporting/reporting_events/application_inventory_activity'
+
+module Contrast
+  module Agent
+    module Reporting
+      # This is the new ApplicationActivity class which will include all the needed information for the new reporting
+      # system to report
+      class ApplicationActivity < Contrast::Agent::Reporting::ApplicationReportingEvent
+        class << self
+          # @param app_activity_dtm [Contrast::Api::Dtm::Activity]
+          # @return [Contrast::Agent::Reporting::ApplicationActivity]
+          def convert app_activity_dtm
+            app_activity = new
+            app_activity.attach_data app_activity_dtm
+            app_activity
+          end
+        end
+
+        def initialize
+          @defend = []
+          @inventory = []
+          @event_type = :application_activity
+          @event_endpoint = Contrast::Agent::Reporting::Endpoints.application_activity
+          super
+        end
+
+        def file_name
+          'activity-application'
+        end
+
+        def to_controlled_hash
+          {
+              lastUpdate: since_last_update,
+              defend: @defend.map(&:to_controlled_hash),
+              inventory: @inventory.map(&:to_controlled_hash)
+          }
+        end
+
+        # @param activity_dtm [Contrast::Api::Dtm::ApplicationActivity]
+        def attach_data activity_dtm
+          @defend << Contrast::Agent::Reporting::ApplicationDefendActivity.convert(activity_dtm)
+          @inventory << Contrast::Agent::Reporting::ApplicationInventoryActivity.convert(activity_dtm)
+        end
+      end
+    end
+  end
+end

data/lib/contrast/agent/reporting/reporting_events/application_defend_activity.rb

@@ -0,0 +1,48 @@
+# 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'
+require 'contrast/agent/reporting/reporting_events/application_defend_attacker_activity'
+
+module Contrast
+  module Agent
+    module Reporting
+      # This is the new ApplicationDefendActivity class which includes information about the defense of the application
+      # which was discovered during exercise of the application during this activity period.
+      class ApplicationDefendActivity
+        # @return [Array<Contrast::Agent::Reporting::ApplicationDefendAttackerActivity>]
+        attr_reader :attackers
+
+        class << self
+          # @param activity_dtm [Contrast::Api::Dtm::ApplicationActivity]
+          # @return [Contrast::Agent::Reporting::ApplicationDefendActivity]
+          def convert activity_dtm
+            activity = new
+            activity.attach_data activity_dtm.results
+            activity
+          end
+        end
+
+        def initialize
+          @attackers = []
+          @event_type = :application_defend_activity
+          super
+        end
+
+        def to_controlled_hash
+          {
+              attackers: attackers.map(&:to_controlled_hash)
+          }
+        end
+
+        # @param attack_dtms [Contrast::Api::Dtm::AttackResult]
+        # @return [Contrast::Agent::Reporting::ApplicationDefendAttackerActivity]
+        def attach_data attack_dtms
+          attack_dtms.each do |attack|
+            @attackers << Contrast::Agent::Reporting::ApplicationDefendAttackerActivity.convert(attack)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/contrast/agent/reporting/reporting_events/application_defend_attack_activity.rb

@@ -0,0 +1,64 @@
+# 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'
+require 'contrast/agent/reporting/reporting_events/application_defend_attack_sample_activity'
+
+module Contrast
+  module Agent
+    module Reporting
+      # This is the new ApplicationDefendAttackActivity class which will include the attacks sent by the source.
+      class ApplicationDefendAttackActivity
+        attr_reader :blocked, :exploited, :ineffective, :suspicious
+
+        class << self
+          def convert attack_result
+            activity = new
+            activity.attach_data attack_result
+            activity
+          end
+        end
+
+        def initialize
+          @start_time = start_time
+          @blocked = []
+          @exploited = []
+          @ineffective = []
+          @suspicious = []
+          super
+        end
+
+        def to_controlled_hash
+          {
+              startTime: @start_time,
+              blocked: blocked.map(&:to_controlled_hash),
+              exploited: exploited.map(&:to_controlled_hash),
+              ineffective: ineffective.map(&:to_controlled_hash),
+              suspicious: suspicious.map(&:to_controlled_hash)
+          }
+        end
+
+        # @param attack_result [Contrast::Agent::Reporting::AttackResult]
+        # @return [Contrast::Agent::Reporting::Defend::AttackSampleActivity]
+        def attach_data attack_result
+          attack_sample_activity =
+            Contrast::Agent::Reporting::ApplicationDefendAttackSampleActivity.convert(attack_result)
+          case attack_result.response
+          when Contrast::Agent::Reporting::ResponseType::BLOCKED
+            @blocked << attack_sample_activity
+          when Contrast::Agent::Reporting::ResponseType::EXPLOITED
+            @exploited << attack_sample_activity
+          when Contrast::Agent::Reporting::ResponseType::MONITORED
+            @ineffective << attack_sample_activity
+          when Contrast::Agent::Reporting::ResponseType::SUSPICIOUS
+            @suspicious << attack_sample_activity
+          end
+        end
+
+        def start_time
+          Contrast::Agent::REQUEST_TRACKER.current&.timer&.start_ms
+        end
+      end
+    end
+  end
+end

data/lib/contrast/agent/reporting/reporting_events/application_defend_attack_sample.rb

@@ -0,0 +1,70 @@
+# 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'
+
+module Contrast
+  module Agent
+    module Reporting
+      # This is the new ApplicationDefendAttackSample class which includes a samples of an attack for the given rule of
+      # the given result observed in the activity period.
+      class ApplicationDefendAttackSample
+        include Contrast::Agent::Reporting::InputType
+
+        class << self
+          def convert attack_result
+            activity = new
+            activity.attach_data attack_result
+            activity
+          end
+        end
+
+        def initialize
+          @blocked = false
+          @event_type = :application_defend_attack_sample
+        end
+
+        def to_controlled_hash
+          {
+              blocked: @blocked,
+              input: @input,
+              request: @request.to_controlled_hash,
+              stack: @stack,
+              timeStamp: @time_stamp
+          }
+        end
+
+        # @param attack_result [Contrast::Api::Dtm::AttackResult]
+        def attach_data attack_result
+          rasp_rule = attack_result.samples[0]
+          @blocked = attack_result.response == Contrast::Agent::Reporting::ResponseType::BLOCKED
+          @input = build_input(rasp_rule)
+          @time_stamp = build_time_stamp(rasp_rule.timestamp_ms)
+          @request = FindingRequest.convert(Contrast::Agent::REQUEST_TRACKER.current&.request)
+          @stack = Contrast::Utils::StackTraceUtils.build_protect_stack_array
+        end
+
+        def build_time_stamp start
+          {
+              start: start,
+              elapsed: Contrast::Utils::Timer.now_ms - start
+          }
+        end
+
+        def build_input rasp_rule
+          user_input = rasp_rule.user_input
+          {
+              details: Contrast::Api::Dtm::RaspRuleSample.to_controlled_hash(rasp_rule),
+              documentPath: user_input.path,
+              documentType: user_input.document_type,
+              filters: user_input.matcher_ids,
+              name: user_input.key,
+              time: rasp_rule.timestamp_ms,
+              type: user_input.input_type,
+              value: user_input.value
+          }
+        end
+      end
+    end
+  end
+end

data/lib/contrast/agent/reporting/reporting_events/application_defend_attack_sample_activity.rb

@@ -0,0 +1,57 @@
+# 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'
+require 'contrast/agent/reporting/reporting_events/application_defend_attack_sample'
+
+module Contrast
+  module Agent
+    module Reporting
+      # This is the new AttackerSampleActivity class which will include Sample of the given attacks in the activity
+      # period.
+      class ApplicationDefendAttackSampleActivity
+        class << self
+          def convert attack_samples
+            activity = new
+            activity.attach_data attack_samples
+            activity
+          end
+        end
+
+        def initialize
+          @samples = []
+          @start_time = (Contrast::Agent::REQUEST_TRACKER.current&.timer&.start_ms || 0)
+          @event_type = :application_defend_attack_sample_activity
+          super
+        end
+
+        def to_controlled_hash
+          {
+              attackTimeMap: attack_time_map,
+              samples: @samples.map(&:to_controlled_hash),
+              startTime: @start_time,
+              total: 1 # there will only ever be 1 attack sample, until batching is done
+          }
+        end
+
+        # @param inventory_dtm [Contrast::Api::Dtm::ApplicationUpdate]
+        # @return [Contrast::Agent::Reporting::ApplicationInventory]
+        # TODO: RUBY-9999 update to handle batching
+        def attach_data attack_sample
+          @samples << Contrast::Agent::Reporting::ApplicationDefendAttackSample.convert(attack_sample)
+        end
+
+        def attack_time_map
+          {
+              second: duration,
+              count: 1 # there will only ever be 1 attack sample, until batching is done
+          }
+        end
+
+        def duration
+          Contrast::Utils::Timer.now_ms - @start_time
+        end
+      end
+    end
+  end
+end

data/lib/contrast/agent/reporting/reporting_events/application_defend_attacker_activity.rb

@@ -0,0 +1,56 @@
+# 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'
+require 'contrast/agent/reporting/reporting_events/application_defend_attack_activity'
+
+module Contrast
+  module Agent
+    module Reporting
+      # This is the new AttackerActivity class which will includes the attacker information discovered during this
+      # activity period.
+      class ApplicationDefendAttackerActivity
+        attr_reader :attackers
+
+        class << self
+          def convert attack_result_dtm
+            activity = new
+            activity.attach_data attack_result_dtm
+            activity
+          end
+        end
+
+        def initialize
+          @protection_rules = {}
+          @request = Contrast::Agent::REQUEST_TRACKER.current.activity.http_request
+          @event_type = :application_defend_attacker_activity
+          super
+        end
+
+        def to_controlled_hash
+          {
+              protectionRules: process_protection_rules,
+              source: {
+                  ip: @request.sender.ip,
+                  xForwardedFor: @request.request_headers['X-Forwarded-For']
+              }
+          }
+        end
+
+        # @param attack_result [Contrast::Agent::Reporting::AttackResult]
+        def attach_data attack_result
+          attack_activity = Contrast::Agent::Reporting::ApplicationDefendAttackActivity.convert(attack_result)
+          @protection_rules[attack_result.rule_id] = attack_activity
+        end
+
+        def process_protection_rules
+          arr = []
+          @protection_rules.each_pair do |k, v|
+            arr << { k => v&.to_controlled_hash }
+          end
+          arr
+        end
+      end
+    end
+  end
+end

data/lib/contrast/agent/reporting/reporting_events/application_inventory.rb

@@ -9,9 +9,13 @@ module Contrast
   module Agent
     module Reporting
       # This is the new ApplicationInventory class which will include all the needed information
-      # for the new reporting system to report
-      class ApplicationInventory < Contrast::Agent::Reporting::ReportingEvent
-        attr_accessor :routes, :agent_session_id_value
+      # for the new reporting system to report. Reporting those components or details discovered at
+      # startup, or as soon as possible, but not necessarily seen used by the application. Each of
+      # these messages should only be sent once per application.
+      class ApplicationInventory < Contrast::Agent::Reporting::ApplicationReportingEvent
+        # @param [Array<Contrast::Agent::Reporting::DiscoveredRoute>] the routes registered to this application, as
+        #   discovered during first request processing.
+        attr_reader :routes
 
         class << self
           def convert app_update_dtm
@@ -21,6 +25,10 @@ module Contrast
           end
         end
 
+        def file_name
+          'applications-inventory'
+        end
+
         def initialize
           @routes = []
           @event_type = :application_inventory
@@ -31,7 +39,7 @@ module Contrast
 
         def to_controlled_hash
           {
-              session_id: agent_session_id_value,
+              session_id: @agent_session_id_value,
               routes: routes.map(&:to_controlled_hash)
           }
         end

data/lib/contrast/agent/reporting/reporting_events/application_inventory_activity.rb

@@ -0,0 +1,58 @@
+# 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'
+require 'contrast/agent/reporting/reporting_events/application_reporting_event'
+require 'contrast/agent/reporting/reporting_events/architecture_component'
+
+module Contrast
+  module Agent
+    module Reporting
+      # This is the new ApplicationInventoryActivity class which will include all the information
+      # about the inventory of the application which was discovered during exercise of the application
+      # during this activity period.
+      class ApplicationInventoryActivity < Contrast::Agent::Reporting::ApplicationReportingEvent
+        # return [Contrast::Agent::Reporting::ArchitectureComponent]
+        attr_reader :components
+        # @ return [String, nil] - User-Agent Header value
+        attr_reader :browser
+
+        class << self
+          # @param activity_dtm [Contrast::Api::Dtm::ApplicationActivity]
+          # @return [Contrast::Agent::Reporting::ApplicationInventoryActivity]
+          def convert activity_dtm
+            inventory = new
+            inventory.attach_data activity_dtm
+            inventory
+          end
+        end
+
+        def initialize
+          @event_type = :application_inventory_activity
+          @components = []
+          super
+        end
+
+        def to_controlled_hash
+          {
+              activityDuration: duration,
+              browser: browser,
+              components: components.map(&:to_controlled_hash)
+          }
+        end
+
+        def attach_data activity
+          activity.architectures.each do |architecture|
+            @components << Contrast::Agent::Reporting::ArchitectureComponent.convert(architecture)
+          end
+          request_headers = activity.http_request&.request_headers
+          @browser = request_headers['USER_AGENT'] if request_headers
+        end
+
+        def duration
+          Contrast::Utils::Timer.now_ms - (Contrast::Agent::REQUEST_TRACKER.current&.timer&.start_ms || 0)
+        end
+      end
+    end
+  end
+end

data/lib/contrast/agent/reporting/reporting_events/application_reporting_event.rb

@@ -0,0 +1,27 @@
+# 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/reporting_event'
+require 'contrast/utils/timer'
+
+module Contrast
+  module Agent
+    module Reporting
+      # This is the new ApplicationReportingEvent class which will include all the needed and mutual information for
+      # those events which correspond to Applications, such as Application Activity or Application Update
+      #
+      # @abstract
+      class ApplicationReportingEvent < Contrast::Agent::Reporting::ReportingEvent
+        protected
+
+        # The timestamp field is a bit of a misnomer. It's really the time, in ms, since the settings for this
+        # application have been updated. If I've never updated, then it's been 0ms since then.
+        #
+        # @return [Integer]
+        def since_last_update
+          (update_time = Contrast::SETTINGS.last_app_update_ms) ? Contrast::Utils::Timer.now_ms - update_time : 0
+        end
+      end
+    end
+  end
+end

data/lib/contrast/agent/reporting/reporting_events/application_startup.rb

@@ -0,0 +1,50 @@
+# 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_reporting_event'
+require 'contrast/agent/reporting/reporting_events/application_startup_instrumentation'
+require 'contrast/config'
+
+module Contrast
+  module Agent
+    module Reporting
+      # This is the new ApplicationStartup class which will include all the needed information for the new reporting
+      # system to report an Application has started; creating a new one or marking an existing one as online in the
+      # Contrast UI
+      class ApplicationStartup < Contrast::Agent::Reporting::ApplicationReportingEvent
+        def initialize
+          @event_method = :PUT
+          @event_endpoint = Contrast::Agent::Reporting::Endpoints::NG_ENDPOINTS[:application_create]
+          super
+        end
+
+        def file_name
+          'applications-create'
+        end
+
+        # Convert the instance variables on the class, and other information, into the identifiers required for
+        # TeamServer to process the JSON form of this message.
+        #
+        # @return [Hash]
+        # @raise [ArgumentError]
+        def to_controlled_hash
+          app_config = ::Contrast::CONFIG.root.application
+          hsh = {
+              code: app_config.code,
+              group: app_config.group,
+              instrumentation: Contrast::Agent::Reporting::ApplicationStartupInstrumentation.new.to_controlled_hash,
+              metadata: app_config.metadata,
+              tags: app_config.tags
+          }
+          if (session_id = ::Contrast::CONFIG.session_id)
+            hsh[:session_id] = session_id
+          end
+          if (session_metadata = ::Contrast::CONFIG.session_metadata)
+            hsh[:session_metadata] = session_metadata
+          end
+          hsh
+        end
+      end
+    end
+  end
+end

data/lib/contrast/agent/reporting/reporting_events/application_startup_instrumentation.rb

@@ -0,0 +1,27 @@
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# frozen_string_literal: true
+
+require 'contrast/components/protect'
+
+module Contrast
+  module Agent
+    module Reporting
+      # This is the new ApplicationStartupInstrumentation class which will include all the needed information for the
+      # system to report the instrumentation mode to which the agent was set by local configuration.
+      class ApplicationStartupInstrumentation
+        # Convert the instance variables on the class, and other information, into the identifiers required for
+        # TeamServer to process the JSON form of this message.
+        #
+        # @return [Hash]
+        # @raise [ArgumentError]
+        def to_controlled_hash
+          {
+              protect: {
+                  enable: ::Contrast::PROTECT.enabled?
+              }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/contrast/agent/reporting/reporting_events/application_update.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require 'contrast/agent/reporting/reporting_events/architecture_component'
+require 'contrast/agent/reporting/reporting_events/application_reporting_event'
 require 'contrast/agent/reporting/reporting_events/library_discovery'
 require 'contrast/agent/reporting/reporting_events/reporting_event'
 require 'contrast/agent/reporting/reporting_events/route_discovery'
@@ -17,7 +18,7 @@ module Contrast
       #
       # @attr_reader components [Array<Contrast::Agent::Reporting::ArchitectureComponent>]
       # @attr_reader libraries [Array<Contrast::Agent::Reporting::LibraryDiscovery>]
-      class ApplicationUpdate < Contrast::Agent::Reporting::ReportingEvent
+      class ApplicationUpdate < Contrast::Agent::Reporting::ApplicationReportingEvent
         attr_reader :components, :libraries
 
         class << self
@@ -36,6 +37,10 @@ module Contrast
           super
         end
 
+        def file_name
+          'update-application'
+        end
+
         # Attach the data from the protobuf models to this reporter so that it can be sent to TeamServer directly.
         #
         # @param app_update_dtm [Contrast::Api::Dtm::ApplicationUpdate]
@@ -58,7 +63,7 @@ module Contrast
           {
               components: components.map(&:to_controlled_hash),
               libraries: libraries.map(&:to_controlled_hash),
-              timestamp: timestamp
+              timestamp: since_last_update
           }
         end
 
@@ -66,16 +71,6 @@ module Contrast
         #
         # @raise [ArgumentError]
         def validate; end
-
-        private
-
-        # The timestamp field is a bit of a misnomer. It's really the time, in ms, since the settings for this
-        # application have been updated.
-        #
-        # @return [Integer]
-        def timestamp
-          Contrast::Utils::Timer.now_ms - (Contrast::Agent.reporter&.client&.response_handler&.last_app_update_ms || 0)
-        end
       end
     end
   end

data/lib/contrast/agent/reporting/reporting_events/finding.rb

@@ -3,9 +3,9 @@
 
 require 'json'
 require 'contrast/components/logger'
+require 'contrast/agent/reporting/reporting_events/application_reporting_event'
 require 'contrast/agent/reporting/reporting_events/finding_event'
 require 'contrast/agent/reporting/reporting_events/finding_request'
-require 'contrast/agent/reporting/reporting_events/reporting_event'
 require 'contrast/agent/assess/events/event_data'
 require 'contrast/utils/timer'
 
@@ -16,7 +16,7 @@ module Contrast
       # relay this information in the Finding/Trace messages. These findings are used by TeamServer to construct the
       # vulnerability information for the assess feature. They represent those parts of the application, either through
       # configuration, method invocation, or dataflow, which are determined to be insecure.
-      class Finding < Contrast::Agent::Reporting::ReportingEvent
+      class Finding < Contrast::Agent::Reporting::ApplicationReportingEvent
         include Contrast::Components::Logger::InstanceMethods
 
         # @return [Integer] the time, in ms, that this object was initialized
@@ -75,6 +75,10 @@ module Contrast
           super()
         end
 
+        def file_name
+          'traces'
+        end
+
         # Some reports require specific additional headers to be used. To that end, we'll attach them here, letting
         # each handle their own.
         #
@@ -100,7 +104,7 @@ module Contrast
           return unless request
 
           @request = Contrast::Agent::Reporting::FindingRequest.convert(request)
-          @routes << Contrast::Agent::Reporting::RouteDiscovery.convert(request.route)
+          @routes << Contrast::Agent::Reporting::RouteDiscovery.convert(request.route) if request.route
         end
 
         # Attach the data from a Contrast::Api::Dtm::Finding required for property based findings generated during
@@ -148,7 +152,9 @@ module Contrast
         # @raise [ArgumentError]
         def validate
           raise(ArgumentError, "#{ self } did not have a proper rule. Unable to continue.") unless @rule_id
-
+          unless @agent_session_id_value
+            raise(ArgumentError, "#{ self } did not have a proper session id. Unable to continue.")
+          end
           if event_based? && events.empty?
             raise(ArgumentError, "#{ self } did not have proper events for #{ @rule_id }. Unable to continue.")
           end

data/lib/contrast/agent/reporting/reporting_events/finding_event.rb

@@ -278,14 +278,12 @@ module Contrast
           unless parent_object_ids
             raise(ArgumentError, "#{ self } did not have a proper parentObjectIds. Unable to continue.")
           end
-          unless taint_ranges && !taint_ranges.empty?
-            raise(ArgumentError, "#{ self } did not have a proper taintRanges. Unable to continue.")
-          end
+          raise(ArgumentError, "#{ self } did not have a proper taintRanges. Unable to continue.") unless taint_ranges
           raise(ArgumentError, "#{ self } did not have a proper args. Unable to continue.") unless args
           raise(ArgumentError, "#{ self } did not have a proper object. Unable to continue.") unless object
           raise(ArgumentError, "#{ self } did not have a proper signature. Unable to continue.") unless signature
           raise(ArgumentError, "#{ self } did not have a proper stack. Unable to continue.") unless stack
-          raise(ArgumentError, "#{ self } did not have a proper tags. Unable to continue.") unless tags && !tags.empty?
+          raise(ArgumentError, "#{ self } did not have a proper tags. Unable to continue.") unless tags
         end
       end
     end