tcell_agent 2.0.0 → 2.2.1

data/lib/tcell_agent/rails/middleware/global_middleware.rb

@@ -7,7 +7,7 @@ require 'tcell_agent/sensor_events/sensor'
 require 'tcell_agent/sensor_events/server_agent'
 require 'tcell_agent/sensor_events/util/sanitizer_utilities'
 
-require 'tcell_agent/userinfo'
+require 'tcell_agent/rails/auth/userinfo'
 require 'cgi'
 
 require 'tcell_agent/instrumentation'
@@ -24,6 +24,9 @@ module TCellAgent
           def call(env)
             if TCellAgent.configuration.should_intercept_requests?
               request = Rack::Request.new(env)
+
+              request['init'] = true
+
               TCellAgent::Instrumentation.safe_block('Setting session_id & user_id') do
                 if request.session
                   env[TCellAgent::Instrumentation::TCELL_ID].session_id =

data/lib/tcell_agent/rails/{on_start.rb → railties/tcell_agent_railties.rb}

@@ -2,36 +2,21 @@
 
 require 'rails'
 
-require 'tcell_agent/rails/routes'
-
 require 'tcell_agent/rails/middleware/global_middleware'
 require 'tcell_agent/rails/middleware/body_filter_middleware'
 require 'tcell_agent/rails/middleware/headers_middleware'
 require 'tcell_agent/rails/middleware/context_middleware'
 
+require 'tcell_agent/rails/routes'
 require 'tcell_agent/rails/settings_reporter'
 require 'tcell_agent/rails/dlp'
 require 'tcell_agent/rails/csrf_exception'
 
-require 'tcell_agent/userinfo'
 require 'cgi'
 require 'thread'
 
 module TCellAgent
   class TCellAgentStartupRailtie < Rails::Railtie
-    # TCellAgent config can be specified thru
-    # Rails initializer's (https://guides.rubyonrails.org/v2.3/configuring.html#using-initializers)
-    # so those need to run first since this relies on configuration
-    initializer :tcell_instrument_auth_frameworks, :after => :load_config_initializers do |_app|
-      next unless TCellAgent.configuration.should_instrument?
-
-      require 'tcell_agent/devise'
-      require 'tcell_agent/rails/auth/devise'
-      require 'tcell_agent/authlogic'
-      require 'tcell_agent/rails/auth/authlogic'
-      require 'tcell_agent/rails/auth/doorkeeper'
-    end
-
     initializer :tcell_insert_middleware, :before => :build_middleware_stack do |app|
       app.config.middleware.insert_before(0, TCellAgent::Instrumentation::Rails::Middleware::ContextMiddleware)
       app.config.middleware.insert_after(0, TCellAgent::Instrumentation::Rails::Middleware::HeadersMiddleware)
@@ -39,4 +24,12 @@ module TCellAgent
       app.config.middleware.use TCellAgent::Instrumentation::Rails::Middleware::GlobalMiddleware
     end
   end
+
+  class TCellAgentCSRFRailtie < Rails::Railtie
+    initializer 'tcell.sensors' do |_app|
+      ActiveSupport.on_load :action_controller do
+        ActionController::Base.send(:include, TCellAgent::CsrfExceptionReporter)
+      end
+    end
+  end
 end

data/lib/tcell_agent/rails/railties/tcell_agent_unicorn_railties.rb

@@ -0,0 +1,8 @@
+module TCellAgent
+  class TCellAgentStartupRailtie < Rails::Railtie
+    initializer :start_tcell_agent,
+                :after => :load_config_initializers do |_app|
+      TCellAgent.thread_agent.start('Unicorn')
+    end
+  end
+end

data/lib/tcell_agent/rails/routes.rb

@@ -77,7 +77,7 @@ module TCellAgent
       end
 
       def self.create_tcell_route(route)
-        return TCellRoute5.new(route) if route && ::Rails::VERSION::MAJOR == 5
+        return TCellRoute5.new(route) if route && ::Rails::VERSION::MAJOR >= 5
         return TCellRoute4.new(route) if route && ::Rails::VERSION::MAJOR < 5
 
         TCellRoute.new
@@ -136,8 +136,7 @@ module TCellAgent
               prepend_around_filter :tcell_around_filter_routes
             end
             def tcell_around_filter_routes
-              if TCellAgent.configuration.should_instrument? &&
-                 TCellAgent.configuration.should_intercept_requests?
+              if TCellAgent.configuration.should_intercept_requests?
                 TCellAgent::Instrumentation.safe_block('Determining Rails Route ID') do
                   _match, parameters, route = ::Rails.application.routes.router.recognize(request) { |r, _| r }.first
 
@@ -173,7 +172,7 @@ module TCellAgent
         end
       end
 
