contrast-agent 4.13.0 → 5.0.0

data/lib/contrast/api/decorators/trace_taint_range_tags.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/api/decorators/user_input.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/string_utils'

data/lib/contrast/api/decorators.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
@@ -13,6 +13,7 @@ require 'contrast/api/decorators/message'
 require 'contrast/api/decorators/agent_startup'
 require 'contrast/api/decorators/application_startup'
 require 'contrast/api/decorators/application_update'
+require 'contrast/api/decorators/architecture_component'
 require 'contrast/api/decorators/input_analysis'
 require 'contrast/api/decorators/application_settings'
 require 'contrast/api/decorators/server_features'

data/lib/contrast/api.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/components/agent.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 'rubygems/version'
@@ -33,31 +33,22 @@ module Contrast
         end
 
         def ruleset
-          @_ruleset ||= Contrast::Agent::RuleSet.new(retrieve_protect_ruleset&.values)
+          @_ruleset ||= Contrast::Agent::RuleSet.new(retrieve_protect_ruleset.values)
         end
 
         def reset_ruleset
           @_ruleset = nil
         end
 
-        def patch_interpolation?
-          interpolation_patch_possible?
-        end
-
-        def rewrite_interpolation?
-          !interpolation_patch_possible?
-        end
-
         def patch_yield?
           @_patch_yield = !false?(::Contrast::CONFIG.root.agent.ruby.propagate_yield) if @_patch_yield.nil?
           @_patch_yield
         end
 
         def interpolation_enabled?
-          if @_interpolation_enabled.nil?
-            @_interpolation_enabled = !false?(::Contrast::CONFIG.root.agent.ruby.interpolate)
-          end
-          @_interpolation_enabled
+          return @_interpolation_enabled unless @_interpolation_enabled.nil?
+
+          @_interpolation_enabled = !false?(::Contrast::CONFIG.root.agent.ruby.interpolate)
         end
 
         def omit_body?
@@ -93,16 +84,6 @@ module Contrast
 
         protected
 
-        INTERPOLATION_HOOKABLE_VERSION = Gem::Version.new('2.6.0')
-        # Ruby exposed the C method for interpolation in version 2.6.0, meaning
-        # we can attempt to patch using Funchook for that version and later.
-        def interpolation_patch_possible?
-          if @_interpolation_patch_possible.nil?
-            @_interpolation_patch_possible = Gem::Version.new(RUBY_VERSION) >= INTERPOLATION_HOOKABLE_VERSION
-          end
-          @_interpolation_patch_possible
-        end
-
         def retrieve_protect_ruleset
           return {} unless enabled? && ::Contrast::PROTECT.enabled?
 

data/lib/contrast/components/api.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/base'
@@ -14,7 +14,11 @@ module Contrast
         include Contrast::Components::ComponentBase
 
         def api_url
-          @_api_url ||= ::Contrast::CONFIG.root.api.url
+          @_api_url ||= begin
+            tmp = ::Contrast::CONFIG.root.api.url
+            tmp += '/Contrast' unless tmp.end_with?('/Contrast')
+            tmp
+          end
         end
 
         def api_key
@@ -28,6 +32,67 @@ module Contrast
         def username
           @_username ||= ::Contrast::CONFIG.root.api.user_name
         end
