tcell_agent 2.0.0 → 2.5.0

data/spec/lib/tcell_agent/rails/better_ip_spec.rb

@@ -4,37 +4,34 @@ module TCellAgent
   module Utils
     describe '.better_ip' do
       context 'with reverse_proxy off' do
-        it 'should return the normal ip' do
+        it 'returns null' do
           configuration = double('configuration')
           request = double('request', :ip => '127.0.0.0')
 
           expect(TCellAgent).to receive(:configuration).and_return(configuration)
           expect(configuration).to receive(:reverse_proxy).and_return(false)
-          expect(Rails.better_ip(request)).to eq('127.0.0.0')
+          expect(Rails.reverse_proxy_header(request)).to eq(nil)
         end
       end
 
       context 'with reverse_proxy on' do
         context 'with empty reverse_proxy_ip_address_header' do
-          it 'should return normal ip' do
+          it 'returns null' do
             configuration = double('configuration')
             request = double('request', :ip => '127.0.0.0')
-            env = double('env')
 
             expect(TCellAgent).to receive(:configuration).and_return(configuration)
             expect(configuration).to receive(:reverse_proxy).and_return(true)
             expect(TCellAgent).to receive(:configuration).and_return(configuration)
             expect(configuration).to receive(:reverse_proxy_ip_address_header).and_return('')
-            expect(request).to receive(:env).and_return(env)
-            expect(env).to receive(:[]).with('HTTP_X_FORWARDED_FOR').and_return('')
-            expect(Rails.better_ip(request)).to eq('127.0.0.0')
+            expect(Rails.reverse_proxy_header(request)).to eq(nil)
           end
         end
 
         context "with reverse_proxy_ip_address_header that doesn't exist" do
-          it 'should return normal ip' do
+          it 'returns null' do
             configuration = double('configuration')
-            request = double('request', :ip => '127.0.0.0')
+            request = double('request', :ip => '127.0.0.0', :env => {})
             env = double('env')
 
             expect(TCellAgent).to receive(:configuration).and_return(configuration)
@@ -45,7 +42,7 @@ module TCellAgent
             )
             expect(request).to receive(:env).and_return(env)
             expect(env).to receive(:[]).with('HTTP_WEIRD_HTTP_PROXY_HEADER').and_return(nil)
-            expect(Rails.better_ip(request)).to eq('127.0.0.0')
+            expect(Rails.reverse_proxy_header(request)).to eq(nil)
           end
         end
 
@@ -57,13 +54,14 @@ module TCellAgent
 
             expect(TCellAgent).to receive(:configuration).and_return(configuration)
             expect(configuration).to receive(:reverse_proxy).and_return(true)
+
             expect(TCellAgent).to receive(:configuration).and_return(configuration)
             expect(configuration).to receive(:reverse_proxy_ip_address_header).and_return(
               'X-Real-IP'
             )
             expect(request).to receive(:env).and_return(env)
             expect(env).to receive(:[]).with('HTTP_X_REAL_IP').and_return('192.168.99.100')
-            expect(Rails.better_ip(request)).to eq('192.168.99.100')
+            expect(Rails.reverse_proxy_header(request)).to eq('192.168.99.100')
           end
         end
       end

data/spec/lib/tcell_agent/rails/csrf_exception_spec.rb

@@ -1,13 +1,13 @@
 require 'spec_helper'
 
-module TCellAgent
-  describe 'CsrfExceptionReporter' do
-    class WrapperClass
-      include TCellAgent::CsrfExceptionReporter
+class WrapperClass
+  include TCellAgent::CsrfExceptionReporter
 
-      def request; end
-    end
+  def request; end
+end
 
+module TCellAgent
+  describe 'CsrfExceptionReporter' do
     before(:all) do
       @csrf_class = WrapperClass.new
     end

data/spec/lib/tcell_agent/rails/dlp_spec.rb

@@ -4,6 +4,7 @@ module TCellAgent
   module DLP
     class SomeColumn
       attr_accessor :name