-      if ::Rails::VERSION::MAJOR == 5
+      if ::Rails::VERSION::MAJOR >= 5
         ActionDispatch::Journey::Routes.class_eval do
           alias_method :tcell_add_route, :add_route
           def add_route(name, mapping)
@@ -188,12 +187,11 @@ module TCellAgent
         end
       end
 
-      if ::Rails::VERSION::MAJOR == 5 || (::Rails::VERSION::MAJOR == 4 && ::Rails::VERSION::MINOR >= 2)
+      if ::Rails::VERSION::MAJOR >= 5 || (::Rails::VERSION::MAJOR == 4 && ::Rails::VERSION::MINOR >= 2)
         ActionDispatch::Journey::Router.class_eval do
           alias_method :tcell_serve, :serve
           def serve(req)
-            if TCellAgent.configuration.should_instrument? &&
-               TCellAgent.configuration.should_intercept_requests?
+            if TCellAgent.configuration.should_intercept_requests?
               TCellAgent::Instrumentation.safe_block('Determining Rails Route ID') do
                 _match, parameters, route = find_routes(req).first
 
@@ -220,8 +218,7 @@ module TCellAgent
           def call(env)
             env['PATH_INFO'] = ActionDispatch::Journey::Router::Utils.normalize_path(env['PATH_INFO'])
 
-            if TCellAgent.configuration.should_instrument? &&
-               TCellAgent.configuration.should_intercept_requests?
+            if TCellAgent.configuration.should_intercept_requests?
               TCellAgent::Instrumentation.safe_block('Determining Rails Route ID') do
                 _match, parameters, route = find_routes(env).first
 

data/lib/tcell_agent/rails/routes/grape.rb

@@ -5,15 +5,9 @@ module TCellAgent
     def self.grape_route?(route)
       if defined?(Grape::API)
         begin
-          if ::Rails::VERSION::MAJOR == 4 && ::Rails::VERSION::MINOR < 2
-            # does app inherit from Grape::API?
-            route.app < Grape::API
-          else
-            # does app inherit from Grape::API?
-            route.app.app < Grape::API
-          end
-
-          return true
+          return route.app < Grape::API if ::Rails::VERSION::MAJOR == 4 &&
+                                           ::Rails::VERSION::MINOR < 2
+          return route.app.app < Grape::API
         rescue StandardError # rubocop:disable Lint/HandleExceptions
           # do nothing
         end
@@ -76,9 +70,7 @@ module TCellAgent
       Grape::Endpoint.class_eval do
         alias_method :tcell_call!, :call!
         def call!(env)
-          if TCellAgent.configuration.should_instrument? &&
-             TCellAgent.configuration.should_intercept_requests?
-
+          if TCellAgent.configuration.should_intercept_requests?
             TCellAgent::Instrumentation.safe_block('Determining Rails Route ID') do
               tcell_context = env[TCellAgent::Instrumentation::TCELL_ID]
               if tcell_context && tcell_context.grape_mount_endpoint && respond_to?(:routes)

data/lib/tcell_agent/rails/tcell_body_proxy.rb

@@ -31,7 +31,6 @@ module TCellAgent
           TCellAgent::Instrumentation.safe_block('Running AppSensor deferred due to streaming') do
             if @meta_data
               @meta_data.response_content_bytes_len = @content_length
-
               appfirewall_policy = TCellAgent.policy(TCellAgent::PolicyTypes::APPSENSOR)
               appfirewall_policy.check_appfirewall_injections(@meta_data)
             end

data/lib/tcell_agent/rust/agent_config.rb

@@ -1,48 +1,59 @@
+# frozen_string_literal: true
+
 require 'tcell_agent/version'
+require 'tcell_agent/rust/models'
 
 module TCellAgent
   module Rust
     class AgentConfig < Hash
       def initialize(configuration)
-        send_mode = 'Normal'
-        send_mode = 'Demo' if configuration.demomode
+        self['agent_type'] = 'Ruby'
+        self['agent_version'] = TCellAgent::VERSION
+        self['default_cache_dir'] = File.join(Dir.getwd, 'tcell/cache')
+        self['default_config_file_dir'] = File.join(Dir.getwd, 'config')
+        self['default_log_dir'] = File.join(Dir.getwd, 'tcell/logs')
+        self['default_preload_policy_file_dir'] = Dir.getwd
 
-        logging_options = configuration.clean_logging_options
-        unless configuration.js_agent_api_base_url
-          parsed_uri = URI.parse(configuration.tcell_api_url)
-          api_url = [parsed_uri.scheme, '://', parsed_uri.host]
-          api_url.push(":#{parsed_uri.port}") unless [80, 443].include?(parsed_uri.port)
-          configuration.js_agent_api_base_url = "#{api_url.join('')}/api/v1"
+        if defined?(ConfigInitializer)
+          overrides = Models.clean_nils(AgentConfigOverrides.new(configuration))
+          self['overrides'] = overrides
+        else
+          self['overrides'] = { 'applications' => [{ :enable_json_body_inspection => true }],
+                                'config_file_dir' => configuration.get_config_file_dir }
         end
