contrast-agent 3.8.4 → 3.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da212693eda842e7117b2c758361ea67915854a4888b3ea0315c51f33951fea3
-  data.tar.gz: d43b26947e6eb4219f97bf90542a3948077578617f925fa90a94d4151674e88e
+  metadata.gz: b789de55c662b3c95a253bac0ab731c931c0d97dad6fe7c6f827c40a17d64ed7
+  data.tar.gz: b7589a20f7d89191ca3b1633a93204fb7195f802272f2701b8d17553104979ae
 SHA512:
-  metadata.gz: 017607d5a9cc4be26f5b970ae072851fb50a3487c9da3d625ed72d346bbbff29daec0dfd5cf2a9b5dcb1445512d9d951a77360980c9ec9f2c37f9759ff706598
-  data.tar.gz: 2a17b8dd9099c3558c5d8d1a2ba085eaec28149ef0def59d04e129e0cd2f863e2e2a6e27ae9defa873163df7b539d6600a620d7674553a71a3899e3e1d426b60
+  metadata.gz: '00693f21684374256997ada3d2a40889c288e116931662126ab7305dd2504c5fbb5d6657acd03c215181fcc839950b5b7a3ceccb7f1a347d2b91e7ae8556cf3b'
+  data.tar.gz: d44389e25b56d8da40e9b9de424ac9189c5d5929d252e2e082d09643dcf79b9d65b5b2179524a09cc9ab0978c5158eea02bcb3d042df12dea2e09b4bdf99a7b2

data/ext/build_funchook.rb

@@ -2,13 +2,25 @@
 # frozen_string_literal: true
 
 require 'fileutils'
-
 unless find_header('funchook.h', ext_path)
 
   FUNCHOOK_DIR_NAME = 'funchook'
   FUNCHOOK_DIR = File.expand_path(File.join(File.dirname(File.expand_path(__FILE__)), '..', FUNCHOOK_DIR_NAME))
 
   COMMANDS = ['./autogen.sh', './configure', 'make clean', 'make'].freeze
+  bundler_install_target_paths = []
+
+  possible_gem_paths = Gem.path # .path and .paths diverge in their return type - .path returns strings, .paths returns PathSupports
+  possible_gem_paths.each do |base_path|
+    contrast_gem_dir_search = File.join(base_path, '**', '*', 'contrast-agent-*')
+    extension_paths = Dir[contrast_gem_dir_search]
+    extension_paths.map! do |extension_path|
+      target_path = File.join(extension_path, 'shared_libraries')
+      FileUtils.mkdir_p(target_path)
+      target_path
+    end
+    bundler_install_target_paths += extension_paths
+  end
 
   puts 'Building funchook'
   COMMANDS.each do |command|
@@ -19,15 +31,15 @@ unless find_header('funchook.h', ext_path)
   end
 
   SOURCE_PATHS = [
-    File.join('include', 'funchook.h'),
-    File.join('src',     'libfunchook.dylib'),
-    File.join('src',     'libfunchook.so')
+      File.join('include', 'funchook.h'),
+      File.join('src', 'libfunchook.dylib'),
+      File.join('src', 'libfunchook.so')
   ].freeze
 
-  TARGET_PATHS = [
-    File.expand_path(File.join(File.expand_path(__dir__), '..', 'shared_libraries')),
-    File.expand_path(__dir__) # should be ext/
-  ].freeze
+  TARGET_PATHS = ([
+      File.expand_path(File.join(File.expand_path(__dir__), '..', 'shared_libraries')),
+      File.expand_path(__dir__)
+  ] + (bundler_install_target_paths)).freeze
 
   puts 'Copying required files'
 
@@ -45,4 +57,5 @@ unless find_header('funchook.h', ext_path)
   end
 end
 
+
 have_header('funchook.h', ext_path)

data/funchook/autom4te.cache/requests

