contrast-agent 6.11.0 → 6.13.0

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

@@ -1,8 +1,9 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'base64'
-require 'contrast/components/logger'
+require 'contrast/agent/reporting/reporting_events/reportable_hash'
+require 'contrast/utils/duck_utils'
 
 module Contrast
   module Agent
@@ -11,14 +12,13 @@ module Contrast
       # reporting system to relay this information in the Finding/Trace messages. These FindingEventParentObject are
       # used by TeamServer to relate this event to those that came previously. They represent the events that directly
       # preceding the FindingEvent generated.
-      class FindingEventParentObject
-        include Contrast::Components::Logger::InstanceMethods
-
+      class FindingEventParentObject < Contrast::Agent::Reporting::ReportableHash
         # @return [Integer] the Id of the parent event
         attr_reader :id
 
         def initialize id
           @id = id
+          super()
         end
 
         # Convert the instance variables on the class, and other information, into the identifiers required for
@@ -27,13 +27,7 @@ module Contrast
         # @return [Hash]
         # @raise [ArgumentError]
         def to_controlled_hash
-          begin
-            validate
-          rescue ArgumentError => e
-            logger.error('FindingEventParentObject validation failed with: ', e)
-            return
-          end
-
+          validate
           {
               id: id
           }
@@ -41,7 +35,9 @@ module Contrast
 
         # @raise [ArgumentError]
         def validate
-          raise(ArgumentError, "#{ self } did not have a proper id. Unable to continue.") unless id
+          return unless Contrast::Utils::DuckUtils.empty_duck?(id)
+
+          raise(ArgumentError, "#{ self } did not have a proper id. Unable to continue.")
         end
       end
     end

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

@@ -1,7 +1,8 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 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/reportable_hash'
+require 'contrast/utils/duck_utils'
 
 module Contrast
   module Agent
@@ -9,9 +10,7 @@ module Contrast
       # This is the new FindingEventProperty class which will include all the needed information for the new reporting
       # system to relay this information in the Finding/Trace messages. Events have properties on them which are held
       # as an array of key-value pairs.
-      class FindingEventProperty
-        include Contrast::Components::Logger::InstanceMethods
-
+      class FindingEventProperty < Contrast::Agent::Reporting::ReportableHash
         # @return [String] the key of the property
         attr_reader :key
         # @return [String] the value of the source
@@ -20,6 +19,7 @@ module Contrast
         def initialize key, value
           @key = key
           @value = value
+          super()
         end
 
         # Convert the instance variables on the class, and other information, into the identifiers required for
@@ -28,13 +28,7 @@ module Contrast
         # @return [Hash]
         # @raise [ArgumentError]
         def to_controlled_hash