+
+        def proxy_enabled?
+          return @_proxy_enabled unless @_proxy_enabled.nil?
+
+          @_proxy_enabled = true?(::Contrast::CONFIG.root.api.proxy.enable)
+        end
+
+        def proxy_url
+          @_proxy_url ||= ::Contrast::CONFIG.root.api.proxy.url
+        end
+
+        def request_audit_enable?
+          return @_request_audit_enable unless @_request_audit_enable.nil?
+
+          @_request_audit_enable = true?(::Contrast::CONFIG.root.api.request_audit.enable)
+        end
+
+        def request_audit_requests?
+          return @_request_audit_requests unless @_request_audit_requests.nil?
+
+          @_request_audit_requests = true?(::Contrast::CONFIG.root.api.request_audit.requests)
+        end
+
+        def request_audit_responses?
+          return @_request_audit_responses unless @_request_audit_responses.nil?
+
+          @_request_audit_responses = true?(::Contrast::CONFIG.root.api.request_audit.responses)
+        end
+
+        def request_audit_path
+          @_request_audit_path ||= ::Contrast::CONFIG.root.api.request_audit.path.to_s
+        end
+
+        def certification_enabled?
+          return @_certification_enabled unless @_certification_enabled.nil?
+
+          @_certification_enabled = certification_truly_enabled?(::Contrast::CONFIG.root.api.certificate)
+        end
+
+        def certification_ca_file
+          @_certification_ca_file ||= ::Contrast::CONFIG.root.api.certificate.ca_file
+        end
+
+        def certification_cert_file
+          @_certification_cert_file ||= ::Contrast::CONFIG.root.api.certificate.cert_file
+        end
+
+        def certification_key_file
+          @_certification_key_file ||= ::Contrast::CONFIG.root.api.certificate.key_file
+        end
+
+        private
+
+        def certification_truly_enabled? config_path
+          return false unless true?(config_path.enable)
+          return true if file_exists?(certification_ca_file) && valid_cert?(certification_ca_file)
+          return true if file_exists?(certification_cert_file) && valid_cert?(certification_cert_file)
+          return true if file_exists?(certification_key_file) && valid_cert?(certification_key_file)
+
+          false
+        end
       end
     end
   end

data/lib/contrast/components/app_context.rb

@@ -1,10 +1,11 @@
-# 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 'rubygems/version'
 require 'contrast/api/decorators/agent_startup'
 require 'contrast/api/decorators/application_startup'
 require 'contrast/utils/object_share'
+require 'contrast/components/app_context_extend'
 
 module Contrast
   module Components
@@ -15,6 +16,7 @@ module Contrast
       # Specifically, this allows for querying the state of the Application,
       # including the Client, Process, and Server information.
       class Interface
+        include Contrast::Components::AppContextExtend
         include Contrast::Components::ComponentBase
         include Contrast::Components::Logger::InstanceMethods
 
@@ -23,10 +25,6 @@ module Contrast
         DEFAULT_SERVER_NAME = 'localhost'
         DEFAULT_SERVER_PATH = '/'
 
-        SUPPORTED_FRAMEWORKS = %w[rails sinatra grape rack].cs__freeze
-
-        SUPPORTED_SERVERS = %w[passenger puma thin unicorn].cs__freeze
-
         def initialize
           original_pid
         end
@@ -50,9 +48,18 @@ module Contrast
           end
         end
 
+        def session_id
+          @_session_id ||= build_app_startup_message.session_id
+        end
+
+        def app_version
+          @_app_version ||= Contrast::CONFIG.root.application.version
+        end
+
         def path
           @_path ||= begin
             tmp = ::Contrast::CONFIG.root.application.path
+            tmp = Contrast::Agent.framework_manager.application_root unless Contrast::Utils::StringUtils.present?(tmp)
             Contrast::Utils::StringUtils.truncate(tmp, DEFAULT_APP_PATH)
           rescue StandardError
             DEFAULT_APP_PATH
@@ -80,67 +87,6 @@ module Contrast
           end
         end
 