@@ -14,64 +14,64 @@
                         'configure.ac'
                       ],
                       {
-                        'AC_REQUIRE_AUX_FILE' => 1,
-                        '_AM_COND_ELSE' => 1,
-                        'AM_MAKEFILE_INCLUDE' => 1,
+                        'AC_PROG_LIBTOOL' => 1,
+                        'm4_sinclude' => 1,
+                        'AM_PROG_F77_C_O' => 1,
+                        'AM_GNU_GETTEXT_INTL_SUBDIR' => 1,
+                        'AM_POT_TOOLS' => 1,
                         'AC_CONFIG_SUBDIRS' => 1,
-                        'AM_INIT_AUTOMAKE' => 1,
-                        'AM_PROG_CC_C_O' => 1,
-                        'AM_AUTOMAKE_VERSION' => 1,
-                        'AC_INIT' => 1,
-                        '_AM_COND_IF' => 1,
-                        'LT_CONFIG_LTDL_DIR' => 1,
-                        'AC_FC_PP_SRCEXT' => 1,
-                        'AM_PROG_CXX_C_O' => 1,
                         'AM_NLS' => 1,
-                        'm4_pattern_forbid' => 1,
-                        'AM_PROG_AR' => 1,
-                        'm4_pattern_allow' => 1,
-                        'AH_OUTPUT' => 1,
-                        'AM_XGETTEXT_OPTION' => 1,
-                        'AC_FC_PP_DEFINE' => 1,
-                        'AM_ENABLE_MULTILIB' => 1,
-                        'm4_sinclude' => 1,
-                        'AM_MAINTAINER_MODE' => 1,
-                        'AM_GNU_GETTEXT' => 1,
-                        '_m4_warn' => 1,
-                        'sinclude' => 1,
-                        '_AM_COND_ENDIF' => 1,
-                        'AC_CANONICAL_HOST' => 1,
-                        'AM_PROG_LIBTOOL' => 1,
-                        'AC_CONFIG_LIBOBJ_DIR' => 1,
                         'AC_FC_SRCEXT' => 1,
-                        'AM_CONDITIONAL' => 1,
                         'LT_SUPPORTED_TAG' => 1,
-                        'AM_POT_TOOLS' => 1,
-                        'AC_FC_FREEFORM' => 1,
-                        'AC_CANONICAL_SYSTEM' => 1,
-                        'AC_CANONICAL_BUILD' => 1,
-                        'AM_PATH_GUILE' => 1,
+                        'AC_LIBSOURCE' => 1,
+                        'AC_CONFIG_LIBOBJ_DIR' => 1,
+                        'sinclude' => 1,
+                        '_LT_AC_TAGCONFIG' => 1,
+                        '_AM_COND_ELSE' => 1,
+                        'AM_PROG_LIBTOOL' => 1,
                         'AC_SUBST' => 1,
+                        '_AM_COND_ENDIF' => 1,
                         'AM_PROG_FC_C_O' => 1,
-                        'AM_SILENT_RULES' => 1,
-                        'AC_PROG_LIBTOOL' => 1,
-                        'AM_PROG_MOC' => 1,
-                        'AM_PROG_F77_C_O' => 1,
-                        'm4_include' => 1,
-                        'AC_CANONICAL_TARGET' => 1,
-                        'AC_CONFIG_FILES' => 1,
-                        'include' => 1,
-                        'AC_DEFINE_TRACE_LITERAL' => 1,
                         '_AM_SUBST_NOTMAKE' => 1,
-                        'AM_GNU_GETTEXT_INTL_SUBDIR' => 1,
-                        'AC_LIBSOURCE' => 1,
-                        'AC_SUBST_TRACE' => 1,
+                        'AC_CONFIG_FILES' => 1,
+                        'AC_REQUIRE_AUX_FILE' => 1,
+                        'AM_PROG_MOC' => 1,
+                        'AH_OUTPUT' => 1,
+                        'AC_FC_PP_SRCEXT' => 1,
+                        'AM_MAINTAINER_MODE' => 1,
+                        'AM_PROG_CC_C_O' => 1,
                         'AC_CONFIG_LINKS' => 1,
-                        '_LT_AC_TAGCONFIG' => 1,
+                        '_m4_warn' => 1,
+                        'AM_PROG_CXX_C_O' => 1,
                         'LT_INIT' => 1,
+                        'AM_PATH_GUILE' => 1,
+                        'LT_CONFIG_LTDL_DIR' => 1,
+                        'AC_FC_FREEFORM' => 1,
+                        'AM_XGETTEXT_OPTION' => 1,
+                        'AM_AUTOMAKE_VERSION' => 1,
+                        'include' => 1,
+                        'AC_CANONICAL_SYSTEM' => 1,
+                        'AM_INIT_AUTOMAKE' => 1,
+                        'm4_pattern_forbid' => 1,
+                        'AC_CONFIG_AUX_DIR' => 1,
+                        'AM_SILENT_RULES' => 1,
+                        'AM_PROG_AR' => 1,
+                        'AC_FC_PP_DEFINE' => 1,
                         'AC_CONFIG_HEADERS' => 1,
                         '_AM_MAKEFILE_INCLUDE' => 1,
-                        'AC_CONFIG_AUX_DIR' => 1
+                        'AC_CANONICAL_BUILD' => 1,
+                        'AM_MAKEFILE_INCLUDE' => 1,
+                        'AM_CONDITIONAL' => 1,
+                        'm4_include' => 1,
+                        'AC_INIT' => 1,
+                        'AC_DEFINE_TRACE_LITERAL' => 1,
+                        'AC_SUBST_TRACE' => 1,
+                        '_AM_COND_IF' => 1,
+                        'AC_CANONICAL_HOST' => 1,
+                        'm4_pattern_allow' => 1,
+                        'AM_GNU_GETTEXT' => 1,
+                        'AC_CANONICAL_TARGET' => 1,
+                        'AM_ENABLE_MULTILIB' => 1
                       }
                     ], 'Autom4te::Request' )
            );

