contrast-agent 3.16.0 → 4.3.1

data/lib/contrast/api/decorators/address.rb

@@ -21,7 +21,6 @@ module Contrast
         module ClassMethods
           include Contrast::Components::Interface
           access_component :logging
-
           # receiver is memoized because it is the address/host/port of the server, once we
           # resolve this for the first time, it shouldn't change
           #

data/lib/contrast/api/decorators/application_update.rb

@@ -44,7 +44,7 @@ module Contrast
             msg = new
             msg.append_route_coverage_data(Contrast::Agent.framework_manager.find_route_discovery_data)
             msg.append_platform_version(Contrast::Agent.framework_manager.platform_version)
-            msg.append_library_update(Contrast::Utils::GemfileReader.instance.library_pb_list)
+            msg.append_library_update(Contrast::Agent::Inventory::DependencyAnalysis.instance.library_pb_list)
             msg
           end
         end

data/lib/contrast/api/decorators/library.rb

@@ -0,0 +1,54 @@
+# Copyright (c) 2020 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/utils/sha256_builder'
+require 'yaml'
+
+module Contrast
+  module Api
+    module Decorators
+      # Used to decorate the Library protobuf model to handle Gem::Specification translation
+      module Library
+        def self.included klass
+          klass.extend(ClassMethods)
+        end
+
+        # Used to add class methods to the Library class on inclusion of the decorator
+        module ClassMethods
+          def build digest, gem_specification
+            msg = new
+            msg.file_path = Contrast::Utils::StringUtils.force_utf8(gem_specification.name)
+            msg.hash_code   = Contrast::Utils::StringUtils.force_utf8(digest)
+            msg.version     = Contrast::Utils::StringUtils.force_utf8(gem_specification.version)
+            msg.manifest    = Contrast::Utils::StringUtils.force_utf8(build_manifest(gem_specification))
+            msg.external_ms = date_to_ms(gem_specification.date)
+            msg.internal_ms = msg.external_ms
+            msg.url         = Contrast::Utils::StringUtils.force_utf8(gem_specification.homepage)
+            msg.class_count = file_count(gem_specification.full_gem_path.to_s)
+            msg.used_class_count = 0
+            msg
+          end
+
+          # These are all the code files that are located in the Gem directory loaded
+          # by the current environment; this includes more than Ruby files
+          def file_count path
+            Contrast::Utils::Sha256Builder.instance.files(path).length
+          end
+
+          def build_manifest spec
+            Contrast::Utils::StringUtils.force_utf8(spec.to_yaml.to_s)
+          rescue StandardError
+            nil
+          end
+
+          def date_to_ms date
+            (date.to_f * 1000.0).to_i
+          end
+        end
+      end
+    end
+  end
+end
+
+Contrast::Api::Dtm::Library.include(Contrast::Api::Decorators::Library)

data/lib/contrast/api/decorators/library_usage_update.rb

@@ -0,0 +1,31 @@
+# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# frozen_string_literal: true
+
+require 'contrast/utils/string_utils'
+
+module Contrast
+  module Api
+    module Decorators
+      # Used to decorate the LibraryUsageUpdate protobuf
+      module LibraryUsageUpdate
+        def self.included klass
+          klass.extend(ClassMethods)
+        end
+
+        # Used to add class methods to the LibraryUsageUpdate class on inclusion of the decorator
+        module ClassMethods
+          def build digest, files
+            msg = new
+            msg.hash_code = Contrast::Utils::StringUtils.force_utf8(digest)
+            files.each do |required_file|
+              msg.class_names[required_file] = true
+            end
+            msg
+          end
+        end
+      end
+    end
+  end
+end
+
+Contrast::Api::Dtm::LibraryUsageUpdate.include(Contrast::Api::Decorators::LibraryUsageUpdate)

data/lib/contrast/api/decorators/trace_event.rb

@@ -15,44 +15,30 @@ module Contrast
 
         # Wrapper around build_event_object for the args array. Handles
         # tainting the correct argument.
-        def build_event_args contrast_event, taint_target
+        def build_event_args! contrast_event, taint_target
           contrast_event.args.each_index do |idx|
             truncate_arg = taint_target != idx
             event_arg = Contrast::Api::Dtm::TraceEventObject.build(contrast_event.args[idx], truncate_arg)
             args << event_arg
           end
+          self
         end
 
-        # TeamServer only supports one object's taint ranges at a time.
-        # We'll find the taint ranges for the target and return those
-        def build_taint_ranges contrast_event, taint_target
+        # TeamServer only supports one object's taint ranges at a time. We keep
+        # those tags on the event directly, so we just need to convert them to
+        # their DTM form in order to report this.
+        #
+        # @param contrast_event [Contrast::Agent::AssessContrastEvent]
+        def build_taint_ranges! contrast_event
           # If there's no taint_target, this isn't a dataflow trace, but a
           # trigger one
