contrast-agent 6.6.4 → 6.8.0

data/lib/contrast/api/communication/speedracer.rb

@@ -1,142 +0,0 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
-# frozen_string_literal: true
-
-require 'contrast/components/logger'
-
-module Contrast
-  module Api
-    module Communication
-      # Wraps all connection data to SpeedRacer. SpeedRacer, also known as the Contrast Service, is a standalone
-      # executable that sits between the Agent and TeamServer. It handles converting our Protobuf messages into a
-      # format consumable by TeamServer. The Agent requires a SpeedRacer process to be running somewhere to which it
-      # can connect, as specified by the user configuration, in order to function.
-      class Speedracer
-        include Contrast::Api::Communication::ServiceLifecycle
-        include Contrast::Components::Logger::InstanceMethods
-
-        attr_reader :status, :response_processor, :socket_client, :ensure_running
-
-        def initialize
-          @status = Contrast::Api::Communication::ConnectionStatus.new
-          @socket_client = Contrast::Api::Communication::SocketClient.new
-          @response_processor = Contrast::Api::Communication::ResponseProcessor.new
-          @ensure_running = Mutex.new
-        end
-
-        # If there is not a SpeedRacer at the location specified by the configuration of this Agent and the Agent is
-        # set such that it should manage one, start up a new child process to run the SpeedRacer executable. If a
-        # connection has not already been made to that process, after starting it, this method will also send the
-        # messages necessary to create a context for this Agent process in the SpeedRacer as well as trigger
-        # SpeedRacer's sending of startup messages which will return features and settings from TeamServer.
-        #
-        # This operation is synchronous and blocking, so it will only happen one at a time per process and will halt
-        # Thread execution here until completion.
-        def ensure_startup!
-          return if status.connected?
-
-          ensure_running.synchronize do
-            if ::Contrast::CONTRAST_SERVICE.use_bundled_service?
-              logger.info('Attempting to start local service')
-              unless attempt_local_service_startup
-                logger.error('Failed to start local service')
-                return
-              end
-            end
-            unless status.startup_messages_sent? || Contrast::CONTRAST_SERVICE.unnecessary?
-              startup_responses = send_initialization_messages
-              return false unless startup_responses
-
-              startup_responses.each { |response| response_processor.process(response) }
-            end
-          end
-        end
-
-        # Send the given Event to SpeedRacer, returning the response from it. This response will either be new settings
-        # if anything's changed in TeamServer meaning the Agent needs to replace its current settings or there is
-        # Protect analysis information or nil if the current Agent settings do not need updating.
-        #
-        # @param event [Contrast::Api::Dtm] One of the DTMs valid for the event field of
-        # Contrast::Api::Dtm::Message|Contrast::Api::Dtm::Activity
-        # @return [Contrast::Api::Settings::AgentSettings,nil]
-        def return_response event
-          send_to_speedracer(event) do |response|
-            return response
-          end
-        end
-
-        # Send the given Event to SpeedRacer and pass the result to our Contrast::Api::Communication::ResponseProcessor
-        # as there is no immediate action required from sending this Event.
-        #
-        # @param event [Contrast::Api::Dtm] One of the DTMs valid for the event field of
-        # Contrast::Api::Dtm::Message|Contrast::Api::Dtm::Activity
-        def process_internally event
-          send_to_speedracer(event) do |response|
-            response_processor.process(response)
-          end
-        end
-
-        private
-
-        # Ensure there is a running SpeedRacer and then send the given Event to it. It is necessary to ensure the
-        # SpeedRacer is running as, if the process has crashed or restarted, we must rebuild our context there.
-        #
-        # @param event [Contrast::Api::Dtm] One of the DTMs valid for the event field of
-        # Contrast::Api::Dtm::Message|Contrast::Api::Dtm::Activity
-        # @return [Contrast::Api::Settings::AgentSettings, nil]
-        def send_to_speedracer event
-          ensure_startup!
-
-          logger.debug_with_time(event.cs__class.cs__name) do
-            response = socket_client.send_one(event)
-            status.success!
-            yield(response)
-          end
-        rescue StandardError => e
-          status.failure!
-          logger.error('Unable to send message.', e, event_id: event.__id__, event_type: event.cs__class.cs__name)
-          nil
-        end
-
-        # Send those messages which are required to build a context for this Agent process on SpeedRacer as well as
-        # report server and application startup to TeamServer. With these messages, the SpeedRacer will be able to
-        # retrieve settings from TeamServer and provide those for the Agent to complete its initialization.
-        def send_initialization_messages
-          agent_startup_msg = ::Contrast::APP_CONTEXT.build_agent_startup_message
-
-          logger.debug('Preparing to send startup messages')
-          # 1 initial attempt, + 3 potential retries.
-          # The agent-service-api REQUIREMENTS.md spec mandates this #.
-          4.times do
-            log_send_event(agent_startup_msg)
-            next unless (agent_response = socket_client.send_one(agent_startup_msg))
-
-            # Connection was successful; send app create with the resolved features.
-            app_startup_msg = ::Contrast::APP_CONTEXT.build_app_startup_message
-            log_send_event(app_startup_msg)
-            app_response = socket_client.send_one(app_startup_msg)
-
-            status.success!
-            logger.debug('Successfully sent startup messages to service.')
-            return [agent_response, app_response]
-          end
-
-          status.failure!
-          logger.error('Could not send agent startup message context')
-          nil
-        rescue StandardError => e
-          logger.error('Could not build service context', e)
-          status.failure!
-          nil
-        end
-
-        # Log the startup message we're sending to SpeedRacer
-        #
-        # @param event [Contrast::Api::Dtm] One of the DTMs valid for the event field of
-        # Contrast::Api::Dtm::Message|Contrast::Api::Dtm::Activity
-        def log_send_event event
-          logger.debug('Immediately sending event.', event_id: event.__id__, event_type: event.cs__class.cs__name)
-        end
-      end
-    end
-  end
-end