+
       def initialize(name = nil)
         @name = name
       end

data/spec/lib/tcell_agent/rails/js_agent_insert_spec.rb

@@ -127,10 +127,10 @@ module TCellAgent
         end
 
         context 'with a <HEAD> tag' do
-          it 'should not append script after <HEAD> tag' do
+          it 'should append script after <HEAD> tag' do
             response = JSAgent.handle_js_agent_insert('SCRIPT', 'i am the <HEAD> response')
 
-            expect(response).to eq('i am the <HEAD> response')
+            expect(response).to eq('i am the <HEAD>SCRIPT response')
           end
         end
 
@@ -142,6 +142,14 @@ module TCellAgent
           end
         end
 
+        context 'with a <HEAD\n> tag' do
+          it 'should append script after <HEAD\n> tag' do
+            response = JSAgent.handle_js_agent_insert('SCRIPT', "i am the <HEAD\n> response")
+
+            expect(response).to eq("i am the <HEAD\n>SCRIPT response")
+          end
+        end
+
         context 'with invalid parameters' do
           context 'with nil response' do
             it 'should return the unmodified response' do

data/spec/lib/tcell_agent/rails/middleware/tcell_body_proxy_spec.rb

@@ -13,7 +13,8 @@ module TCellAgent
               'session_id',
               'user_id',
               'transaction_id',
-              'http://test.com/'
+              'http://test.com/',
+              '0.0.0.0'
             )
           end
 

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

@@ -3,7 +3,7 @@ require 'spec_helper'
 module TCellAgent
   module Instrumentation
     describe RouteId do
-      TCELL_CONTEXT_KEY = TCellAgent::Instrumentation::TCELL_ID
+      tcell_context_key = TCellAgent::Instrumentation::TCELL_ID
 
       describe '.update_context' do
         context 'with nil route' do
@@ -11,7 +11,7 @@ module TCellAgent
             tcell_context = TCellData.new
             tcell_context.route_id = nil
 
-            RouteId.update_context({ TCELL_CONTEXT_KEY => tcell_context }, {}, nil)
+            RouteId.update_context({ tcell_context_key => tcell_context }, {}, nil)
 
             expect(tcell_context.route_id).to eq(nil)
             expect(tcell_context.grape_mount_endpoint).to eq(nil)
@@ -41,7 +41,7 @@ module TCellAgent
 
             expect(TCellAgent::Instrumentation).to receive(:grape_route?).with(route).and_return(false)
 
-            RouteId.update_context({ TCELL_CONTEXT_KEY => tcell_context }, { :id => 1 }, route)
+            RouteId.update_context({ tcell_context_key => tcell_context }, { :id => 1 }, route)
 
             expect(tcell_context.route_id).to eq(
               TCellAgent::SensorEvents::Util.calculate_route_id('GET', '/some/regular/path')
@@ -64,7 +64,7 @@ module TCellAgent
 
             expect(TCellAgent::Instrumentation).to receive(:grape_route?).with(route).and_return(true)
 
-            RouteId.update_context({ TCELL_CONTEXT_KEY => tcell_context }, { :id => 1 }, route)
+            RouteId.update_context({ tcell_context_key => tcell_context }, { :id => 1 }, route)
 
             expect(tcell_context.route_id).to eq(nil)
             expect(tcell_context.grape_mount_endpoint).to eq('/grape_api')

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/settings_reporter_spec.rb

@@ -14,7 +14,6 @@ module TCellAgent
                              :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,
@@ -28,26 +27,12 @@ module TCellAgent
       ).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',
@@ -57,78 +42,6 @@ module TCellAgent
           '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' => '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
     end

data/spec/lib/tcell_agent/tcell_context_spec.rb

@@ -4,9 +4,9 @@ module TCellAgent
   describe MetaData do
     describe '#set_headers_dict' do
       it 'should set all headers that start with http and skip cookies' do