-          return Contrast::Utils::ObjectShare::EMPTY_ARRAY unless taint_target
+          return self unless contrast_event&.tags
 
-          properties = case taint_target
-                       when Contrast::Utils::ObjectShare::OBJECT_KEY
-                         Contrast::Agent::Assess::Tracker.properties(contrast_event.object)
-                       when Contrast::Utils::ObjectShare::RETURN_KEY
-                         Contrast::Agent::Assess::Tracker.properties(contrast_event.ret)
-                       else
-                         target = contrast_event.args[taint_target]
-                         if target.is_a?(Hash)
-                           if contrast_event.policy_node&.targets&.any?
-                             Contrast::Agent::Assess::Tracker.properties(target[contrast_event.policy_node.targets[0]])
-                           else
-                             Contrast::Agent::Assess::Tracker.properties(target[contrast_event.policy_node.sources[0]])
-                           end
-                         else
-                           Contrast::Agent::Assess::Tracker.properties(target)
-                         end
-                       end
-          return unless properties.tracked?
-
-          self.taint_ranges += properties.tags_to_dtm
+          self.taint_ranges += Contrast::Api::Dtm::TraceTaintRange.build_for_event(contrast_event.tags)
+          self
         end
 
-        def build_parent_ids contrast_event
+        def build_parent_ids! contrast_event
           contrast_event&.parent_events&.each do |event|
             next unless event
 
@@ -60,12 +46,14 @@ module Contrast
             parent.id = event.event_id.to_i
             parent_object_ids << parent
           end
+          self
         end
 
-        def build_stack contrast_event
+        def build_stack! contrast_event
           # We delayed doing this as long as possible b/c it's expensive
           stack_dtms = Contrast::Utils::StackTraceUtils.build_assess_stack_array(contrast_event.stack_trace)
           self.stack += stack_dtms
+          self
         end
 
         # Class methods for TraceEvent
@@ -85,10 +73,10 @@ module Contrast
             event_dtm.object = Contrast::Api::Dtm::TraceEventObject.build(contrast_event.object, truncate_obj)
             truncate_ret = Contrast::Utils::ObjectShare::RETURN_KEY != taint_target
             event_dtm.ret = Contrast::Api::Dtm::TraceEventObject.build(contrast_event.ret, truncate_ret)
-            event_dtm.build_event_args(contrast_event, taint_target)
-            event_dtm.build_parent_ids(contrast_event)
-            event_dtm.build_taint_ranges(contrast_event, taint_target)
-            event_dtm.build_stack(contrast_event)
+            event_dtm.build_event_args!(contrast_event, taint_target)
+            event_dtm.build_parent_ids!(contrast_event)
+            event_dtm.build_taint_ranges!(contrast_event)
+            event_dtm.build_stack!(contrast_event)
             event_dtm.object_id = contrast_event.event_id.to_i
             event_dtm.signature = Contrast::Api::Dtm::TraceEventSignature.build(contrast_event.ret, contrast_event.policy_node, contrast_event.args)
             event_dtm

data/lib/contrast/api/decorators/trace_event_object.rb

@@ -29,13 +29,21 @@ module Contrast
           ELLIPSIS = '...'
           UNTRUNCATED_PORTION_LENGTH = 25
           TRUNCATION_LENGTH = (UNTRUNCATED_PORTION_LENGTH * 2) + ELLIPSIS.length
-          def build object, truncate
+
+          # Convert the given Object into a Contrast::Api::Dtm::TraceEventObject
+          #
+          # @param contrast_object [Contrast::Agent::Assess::ContrastObject, nil]
+          #   the thing to convert, if any
+          # @param truncate [Boolean] if the converted object can/should be
+          #   truncated.
+          # @return [Contrast::Api::Dtm::TraceEventObject]
+          def build contrast_object, truncate
             event_object = new
             with_contrast_scope do
-              obj_string = Contrast::Utils::StringUtils.force_utf8(object)
+              obj_string = Contrast::Utils::StringUtils.force_utf8(contrast_object&.object)
               obj_string = truncate(obj_string) if truncate && obj_string.length > TRUNCATION_LENGTH
               event_object.value = Base64.encode64(obj_string)
-              event_object.tracked = Contrast::Utils::Assess::TrackingUtil.tracked?(object)
+              event_object.tracked = contrast_object&.tracked?
             end
             event_object
           end

data/lib/contrast/api/decorators/trace_event_signature.rb

@@ -17,27 +17,49 @@ module Contrast
 
         # Class methods for TraceEventSignature
         module ClassMethods