-        def build_app_startup_message
-          Contrast::Api::Dtm::ApplicationCreate.build
-        end
-
-        def build_agent_startup_message
-          msg = Contrast::Api::Dtm::AgentStartup.build(server_name, server_path, server_type)
-          logger.info('Application context',
-                      server_name: msg.server_name,
-                      server_path: msg.server_path,
-                      server_type: msg.server_type,
-                      application_name: app_name,
-                      application_path: path,
-                      application_language: Contrast::Utils::ObjectShare::RUBY)
-
-          msg
-        end
-
-        def pid
-          Process.pid
-        end
-
-        def ppid
-          Process.ppid
-        end
-
-        def pgid
-          Process.getpgid(pid)
-        end
-
-        def client_id
-          @_client_id ||= [app_name, pgid].join('-')
-        end
-
-        def app_and_server_information
-          {
-              application_info: find_gem_information(SUPPORTED_FRAMEWORKS),
-              server_info: find_gem_information(SUPPORTED_SERVERS)
-          }
-        end
-
-        def find_gem_information arr
-          arr.each do |framework|
-            next unless Gem.loaded_specs.key?(framework)
-
-            loaded = Gem.loaded_specs[framework]
-            next unless loaded
-
-            name = loaded.instance_variable_get(:@name)
-            version = loaded.instance_variable_get(:@version).to_s
-            return [name, version].join(' ')
-          end
-        end
-
-        def instrument_middleware_stack?
-          !Contrast::Utils::JobServersRunning.job_servers_running?
-        end
-
-        def disabled_agent_rake_tasks
-          ::Contrast::CONFIG.root.agent.ruby.disabled_agent_rake_tasks
-        end
-
         # Determines if the Process we're currently in matches that of the
         # Process in which the App Context instance was created.
         # If it doesn't, that indicates the running context is in a new

data/lib/contrast/components/app_context_extend.rb

@@ -0,0 +1,78 @@
+# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
+# frozen_string_literal: true
+
+module Contrast
+  module Components
+    # A wrapper build around the Common Agent Configuration project to allow
+    # for access of the values contained in its
+    # parent_configuration_spec.yaml.
+    # Specifically, this allows for querying the state of the Application,
+    # including the Client, Process, and Server information.
+    module AppContextExtend
+      SUPPORTED_FRAMEWORKS = %w[rails sinatra grape rack].cs__freeze
+      SUPPORTED_SERVERS = %w[passenger puma thin unicorn].cs__freeze
+
+      def build_app_startup_message
+        @_build_app_startup_message ||= Contrast::Api::Dtm::ApplicationCreate.build
+      end
+
+      def build_agent_startup_message
+        msg = Contrast::Api::Dtm::AgentStartup.build(server_name, server_path, server_type)
+        logger.info('Application context',
+                    server_name: msg.server_name,
+                    server_path: msg.server_path,
+                    server_type: msg.server_type,
+                    application_name: app_name,
+                    application_path: path,
+                    application_language: Contrast::Utils::ObjectShare::RUBY)
+
+        msg
+      end
+
+      def pid
+        Process.pid
+      end
+
+      def ppid
+        Process.ppid
+      end
+
+      def pgid
+        Process.getpgid(pid)
+      end
+
+      def client_id
+        @_client_id ||= [app_name, pgid].join('-')
+      end
+
+      def app_and_server_information
+        {
+            application_info: find_gem_information(SUPPORTED_FRAMEWORKS),
+            server_info: find_gem_information(SUPPORTED_SERVERS)
+        }
+      end
+
+      def find_gem_information arr
+        arr.each do |framework|
+          next unless Gem.loaded_specs.key?(framework)
+
+          loaded = Gem.loaded_specs[framework]
+          next unless loaded
+
+          name = loaded.instance_variable_get(:@name)
+          version = loaded.instance_variable_get(:@version).to_s
+          return [name, version].join(' ')
+        end
+        nil
+      end
+
+      def instrument_middleware_stack?
+        !Contrast::Utils::JobServersRunning.job_servers_running?
+      end
+
+      def disabled_agent_rake_tasks
+        ::Contrast::CONFIG.root.agent.ruby.disabled_agent_rake_tasks
+      end
+    end
+  end
+end

data/lib/contrast/components/assess.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/base'
@@ -77,9 +77,8 @@ module Contrast
         end
 
         def track_frozen_sources?
-          if @_track_frozen_sources.nil?
-            @_track_frozen_sources = !false?(::Contrast::CONFIG.root.agent.ruby.track_frozen_sources)
-          end
+          @_track_frozen_sources = !false?(::Contrast::CONFIG.root.agent.ruby.track_frozen_sources) if
+            @_track_frozen_sources.nil?
           @_track_frozen_sources
         end
 