-        method = remote_address = route_id = session_id = user_id = transaction_id = location = nil
+        method = remote_address = route_id = session_id = user_id = transaction_id = location = reverse_proxy_header_value = nil
 
-        meta = MetaData.new(method, remote_address, route_id, session_id, user_id, transaction_id, location)
+        meta = MetaData.new(method, remote_address, route_id, session_id, user_id, transaction_id, location, reverse_proxy_header_value)
         meta.headers_dict = {
           'rack.version' => [1, 2],
           'REQUEST_METHOD' => 'POST',
@@ -24,9 +24,9 @@ module TCellAgent
       end
 
       it 'should set all headers that start with http and include content_length and content_type' do
-        method = remote_address = route_id = session_id = user_id = transaction_id = location = nil
+        method = remote_address = route_id = session_id = user_id = transaction_id = location = reverse_proxy_header_value = nil
 
-        meta = MetaData.new(method, remote_address, route_id, session_id, user_id, transaction_id, location)
+        meta = MetaData.new(method, remote_address, route_id, session_id, user_id, transaction_id, location, reverse_proxy_header_value)
         meta.headers_dict = {
           'REQUEST_METHOD' => 'POST',
           'HTTP_VERSION' => 'HTTP/1.1',
@@ -71,7 +71,8 @@ module TCellAgent
           'session_id',
           'user_id',
           'transaction_id',
-          'http://test.com'
+          'http://test.com',
+          '0.0.0.0'
         )
       end
 

data/spec/spec_helper.rb

@@ -12,11 +12,19 @@ end
 ENV['TCELL_AGENT_SERVER'] = 'mock'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'tcell_agent')
 
-Dir[File.join(File.dirname(__FILE__), 'support', '**', '*.rb')].each { |f| require f }
+Dir[File.join(File.dirname(__FILE__), 'support', '**', '*.rb')].sort.each { |f| require f }
 
 def get_test_resource_path(name)
   File.join(File.dirname(__FILE__), 'support', 'resources', name)
 end
 
+NEW_FILE_NAME ||= "/tmp/#{SecureRandom.uuid}".freeze
+
 require 'tcell_agent/agent'
 require 'tcell_agent/rails/routes'
+
+TCellAgent.configuration.enabled = true
+TCellAgent.configuration.instrument = true
+TCellAgent.configuration.enable_intercept_requests = true
+TCellAgent.configuration.disabled_instrumentation = []
+TCellAgent.thread_agent.instrument_built_ins

data/spec/support/builders.rb

@@ -1,12 +1,11 @@
 require 'spec_helper'
+require 'tcell_agent/config_initializer'
+
 module TCellAgent
   module Tests
     class ConfigurationBuilder
       def initialize
-        @configuration = TCellAgent::Configuration.new
-        @configuration.config_filename = 'tcell_agent.config'
-        @configuration.demomode = false
-        @configuration.enable_event_manager = false
+        @configuration = TCellAgent::ConfigInitializer.new
         @configuration.fetch_policies_from_tcell = false
         @configuration.max_csp_header_bytes = nil
         @configuration.app_id = 'TestAppId-AppId'
@@ -18,11 +17,12 @@ module TCellAgent
         @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_folder = nil
         @configuration.agent_log_dir = 'tcell/logs'
-        @configuration.logging_options = { 'enabled' => false }
+        @configuration.logging_options = { :enabled => false }
         @configuration.host_identifier = 'python-test-suite'
         @configuration.reverse_proxy_ip_address_header = 'X-Forwarded-For'
+        @configuration.enable_intercept_requests = true
+        @configuration.enabled = true
       end
 
       def update_attribute(attribute, setting)
@@ -73,7 +73,8 @@ module TCellAgent
           'session-id',
           'user-id',
           SecureRandom.uuid,
-          'http://domain.com/some/path?hide-my-value=sensitive'
+          'http://domain.com/some/path?hide-my-value=sensitive',
+          '0.0.0.0'
         )
 
         @meta_data.path = '/some/path'