+      end
+    end
 
-        self['disable_event_sending'] = !configuration.should_start_event_manager?
-        self['send_mode'] = send_mode
-        self['agent_type'] = 'Ruby'
-        self['agent_version'] = TCellAgent::VERSION
-        self['diagnostics_enabled'] = false
-        self['application'] = {
+    class AgentConfigOverrides < Hash
+      def initialize(configuration)
+        applications = {
+          :allow_payloads => configuration.allow_payloads,
+          :api_key => configuration.api_key,
           :app_id => configuration.app_id,
-          :api_key =>  configuration.api_key,
-          :tcell_api_url => configuration.tcell_api_url,
-          :tcell_input_url => configuration.tcell_input_url,
+          :enable_json_body_inspection => true,
           :hmac_key => configuration.hmac_key,
+          :max_header_size => configuration.max_csp_header_bytes,
           :password_hmac_key => configuration.password_hmac_key,
-          :allow_payloads => configuration.allow_payloads,
-          :js_agent_api_base_url => configuration.js_agent_api_base_url,
-          :js_agent_url => configuration.js_agent_url,
-          :cache_dir => configuration.cache_folder,
-          :log_dir => configuration.agent_log_dir,
-          :logging_options => logging_options,
-          :host_identifier => configuration.host_identifier,
-          :reverse_proxy_ip_address_header => configuration.reverse_proxy_ip_address_header,
-          :fetch_policies_from_tcell => configuration.should_start_policy_poll?,
-          :preload_policy_filename => configuration.preload_policy_filename
-        }
-        self['appfirewall'] = {
-          :enable_body_json_inspection => true,
-          :allow_log_payloads => true
+          :reverse_proxy => configuration.reverse_proxy,
+          :reverse_proxy_ip_address_header => configuration.reverse_proxy_ip_address_header
         }
-        self['max_header_size'] = configuration.max_csp_header_bytes || (1024 * 1024)
+
+        self['api_url'] = configuration.tcell_api_url
+        self['applications'] = [Models.clean_nils(applications)]
+        self['config_file_dir'] = configuration.get_config_file_dir
+        self['disabled_instrumentation'] = configuration.disabled_instrumentation
+        self['enabled'] = configuration.enabled
+        self['host_identifier'] = configuration.host_identifier
+        self['input_url'] = configuration.tcell_input_url
+        self['instrument'] = configuration.instrument
+        self['js_agent_api_url'] = configuration.js_agent_api_base_url
+        self['js_agent_url'] = configuration.js_agent_url
+        self['log_destination'] = configuration.logging_options[:destination]
+        self['log_dir'] = configuration.log_dir
+        self['log_enabled'] = configuration.logging_options[:enabled]
+        self['log_filename'] = configuration.logging_options[:log_filename]
+        self['log_level'] = configuration.logging_options[:level]
+        self['update_policy'] = configuration.fetch_policies_from_tcell
       end
     end
   end

data/lib/tcell_agent/rust/models.rb

@@ -13,6 +13,15 @@ module TCellAgent
 
         flattened_params
       end
+
+      def self.clean_nils(hash)
+        if hash.respond_to?(:compact!)
+          hash.compact!
+        else
+          hash.delete_if { |_, v| v.nil? }
+        end
+        hash
+      end
     end
   end
 end

data/lib/tcell_agent/rust/native_agent.rb

@@ -58,6 +58,20 @@ module TCellAgent
         response.errors
       end
 
+      def self.test_agent(config)
+        agent_config = TCellAgent::Rust::AgentConfig.new(config)
+
+        config_pointer = FFI::MemoryPointer.from_string(
+          JSON.dump(agent_config)
+        )
+
+        buf = FFI::MemoryPointer.new(:uint8, 1024 * 8)
+        # config_pointer.size - 1: strips null terminator
+        TCellAgent::Rust::NativeLibrary.test_agent(
+          config_pointer, config_pointer.size - 1, buf, buf.size
+        )
+      end
+
       def self.free_agent(agent_ptr)
         if TCellAgent::Rust::NativeLibrary.common_lib_available? &&
            agent_ptr
@@ -88,6 +102,9 @@ module TCellAgent
           return nil
         end
 
+        return unless response['config'] && response['agent_enabled']
+
+        TCellAgent.configuration.populate_configuration(response['config'])
         NativeAgent.new(response['agent_ptr'])
       end
 
@@ -209,6 +226,7 @@ module TCellAgent
           :user_id => tcell_context.user_id,
           :full_uri => tcell_context.uri
         }
