contrast-agent 3.9.1 → 6.15.3

data/lib/contrast/api/unix_socket.rb

@@ -1,25 +0,0 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
-# frozen_string_literal: true
-
-cs__scoped_require 'contrast/api/socket'
-
-module Contrast
-  module Api
-    # Implements a UNIX domain socket to connect to the Contrast Service.
-    class UnixSocket
-      include Contrast::Api::Socket
-
-      attr_reader :path
-
-      # Create the socket
-      # @param path [String] file path to a UNIX domain socket
-      def initialize path
-        @path = path
-      end
-
-      def new_socket
-        ::UNIXSocket.new(path)
-      end
-    end
-  end
-end

data/lib/contrast/api.rb

@@ -1,18 +0,0 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
-# frozen_string_literal: true
-
-module Contrast
-  # Builds out the Contrast::Api namespace and requires the classes in the api
-  # directory, making available those classes required to communicate with the
-  # Contrast Service, including those generated from Protobuf
-  module Api
-    ENCODING_STRING = 'I>'
-  end
-end
-
-cs__scoped_require 'contrast/api/dtm_pb'
-cs__scoped_require 'contrast/api/settings_pb'
-cs__scoped_require 'contrast/delegators'
-cs__scoped_require 'contrast/api/unix_socket'
-cs__scoped_require 'contrast/api/tcp_socket'
-cs__scoped_require 'contrast/api/speedracer'

data/lib/contrast/common_agent_configuration.rb

@@ -1,86 +0,0 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
-# frozen_string_literal: true
-
-# rubocop:disable Style/MethodMissingSuper, Style/MissingRespondToMissing
-module Contrast
-  # A wrapper build around the Common Agent Configuration project to allow for
-  # access of the values contained in its parent_configuration_spec.yaml
-  class CommonAgentConfiguration
-    # The CAC spec, deserialized to a hash.
-
-    SPEC       = 'spec'
-    NODES      = 'nodes'
-    PROPERTIES = 'properties'
-
-    def initialize hsh
-      @hsh = hsh[SPEC]
-    end
-
-    # Used to indicate those sections of the configuration which have
-    # references to other nodes or properties, allowing for the parsing of and
-    # access to the nested configuration structure.
-    module IsANode
-      def children
-        hsh[NODES]&.map { |raw_node| Node.new(raw_node) } || []
-      end
-
-      def properties
-        hsh[PROPERTIES].map { |raw_property| Property.new(raw_property) }
-      end
-
-      def lookup *path
-        # Path will be N args, representing a path of nodes.
-        path.reduce(self) do |node, next_arg|
-          # If we can travel to a node by that name, do that.
-          candidate_node = node.children.find { |n| n.name == next_arg }
-          next candidate_node if candidate_node
-
-          # If there's a property, dereference that.
-          candidate_property = node.properties.find { |n| n.name == next_arg }
-          next candidate_property if candidate_property
-
-          raise IndexError, "couldn't traverse path:\t#{ path.join(Contrast::Utils::ObjectShare::PERIOD) }"
-        end
-      end
-
-      def method_missing method, *args, &block
-        if args.any?
-          lookup(method.to_s).public_send(args, block)
-        else
-          lookup(method.to_s)
-        end
-      rescue IndexError
-        super(method, args, block)
-      end
-    end
-
-    # Used to indicate those sections of the configuration which are for a
-    # single property, allowing for the parsing of and access to the
-    # information describing the property.
-    module IsAProperty
-      attr_reader :hsh
-
-      def initialize hsh
-        @hsh = hsh
-      end
-
-      %w[name default description required_languages display].each do |field|
-        define_method(field) { hsh[field].dup }
-      end
-    end
-
-    include IsANode
-    include IsAProperty
-
-    # A Property in the Common Agent Configuration
-    class Property
-      include IsAProperty
-    end
-
-    # A Node in the Common Agent Configuration
-    class Node < Property
-      include IsANode
-    end
-  end
-end
-# rubocop:enable Style/MethodMissingSuper, Style/MissingRespondToMissing

data/lib/contrast/components/contrast_service.rb