data/spec/support/server_mocks/passenger_mock.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module PhusionPassenger
+  module LoaderSharedHelpers
+    def before_handling_requests; end
+  end
+end

data/spec/support/server_mocks/puma_mock.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Puma
+  class Server
+    def run; end
+  end
+
+  class Config
+    def self.options
+      {}
+    end
+  end
+
+  def self.cli_config
+    Config
+  end
+
+  module Const
+    PUMA_VERSION = '5.1.0'
+  end
+end

data/spec/support/server_mocks/rails_mock.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rails
+  module Server
+    def build_app; end
+  end
+end

data/spec/support/server_mocks/thin_mock.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Thin
+  module Server
+    def start; end
+  end
+end

data/spec/support/server_mocks/unicorn_mock.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Unicorn
+  class HttpServer
+    START_CTX = {}.freeze
+
+    def init_worker_process; end
+
+    def load_config!; end
+  end
+end

data/spec/support/shared_spec.rb

@@ -0,0 +1,29 @@
+def test_ruby2_ruby3_keywords(cls, func, args, options, res, min_ruby = '2.0.0')
+  ruby_version = Gem::Version.new(RUBY_VERSION)
+
+  context 'using ruby2_3 helper function' do
+    after(:each) do
+      expect(@result).to eq res unless res.nil?
+    end
+
+    if ruby_version >= Gem::Version.new(min_ruby) && \
+       ruby_version < Gem::Version.new('3.0.0')
+      # This spec tests the following format:
+      #   File.new('/dev/null', 'w', 0o644, { :binmode => true })
+      it 'behaves correctly in ruby < 2.7' do
+        args_cp = Array.new(args)
+        args_cp << options
+
+        @result = cls.send(func, *args_cp)
+      end
+    end
+
+    if ruby_version >= Gem::Version.new(min_ruby)
+      # This spec tests the following format:
+      #   File.new('/dev/null', 'w', 0o644, :binmode => true )
+      it 'behaves correctly in ruby >= 3.0' do
+        @result = cls.send(func, *args, **options)
+      end
+    end
+  end
+end

data/tcell_agent.gemspec

@@ -6,23 +6,23 @@ require 'tcell_agent/version'
 Gem::Specification.new do |spec|
   spec.name          = 'tcell_agent'
   spec.version       = TCellAgent::VERSION
-  spec.authors       = %w[Rafael]
-  spec.email         = ['rafael@tcell.io']
-  spec.summary       = 'tCell.io Agent for Rails'
-  spec.description   = 'This agent allows users to use the tCell.io service with their Rails app.'
-  spec.homepage      = 'https://www.tcell.io'
-  spec.license       = 'Copyright (c) 2017 tCell.io (see LICENSE file)'
+  spec.authors       = 'Rapid7, Inc.'
+  spec.summary       = 'tCell Agent for Rails'
+  spec.description   = 'This agent allows users to use the tCell service with their Rails app.'
+  spec.homepage      = 'https://www.rapid7.com/tcell'
+  spec.license       = 'Copyright (c) 2020 Rapid7, Inc. (see LICENSE file)'
 
   spec.files = Dir[
-    'Rakefile',
+    'README.md',
+    'LICENSE',
+    'tcell_agent.gemspec',
+    'spec/**/*',
     'lib/tcell_agent.rb',
-    '{lib/tcell_agent,spec}/**/*',
-    'lib/tcell_agent/rust/libtcellagent-*.so',
-    'lib/tcell_agent/rust/libtcellagent-*.dylib',
-    'lib/tcell_agent/rust/tcellagent-*.dll',
-    'README*',
-    'LICENSE*',
-    'tcell_agent.gemspec'
+    'lib/tcell_agent/**/*rb',
+    'lib/tcell_agent/rust/libtcellagent.dylib',
+    'lib/tcell_agent/rust/libtcellagent.so',
+    'lib/tcell_agent/rust/libtcellagent-alpine.so',
+    'lib/tcell_agent/rust/libtcellagent-x64.dll',
   ]
   spec.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})