data/funchook/config.log

@@ -10,7 +10,7 @@ generated by GNU Autoconf 2.69.  Invocation command line was
 ## Platform. ##
 ## --------- ##
 
-hostname = 99183398-517c-41c3-9907-625f03502c54-9m4hk
+hostname = 190fbedb-dc16-42d3-8ff7-6ac407e6f5f6-sf5wp
 uname -m = x86_64
 uname -r = 4.19.95-flatcar
 uname -s = Linux
@@ -326,7 +326,7 @@ generated by GNU Autoconf 2.69.  Invocation command line was
   CONFIG_COMMANDS = 
   $ ./config.status 
 
-on 99183398-517c-41c3-9907-625f03502c54-9m4hk
+on 190fbedb-dc16-42d3-8ff7-6ac407e6f5f6-sf5wp
 
 config.status:822: creating Makefile
 config.status:822: creating src/Makefile

data/lib/contrast/agent/socket_client.rb

@@ -47,10 +47,11 @@ module Contrast
       # service config option, we must first start up the service. Afterwards, we
       # must send agent startup messages no matter what the config options are.
       #
-      # @param msg [Contrast::Api::Dtm::Message] the message to be sent.
+      # @param event [Contrast::Api::Dtm] One of the DTMs valid for the event
+      #   field of Contrast::Api::Dtm::Message
       # @return [Array<Contrast::Api::Settings::AgentSettings>] the response from SpeedRacer or nil
       #   if it failed to send or the service is unavailable.
-      def send_to_speedracer msg
+      def send_to_speedracer event
         return if service_unavailable?
 
         @ensure_running.synchronize do
@@ -60,16 +61,14 @@ module Contrast
           build_service_context unless status.startup_messages_sent?
         end
 
-        logger.debug_with_time(msg.cs__class.name) do
-          logger.debug "[m__id__:#{ msg.__id__ }]\tSending message."
-          response = speedracer.send_one msg
+        logger.debug_with_time(event.cs__class.name) do
+          response = speedracer.send_one event
           status.success!
-          logger.debug "[m__id__:#{ msg.__id__ }]\tReceived response:#{ response ? response.__id__ : '[No Response]' } for message."
           response
         end
       rescue StandardError => e
         status.failure!
-        logger.error(e, "Unable to send message=#{ msg.cs__class }.")
+        logger.error(e, "Unable to send #{ event.cs__class } message #{ event.__id__ }.")
         nil
       end
 
@@ -103,9 +102,13 @@ module Contrast
         # 1 initial attempt, + 3 potential retries.
         # The agent-service-api REQUIREMENTS.md spec mandates this #.
         4.times do
+          # TODO: RUBY-794 make Type & ID structured for parsing)
+          logger.debug("Immediately sending #{ agent_startup_msg.cs__class.name } event #{ agent_startup_msg.__id__ }.")
           next unless (agent_response = speedracer.send_one(agent_startup_msg))
 
           # Connection was successful
+          # TODO: RUBY-794 make Type & ID structured for parsing)
+          logger.debug("Immediately sending #{ app_startup_msg.cs__class.name } event #{ app_startup_msg.__id__ }.")
           app_response = speedracer.send_one(app_startup_msg)
           [agent_response, app_response].each do |msg|
             Contrast::Utils::ServiceResponseUtil.process_response msg

data/lib/contrast/agent/version.rb

@@ -3,6 +3,6 @@
 
 module Contrast
   module Agent
-    VERSION = '3.8.4'
+    VERSION = '3.8.5'
   end
 end

data/lib/contrast/api/speedracer.rb

@@ -59,27 +59,14 @@ module Contrast
         is_service_started
       end
 