@@ -1,117 +0,0 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
-# frozen_string_literal: true
-
-cs__scoped_require 'monitor'
-
-module Contrast
-  module Components
-    module ContrastService
-      # 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 connection to
-      # the Service, as well as sending a message to the Service.
-      class Interface
-        include Contrast::Components::ComponentBase
-        include Contrast::Components::Interface
-
-        access_component :config, :agent
-
-        def update_received?
-          state.update_received?
-        end
-
-        def enabled?
-          state.service_enabled?
-        end
-
-        def unavailable?
-          !enabled?
-        end
-
-        def disabled?
-          state.service_forcibly_disabled?
-        end
-
-        def host
-          @_host ||= (CONFIG.root.agent.service.host || Contrast::Configuration::DEFAULT_HOST).to_s
-        end
-
-        def port
-          @_port ||= (CONFIG.root.agent.service.port || Contrast::Configuration::DEFAULT_PORT).to_i
-        end
-
-        def socket_path
-          @_socket_path ||= CONFIG.root.agent.service.socket
-        end
-
-        def logger_path
-          @_logger_path ||= CONFIG.root.agent.service.logger.path || DEFAULT_LOG_FILENAME
-        end
-
-        def use_tcp?
-          socket_path.nil?
-        end
-
-        def last_update
-          state.last_update
-        end
-
-        def use_bundled_service?
-          # Validates the config to decide if it's suitable for starting
-          # the bundled service
-          @_use_bundled_service ||= begin
-                                      # Requirement says "must be true" but that
-                                      # should be "must not be false" -- oops.
-                                      !false?(CONFIG.root.agent.start_bundled_service) &&
-                                          # Either a valid host or a valid socket
-                                          ((CONFIG.root.agent.service.host.nil? ||
-                                          CONFIG.root.agent.service.host == 'localhost' ||
-                                          CONFIG.root.agent.service.host == '127.0.0.1') ||
-                                          # Path validity is the service's problem
-                                          !!CONFIG.root.agent.service.socket)
-                                    end
-        end
-
-        # TODO: As part of RUBY-356. Add new handling for SQL analysis via RPC (SPEED-211)
-
-        # The API for Agent to Service communication. These methods abstract away implementation
-        # details, responsibilities of sending messages to the service, and requirements mandated
-        # within the Agent<>SpeedRacer contract.
-
-        # Pushes a message onto a queue to later be consumed when the service sender thread is ready to
-        # handle it. The service response is not returned; rather, it is processed by the service sender
-        # thread. All messages sent to SpeedRacer should be queued rather than sent unless the calling method
-        # explicitly needs to act on the response object with custom logic (i.e. RequestContext#service_extract_response)
-        #
-        # @param event [Contrast::Api::Dtm] One of the DTMs valid for the event
-        #  field of Contrast::Api::Dtm::Message
-        # TODO: rename method to queue_event
-        def queue_message event
-          return unless event
-
-          Contrast::Utils::ServiceSenderUtil.push_to_ready_queue(event)
-        end
-
-        # TODO: RUBY-662. Add additional check before we queue/send a message to see if we were unable
-        # to connect to the service.
-
-        # Bypass the queue and send the message directly to SpeedRacer. This is the only way
-        # to receive the response object back from SpeedRacer. An invoking method that needs
-        # to process the response object with custom logic should use this method.
-        #
-        # @param event [Contrast::Api::Dtm] One of the DTMs valid for the event
-        #   field of Contrast::Api::Dtm::Message
-        # @return [Array<Contrast::Api::Dtm::AttackResult>] the response from SpeedRacer
-        # TODO: rename method to send_event
-        def send_message event
-          return unless event
-
-          state.client.send_to_speedracer(event)
-        end
-      end
-
-      COMPONENT_INTERFACE = Interface.new
-    end
-  end
-end

data/lib/contrast/components/interface.rb

