blouson 1.1.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a561df78a14ba07951254ce32982357a83a32eab60691ba688fe95a4049e1d77
-  data.tar.gz: 53d9f65de40ed900cf5e3fbb4ac2525c74eb563695a1320dd5ae3b0d53b50b73
+  metadata.gz: 2b25599e819a53e78883ffd4e743eb30202e9e2fb3f8c7b040d89b538fae446f
+  data.tar.gz: 36685c9343cc6db285668bb8bfdd2d7d8ec29c15c621de8005551f6907ca0250
 SHA512:
-  metadata.gz: aec465e833f9b260e8d2180ae9147accf15220d3431cf4975a50d73075c56975288d83c0b1245396a281ac492546b3aa36d2f43410ce016f9e770436e0d459aa
-  data.tar.gz: 2ff71f692ae850d89b3a702480bbb4c13ce226c77984bd1092835a0b1cf55e4335e2d03d7f68857056909d2589a84e895c389a31eccd041437a46aaef640f2b6
+  metadata.gz: ade492f5a1994bfed0f02412d98c0e996baa827bcc65ac4256bda7f851e6814d6f9c017e13da5013d7e0c9821e83859f3870ad82d5f7c2d4ac59d0aac024d01f
+  data.tar.gz: 3e995584ca65d2498bdcff2d4c6c5bc8cd3d06beadc22569e808408af634577e4d94bd70c18f0613b458e1b6b1466e7807a18bc52aacbce573389a5e4372fe52

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 2.0.0 (2022-05-23)
+- Support parameter filter for `sentry-ruby` gem
+- [Breaking change] Drop dependency of `sentry-raven` gem
+
 # 1.1.4 (2022-05-02)
 - Fix ArgumentError on activerecord 7.0
 

data/README.md

@@ -65,6 +65,28 @@ end
 Arproxy.enable!
 ```
 
+### SentryParameterFilter
+Blouson provides an [sentry-ruby](https://github.com/getsentry/sentry-ruby) filter to conceal sensitive data from query string, request body, request headers and cookie values.
+
+```ruby
+require 'sentry-ruby'
+require 'blouson/sentry_parameter_filter'
+
+Sentry.init do |config|
+  # Enable `send_default_pii` to send the filtered sensitive information.
+  config.send_default_pii = true
+
+  filter_pattern = Rails.application.config.filter_parameters
+  secure_headers = %w(secret_token)
+  filter = Blouson::SentryParameterFilter.new(filter_pattern, secure_headers)
+
+  config.before_send = lambda do |event, _hint|
+    filter.process(event.to_hash)
+  end
+end
+
+```
+
 ### RavenParameterFilterProcessor
 Blouson provides an [Raven-Ruby](https://github.com/getsentry/raven-ruby) processor to conceal sensitive data from query string, request body, request headers and cookie values.
 
@@ -81,6 +103,7 @@ Raven.configure do |config|
 end
 ```
 
+
 ### SensitiveMailLogFilter
 ActionMailer outputs email address, all headers, and body text to the log when sending email.
 

data/blouson.gemspec

@@ -22,11 +22,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'rails', '>= 4.0.0'
-  spec.add_dependency 'sentry-raven'
 
   spec.add_development_dependency 'arproxy'
   spec.add_development_dependency 'mysql2'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'sentry-raven'
+  spec.add_development_dependency 'sentry-ruby'
 
   spec.add_development_dependency 'appraisal'
   spec.add_development_dependency "bundler", ">= 1.14"

data/lib/blouson/sentry_parameter_filter.rb

@@ -0,0 +1,76 @@
+module Blouson
+  class SentryParameterFilter
+    def initialize(filters, header_filters = [])
+      # ActionDispatch::Http::ParameterFilter is deprecated and will be removed from Rails 6.1.
+      parameter_filter_klass = if defined?(ActiveSupport::ParameterFilter)
+                                 ActiveSupport::ParameterFilter
+                               else
+                                 ActionDispatch::Http::ParameterFilter
+                               end
+      @parameter_filter = parameter_filter_klass.new(filters)
+      @header_filters = header_filters.map(&:downcase)
+    end
+
+    def process(event)
+      process_query_string(event)
+      process_request_body(event)
+      process_request_header(event)
+      process_cookie(event)
+    ensure
+      return event
+    end
+
+    private
+
+    def process_request_body(event)
+      if event[:request] && event[:request][:data].present?
+        data = event[:request][:data]
+        if data.is_a?(String)
+          # Maybe JSON request
+          begin
+            data = JSON.parse(data)
+            event[:request][:data] = JSON.dump(@parameter_filter.filter(data))
+          rescue JSON::ParserError => e
+            # Record parser error to extra field
+            event[:extra]['BlousonError'] = e.message
+          end
+        else
+          event[:request][:data] = @parameter_filter.filter(data)
+        end
+      end
+    end
+
+    def process_query_string(event)
+      if event[:request] && event[:request][:query_string].present?
+        query    = Rack::Utils.parse_query(event[:request][:query_string])
+        filtered = @parameter_filter.filter(query)
+
+        event[:request][:query_string] = Rack::Utils.build_query(filtered)
+      end
+    end
+
+    def process_request_header(event)
+      if event[:request] && event[:request][:headers]
+        headers = event[:request][:headers]
+        headers.each_key do |k|
+          if @header_filters.include?(k.downcase)
+            headers[k] = 'FILTERED'
+          end
+        end
+      end
+    end
+
+    def process_cookie(event)
+      if (cookies = event.dig(:request, :cookies))
+        event[:request][:cookies] = @parameter_filter.filter(cookies)
+      end
+
+      if event[:request] && event[:request][:headers] && event[:request][:headers]['Cookie']
+        cookies  = Hash[event[:request][:headers]['Cookie'].split('; ').map { |pair| pair.split('=', 2) }]
+        filtered = @parameter_filter.filter(cookies)
+
+        event[:request][:headers]['Cookie'] = filtered.map { |pair| pair.join('=') }.join('; ')
+      end
+    end
+  end
+end

data/lib/blouson/version.rb

@@ -1,3 +1,3 @@
 module Blouson
-  VERSION = "1.1.4"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blouson
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 2.0.0
 platform: ruby
 authors:
 - Cookpad Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-02 00:00:00.000000000 Z
+date: 2022-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,13 +25,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.0.0
 - !ruby/object:Gem::Dependency
-  name: sentry-raven
+  name: arproxy
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: arproxy
+  name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: sentry-raven
+  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: sentry-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -168,6 +182,7 @@ files:
 - lib/blouson/sensitive_params_silener.rb
 - lib/blouson/sensitive_query_filter.rb
 - lib/blouson/sensitive_table_query_log_silencer.rb
+- lib/blouson/sentry_parameter_filter.rb
 - lib/blouson/tolerant_regexp.rb
 - lib/blouson/version.rb
 homepage: https://github.com/cookpad/blouson
@@ -189,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.8
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Filter tools to mask sensitive data in various logs