logjam_agent 0.38.2 → 0.38.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 623b528c086e5359f9824c6ed231207340d9abc8fb1046f2763200404e9c3ee9
-  data.tar.gz: 0d7de9ffac6e355314388c15c9e6fb0d18f1c5ad723dce7c9b19ef64a864fa1c
+  metadata.gz: 40a7fc87817d5d47fd6ec90066a0f383436cb25f3f50ee835c0372c2a7f895e2
+  data.tar.gz: c5a89ddd87c4cc14191d9c69a16c3a0a91790ef8cbc513e35635b30f4a0a2c93
 SHA512:
-  metadata.gz: 24d13d8931fc1a3ff1ec13a0617f941798719ccb9cec724d2934f0b80fc7365027029996b867194b60d780589fbfc7b8f391102d16cca28b7b9a5f6fda2668ae
-  data.tar.gz: c130018a95950bb0dfe32afe866f9ce891685ed37edd845b96f76fbe0c97b869bbcb08ba185a9b7f028b3eb9ff98a0a2a7f360a4292efcdb6d840b01a0e0c29e
+  metadata.gz: 239cf4fda9b20bf22e65d5d7454f642f453cf34b4e5f4adcade67d7dae2233d6e596c35f70fbd9a9f4c68cf4f2e847a80a7f310002719d5f9a9852633f8cfe95
+  data.tar.gz: d376a763eee26ec914c930afeb9379119c2f4a6b03e28aa45d1ff8110f5119f4974dc899054f952d647141db84f70e37620312ef29887b00ea3eb2bffe284723

data/lib/logjam_agent/obfuscation.rb