@@ -1,178 +0,0 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
-# frozen_string_literal: true
-
-cs__scoped_require 'delegate'
-cs__scoped_require 'contrast/extensions/ruby_core/module'
-cs__scoped_require 'contrast/utils/boolean_util'
-
-module Contrast
-  # This is the base module for our components classes. It is intended to
-  # facilitate the translation of the Common Configuration settings to usable
-  # Ruby methods. Any class under this namespace should be required here,
-  # providing a single point of require for this functionality.
-  module Components
-    # Include this into your classes and modules,
-    # and use 'access_component' to define constants that will allow
-    # interaction with other components.
-    module Interface
-      def self.included klass
-        # Upon inclusion, ComponentInterfaces extends the including with
-        # these two interfaces.
-        # Interface provides a class-level method 'access_component'
-        # that regulates per-class access to agent state.
-        # (It's a glorified `include MyComponent`).
-        klass.extend Contrast::Components::ComponentReceiverClassInterface
-      end
-    end
-
-    # All component access is gated through delegators.
-    #
-    # One delegator is used by the calling class,
-    # so we can tweak outgoing calls.
-    #
-    # The second delegator is used by the receiving component,
-    # so we can tweak incoming calls.
-    #
-    # We use __setobj__ to decide which component implementation to use.
-    # This is intended to provide flexibility in design and
-    # simplicity in testing.
-    class ComponentDelegator < SimpleDelegator
-      # intentionally left blank
-    end
-
-    # All components should inherit from this,
-    # whether Interfaces, InstanceMethods or ClassMethods.
-    module ComponentBase
-      def self.included klass
-        klass.extend  Methods
-        klass.include Methods
-      end
-
-      module Methods # :nodoc:
-        def false? config_param
-          Contrast::Utils::BooleanUtil.false?(config_param)
-        end
-
-        def true? config_param
-          Contrast::Utils::BooleanUtil.true?(config_param)
-        end
-
-        # TODO: RUBY-536
-        private
-
-        def _state_shim
-          Contrast::Agent::FeatureState.instance
-        end
-        alias_method :state, :_state_shim
-      end
-    end
-
-    def self.component_const_name mod_name
-      mod_name = mod_name.split('::').last
-      @cache ||= {}
-      @cache[mod_name] ||= mod_name. # CamelCaseName
-          split(/(?=[A-Z])/)&.          # ['Camel', 'Case', 'Name']
-          map(&:upcase)&.               # ['CAMEL', 'CASE', 'NAME']
-          join('_')                     # 'CAMEL_CASE_NAME'
-    end
-
-    # Interface to allow for iteration over each of the configuration
-    # components
-    module ComponentReceiverClassInterface
-      # Components are manually required at the end of
-      # this file, and this constant is then frozen.
-      # RUBY-535 to handle this better.
-      COMPONENT_MAP = {} # rubocop:disable Style/MutableConstant
-
-      # TODO: RUBY-535
-      # This module is used via `extend`, so it can't access
-      # constants we define here.
-      def component_map
-        COMPONENT_MAP
-      end
-
-      # .access_component
-      #
-      # to be used as:
-      #
-      # class Abc
-      #   include Contrast::Components::Interface
-      #   access_component :logger, :agent
-      #
-      #   def function
-      #     if AGENT.disabled?
-      #       0 / 3
-      #     end
-      #   rescue
-      #     logger.error "this function did error"
-      #   end
-      # end
-      #
-      # `:logger` creates a #logger and .logger method
-      # `:agent` provides an AGENT constant, analogous to a local singleton.
-      #
-      def access_component *component_set_syms
-        @_access_component ||= {}
-
-        component_set_syms.each do |sym|
-          next if @_access_component[sym]
-
-          if (mods = component_map[sym]) # rubocop:disable Style/GuardClause
-            # We may support multiple components via one access request.
-            mods.each do |m|
-              name = Contrast::Components.component_const_name(m.name)
-              cs__const_set(name, m::COMPONENT_INTERFACE) if m.cs__const_defined?(:COMPONENT_INTERFACE)
-              include m::InstanceMethods               if m.cs__const_defined?(:InstanceMethods, false)
-              extend  m::ClassMethods                  if m.cs__const_defined?(:ClassMethods, false)
-            end
-
-            @_access_component[sym] = true
-          else
-            raise NotImplementedError, "#{ self } asked to access undefined component '#{ sym }'."
-          end
-        end
-      end
-    end
-  end
-end
-
-# Components can depend on other components, but it should be a
-# directed acyclic graph.
-
-# Scope shouldn't depend on anything.
-cs__scoped_require 'contrast/components/scope'
-Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:scope] = [Contrast::Components::Scope]
-
-# Config depends on Scope.
-cs__scoped_require 'contrast/components/config'
-Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:config] = [Contrast::Components::Config]
-
-# Settings should not depend on anything but Config.
-cs__scoped_require 'contrast/components/settings'
-Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:settings] = [Contrast::Components::Settings]
-
-cs__scoped_require 'contrast/components/agent'
-Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:agent] = [Contrast::Components::Agent]
-
-cs__scoped_require 'contrast/components/app_context'
-Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:app_context] = [Contrast::Components::AppContext]
-
-cs__scoped_require 'contrast/components/contrast_service'
-Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:contrast_service] = [Contrast::Components::ContrastService]
-
-cs__scoped_require 'contrast/components/heap_dump'
-Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:heap_dump] = [Contrast::Components::HeapDump]
-
-cs__scoped_require 'contrast/components/logger'
-Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:logging] = [Contrast::Components::Logger]
-
-cs__scoped_require 'contrast/components/assess'
-cs__scoped_require 'contrast/components/protect'
-cs__scoped_require 'contrast/components/inventory'
-Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:analysis] = [Contrast::Components::Protect,
-                                                                                   Contrast::Components::Assess,
-                                                                                   Contrast::Components::Inventory]
-cs__scoped_require 'contrast/components/sampling'
-Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP[:sampling] = [Contrast::Components::Sampling]
-
-Contrast::Components::ComponentReceiverClassInterface::COMPONENT_MAP.cs__freeze