@@ -89,10 +88,15 @@ module Contrast
         end
 
         def require_dynamic_sources?
-          if @_require_dynamic_sources.nil?
-            @_require_dynamic_sources = !false?(::Contrast::CONFIG.root.assess.enable_dynamic_sources)
-          end
-          @_require_dynamic_sources
+          return @_require_dynamic_sources unless @_require_dynamic_sources.nil?
+
+          @_require_dynamic_sources = !false?(::Contrast::CONFIG.root.assess.enable_dynamic_sources)
+        end
+
+        def non_request_tracking?
+          @_non_request_tracking = true?(::Contrast::CONFIG.root.agent.ruby.non_request_tracking) if
+            @_non_request_tracking.nil?
+          @_non_request_tracking
         end
 
         def tags

data/lib/contrast/components/base.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
@@ -35,6 +35,29 @@ module Contrast
 
         config_param.downcase == Contrast::Utils::ObjectShare::TRUE
       end
+
+      # this method will check if a path could be possibly used
+      # So for example if we pass a path to a file - we'll check
+      # if there is actually that file and if it's with certain extension
+      #
+      # @param config_path [String,nil]
+      # @return [Boolean]
+      def valid_cert? config_path
+        return false if config_path.nil?
+
+        exts = %w[.pem .crt .cer].cs__freeze
+        return false unless exts.include?(File.extname(config_path))
+
+        true
+      end
+
+      # check if file exists at all
+      # @param path [String,nil]
+      def file_exists? path
+        return false unless path
+
+        File.exist? path
+      end
     end
   end
 end

data/lib/contrast/components/config.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/env_configuration_item'
@@ -80,27 +80,42 @@ module Contrast
         API_KEY = "Invalid configuration. Missing a required connection value 'api_key' is not set."
         API_SERVICE_KEY = "Invalid configuration. Missing a required connection value 'service_tag' is not set."
         API_USERNAME = "Invalid configuration. Missing a required connection value 'user_name' is not set."
+        # The config has information about how to construct the logger. If the config is invalid, and you want to know
+        # about it, then you have a circular dependency if you try to log it, so we use basic proto_logger to do this
+        # job.
         def validate
-          # The config has information about how to construct the logger.
-          # If the config is invalid, and you want to know about it, then
-          # you have a circular dependency if you try to log it,
-          # so we use basic proto_logger to do this job.
-          if !session_id.empty? && !session_metadata.empty?
+          return false unless valid_session_metadata?
+
+          valid_api?
+        end
+
+        # The use can set either the application's session id or session metadata or neither, but never both.
+        #
+        # @return [boolean]
+        def valid_session_metadata?
+          if !session_id&.empty? && !session_metadata&.empty?
             proto_logger.error(SESSION_VARIABLES)
             return false
           end
-          if bypass
-            msg = []
-            msg << API_URL unless api_url
-            msg << API_KEY unless api_key
-            msg << API_SERVICE_KEY unless api_service_key
-            msg << API_USERNAME unless api_username
-            msg.any? { |m| proto_logger.error(m) }
-            return false unless msg.empty?
-          end
           true
         end
 
+        # If the agent is to use the bypass to communicate with TeamServer directly, than it must have the
+        # configuration values required for that connection.
+        #
+        # @return [boolean]
+        def valid_api?
+          return true unless bypass
+
+          msg = []
+          msg << API_URL unless api_url
+          msg << API_KEY unless api_key
+          msg << API_SERVICE_KEY unless api_service_key
+          msg << API_USERNAME unless api_username
+          msg.any? { |m| proto_logger.error(m) }
+          msg.empty?
+        end
+
         def env_overrides
           # For env variables resembling CONTRAST__WHATEVER__NESTED_VALUE
           # override raw.whatever.nested_value
@@ -120,7 +135,7 @@ module Contrast
         # @return [String,nil] the value of the session id set in the
         #   configuration, or nil if unset
         def session_id
-          @config.application.session_id
+          root.application.session_id
         end
 
         # Typically, this would be accessed through