+          # Convert the given composites into components that TeamServer can
+          # understand in order to build a representation of the method
+          # invoked.
+          #
+          # @param ret_obj [Contrast::Agent::Assess::ContrastObject, nil] the
+          #   return value of the method call.
+          # @param policy_node [Contrast::Agent::Assess::Policy::PolicyNode]
+          #   the policy which pertains to the method invoked.
+          # @param args [Array<Contrast::Agent::Assess::ContrastObject>, nil]
+          # @return [Contrast::Api::Dtm::TraceEventSignature]
           def build ret_obj, policy_node, args
             signature = new
-            return_type = ret_obj ? ret_obj.cs__class.name : Contrast::Utils::ObjectShare::NIL_STRING
-            signature.return_type = Contrast::Utils::StringUtils.force_utf8(return_type)
+            signature.return_type = Contrast::Utils::StringUtils.force_utf8(type_name(ret_obj))
             signature.class_name = Contrast::Utils::StringUtils.force_utf8(policy_node.class_name)
             signature.method_name = Contrast::Utils::StringUtils.force_utf8(policy_node.method_name)
             if args
               args&.each do |arg|
-                arg_type = arg ? arg.cs__class.name : Contrast::Utils::ObjectShare::NIL_STRING
-                signature.arg_types << Contrast::Utils::StringUtils.force_utf8(arg_type)
+                signature.arg_types << Contrast::Utils::StringUtils.force_utf8(type_name(arg))
               end
             end
             signature.constructor = policy_node.method_name == :new
             # 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.
-            signature.void_method = ret_obj.nil?
+            signature.void_method = ret_obj.nil? || ret_obj.object.nil?
             # 8 is STATIC in Java... we have to placate them for now
             # it has been requested that flags be removed since it isn't used
             signature.flags = 8 unless policy_node.instance_method?
             signature
           end
+
+          private
+
+          # While Ruby signatures do not require neither a return type and can
+          # return anything depending on inputs, code paths, etc, nor constant
+          # parameter types, TeamServer was designed with strongly typed
+          # languages (Java) in mind, so we need types in our signatures.
+          #
+          # @param contrast_object [Contrast::Agent::Assess::ContrastObject, nil]
+          #   the object to find the type of
+          # @return [String] the name of the module of the ret_obj, or `nil`
+          def type_name contrast_object
+            contrast_object ? contrast_object.object_type : Contrast::Utils::ObjectShare::NIL_STRING
+          end
         end
       end
     end

data/lib/contrast/api/decorators/user_input.rb

@@ -12,7 +12,8 @@ module Contrast
       module UserInput
         UNKNOWN_USER_INPUT = Contrast::Api::Dtm::UserInput.new.tap do |user_input|
           user_input.input_type = :UNKNOWN
-        end.cs__freeze
+        end
+        UNKNOWN_USER_INPUT.cs__freeze
 
         def self.included klass
           klass.extend(ClassMethods)

data/lib/contrast/common_agent_configuration.rb

@@ -65,7 +65,8 @@ module Contrast
       end
 
       %w[name default description required_languages display].each do |field|
-        define_method(field) { hsh[field].dup }
+        # TODO: RUBY-1052
+        define_method(field) { hsh[field].dup } # rubocop:disable Performance/Kernel/DefineMethod
       end
     end
 

data/lib/contrast/components/agent.rb

@@ -17,7 +17,8 @@ module Contrast
         access_component :analysis, :config, :settings
 
         def enabled?
-          !!@enabled
+          @_enabled = !false?(CONFIG.root.enable) if @_enabled.nil?
+          @_enabled
         end
 
         def disabled?
@@ -25,11 +26,11 @@ module Contrast
         end
 
         def enable!
-          @enabled = true
+          @_enabled = true
         end
 
         def disable!
-          @enabled = false
+          @_enabled = false
         end
 
         def ruleset
@@ -49,12 +50,12 @@ module Contrast
         end
 
         def patch_yield?
-          @_patch_yield = !Contrast::Utils::BooleanUtil.false?(CONFIG.root.agent.ruby.propagate_yield) if @_patch_yield.nil?
+          @_patch_yield = !false?(CONFIG.root.agent.ruby.propagate_yield) if @_patch_yield.nil?
           @_patch_yield
         end
 
         def interpolation_enabled?
-          @_interpolation_enabled = !Contrast::Utils::BooleanUtil.false?(CONFIG.root.agent.ruby.interpolate) if @_interpolation_enabled.nil?
+          @_interpolation_enabled = !false?(CONFIG.root.agent.ruby.interpolate) if @_interpolation_enabled.nil?
           @_interpolation_enabled
         end
 

data/lib/contrast/components/assess.rb