+
         command_pointer = FFI::MemoryPointer.from_string(
           JSON.dump(command_info)
         )

data/lib/tcell_agent/rust/native_library.rb

@@ -6,7 +6,7 @@ module TCellAgent
       require 'ffi'
       extend FFI::Library
 
-      VERSION = '4.14.0'.freeze
+      VERSION = '5.0.2'.freeze
       prefix = 'lib'
       extension = '.so'
       variant = ''
@@ -50,6 +50,7 @@ module TCellAgent
         attach_function :update_policies, %i[pointer pointer size_t pointer size_t], :int
         attach_function :test_event_sender, %i[pointer size_t pointer size_t], :int
         attach_function :test_policies, %i[pointer size_t pointer size_t], :int
+        attach_function :test_agent, %i[pointer size_t pointer size_t], :int
 
         def self.common_lib_available?
           true

data/lib/tcell_agent/servers/puma.rb

@@ -4,21 +4,21 @@ if defined?(Puma.cli_config)
       # Puma is running in single mode, so run both the initial instrumentation and
       # start the agent
       Puma::Runner.class_eval do
-        alias_method :original_start_server, :start_server
+        alias_method :tcell_original_start_server, :start_server
         def start_server
-          TCellAgent.thread_agent.start('Puma Single Mode')
+          TCellAgent.thread_agent.start('Puma')
 
-          original_start_server
+          tcell_original_start_server
         end
       end
 
     else
       Puma::Server.class_eval do
-        alias_method :original_run, :run
+        alias_method :tcell_original_run, :run
         def run(background = true)
           TCellAgent.thread_agent.start('Puma Cluster Mode (Worker)')
 
-          original_run(background)
+          tcell_original_run(background)
         end
       end
     end
@@ -28,11 +28,11 @@ if defined?(Puma.cli_config)
     # Instrumentation will run for each worker but there's
     # nothing we can do about that (Unicorn's preload_app behaves the same way)
     Puma::Server.class_eval do
-      alias_method :original_run, :run
+      alias_method :tcell_original_run, :run
       def run(background = true)
         TCellAgent.thread_agent.start('Puma Cluster Mode (Worker)')
 
-        original_run(background)
+        tcell_original_run(background)
       end
     end
   end

data/lib/tcell_agent/servers/rack_puma_handler.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+Rack::Handler::Puma.class_eval do
+  class << self
+    alias_method :tcell_original_config, :config
+    def config(app, options = {})
+      conf = tcell_original_config(app, options)
+
+      if defined?(Puma::Server) && !Puma::Server.instance_methods.include?(:tcell_original_run)
+        Puma::Server.class_eval do
+          alias_method :tcell_original_run, :run
+          def run(background = true)
+            TCellAgent.thread_agent.start('Puma')
+
+            tcell_original_run(background)
+          end
+        end
+      end
+
+      conf
+    end
+  end
+end

data/lib/tcell_agent/servers/rails_server.rb

@@ -5,17 +5,17 @@
 Rails::Server.class_eval do
   alias_method :tcell_build_app, :build_app
   def build_app(app)
+    require('tcell_agent/servers/rack_puma_handler') if defined?(Rack::Handler::Puma)
     require('tcell_agent/servers/unicorn') if defined?(Unicorn::HttpServer)
     require('tcell_agent/servers/webrick') if defined?(Rack::Handler::WEBrick)
     require('tcell_agent/servers/thin') if defined?(Thin::Server)
 
     if defined?(Puma::Server)
       Puma::Server.class_eval do
-        alias_method :original_run, :run
+        alias_method :tcell_original_run, :run
         def run(background = true)
-          TCellAgent.thread_agent.start('Puma Single Mode')
-
-          original_run(background)
+          TCellAgent.thread_agent.start('Puma')
+          tcell_original_run(background)
         end
       end
     end

data/lib/tcell_agent/servers/unicorn.rb

@@ -3,7 +3,7 @@ Unicorn::HttpServer.class_eval do
   # - This check also ensures that a server is running as opposed to a different command such
   # as `bundle exec rails runner User.count`.
   unless Unicorn::HttpServer::START_CTX && Unicorn::HttpServer::START_CTX[0]
-    require 'tcell_agent/rails/start_agent_after_initializers'
+    require 'tcell_agent/rails/railties/tcell_agent_unicorn_railties'
   end
 
   # This only gets instrumented when preload_app is true

data/lib/tcell_agent/servers/webrick.rb

@@ -3,7 +3,6 @@ Rack::Handler::WEBrick.class_eval do
     alias_method :original_run, :run
     def run(app, options = {})
       TCellAgent.thread_agent.start('WEBrick')
-
       original_run(app, options)
     end
   end