data/lib/contrast/api/communication/tcp_socket.rb

@@ -1,32 +0,0 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
-# frozen_string_literal: true
-
-require 'contrast/api/communication/socket'
-
-module Contrast
-  module Api
-    module Communication
-      # This class allows us to create a TCP Socket to communicate to the Service (Speed Racer). Either it or the Unix
-      # Socket will be used, as determined by the configuration options set for Service communication.
-      class TcpSocket
-        include Contrast::Api::Communication::Socket
-
-        attr_reader :host, :port
-
-        # Create the socket
-        #
-        # @param host [String] socket target hostname or IP address
-        # @param port [String,Integer] socket target port
-        def initialize host, port
-          @host = host.to_s
-          @port = port.to_i
-        end
-
-        # @return [::TCPSocket]
-        def new_socket
-          ::TCPSocket.new(host, port)
-        end
-      end
-    end
-  end
-end

data/lib/contrast/api/communication/unix_socket.rb

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

data/lib/contrast/api/communication.rb

@@ -1,20 +0,0 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
-# frozen_string_literal: true
-
-module Contrast
-  module Api
-    # Used to contain all modules that handle communication with speedracer
-    module Communication
-    end
-  end
-end
-
-require 'contrast/api/communication/service_lifecycle'
-require 'contrast/api/communication/connection_status'
-require 'contrast/api/communication/socket'
-require 'contrast/api/communication/tcp_socket'
-require 'contrast/api/communication/unix_socket'
-require 'contrast/api/communication/socket_client'
-require 'contrast/api/communication/messaging_queue'
-require 'contrast/api/communication/response_processor'
-require 'contrast/api/communication/speedracer'

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