@@ -131,7 +146,7 @@ module Contrast
         # @return [String,nil] the value of the session metadata set in the
         #   configuration, or nil if unset
         def session_metadata
-          @config.application.session_metadata
+          root.application.session_metadata
         end
 
         # Typically, the following values would be accessed through Contrast::Components::AppContext
@@ -140,7 +155,7 @@ module Contrast
         #
         # @return [String, nil]
         def api_url
-          @config.api.url
+          root.api.url
         end
 
         # Typically, the following values would be accessed through Contrast::Components::AppContext
@@ -149,7 +164,7 @@ module Contrast
         #
         # @return [String, nil]
         def api_key
-          @config.api.api_key
+          root.api.api_key
         end
 
         # Typically, the following values would be accessed through Contrast::Components::AppContext
@@ -158,7 +173,7 @@ module Contrast
         #
         # @return [String, nil]
         def api_service_key
-          @config.api.service_key
+          root.api.service_key
         end
 
         # Typically, the following values would be accessed through Contrast::Components::AppContext
@@ -167,7 +182,7 @@ module Contrast
         #
         # @return [String, nil]
         def api_username
-          @config.api.user_name
+          root.api.user_name
         end
 
         # Typically, the following values would be accessed through Contrast::Components::AppContext
@@ -176,7 +191,7 @@ module Contrast
         #
         # @return [String, nil]
         def bypass
-          @config.root.agent.service.bypass
+          root.agent.service.bypass
         end
 
         # Typically, the following values would be accessed through Contrast::Components::AppContext
@@ -185,7 +200,7 @@ module Contrast
         #
         # @return [String, nil]
         def logger_path
-          @config.root.agent.logger.path
+          root.agent.logger.path
         end
       end
     end

data/lib/contrast/components/contrast_service.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 'monitor'
@@ -15,6 +15,7 @@ module Contrast
         include Contrast::Components::ComponentBase
 
         DEFAULT_SERVICE_LOG = 'contrast_service.log'
+        DEFAULT_SERVICE_LEVEL = :TRACE
         # The Rails ActionDispatch regexp for localhost IP + literal localhost
         # https://github.com/rails/rails/blob/master/actionpack/lib/action_dispatch/http/request.rb#L32
         LOCALHOST = Regexp.union [/^127\.\d{1,3}\.\d{1,3}\.\d{1,3}$/, /^::1$/, /^0:0:0:0:0:0:0:1(%.*)?$/, /^localhost$/]
@@ -59,6 +60,10 @@ module Contrast
           @_logger_path ||= ::Contrast::CONFIG.root.agent.service.logger.path || DEFAULT_SERVICE_LOG
         end
 
+        def logger_level
+          @_logger_level ||= ::Contrast::CONFIG.root.agent.service.logger.level || DEFAULT_SERVICE_LEVEL
+        end
+
         private
 
         def disabled?

data/lib/contrast/components/heap_dump.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/base'

data/lib/contrast/components/inventory.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
@@ -21,6 +21,10 @@ module Contrast
           @_analyze_libraries = !false?(::Contrast::CONFIG.root.inventory.analyze_libraries) if @_analyze_libraries.nil?
           @_analyze_libraries
         end
+
+        def tags
+          ::Contrast::CONFIG.root.inventory&.tags
+        end
       end
     end
   end

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

data/lib/contrast/components/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
 
 require 'contrast/components/base'
@@ -54,12 +54,16 @@ module Contrast
         end
 
         def forcibly_disabled?
-          @_forcibly_disabled ||= false?(::Contrast::CONFIG.root.protect.enable)
+          return @_forcibly_disabled unless @_forcibly_disabled.nil?
+
+          @_forcibly_disabled = false?(::Contrast::CONFIG.root.protect.enable)
         end
 
         private
 
         def forcibly_enabled?
+          return @_forcibly_enabled unless @_forcibly_enabled.nil?
+
           @_forcibly_enabled ||= true?(::Contrast::CONFIG.root.protect.enable)
         end
       end