@@ -0,0 +1,44 @@
+module LogjamAgent
+  module Obfuscation
+
+    mattr_accessor :obfuscate_ips
+    self.obfuscate_ips = false
+
+    # TODO: ipv6 obfuscation
+    def ip_obfuscator(ip)
+      obfuscate_ips ? ip.to_s.sub(/\d+\z/, 'XXX') : ip
+    end
+
+    mattr_accessor :obfuscated_cookies
+    self.obfuscated_cookies = [/_session\z/]
+
+    def cookie_obfuscator
+      @cookie_obfuscator ||= ParameterFilter.new(obfuscated_cookies)
+    end
+
+    def obfuscate_cookie(cookie, filter = cookie_obfuscator)
+      filter_pairs(cookie, filter)
+    end
+
+    begin
+      # rails 6.1 and higher
+      require "active_support/parameter_filter"
+      ParameterFilter = ::ActiveSupport::ParameterFilter
+    rescue LoadError
+      # rails 6.0 and older
+      require "action_dispatch/http/parameter_filter"
+      ParameterFilter = ::ActionDispatch::Http::ParameterFilter
+    end
+
+    KEY_RE = '[^&;=\s]+'
+    VAL_RE = '[^&;=]+'
+    PAIR_RE = %r{(#{KEY_RE})=(#{VAL_RE})}
+
+    def filter_pairs(str, filter)
+      str.gsub(PAIR_RE) do |_|
+        filter.filter($1 => $2).first.join("=")
+      end
+    end
+
+  end
+end

data/lib/logjam_agent/rack/logger.rb

@@ -216,8 +216,7 @@ module LogjamAgent
       CONTENT_LENGTH = 'CONTENT_LENGTH'
       COOKIE = 'HTTP_COOKIE'
 
-      KV_RE   = '[^&;=]+'
-      PAIR_RE = %r{(#{KV_RE})=(#{KV_RE})}
+      include Obfuscation
 
       def extract_headers(request, filter)
         headers = request.env.reject{|k,v| k =~ HIDDEN_VARIABLES }
@@ -225,15 +224,11 @@ module LogjamAgent
         headers = filter.filter(headers)
 
         if referer = headers[REFERER]
-          headers[REFERER] = referer.gsub(PAIR_RE) do |_|
-            filter.filter($1 => $2).first.join("=")
-          end
+          headers[REFERER] = filter_pairs(referer, filter)
         end
 
-        if (cookie = headers[COOKIE]) && LogjamAgent.obfuscated_cookies.present?
-          headers[COOKIE] = cookie.gsub(PAIR_RE) do |_|
-            LogjamAgent.cookie_obfuscator.filter($1 => $2).first.join("=")
-          end
+        if (cookie = headers[COOKIE]) && obfuscated_cookies.present?
+          headers[COOKIE] = obfuscate_cookie(cookie, cookie_obfuscator)
         end
 
         headers.keys.each do |k|

data/lib/logjam_agent/version.rb

@@ -1,3 +1,3 @@
 module LogjamAgent
-  VERSION = "0.38.2"
+  VERSION = "0.38.4"
 end

data/lib/logjam_agent.rb

@@ -10,6 +10,7 @@ end
 
 require "logjam_agent/version"
 require "logjam_agent/util"
+require "logjam_agent/obfuscation"
 require "logjam_agent/zmq_forwarder"
 require "logjam_agent/forwarders"
 require "logjam_agent/request"
@@ -77,26 +78,7 @@ module LogjamAgent
   mattr_accessor :ensure_ping_at_exit
   self.ensure_ping_at_exit = true
 
-  mattr_accessor :obfuscate_ips
-  self.obfuscate_ips = false
-
-  # TODO: ipv6 obfuscation
-  def self.ip_obfuscator(ip)
-    obfuscate_ips ? ip.to_s.sub(/\d+\z/, 'XXX') : ip
-  end
-
-  mattr_accessor :obfuscated_cookies
-  self.obfuscated_cookies = [/_session\z/]
-
-  def self.cookie_obfuscator
-    @cookie_obfuscator ||=
-      if defined?(ActiveSupport::ParameterFilter)
-        ActiveSupport::ParameterFilter.new(obfuscated_cookies)
-      else
-        ActionDispatch::Http::ParameterFilter.new(obfuscated_cookies)
-      end
-  end
-
+  extend Obfuscation
   extend RequestHandling
   extend SelectiveLogging
 

data/test/obfuscator_test.rb

@@ -0,0 +1,27 @@
+require_relative "test_helper.rb"
+
+module LogjamAgent
+  class ObfuscatorTest < MiniTest::Test
+    include Obfuscation
+
+    test "obfuscates session cookie by default" do
+      assert_equal "_session=[FILTERED]", obfuscate_cookie("_session=data")
+      assert_equal "my_session=[FILTERED]", obfuscate_cookie("my_session=mdata")
+      assert_equal "blabber=1; _session=[FILTERED]", obfuscate_cookie("blabber=1; _session=data")
+      assert_equal "blabber=1; _session=[FILTERED]; blubber=2", obfuscate_cookie("blabber=1; _session=data; blubber=2")
+    end
+
+    test "obfuscates with complex regex" do
+      filter = ParameterFilter.new([/(login|_session)\z/])
+      assert_equal "_session=[FILTERED]; login=[FILTERED]",  obfuscate_cookie("_session=my_session; login=foo", filter)
+      assert_equal "_session=[FILTERED]; my_login=[FILTERED]",  obfuscate_cookie("_session=my_session; my_login=foo", filter)
+    end
+
+    test "obfuscates with exact matches" do
+      filter = ParameterFilter.new([/\A(login|.*_session)\z/])
+      assert_equal "_session=[FILTERED]; login=[FILTERED]",  obfuscate_cookie("_session=my_session; login=foo", filter)
+      assert_equal "_session=[FILTERED]; my_login=foo",  obfuscate_cookie("_session=my_session; my_login=foo", filter)
+      assert_equal "my_session=[FILTERED]; my_login=foo",  obfuscate_cookie("my_session=my_session; my_login=foo", filter)
+    end
+  end
+end

data/test/sinatra_app.rb

@@ -1,12 +1,15 @@
 $:.unshift File.expand_path('../../lib', __FILE__)
 
 require 'logjam_agent/sinatra'
+require 'sinatra/cookies'
 
 class SinatraTestApp < Sinatra::Base
   register LogjamAgent::Sinatra
 
   use LogjamAgent::Sinatra::Middleware
 
+  helpers Sinatra::Cookies
+
   configure do
     set :root, File.expand_path('../..', __FILE__)
     set :environment, :test
@@ -24,6 +27,8 @@ class SinatraTestApp < Sinatra::Base
   end
 
   get '/index' do
+    cookies[:foo] = 'bar'
+    cookies[:frerks] = "no micro"
     logger.info 'Hello World!'
     'Hello World!'
   end

data/test/sinatra_classic_app.rb

@@ -1,6 +1,7 @@
 $:.unshift File.expand_path('../../lib', __FILE__)
 
 require 'logjam_agent/sinatra'
+require 'sinatra/cookies'
 
 use LogjamAgent::Sinatra::Middleware
 
@@ -27,5 +28,7 @@ end
 get '/index' do
   action_name "Simple#index"
   logger.info 'Hello World!'
+  cookies[:foo] = 'bar'
+  cookies[:frerks] = "no micro"
   'Hello World!'
 end

data/test/sinatra_classic_test.rb

@@ -12,7 +12,10 @@ module LogjamAgent
     end
 
     def test_root
-      get '/index?mumu=1&password=5'
+      cookie_jar = ::Rack::Test::CookieJar.new
+      cookie_jar['foo'] = 'bar'
+      cookie_jar['baz'] = 'gni'
+      get '/index?mumu=1&password=5', {}, 'HTTP_COOKIE' => cookie_jar.for(nil)
       assert_equal 'Hello World!', last_response.body
     end
 

data/test/sinatra_test.rb

@@ -24,7 +24,10 @@ module LogjamAgent
     end
 
     def test_root
-      get '/index?mumu=1&password=5'
+      cookie_jar = ::Rack::Test::CookieJar.new
+      cookie_jar['foo'] = 'bar'
+      cookie_jar['baz'] = 'gni'
+      get '/index?mumu=1&password=5', {}, 'HTTP_COOKIE' => cookie_jar.for(nil)
       assert_equal 'Hello World!', last_response.body
       assert_equal 200, last_response.status
 
@@ -49,6 +52,8 @@ module LogjamAgent
       assert_equal method, "GET"
       assert_equal url, "/index?mumu=1&password=[FILTERED]"
       assert_equal(query_parameters, { "mumu" => "1", "password" => "[FILTERED]" })
+      assert_match(/baz=gni/, request_info["headers"]["Cookie"])
+      assert_match(/foo=\[FILTERED\]/, request_info["headers"]["Cookie"])
     end
 
   end

data/test/test_helper.rb

@@ -20,6 +20,9 @@ require "logjam_agent/receiver"
 # for Sinatra
 ENV['RACK_ENV'] = "test"
 
+# Obfuscate the foo cookie.
+LogjamAgent.obfuscated_cookies = [/\A(foo|.*_session)\z/]
+
 class MockLogDev
   attr_reader :lines
   def initialize

metadata

@@ -1,183 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: logjam_agent
 version: !ruby/object:Gem::Version
-  version: 0.38.2
+  version: 0.38.4
 platform: ruby
 authors:
 - Stefan Kaes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-02 00:00:00.000000000 Z
+date: 2023-03-22 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: i18n
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: snappy
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: lz4-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: oj
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -252,6 +84,7 @@ files:
 - lib/logjam_agent/logging_attributes.rb
 - lib/logjam_agent/middleware.rb
 - lib/logjam_agent/monkey_patches/ffi-rzmq-patch.rb
+- lib/logjam_agent/obfuscation.rb
 - lib/logjam_agent/rack/logger.rb
 - lib/logjam_agent/rack/rails_support.rb
 - lib/logjam_agent/rack/sinatra_request.rb
@@ -266,6 +99,7 @@ files:
 - lib/logjam_agent/version.rb
 - lib/logjam_agent/zmq_forwarder.rb
 - test/json_logging_test.rb
+- test/obfuscator_test.rb
 - test/request_test.rb
 - test/selective_logging_test.rb
 - test/sinatra_app.rb
@@ -300,6 +134,7 @@ specification_version: 4
 summary: Logjam client library to be used with logjam
 test_files:
 - test/json_logging_test.rb
+- test/obfuscator_test.rb
 - test/request_test.rb
 - test/selective_logging_test.rb
 - test/sinatra_app.rb