-          begin
-            validate
-          rescue ArgumentError => e
-            logger.error('FindingEventProperty validation failed with: ', e)
-            return
-          end
-
+          validate
           {
               key: key,
               value: value
@@ -43,7 +37,9 @@ module Contrast
 
         # @raise [ArgumentError]
         def validate
-          raise(ArgumentError, "#{ self } did not have a proper key. Unable to continue.") unless key && !key.empty?
+          return unless Contrast::Utils::DuckUtils.empty_duck?(key)
+
+          raise(ArgumentError, "#{ self } did not have a proper key. Unable to continue.")
         end
       end
     end

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

@@ -1,8 +1,8 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/utils/object_share'
-require 'contrast/components/logger'
+require 'contrast/agent/reporting/reporting_events/reportable_hash'
 
 module Contrast
   module Agent
@@ -11,9 +11,7 @@ module Contrast
       # system to relay this information in the Finding/Trace messages. These FindingEventSignatures are used by
       # TeamServer to construct the method signature for the assess feature. They represent the method invoked when the
       # FindingEvent was generated.
-      class FindingEventSignature
-        include Contrast::Components::Logger::InstanceMethods
-
+      class FindingEventSignature < Contrast::Agent::Reporting::ReportableHash
         # @return [String] the types of the arguments in this event; may be different for each invocation of the
         #   method.
         attr_reader :arg_types
@@ -55,6 +53,7 @@ module Contrast
           # if there's a ret, then this method isn't nil. not 100% full proof since you can return nil, but this is the
           # best we've got currently.
           @void_method = ret.nil? || ret.object.nil? || ret.object == Contrast::Utils::ObjectShare::NIL_STRING
+          super()
         end
 
         # Convert the instance variables on the class, and other information, into the identifiers required for
@@ -63,13 +62,7 @@ module Contrast
         # @return [Hash]
         # @raise [ArgumentError]
         def to_controlled_hash
-          begin
-            validate
-          rescue ArgumentError => e
-            logger.error('FindingEventSignature validation failed with: ', e)
-            return
-          end
-
+          validate
           {
               argTypes: arg_types,
               className: class_name,

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

@@ -1,8 +1,9 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'base64'
-require 'contrast/components/logger'
+require 'contrast/agent/reporting/reporting_events/reportable_hash'
+require 'contrast/utils/duck_utils'
 
 module Contrast
   module Agent
@@ -11,9 +12,7 @@ module Contrast
       # system to relay this information in the Finding/Trace messages. These FindingEventSource are used by TeamServer
       # to construct the vulnerability information for the assess feature. They indicate the type of data that the
       # event represents.
-      class FindingEventSource
-        include Contrast::Components::Logger::InstanceMethods
-
+      class FindingEventSource < Contrast::Agent::Reporting::ReportableHash
         # @return [String] the name of the source
         attr_reader :source_name
         # @return [String] the type of the source
@@ -24,6 +23,7 @@ module Contrast
         def initialize type, name
           @source_type = type
           @source_name = name
+          super()
         end
 
         # Convert the instance variables on the class, and other information, into the identifiers required for
@@ -32,13 +32,7 @@ module Contrast
         # @return [Hash]
         # @raise [ArgumentError]
         def to_controlled_hash
-          begin
-            validate
-          rescue ArgumentError => e
-            logger.error('FindingEventSource validation failed with: ', e)
-            return
-          end
-
+          validate
           {
               sourceName: source_name,
               sourceType: source_type
@@ -50,13 +44,7 @@ module Contrast
         # @return [Hash]
         # @raise [ArgumentError]
         def to_controlled_observation_hash
-          begin
-            validate
-          rescue ArgumentError => e
-            logger.error('FindingEventSource observation validation failed with: ', e)
-            return
-          end
-
+          validate
           {
               name: source_name,
               type: source_type
@@ -65,8 +53,9 @@ module Contrast
 
         # @raise [ArgumentError]
         def validate
-          raise(ArgumentError, "#{ self } did not have a proper type. Unable to continue.") unless source_type &&
-              !source_type.empty?
+          return unless Contrast::Utils::DuckUtils.empty_duck?(source_type)
+
+          raise(ArgumentError, "#{ self } did not have a proper type. Unable to continue.")
         end
       end
     end

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

@@ -1,7 +1,9 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/components/logger'
+require 'contrast/utils/duck_utils'
+require 'contrast/agent/reporting/reporting_events/reporting_event'
 
 module Contrast
   module Agent
@@ -10,9 +12,7 @@ module Contrast
       # system to relay this information in the Finding/Trace messages. These FindingEventStack are used by TeamServer
       # to construct the vulnerability information for the assess feature. They represent the callstack at the time
       # that each FindingEvent was generated.
-      class FindingEventStack
-        include Contrast::Components::Logger::InstanceMethods
-
+      class FindingEventStack < Contrast::Agent::Reporting::ReportingEvent
         # @return [String] unused
         attr_reader :eval
         # @return [String] the stack frame to show in TeamServer; the value of an entry in #caller
@@ -34,6 +34,7 @@ module Contrast
         # @param file_name [String] the caller location this stack frame represents.
         def initialize file_name
           @file = file_name
+          super()
         end
 
         # Convert the instance variables on the class, and other information, into the identifiers required for
@@ -42,13 +43,7 @@ module Contrast
         # @return [Hash]
         # @raise [ArgumentError]
         def to_controlled_hash
-          begin
-            validate
-          rescue ArgumentError => e
-            logger.error('FindingEventStack validation failed with: ', e)
-            return
-          end
-
+          validate
           {
               file: file
             # eval: eval, # This is unused by the Ruby agent
@@ -60,7 +55,9 @@ module Contrast
         end
 
         def validate
-          raise(ArgumentError, "#{ self } did not have a proper hash. Unable to continue.") unless file && !file.empty?
+          return unless Contrast::Utils::DuckUtils.empty_duck?(file)
+
+          raise(ArgumentError, "#{ self } did not have a proper file. Unable to continue.")
         end
       end
     end

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

@@ -1,9 +1,10 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/agent/assess/tag'
 require 'contrast/agent/reporting/reporting_events/finding_event_taint_range_tags'
-require 'contrast/components/logger'
+require 'contrast/utils/duck_utils'
+require 'contrast/agent/reporting/reporting_events/reportable_hash'
 
 module Contrast
   module Agent
@@ -12,9 +13,7 @@ module Contrast
       # reporting system to relay this information in the Finding/Trace messages. These FindingTaintRanges are used by
       # TeamServer to construct the vulnerability information for the assess feature. They represent those parts of the
       # objects that are tracked because of a security relevant operation acting on them.
-      class FindingEventTaintRange
-        include Contrast::Components::Logger::InstanceMethods
-
+      class FindingEventTaintRange < Contrast::Agent::Reporting::ReportableHash
         # @return [String] the range (inclusive:exclusive), that this tag covers.
         attr_reader :range
         # @return [String] the type of action this tag represents.
@@ -45,13 +44,7 @@ module Contrast
         # @return [Hash]
         # @raise [ArgumentError]
         def to_controlled_hash
-          begin
-            validate
-          rescue ArgumentError => e
-            logger.error('FindingEventTaintRange validation failed with: ', e)
-            return
-          end
-
+          validate
           {
               range: range,
               tag: tag
@@ -60,10 +53,13 @@ module Contrast
 
         # @raise [ArgumentError]
         def validate
-          unless range && !range.empty?
+          if Contrast::Utils::DuckUtils.empty_duck?(range) # rubocop:disable Style/GuardClause
             raise(ArgumentError, "#{ self } did not have a proper range. Unable to continue.")
+          elsif Contrast::Utils::DuckUtils.empty_duck?(tag)
+            raise(ArgumentError, "#{ self } did not have a proper tag. Unable to continue.")
           end
-          raise(ArgumentError, "#{ self } did not have a proper tag. Unable to continue.") unless tag && !tag.empty?
+
+          nil
         end
       end
     end

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

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 module Contrast

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

@@ -1,7 +1,7 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 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/reportable_hash'
 
 module Contrast
   module Agent
@@ -10,9 +10,7 @@ module Contrast
       # to relay this information in the Finding/Trace messages. These requests are used by TeamServer to construct the
       # HTTP information for the assess feature. They represent the literal request made that resulted in the
       # vulnerability being triggered.
-      class FindingRequest
-        include Contrast::Components::Logger::InstanceMethods
-
+      class FindingRequest < Contrast::Agent::Reporting::ReportableHash
         OMITTED_BODY = '{{body-omitted-by-contrast}}'
 
         # @return [String] the body of this request
@@ -84,13 +82,7 @@ module Contrast
         # @return [Hash]
         # @raise [ArgumentError]
         def to_controlled_hash
-          begin
-            validate
-          rescue ArgumentError => e
-            logger.error('FindingRequest validation failed with: ', e)
-            return
-          end
-
+          validate
           {
               body: body,
               headers: headers,

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

@@ -1,8 +1,9 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'contrast/utils/string_utils'
-require 'contrast/components/logger'
+require 'contrast/utils/duck_utils'
+require 'contrast/agent/reporting/reporting_events/reportable_hash'
 
 module Contrast
   module Agent
@@ -21,9 +22,7 @@ module Contrast
       # @attr_reader tags [String] Inventory tags set by the user via configuration.
       # @attr_reader url [String] The homepage of the Gem.
       # @attr_reader version [String] The version of the Gem.
-      class LibraryDiscovery
-        include Contrast::Components::Logger::InstanceMethods
-
+      class LibraryDiscovery < Contrast::Agent::Reporting::ReportableHash
         StringUtils = Contrast::Utils::StringUtils
 
         # required attributes
@@ -42,6 +41,7 @@ module Contrast
           @url         = StringUtils.force_utf8(spec.homepage)
           @class_count = Contrast::Utils::Sha256Builder.instance.files(spec.full_gem_path.to_s).length
           @tags = Contrast::INVENTORY.tags
+          super()
         end
 
         # Convert the instance variables on the class, and other information, into the identifiers required for
@@ -50,13 +50,7 @@ module Contrast
         # @return [Hash]
         # @raise [ArgumentError]
         def to_controlled_hash
-          begin
-            validate
-          rescue ArgumentError => e
-            logger.error('LibraryDiscovery validation failed with: ', e)
-            return
-          end
-
+          validate
           {
               classCount: class_count,
               externalDate: external_date,
@@ -74,14 +68,20 @@ module Contrast
         #
         # @raise [ArgumentError]
         def validate
+          if Contrast::Utils::DuckUtils.empty_duck?(file)
+            raise(ArgumentError, "#{ self } did not have a proper file. Unable to continue.")
+          end
+          if Contrast::Utils::DuckUtils.empty_duck?(hash)
+            raise(ArgumentError, "#{ self } did not have a proper hash. Unable to continue.")
+          end
           unless external_date
             raise(ArgumentError, "#{ self } did not have a proper external date. Unable to continue.")
           end
           unless internal_date
             raise(ArgumentError, "#{ self } did not have a proper internal date. Unable to continue.")
           end
-          raise(ArgumentError, "#{ self } did not have a proper file. Unable to continue.") unless file
-          raise(ArgumentError, "#{ self } did not have a proper hash. Unable to continue.") unless hash
+
+          nil
         end
       end
     end

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

@@ -1,15 +1,14 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 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/reportable_hash'
+require 'contrast/utils/duck_utils'
 
 module Contrast
   module Agent
     module Reporting
       # The usage, meaning loaded files, of a library seen during this request
-      class LibraryUsageObservation
-        include Contrast::Components::Logger::InstanceMethods
-
+      class LibraryUsageObservation < Contrast::Agent::Reporting::ReportableHash
         # @param [String] Sha256Sum of library as identified by the agent
         attr_reader :id
         # @param [Array<String>] List of file paths that have been loaded out of or executed by the library
@@ -20,17 +19,12 @@ module Contrast
         def initialize id, class_names
           @id = id
           @names = class_names
+          super()
         end
 
         # @raise [ArgumentError]
         def to_controlled_hash
-          begin
-            validate
-          rescue ArgumentError => e
-            logger.error('LibraryUsageObservation validation failed with: ', e)
-            return
-          end
-
+          validate
           {
               id: @id,
               names: @names
@@ -39,8 +33,14 @@ module Contrast
 
         # @raise [ArgumentError]
         def validate
-          raise(ArgumentError, "#{ self } did not have a proper id. Unable to continue.") unless id
-          raise(ArgumentError, "#{ self } did not have a proper names. Unable to continue.") if names.empty?
+          if Contrast::Utils::DuckUtils.empty_duck?(id)
+            raise(ArgumentError, "#{ self } did not have a proper id. Unable to continue.")
+          end
+          if Contrast::Utils::DuckUtils.empty_duck?(names)
+            raise(ArgumentError, "#{ self } did not have a proper names. Unable to continue.")
+          end
+
+          nil
         end
       end
     end

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

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 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'
@@ -10,15 +10,13 @@ module Contrast
     module Reporting
       # List of libraries that have been observed to have something loaded or executed.
       class ObservedLibraryUsage < Contrast::Agent::Reporting::ApplicationReportingEvent
-        include Contrast::Components::Logger::InstanceMethods
-
         # @return Array[Contrast::Agent::Reporting::LibraryUsageObservation]
         attr_reader :observations
 
         def initialize
           @event_endpoint = Contrast::Agent::Reporting::Endpoints.library_usage
           @observations = []
-          super
+          super()
         end
 
         def file_name
@@ -26,13 +24,7 @@ module Contrast
         end
 
         def to_controlled_hash
-          begin
-            validate
-          rescue ArgumentError => e
-            logger.error('ObservedLibraryUsage validation failed with: ', e)
-            return
-          end
-
+          validate
           { observations: @observations.map(&:to_controlled_hash) }
         end
 

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

@@ -1,9 +1,8 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
 require 'digest'
 require 'json'
-require 'contrast/components/logger'
 require 'contrast/agent/reporting/reporting_events/application_reporting_event'
 require 'contrast/utils/object_share'
 require 'contrast/utils/duck_utils'
@@ -18,8 +17,6 @@ module Contrast
       # includes the literal URL and HTTP Verb used to invoke them, as they must have been called at this point to be
       # recorded.
       class ObservedRoute < Contrast::Agent::Reporting::ApplicationReportingEvent
-        include Contrast::Components::Logger::InstanceMethods
-
         # @param [String] the method signature used to uniquely identify the coverage report.
         attr_accessor :signature
         # @param [String] the normalized URL used to access the method in the route.
@@ -47,13 +44,7 @@ module Contrast
         # @return [Hash]
         # @raise [ArgumentError]
         def to_controlled_hash
-          begin
-            validate
-          rescue ArgumentError => e
-            logger.error('ObservedRoute validation failed with: ', e)
-            return
-          end
-
+          validate
           {
               session_id: ::Contrast::ASSESS.session_id,
               sources: @sources.map(&:to_controlled_observation_hash),

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

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 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'
@@ -11,7 +11,7 @@ module Contrast
         def initialize
           @event_type = :heartbeat
           @event_endpoint = Contrast::Agent::Reporting::Endpoints.heartbeat
-          super
+          super()
         end
 
         def file_name

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

@@ -1,7 +1,8 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# Copyright (c) 2023 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/utils/duck_utils'
 
 module Contrast
   module Agent
@@ -20,7 +21,7 @@ module Contrast
           @event_method = :PUT
           @event_endpoint = "#{ Contrast::API.api_url }/api/ng/preflight/"
           @messages = []
-          super
+          super()
         end
 
         def file_name
@@ -33,8 +34,18 @@ module Contrast
         # @return [Hash]
         # @raise [ArgumentError]
         def to_controlled_hash
+          validate
           { messages: @messages.map(&:to_controlled_hash) }
         end
+
+        # @raise [ArgumentError]
+        def validate
+          if Contrast::Utils::DuckUtils.empty_duck?(messages)
+            raise(ArgumentError, "#{ cs__class } did not have any messages. Unable to continue.")
+          end
+
+          nil
+        end
       end
     end
   end