tcell_agent 1.1.12 → 2.2.0

data/spec/lib/tcell_agent/rails/routes/routes_spec.rb

@@ -17,9 +17,9 @@ module TCellAgent
     describe '.instrument_route' do
       context 'with a nil route' do
         it "shouldn't be reported" do
-          configuration = double('configuration', :enabled => true, :should_instrument? => true)
+          configuration = double('configuration', :should_instrument? => true)
 
-          expect(TCellAgent).to receive(:configuration).and_return(configuration).twice
+          expect(TCellAgent).to receive(:configuration).and_return(configuration)
           expect(TCellAgent::Instrumentation).to_not receive(:instrument_grape_api)
           expect(TCellAgent::SensorEvents::Util).to_not receive(:calculate_route_id)
 
@@ -33,7 +33,7 @@ module TCellAgent
             stub_const('::Rails::VERSION::MAJOR', 5)
             stub_const('::Rails::VERSION::MINOR', 0)
 
-            configuration = double('configuration', :enabled => true, :should_instrument? => true)
+            configuration = double('configuration', :should_instrument? => true)
             route = double(
               'route',
               :path => double('path', :spec => '/regular/route'),
@@ -41,7 +41,7 @@ module TCellAgent
               :app => double('app', :app => 'some_app')
             )
 