data/lib/contrast/config/agent_configuration.rb

@@ -1,24 +0,0 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
-# frozen_string_literal: true
-
-module Contrast
-  module Config
-    # Common Configuration settings. Those in this section pertain to the
-    # core functionality of the Agent.
-    class AgentConfiguration < BaseConfiguration
-      KEYS = {
-          enable: EMPTY_VALUE,
-          start_bundled_service: Contrast::Config::DefaultValue.new(true),
-          omit_body: EMPTY_VALUE,
-          service: Contrast::Config::ServiceConfiguration,
-          logger: Contrast::Config::LoggerConfiguration,
-          ruby: Contrast::Config::RubyConfiguration,
-          heap_dump: Contrast::Config::HeapDumpConfiguration
-      }.cs__freeze
-
-      def initialize hsh
-        super(hsh, KEYS)
-      end
-    end
-  end
-end

data/lib/contrast/config/application_configuration.rb

@@ -1,27 +0,0 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
-# frozen_string_literal: true
-
-module Contrast
-  module Config
-    # Common Configuration settings. Those in this section pertain to the
-    # application identification functionality of the Agent.
-    class ApplicationConfiguration < BaseConfiguration
-      KEYS = {
-          name: EMPTY_VALUE,
-          version: EMPTY_VALUE,
-          language: EMPTY_VALUE,
-          path: EMPTY_VALUE,
-          group: EMPTY_VALUE,
-          tags: EMPTY_VALUE,
-          code: EMPTY_VALUE,
-          metadata: EMPTY_VALUE,
-          session_id: EMPTY_VALUE,
-          session_metadata: EMPTY_VALUE
-      }.cs__freeze
-
-      def initialize hsh
-        super(hsh, KEYS)
-      end
-    end
-  end
-end

data/lib/contrast/config/assess_configuration.rb

@@ -1,22 +0,0 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
-# frozen_string_literal: true
-
-module Contrast
-  module Config
-    # Common Configuration settings. Those in this section pertain to the
-    # assess functionality of the Agent.
-    class AssessConfiguration < BaseConfiguration
-      KEYS = {
-          tags: EMPTY_VALUE,
-          enable: EMPTY_VALUE,
-          enable_scan_response: Contrast::Config::DefaultValue.new('true'),
-          sampling: Contrast::Config::SamplingConfiguration,
-          rules: Contrast::Config::AssessRulesConfiguration
-      }.cs__freeze
-
-      def initialize hsh
-        super(hsh, KEYS)
-      end
-    end
-  end
-end

data/lib/contrast/config/assess_rules_configuration.rb

@@ -1,18 +0,0 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
-# frozen_string_literal: true
-
-module Contrast
-  module Config
-    # Common Configuration settings. Those in this section pertain to the
-    # disabled assess rule functionality of the Agent.
-    class AssessRulesConfiguration < BaseConfiguration
-      KEYS = {
-          disabled_rules: EMPTY_VALUE
-      }.cs__freeze
-
-      def initialize hsh
-        super(hsh, KEYS)
-      end
-    end
-  end
-end

data/lib/contrast/config/default_value.rb