@@ -1,33 +0,0 @@
-# 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'
-
-module Contrast
-  module Api
-    module Decorators
-      # Used to decorate the {Contrast::Api::Dtm::Activity} protobuf model
-      # to handle conversion between framework route classes and the dtm.
-      module Activity
-        def self.included klass
-          klass.extend(ClassMethods)
-        end
-
-        # Class methods for Activity
-        module ClassMethods
-          def source_or_string obj
-            if obj.cs__is_a?(Regexp)
-              obj.source
-            elsif obj.cs__respond_to?(:safe_string)
-              obj.safe_string
-            else
-              obj.to_s
-            end
-          end
-        end
-      end
-    end
-  end
-end
-
-Contrast::Api::Dtm::Activity.include(Contrast::Api::Decorators::Activity)

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

@@ -1,59 +0,0 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
-# frozen_string_literal: true
-
-require 'contrast/api/dtm.pb'
-require 'contrast/components/logger'
-require 'contrast/utils/string_utils'
-require 'contrast/utils/timer'
-
-module Contrast
-  module Api
-    module Decorators
-      # Used to decorate the {Contrast::Api::Dtm::Address} protobuf model so it
-      # can own some of the data massaging required for Request dtm. Only works
-      # as an extension of that class.
-      module Address
-        def self.included klass
-          klass.extend(ClassMethods)
-        end
-
-        # Used to add class methods to the ApplicationUpdate class on inclusion of the decorator
-        module ClassMethods
-          include Contrast::Components::Logger::InstanceMethods
-          # 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
-          #
-          # @return [Contrast::Api::Dtm::Address] the address of this server
-          def build_receiver
-            @_build_receiver ||= begin
-              address = new
-              address.host = 'localhost'
-              address.ip = '127.0.0.1' # rubocop:disable Style/IpAddresses
-              begin
-                Timeout.timeout(1) do
-                  address.host = Contrast::Utils::StringUtils.force_utf8(Socket.gethostname)
-                  address.ip = Contrast::Utils::StringUtils.force_utf8(Resolv.getaddress(address.host))
-                end
-              rescue StandardError => e
-                logger.warn('Unable to resolve host or ip', e, address: address)
-              end
-              address
-            end
-          end
-
-          # Parse out the sender of the Request and return it as an Address
-          #
-          # @return [Contrast::Api::Dtm::Address] the address from which the
-          #   request originated
-          def build_sender request
-            sender = new
-            sender.ip = Contrast::Utils::StringUtils.force_utf8(request.ip)
-            sender
-          end
-        end
-      end
-    end
-  end
-end
-
-Contrast::Api::Dtm::Address.include(Contrast::Api::Decorators::Address)

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

@@ -1,57 +0,0 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
-# frozen_string_literal: true
-
-require 'contrast/api/dtm.pb'
-require 'contrast/utils/string_utils'
-require 'contrast/components/base'
-
-module Contrast
-  module Api
-    module Decorators
-      # Used to decorate the AgentStartup protobuf model to handle reporting Agent process start
-      module AgentStartup
-        include Contrast::Components::ComponentBase
-
-        def self.included klass
-          klass.extend(ClassMethods)
-        end
-
-        # Used to add class methods to the AgentStartup class on inclusion of the decorator
-        module ClassMethods
-          # Return a new DTM with the values from the configuration and Agent discovery
-          #
-          # @parma name [String] the Hostname of this Server, or overridden value, used to identify this process
-          # @parma name [String] the Hostname of this Server, or overridden value, used to identify this process
-          # @parma name [String] the Hostname of this Server, or overridden value, used to identify this process
-          # @return [Contrast::Api::Dtm::AgentStartup]
-          def build name, path, type
-            msg = new
-            msg.server_version   = Contrast::Agent::VERSION
-            msg.server_name      = Contrast::Utils::StringUtils.protobuf_format(name)
-            msg.server_path      = Contrast::Utils::StringUtils.protobuf_format(path)
-            msg.server_type      = Contrast::Utils::StringUtils.protobuf_format(type)
-            config!(msg)
-            msg.finding_tags = Contrast::Utils::StringUtils.protobuf_format(::Contrast::ASSESS.tags)
-            msg
-          end
-
-          private
-
-          # set the configuration driven values for this AgentStartup msg
-          #
-          # @param msg [Contrast::Api::Dtm::AgentStartup]
-          def config! msg
-            msg.version      = Contrast::Utils::StringUtils.protobuf_format(::Contrast::CONFIG.root.server.version)
-            msg.server_tags  = Contrast::Utils::StringUtils.protobuf_format(::Contrast::CONFIG.root.server.tags)
-            msg.library_tags = Contrast::Utils::StringUtils.protobuf_format(::Contrast::CONFIG.root.inventory.tags)
-            msg.environment  = Contrast::Utils::StringUtils.protobuf_format(::Contrast::CONFIG.root.server.environment)
-            msg.application_tags =
-              Contrast::Utils::StringUtils.protobuf_format(::Contrast::CONFIG.root.application.tags)
-          end
-        end
-      end
-    end
-  end
-end
-
-Contrast::Api::Dtm::AgentStartup.include(Contrast::Api::Decorators::AgentStartup)

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