-      def send_one msg
-        case msg
-        when Contrast::Api::Dtm::ServerActivity
-          send_server_activity(msg)
-        when Contrast::Api::Dtm::AgentStartup
-          send_agent_startup(msg)
-        when Contrast::Api::Dtm::ApplicationCreate
-          send_application_create(msg)
-        when Contrast::Api::Dtm::ApplicationUpdate
-          send_application_update(msg)
-        when Contrast::Api::Dtm::Activity
-          send_application_activity(msg)
-        when Contrast::Api::Dtm::HttpRequest
-          send_prefilter(msg)
-        when Contrast::Api::Dtm::HttpResponse
-          send_postfilter(msg)
-        when Contrast::Api::Dtm::Noop
-          send_noop(msg)
-        when Contrast::Api::Dtm::ObservedRoute
-          send_observed_route(msg)
-        end
+      # Wrap the given DTM in a Contrast::Api::Dtm::Message and send it to the
+      # Service for processing
+      #
+      # @param event [Contrast::Api::Dtm] One of the DTMs valid for the event field of
+      #   Contrast::Api::Dtm::Message
+      def send_one event
+        msg = build_message(event)
+        send_message(msg)
       end
 
       private
@@ -124,58 +111,39 @@ module Contrast
         end
       end
 
-      def send_server_activity server_activity
-        msg = base_message
-        msg.server_activity = server_activity
-        send_message(msg)
-      end
-
-      def send_agent_startup agent_startup
-        msg = base_message
-        msg.agent_startup = agent_startup
-        send_message(msg)
-      end
-
-      def send_application_create app_create
-        msg = base_message
-        msg.application_create = app_create
-        send_message(msg)
-      end
-
-      def send_application_update app_update
-        msg = base_message
-        msg.application_update = app_update
-        send_message(msg)
-      end
-
-      def send_application_activity activity
-        msg = base_message
-        msg.activity = activity
-        send_message(msg)
-      end
-
-      def send_prefilter http_request
-        msg = base_message
-        msg.prefilter = http_request
-        send_message(msg)
-      end
-
-      def send_postfilter http_response
-        msg = base_message
-        msg.postfilter = http_response
-        send_message(msg)
-      end
-
-      def send_noop noop = nil
-        msg = base_message
-        msg.noop = noop || Contrast::Api::Dtm::Noop.new
-        send_message(msg)
-      end
-
-      def send_observed_route observed_route
-        msg = base_message
-        msg.observed_route = observed_route
-        send_message(msg)
+      # Wrap the given event in a Contrast::Api::Dtm::Message
+      #
+      # @param event [Contrast::Api::Dtm] One of the DTMs valid for the event field of
+      #   Contrast::Api::Dtm::Message
+      # @return Contrast::Api::Dtm::Message
+      def build_message event
+        message = base_message
+        case event
+        when Contrast::Api::Dtm::ServerActivity
+          message.server_activity = event
+        when Contrast::Api::Dtm::AgentStartup
+          message.agent_startup = event
+        when Contrast::Api::Dtm::ApplicationCreate
+          message.application_create = event
+        when Contrast::Api::Dtm::ApplicationUpdate
+          message.application_update = event
+        when Contrast::Api::Dtm::Activity
+          message.activity = event
+        when Contrast::Api::Dtm::HttpRequest
+          message.prefilter = event
+        when Contrast::Api::Dtm::HttpResponse
+          message.postfilter = event
+        when Contrast::Api::Dtm::Noop
+          message.noop = event
+        when Contrast::Api::Dtm::ObservedRoute
+          message.observed_route = event
+        else
+          logger.error("Unknown event type #{ event.cs__class.name } received. Unsure how to send.")
+          return
+        end
+        # TODO: RUBY-794 make ID structured for parsing
+        logger.debug("Wrapping the event #{ event.__id__ } in message #{ message.__id__ } (#{ message.pid }-#{ message.message_count }.")
+        message
       end
 
       def base_message
@@ -192,10 +160,22 @@ module Contrast
         msg
       end
 
-      def send_message message
-        to_service = Contrast::Api::Dtm::Message.encode(message)
+      def send_message msg
+        # TODO: RUBY-794 make PID & Count structured for parsing
+        logger.debug "[m__id__:#{ msg.__id__ }]\tSending message #{ msg.pid }-#{ msg.message_count }."
+        to_service = Contrast::Api::Dtm::Message.encode(msg)
         from_service = send_marshaled(to_service)
-        Contrast::Api::Settings::AgentSettings.decode(from_service)
+        response = Contrast::Api::Settings::AgentSettings.decode(from_service)
+        # TODO: RUBY-794 make PID & Count structured for parsing
+        log_message = "[m__id__:#{ msg.__id__ }]\tReceived response: " \
+                      "#{ response ? response.__id__ : '[No Response]' } for " \
+                      "message #{ msg.pid }-#{ msg.message_count }."
+        logger.debug(log_message)
+        response
+      rescue StandardError => e
+        # TODO: RUBY-794 make PID & Count structured for parsing
+        logger.error(e, "[m__id__:#{ msg.__id__ }]\tSending failed for message #{ msg.pid }-#{ msg.message_count }.")
+        raise e # reraise to let SocketClient manage the connection
       end
 
       def send_marshaled marshaled