@@ -1,16 +0,0 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
-# frozen_string_literal: true
-
-module Contrast
-  module Config
-    # This is the wrapper for the default values in the configurations, used to
-    # differentiate between nil or false defaults and things being set
-    # explicitly to false.
-    class DefaultValue
-      attr_reader :value
-      def initialize value
-        @value = value
-      end
-    end
-  end
-end

data/lib/contrast/config/heap_dump_configuration.rb

@@ -1,23 +0,0 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
-# frozen_string_literal: true
-
-module Contrast
-  module Config
-    # Common Configuration settings. Those in this section pertain to the
-    # Heap Dump collection functionality of the Agent.
-    class HeapDumpConfiguration < BaseConfiguration
-      KEYS = {
-          enable: Contrast::Config::DefaultValue.new(Contrast::Utils::ObjectShare::FALSE), # should dumps be taken
-          path: Contrast::Config::DefaultValue.new('contrast_heap_dumps'),                 # dir to which dumps should be saved
-          delay_ms: Contrast::Config::DefaultValue.new(10_000),                            # time, in ms, after initialization to delay before taking dump
-          window_ms: Contrast::Config::DefaultValue.new(10_000),                           # ms between each dump
-          count: Contrast::Config::DefaultValue.new(5),                                    # number of dumps to take
-          clean: Contrast::Config::DefaultValue.new(Contrast::Utils::ObjectShare::FALSE)   # remove temporary objects
-      }.cs__freeze
-
-      def initialize hsh
-        super(hsh, KEYS)
-      end
-    end
-  end
-end

data/lib/contrast/config/inventory_configuration.rb

@@ -1,20 +0,0 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
-# frozen_string_literal: true
-
-module Contrast
-  module Config
-    # Common Configuration settings. Those in this section pertain to the
-    # inventory functionality of the Agent.
-    class InventoryConfiguration < BaseConfiguration
-      KEYS = {
-          enable: EMPTY_VALUE,
-          record_used_classes: EMPTY_VALUE,
-          tags: EMPTY_VALUE
-      }.cs__freeze
-
-      def initialize hsh
-        super(hsh, KEYS)
-      end
-    end
-  end
-end

data/lib/contrast/config/logger_configuration.rb

@@ -1,20 +0,0 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
-# frozen_string_literal: true
-
-module Contrast
-  module Config
-    # Common Configuration settings. Those in this section pertain to the
-    # logging in the Agent.
-    class LoggerConfiguration < BaseConfiguration
-      KEYS = {
-          path: EMPTY_VALUE,
-          level: EMPTY_VALUE,
-          progname: EMPTY_VALUE
-      }.cs__freeze
-
-      def initialize hsh
-        super(hsh, KEYS)
-      end
-    end
-  end
-end

data/lib/contrast/config/protect_configuration.rb

@@ -1,20 +0,0 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
-# frozen_string_literal: true
-
-module Contrast
-  module Config
-    # Common Configuration settings. Those in this section pertain to the
-    # protect functionality of the Agent.
-    class ProtectConfiguration < BaseConfiguration
-      KEYS = {
-          exceptions: Contrast::Config::ExceptionConfiguration,
-          rules: Contrast::Config::ProtectRulesConfiguration,
-          enable: EMPTY_VALUE
-      }.cs__freeze
-
-      def initialize hsh
-        super(hsh, KEYS)
-      end
-    end
-  end
-end

data/lib/contrast/config/root_configuration.rb

@@ -1,26 +0,0 @@
-# Copyright (c) 2020 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
-# frozen_string_literal: true
-
-module Contrast
-  module Config
-    # The base of the Common Configuration settings.
-    class RootConfiguration < BaseConfiguration
-      KEYS = {
-          enable: BaseConfiguration::EMPTY_VALUE,
-          agent: Contrast::Config::AgentConfiguration,
-          application: Contrast::Config::ApplicationConfiguration,
-          server: Contrast::Config::ServerConfiguration,
-          assess: Contrast::Config::AssessConfiguration,
-          inventory: Contrast::Config::InventoryConfiguration,
-          protect: Contrast::Config::ProtectConfiguration,
-          service: Contrast::Config::ServiceConfiguration
-      }.cs__freeze
-
-      def initialize hsh = {}
-        raise ArgumentError, 'Expected a hash' unless hsh.is_a?(Hash)
-
-        super(hsh, KEYS)
-      end
-    end
-  end
-end