@@ -1,42 +0,0 @@
-# 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'
-
-module Contrast
-  module Api
-    module Decorators
-      # Used to decorate the {Contrast::Api::Settings::ApplicationSettings}
-      # protobuf model to handle setting translation.
-      module ApplicationSettings
-        MODE_ALLOWLIST = [
-          Contrast::Api::Settings::ProtectionRule::Mode::NO_ACTION,
-          Contrast::Api::Settings::ProtectionRule::Mode::BLOCK,
-          Contrast::Api::Settings::ProtectionRule::Mode::MONITOR,
-          Contrast::Api::Settings::ProtectionRule::Mode::BLOCK_AT_PERIMETER
-        ].cs__freeze
-        # Convert protobuf exlcusions into Agent exclusions
-        def translated_exclusions
-          exclusions.map { |exc| Contrast::Agent::ExclusionMatcher.new(exc) }
-        end
-
-        # Convert protobuf protect rule settings into a hash that settings state understands
-        def translated_protection_mode_by_id
-          protection_rules = self.protection_rules.map { |pr, _hash| [pr.id, pr.mode] } # [[RULE_ID, MODE]]
-          protection_rules.select! { |(_id, mode)| MODE_ALLOWLIST.include?(mode) } # [REMOVE IF MODE INVALID]
-          protection_rules.to_h # {RULE_ID => MODE}
-        end
-
-        def application_state_translation
-          {
-              modes_by_id: translated_protection_mode_by_id,
-              exclusion_matchers: translated_exclusions,
-              disabled_assess_rules: disabled_assess_rules
-          }
-        end
-      end
-    end
-  end
-end
-
-Contrast::Api::Settings::ApplicationSettings.include(Contrast::Api::Decorators::ApplicationSettings)

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

@@ -1,56 +0,0 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
-# frozen_string_literal: true
-
-require 'contrast/api/dtm.pb'
-require 'contrast/api/decorators/instrumentation_mode'
-require 'contrast/components/base'
-require 'contrast/utils/string_utils'
-
-module Contrast
-  module Api
-    module Decorators
-      # Used to decorate the ApplicationCreate protobuf model to handle reporting Agent process start
-      module ApplicationStartup
-        include Contrast::Components::ComponentBase
-
-        def self.included klass
-          klass.extend(ClassMethods)
-        end
-
-        # Used to add class methods to the AgentStartup class on inclusion of the decorator
-        module ClassMethods
-          # Return a new DTM with the values from the configuration
-          #
-          # @return [Contrast::Api::Dtm::ApplicationCreate]
-          def build
-            msg = new
-            msg.code     = Contrast::Utils::StringUtils.protobuf_format(::Contrast::CONFIG.root.application.code)
-            msg.group    = Contrast::Utils::StringUtils.protobuf_format(::Contrast::CONFIG.root.application.group)
-            msg.metadata = Contrast::Utils::StringUtils.protobuf_format(::Contrast::CONFIG.root.application.metadata)
-            msg.mode     = Contrast::Api::Dtm::InstrumentationMode.build
-            msg.app_version =
-                Contrast::Utils::StringUtils.protobuf_format(::Contrast::CONFIG.root.application.version.to_s) # rubocop:disable Layout/AssignmentIndentation Layout/FirstArgumentIndentation:
-            session!(msg)
-            msg
-          end
-
-          private
-
-          # Set the session metadata for this ApplicationCreate msg
-          #
-          # @param msg [Contrast::Api::Dtm::ApplicationCreate]
-          def session! msg
-            msg.session_id = Contrast::Utils::StringUtils.protobuf_format(
-                ::Contrast::CONFIG.root.application.session_id,
-                truncate: false)
-            msg.session_metadata = Contrast::Utils::StringUtils.protobuf_format(
-                ::Contrast::CONFIG.root.application.session_metadata,
-                truncate: false)
-          end
-        end
-      end
-    end
-  end
-end
-
-Contrast::Api::Dtm::ApplicationCreate.include(Contrast::Api::Decorators::ApplicationStartup)

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