data/lib/contrast/components/contrast_service.rb

@@ -84,11 +84,14 @@ module Contrast
         # 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 msg [Contrast::Api::Dtm::Message] the message to be sent
-        def queue_message msg
-          return unless msg
+        #
+        # @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(msg)
+          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
@@ -98,12 +101,14 @@ module Contrast
         # 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 msg [Contrast::Api::Dtm::Message] the message to be sent
+        # @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
-        def send_message msg
-          return unless msg
+        # TODO: rename method to send_event
+        def send_message event
+          return unless event
 
-          state.client.send_to_speedracer(msg)
+          state.client.send_to_speedracer(event)
         end
       end
 

data/lib/contrast/utils/service_sender_util.rb

@@ -18,11 +18,18 @@ module Contrast
       class << self
         attr_reader :assess_messages, :ready_messages_queue
 
-        def push_to_ready_queue msg
+        # Push the given DTM into a queue to be sent to the Service.
+        #
+        # @param event [Contrast::Api::Dtm] One of the DTMs valid for the event field of
+        #   Contrast::Api::Dtm::Message
+        def push_to_ready_queue event
+          return unless event
+
           # Since a message may try to be pushed before sending_thread starts up, we need to initialize
           # the queue on first message sent
           @ready_messages_queue ||= Queue.new
-          ready_messages_queue.push msg
+          ready_messages_queue.push event
+          logger.debug("Enqueued the #{ event.cs__class.name } event #{ event.__id__ }.") # TODO: RUBY-794 make Type & ID structured for parsing)
         end
 
         def sending_thread
@@ -34,9 +41,10 @@ module Contrast
             loop do
               check_assess_queue if assess_messages # don't bother checking if assess queue is already cleared
               # if ready messages queue is empty, calling thread is suspended until a message is pushed onto queue
-              msg = ready_messages_queue.pop
+              event = ready_messages_queue.pop
               begin
-                response = Contrast::Agent::FeatureState.instance.client.send_to_speedracer msg
+                logger.debug("Dequeued the #{ event.cs__class.name } event #{ event.__id__ }.") # TODO: RUBY-794 make Type & ID structured for parsing)
+                response = Contrast::Agent::FeatureState.instance.client.send_to_speedracer event
                 Contrast::Utils::ServiceResponseUtil.process_response(response) if response
               rescue StandardError => e
                 logger.error(e, 'Could not send message to service from service sender thread.')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contrast-agent
 version: !ruby/object:Gem::Version
-  version: 3.8.4
+  version: 3.8.5
 platform: ruby
 authors:
 - galen.palmer@contrastsecurity.com
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-16 00:00:00.000000000 Z
+date: 2020-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -392,21 +392,21 @@ executables:
 - contrast_service
 extensions:
 - ext/cs__common/extconf.rb
+- ext/cs__assess_basic_object/extconf.rb
+- ext/cs__assess_marshal_module/extconf.rb
 - ext/cs__scope/extconf.rb
-- ext/cs__assess_module/extconf.rb
+- ext/cs__assess_regexp/extconf.rb
+- ext/cs__assess_hash/extconf.rb
+- ext/cs__assess_fiber_track/extconf.rb
+- ext/cs__assess_array/extconf.rb
 - ext/cs__assess_active_record_named/extconf.rb
 - ext/cs__assess_kernel/extconf.rb
-- ext/cs__assess_marshal_module/extconf.rb
-- ext/cs__assess_fiber_track/extconf.rb
-- ext/cs__assess_regexp/extconf.rb
-- ext/cs__assess_basic_object/extconf.rb
-- ext/cs__contrast_patch/extconf.rb
-- ext/cs__assess_string_interpolation26/extconf.rb
 - ext/cs__assess_regexp_track/extconf.rb
 - ext/cs__protect_kernel/extconf.rb
 - ext/cs__assess_string/extconf.rb
-- ext/cs__assess_array/extconf.rb
-- ext/cs__assess_hash/extconf.rb
+- ext/cs__assess_string_interpolation26/extconf.rb
+- ext/cs__contrast_patch/extconf.rb
+- ext/cs__assess_module/extconf.rb
 extra_rdoc_files: []
 files:
 - ".clang-format"