-            expect(TCellAgent).to receive(:configuration).and_return(configuration).twice
+            expect(TCellAgent).to receive(:configuration).and_return(configuration)
             expect(route).to receive(:verb).and_return('GET|POST').twice
             expect(TCellAgent::SensorEvents::AppRoutesSensorEvent).to receive(:new).with(
               '/regular/route', 'GET', '-1187510355', nil, '{}'
@@ -59,7 +59,7 @@ module TCellAgent
             stub_const('::Rails::VERSION::MAJOR', 5)
             stub_const('::Rails::VERSION::MINOR', 0)
 
-            configuration = double('configuration', :enabled => true, :should_instrument? => true)
+            configuration = double('configuration', :should_instrument? => true)
             route = double(
               'route',
               :path => double('path', :spec => '/grape'),
@@ -67,7 +67,7 @@ module TCellAgent
               :app => double('app', :app => GrapeRoute)
             )
 
-            expect(TCellAgent).to receive(:configuration).and_return(configuration).twice
+            expect(TCellAgent).to receive(:configuration).and_return(configuration)
             expect(route).to receive(:verb).and_return('GET|POST')
             expect(TCellAgent::SensorEvents::Util).to_not receive(:calculate_route_id)
             expect(TCellAgent::Instrumentation).to receive(:instrument_grape_api).with(
@@ -85,7 +85,7 @@ module TCellAgent
             stub_const('::Rails::VERSION::MAJOR', 4)
             stub_const('::Rails::VERSION::MINOR', 2)
 
-            configuration = double('configuration', :enabled => true, :should_instrument? => true)
+            configuration = double('configuration', :should_instrument? => true)
             route = double(
               'route',
               :path => double('path', :spec => '/regular/route'),
@@ -94,7 +94,7 @@ module TCellAgent
               :app => double('app', :app => 'some_app')
             )
 
-            expect(TCellAgent).to receive(:configuration).and_return(configuration).twice
+            expect(TCellAgent).to receive(:configuration).and_return(configuration)
             expect(TCellAgent::Instrumentation).to_not receive(:instrument_grape_api)
             expect(route).to receive(:verb).and_return(/DELETE/).at_least(9)
             expect(TCellAgent::SensorEvents::AppRoutesSensorEvent).to receive(:new).with(
@@ -110,7 +110,7 @@ module TCellAgent
             stub_const('::Rails::VERSION::MAJOR', 4)
             stub_const('::Rails::VERSION::MINOR', 2)
 
-            configuration = double('configuration', :enabled => true, :should_instrument? => true)
+            configuration = double('configuration', :should_instrument? => true)
             route = double(
               'route',
               :path => double('path', :spec => '/grape'),
@@ -119,7 +119,7 @@ module TCellAgent
               :app => double('app', :app => GrapeRoute)
             )
 
-            expect(TCellAgent).to receive(:configuration).and_return(configuration).twice
+            expect(TCellAgent).to receive(:configuration).and_return(configuration)
             expect(TCellAgent::Instrumentation).to receive(:instrument_grape_api).with(
               '/grape', ['/api/grape/route']
             )
@@ -136,7 +136,7 @@ module TCellAgent
             stub_const('::Rails::VERSION::MAJOR', 4)
             stub_const('::Rails::VERSION::MINOR', 1)
 
-            configuration = double('configuration', :enabled => true, :should_instrument? => true)
+            configuration = double('configuration', :should_instrument? => true)
             route = double(
               'route',
               :path => double('path', :spec => '/regular/route'),
@@ -145,7 +145,7 @@ module TCellAgent
               :app => 'some_app'
             )
 
-            expect(TCellAgent).to receive(:configuration).and_return(configuration).twice
+            expect(TCellAgent).to receive(:configuration).and_return(configuration)
             expect(TCellAgent::Instrumentation).to_not receive(:instrument_grape_api)
             expect(route).to receive(:verb).and_return(/PUT/).at_least(9)
             expect(TCellAgent::SensorEvents::AppRoutesSensorEvent).to receive(:new).with(
@@ -160,7 +160,7 @@ module TCellAgent
           it 'should instrument the grape endpoint' do
             stub_const('::Rails::VERSION::MAJOR', 4)
             stub_const('::Rails::VERSION::MINOR', 1)
-            configuration = double('configuration', :enabled => true, :should_instrument? => true)
+            configuration = double('configuration', :should_instrument? => true)
             route = double(
               'route',
               :path => double('path', :spec => '/grape'),
@@ -169,7 +169,7 @@ module TCellAgent
               :app => GrapeRoute
             )
 
-            expect(TCellAgent).to receive(:configuration).and_return(configuration).twice
+            expect(TCellAgent).to receive(:configuration).and_return(configuration)
             expect(TCellAgent::Instrumentation).to receive(:instrument_grape_api).with(
               '/grape', ['/api/grape/route']
             )

data/spec/lib/tcell_agent/rust/agent_config_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module TCellAgent
+  module Rust
+    describe AgentConfig do
+      context 'with initializers set' do
+        before do
+          TCellAgent.configure do |config|
+            config.app_id = 'initializer_app_id_set'
+            config.api_key = 'initializer_api_key_set'
+            config.enabled_instrumentations = { 'authlogic' => false, :devise => false, 'doorkeeper' => false }
+            config.hmac_key = config.app_id
+          end
+        end
+        it 'should return the correct values' do
+          config = AgentConfig.new(TCellAgent.initializer_configuration)
+
+          expect(config['agent_type']).to eq 'Ruby'
+          expect(config['overrides']['disabled_instrumentation']).to contain_exactly('authlogic', 'devise', 'doorkeeper')
+          expect(config['overrides']['applications'][0][:api_key]).to eq 'initializer_api_key_set'
+          expect(config['overrides']['applications'][0][:app_id]).to eq 'initializer_app_id_set'
+          expect(config['overrides']['applications'][0][:api_key]).to eq 'initializer_api_key_set'
+        end
+      end
+    end
+  end
+end

data/spec/lib/tcell_agent/sensor_events/util/sanitizer_utilities_spec.rb

@@ -17,41 +17,6 @@ module TCellAgent
             TCellAgent.configuration.hmac_key = old_hmac
           end
         end
-        context 'Parsing request cookies and replacing values' do
-          it 'Parsing regular uri without params' do
-            TCellAgent.configuration.app_id = nil
-            original_uri = 'http://foo.com/posts'
-            expect_santized_uri = 'http://foo.com/posts'
-            expect(Util.sanitize_uri(original_uri)).to eq(expect_santized_uri)
-          end
-          it 'Parsing regular uri with regular query string' do
-            TCellAgent.configuration.app_id = nil
-            original_uri = 'http://foo.com/posts?abcd'
-            expect_santized_uri = 'http://foo.com/posts?abcd='
-            expect(Util.sanitize_uri(original_uri)).to eq(expect_santized_uri)
-          end
-          it 'Parsing uri' do
-            TCellAgent.configuration.app_id = nil
-            original_uri = 'http://foo.com/posts?id=30&limit=5#time=1305298413'
-            expect_santized_uri = 'http://foo.com/posts?id=61aa3630ced0e67b63a1c61e3b86f4d3&limit=89abb06a7bf0401b5911e61b68660c24#time=1305298413'
-            expect(Util.sanitize_uri(original_uri)).to eq(expect_santized_uri)
-          end
-          it 'returns an empty set' do
-            TCellAgent.configuration.app_id = nil
-            expect(Util.santize_request_cookie_string('ABC')).to eq('')
-            expect(Util.santize_request_cookie_string('abcd=')).to match('')
-          end
-          it 'parses a cookie' do
-            TCellAgent.configuration.app_id = nil
-            expect(Util.santize_request_cookie_string('x=y;z=a')).to eq('x=97cb9e2aa3ec93888b356dbcf13b280e;z=566c1a1c12ad909d628d4537e10773bf')
-          end
-        end
-        context 'Parsing a response set-cookie and replacing values' do
-          it 'sanitize a typical response set-cookie value' do
-            santized_string = Util.santize_response_cookie_string('name=Nicholas; expires=Sat, 02 May 2009 23:38:25 GMT; httponly')
-            expect(santized_string).to eq('name=beb56c04cdd764f6b7cbe6c078236aeb=; expires=Sat, 02 May 2009 23:38:25 GMT=; httponly=')
-          end
-        end
       end
     end
   end

data/spec/lib/tcell_agent/settings_reporter_spec.rb

@@ -1,162 +1,63 @@
+require 'spec_helper'
+
 module TCellAgent
   describe '.report_settings' do
     require 'tcell_agent/settings_reporter'
 
-    context 'with send_startup_events=false' do
-      it 'should not report anything' do
-        expect(TCellAgent).to_not receive(:configuration)
-        expect(TCellAgent).to_not receive(:send_event)
-
-        TCellAgent.report_settings(false)
-      end
-    end
-
-    context 'with send_startup_events=true' do
-      context 'should_instrument?=false' do
-        it 'should not report anything' do
-          configuration = double('configuration',
-                                 :should_instrument? => false)
-
-          expect(TCellAgent).to receive(:configuration).and_return(
-            configuration
-          )
-          expect(TCellAgent).to_not receive(:send_event)
-
-          TCellAgent.report_settings(true)
-        end
-      end
-
-      context 'should_instrument?=true' do
-        it 'should not report all the settings' do
-          logger = double('logger')
-          configuration = double('configuration',
-                                 :enabled => true,
-                                 :should_instrument? => true,
-                                 :logger => logger,
-                                 :allow_payloads => true,
-                                 :reverse_proxy => true,
-                                 :reverse_proxy_ip_address_header => nil,
-                                 :log_filename => 'log-filename',
-                                 :config_filename => 'config-filename',
-                                 :agent_log_dir => 'agent-log-dir',
-                                 :agent_home_dir => 'agent-home-dir',
-                                 :agent_home_owner => nil,
-                                 :logging_options => {
-                                 },
-                                 :hmac_key => nil)
-
-          expect(TCellAgent).to receive(:configuration).and_return(
-            configuration
-          ).at_least(:once)
-          expect(TCellAgent).to receive(:logger).and_return(logger).at_least(:once)
-          expect(Thread).to receive(:new).and_yield
-          expect(logger).to receive(:debug).with('User unknown')
-          expect(logger).to receive(:debug).with('Group unknown')
-          expect(TCellAgent).to receive(:send_event).with(
-            {
-              'event_type' => 'server_agent_details',
-              'user' => 'unknown',
-              'group' => 'unknown'
-            }
-          )
-          expect(logger).to receive(:debug).with(anything).at_least(:once)
-          expect(TCellAgent).to receive(:send_event).with(
-            hash_including('event_type' => 'server_agent_packages')
-          ) # packages event
-          expect(TCellAgent).to receive(:send_event).with(
-            {
-              'event_type' => 'app_config_setting',
-              'package' => 'tcell',
-              'section' => 'config',
-              'name' => 'native_lib_loaded',
-              'value' => 'true'
-            }
-          )
-          expect(TCellAgent).to receive(:send_event).with(
-            {
-              'event_type' => 'app_config_setting',
-              'package' => 'tcell',
-              'section' => 'config',
-              'name' => 'allow_payloads',
-              'value' => 'true'
-            }
-          )
-          expect(TCellAgent).to receive(:send_event).with(
-            {
-              'event_type' => 'app_config_setting',
-              'package' => 'tcell',
-              'section' => 'config',
-              'name' => 'reverse_proxy',
-              'value' => 'true'
-            }
-          )
-          expect(TCellAgent).to receive(:send_event).with(
-            {
-              'event_type' => 'app_config_setting',
-              'package' => 'tcell',
-              'section' => 'config',
-              'name' => 'config_filename',
-              'value' => 'config-filename'
-            }
-          )
-          expect(TCellAgent).to receive(:send_event).with(
-            {
-              'event_type' => 'app_config_setting',
-              'package' => 'tcell',
-              'section' => 'config',
-              'name' => 'logging_directory',
-              'value' => 'agent-log-dir'
-            }
-          )
-          expect(TCellAgent).to receive(:send_event).with(
-            {
-              'event_type' => 'app_config_setting',
-              'package' => 'tcell',
-              'section' => 'config',
-              'name' => 'agent_home_directory',
-              'value' => 'agent-home-dir'
-            }
-          )
-          expect(TCellAgent).to receive(:send_event).with(
-            {
-              'event_type' => 'app_config_setting',
-              'package' => 'tcell',
-              'section' => 'config',
-              'name' => 'agent_home_owner',
-              'value' => ''
-            }
-          )
-          expect(TCellAgent).to receive(:send_event).with(
-            {
-              'event_type' => 'app_config_setting',
-              'package' => 'tcell',
-              'section' => 'config',
-              'name' => 'logging_enabled',
-              'value' => 'true'
-            }
-          )
-          expect(TCellAgent).to receive(:send_event).with(
-            {
-              'event_type' => 'app_config_setting',
-              'package' => 'tcell',
-              'section' => 'config',
-              'name' => 'logging_level',
-              'value' => 'INFO'
-            }
-          )
-          expect(TCellAgent).to receive(:send_event).with(
-            {
-              'event_type' => 'app_config_setting',
-              'package' => 'tcell',
-              'section' => 'config',
-              'name' => 'reverse_proxy_ip_address_header',
-              'value' => ''
-            }
-          )
-
-          TCellAgent.report_settings(true)
-        end
-      end
+    it 'should not report all the settings' do
+      logger = double('logger')
+      configuration = double('configuration',
+                             :enabled => true,
+                             :should_instrument? => true,
+                             :logger => logger,
+                             :allow_payloads => true,
+                             :reverse_proxy => true,
+                             :reverse_proxy_ip_address_header => nil,
+                             :log_filename => 'log-filename',
+                             :agent_log_dir => 'agent-log-dir',
+                             :agent_home_dir => 'agent-home-dir',
+                             :agent_home_owner => nil,
+                             :log_tag => nil,
+                             :logging_options => {
+                             },
+                             :hmac_key => nil)
+
+      expect(TCellAgent).to receive(:configuration).and_return(
+        configuration
+      ).at_least(:once)
+      expect(TCellAgent).to receive(:logger).and_return(logger).at_least(:once)
+      expect(Thread).to receive(:new).and_yield
+      expect(logger).to receive(:debug).with('TCellAgent::SensorEvents::ServerAgentDetailsSensorEvent', 'User unknown')
+      expect(logger).to receive(:debug).with('TCellAgent::SensorEvents::ServerAgentDetailsSensorEvent', 'Group unknown')
+      expect(TCellAgent).to receive(:send_event).with(
+        {
+          'event_type' => 'server_agent_details',
+          'user' => 'unknown',
+          'group' => 'unknown'
+        }
+      )
+      expect(logger).to receive(:debug).with(anything, anything).at_least(:once)
+      expect(TCellAgent).to receive(:send_event).with(
+        hash_including('event_type' => 'server_agent_packages')
+      ) # packages event
+      expect(TCellAgent).to receive(:send_event).with(
+        {
+          'event_type' => 'server_agent_details',
+          'language' => 'Ruby',
+          'language_version' => RUBY_VERSION
+        }
+      )
+      expect(TCellAgent).to receive(:send_event).with(
+        {
+          'event_type' => 'app_config_setting',
+          'package' => 'tcell',
+          'section' => 'config',
+          'name' => 'native_lib_loaded',
+          'value' => 'true'
+        }
+      )
+
+      TCellAgent.report_settings
     end
   end
 end

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ require 'rspec'
 require 'rails'
 require 'webmock/rspec'
 require 'fork_break'
+require 'rack/request'
 
 if ENV['COVERAGE']
   require 'simplecov'
@@ -10,7 +11,6 @@ end
 
 ENV['TCELL_AGENT_SERVER'] = 'mock'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'tcell_agent')
-require File.join(File.dirname(__FILE__), '..', 'lib', 'tcell_agent', 'rails') if defined?(Rails)
 
 Dir[File.join(File.dirname(__FILE__), 'support', '**', '*.rb')].each { |f| require f }
 

data/spec/support/builders.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+require 'tcell_agent/config_initializer'
+
+module TCellAgent
+  module Tests
+    class ConfigurationBuilder
+      def initialize
+        @configuration = TCellAgent::ConfigInitializer.new
+        @configuration.fetch_policies_from_tcell = false
+        @configuration.max_csp_header_bytes = nil
+        @configuration.app_id = 'TestAppId-AppId'
+        @configuration.api_key = 'TestAppId-AppId'
+        @configuration.tcell_api_url = 'https://api.tcell-preview.io/agents/api/v1'
+        @configuration.tcell_input_url = 'https://input.tcell-preview.io/api/v1'
+        @configuration.hmac_key = nil
+        @configuration.password_hmac_key = nil
+        @configuration.allow_payloads = true
+        @configuration.js_agent_api_base_url = @configuration.tcell_api_url
+        @configuration.js_agent_url = 'https://jsagent.tcell.io/tcellagent.min.js'
+        @configuration.cache_dir = nil
+        @configuration.agent_log_dir = 'tcell/logs'
+        @configuration.logging_options = { :enabled => false }
+        @configuration.host_identifier = 'python-test-suite'
+        @configuration.reverse_proxy_ip_address_header = 'X-Forwarded-For'
+      end
+
+      def update_attribute(attribute, setting)
+        @configuration.send("#{attribute}=", setting)
+
+        self
+      end
+
+      def build
+        @configuration
+      end
+    end
+
+    class TCellContextBuilder
+      def initialize
+        @tcell_context = TCellAgent::Instrumentation::TCellData.new
+        @tcell_context.session_id = 'session-id'
+        @tcell_context.user_id = 'user-id'
+        @tcell_context.user_agent = 'user-agent'
+        @tcell_context.remote_address = '127.0.0.1'
+        @tcell_context.transaction_id = nil
+        @tcell_context.route_id = 'route-id'
+        @tcell_context.path = '/some/path'
+        @tcell_context.fullpath = '/some/path?hide-my-value=sensitive'
+        @tcell_context.uri = 'http://domain.com/some/path?hide-my-value=sensitive'
+        @tcell_context.patches_blocking_triggered = false
+        @tcell_context.request_method = 'GET'
+        @tcell_context.referrer = 'http://domain.com/home?_utm=some-value'
+      end
+
+      def update_attribute(attribute, setting)
+        @tcell_context.send("#{attribute}=", setting)
+
+        self
+      end
+
+      def build
+        @tcell_context
+      end
+    end
+
+    class MetaDataBuilder
+      def initialize
+        @meta_data = TCellAgent::MetaData.new(
+          'GET',
+          '127.0.0.1',
+          'route-id',
+          'session-id',
+          'user-id',
+          SecureRandom.uuid,
+          'http://domain.com/some/path?hide-my-value=sensitive'
+        )
+
+        @meta_data.path = '/some/path'
+        @meta_data.request_content_bytes_len = 0
+        @meta_data.response_content_bytes_len = 0
+        @meta_data.response_code = 0
+        @meta_data.user_agent = 'user-agent'
+        @meta_data.get_dict = {}
+        @meta_data.cookie_dict = {}
+        @meta_data.headers_dict = {}
+        @meta_data.post_dict = {}
+        @meta_data.path_parameters = {}
+        request = Rack::Request.new({ 'CONTENT_TYPE' => 'text/html', 'rack.input' => {} })
+        @meta_data.set_parameter_dicts(request)
+      end
+
+      def update_attribute(attribute, setting)
+        @meta_data.send("#{attribute}=", setting)
+
+        self
+      end
+
+      def build
+        @meta_data
+      end
+    end
+  end
+end