@@ -1,36 +0,0 @@
-# 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'
-
-module Contrast
-  module Api
-    module Decorators
-      # Used to decorate the {Contrast::Api::Dtm::ArchitectureComponent} protobuf model so it can own some of the data
-      # massaging required for AppUpdate and Activity dtms.
-      module ArchitectureComponent
-        def self.included klass
-          klass.extend(ClassMethods)
-        end
-
-        # Used to add class methods to the ApplicationUpdate class on inclusion of the decorator
-        module ClassMethods
-          # TeamServer only accepts certain values for ArchitectureComponents.
-          # DO NOT CHANGE THIS!
-          AC_TYPE_DB = 'db'
-
-          # Create a Contrast::Api::Dtm::ArchitectureComponent of the database type.
-          #
-          # @return [Contrast::Api::Dtm::ArchitectureComponent]
-          def build_database
-            msg = Contrast::Api::Dtm::ArchitectureComponent.new
-            msg.type = AC_TYPE_DB
-            msg
-          end
-        end
-      end
-    end
-  end
-end
-
-Contrast::Api::Dtm::ArchitectureComponent.include(Contrast::Api::Decorators::ArchitectureComponent)

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

@@ -1,37 +0,0 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
-# frozen_string_literal: true
-
-require 'contrast/api/dtm.pb'
-require 'contrast/utils/string_utils'
-require 'contrast/components/base'
-
-module Contrast
-  module Api
-    module Decorators
-      # Used to decorate the {Contrast::Api::Dtm::BotBlockerDetails} protobuf
-      # model so it can own the request which its data is for.
-      module BotBlockerDetails
-        def self.included klass
-          klass.extend(ClassMethods)
-        end
-
-        # Used to add class methods to the AgentStartup class on inclusion of the decorator
-        module ClassMethods
-          def build
-            new
-          end
-
-          # @param result [Contrast::Api::Dtm::BotBlockerDetails]
-          def to_controlled_hash result
-            {
-                bot: result.bot,
-                user_agent: result.user_agent
-            }
-          end
-        end
-      end
-    end
-  end
-end
-
-Contrast::Api::Dtm::BotBlockerDetails.include(Contrast::Api::Decorators::BotBlockerDetails)

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

@@ -1,29 +0,0 @@
-# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
-# frozen_string_literal: true
-
-require 'contrast/api/dtm.pb'
-require 'contrast/utils/string_utils'
-require 'contrast/components/base'
-
-module Contrast
-  module Api
-    module Decorators
-      # Used to decorate the {Contrast::Api::Dtm::Finding} protobuf
-      # model so it can own the request which its data is for.
-      module Finding
-        def self.included klass
-          klass.extend(ClassMethods)
-        end
-
-        # Used to add class methods to the AgentStartup class on inclusion of the decorator
-        module ClassMethods
-          def build
-            new
-          end
-        end
-      end
-    end
-  end
-end
-
-Contrast::Api::Dtm::Finding.include(Contrast::Api::Decorators::Finding)