@@ -35,6 +35,42 @@ module Contrast
           disabled_rules.include?(name)
         end
 
+        # The value of the stacktrace should be treated as an ENUM. We upcase it for
+        # faster comparisons when we use it. Anything not one of the known values of
+        # 'NONE',  'SOME', or 'ALL' is treated as 'ALL'
+        #
+        # @return [Symbol] the normalized value of CONFIG.root.assess.stacktraces
+        def capture_stacktrace_value
+          @_capture_stacktrace_value ||= case CONFIG.root.assess.stacktraces.upcase
+                                         when 'NONE'
+                                           :NONE
+                                         when 'SOME'
+                                           :SOME
+                                         else
+                                           :ALL
+                                         end
+        end
+
+        # Consider capture_stacktrace_value along with the node type
+        # to dertmine whether stacktraces should be captured.
+        #
+        # capture_stacktrace_value -> (:ALL, :NONE, :SOME)
+        # node types (SourceNode, PolicyNode, TriggerNode, PropagationNode)
+        #
+        # @param policy_node [Contrast::Agent::Assess::Policy::PolicyNode] The node in question.
+        # @param return [Boolean] to capture or not to capture, that is the question.
+        def capture_stacktrace? policy_node
+          return true if capture_stacktrace_value == :ALL
+
+          return false if capture_stacktrace_value == :NONE
+
+          # Below here capture_stacktrace_value must be :SOME.
+          return true if policy_node.cs__is_a?(Contrast::Agent::Assess::Policy::SourceNode)
+          return true if policy_node.cs__is_a?(Contrast::Agent::Assess::Policy::TriggerNode)
+
+          false
+        end
+
         def scan_response?
           @_scan_response = !false?(CONFIG.root.assess.enable_scan_response) if @_scan_response.nil?
           @_scan_response

data/lib/contrast/components/config.rb

@@ -1,9 +1,7 @@
 # Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
 # frozen_string_literal: true
 
-require 'contrast/utils/boolean_util'
 require 'contrast/utils/env_configuration_item'
-require 'contrast/utils/object_share'
 require 'contrast/configuration'
 
 module Contrast
@@ -39,41 +37,9 @@ module Contrast
         end
         alias_method :rebuild, :build
 
-        # Prefer abstraction, but use #raw if you need.
-        # grep 'CONFIG.raw' for opportunities to refactor.
-        def raw
-          @config
-        end
-
+        # @return [Contrast::Config::RootConfiguration]
         def root
-          raw.root
-        end
-
-        def enabled?
-          @_enabled = !Contrast::Utils::BooleanUtil.false?(raw.enable) if @_enabled.nil?
-          @_enabled
-        end
-
-        def disabled?
-          !enabled?
-        end
-
-        def protect?
-          @_protect = Contrast::Utils::BooleanUtil.true?(raw.protect.enable) if @_protect.nil?
-          @_protect
-        end
-
-        def assess?
-          @_assess = Contrast::Utils::BooleanUtil.true?(raw.assess.enable) if @_assess.nil?
-          @_assess
-        end
-
-        def session_id
-          @_session_id ||= raw.application.session_id
-        end
-
-        def session_metadata
-          @_session_metadata ||= raw.application.session_metadata
+          @config.root
         end
 
         def valid?
@@ -84,6 +50,10 @@ module Contrast
           !valid?
         end
 
+        def loggable
+          @config.loggable
+        end
+
         private
 
         SESSION_VARIABLES = "Invalid configuration. Setting both application.session_id and application.session_metadata is not allowed.\n"
@@ -111,9 +81,31 @@ module Contrast
             next unless env_key.to_s.start_with?(CONTRAST_ENV_MARKER)
 
             config_item = Contrast::Utils::EnvConfigurationItem.new(env_key, env_value)
-            raw.assign_value_to_path_array(config_item.dot_path_array, config_item.value)
+            @config.assign_value_to_path_array(config_item.dot_path_array, config_item.value)
           end
         end
+
+        # Typically, this would be accessed through
+        # Contrast::Components::AppContext, but we're too early in the
+        # initialization of the Agent to use that mechanism, so we look it up
+        # directly for ourselves
+        #
+        # @return [String,nil] the value of the session id set in the
+        #   configuration, or nil if unset
+        def session_id
+          @config.application.session_id
+        end
+
+        # Typically, this would be accessed through
+        # Contrast::Components::AppContext, but we're too early in the
+        # initialization of the Agent to use that mechanism, so we look it up
+        # directly for ourselves
+        #
+        # @return [String,nil] the value of the session metadata set in the
+        #   configuration, or nil if unset
+        def session_metadata
+          @config.application.session_metadata
+        end
       end
 
       COMPONENT_INTERFACE = Interface.new