blouson 1.0.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3f0289a12d72b9395df1eda3e175fb719eeca8f9
-  data.tar.gz: b3eabf713614461869750438ffc28a4855baf55a
+SHA256:
+  metadata.gz: 3c5a05fbdf574e2e9c8420e7d24ad36ba81786df09d1916073d409ba47f764ec
+  data.tar.gz: 4d14dbf88a1e8aa457bcc5b2dae76846bf02d1cb5da4fb32e9ef23909e600f5a
 SHA512:
-  metadata.gz: fe01b3072ceb5bc18903850320cd53c937df2b3132e75637e36158fc6ddf854ff5ec2613440952667d19ddd3497de22d9c826969efca5013cecf6c80769b5642
-  data.tar.gz: da9de96010abbc0bd01299206e38f6b45e774fe80071c797d84a1e72bc88701d0677247ccb4b07e58518bd2afb32b6b7e1786cc5ac486647f28f5e58e7e6fe01
+  metadata.gz: 552ac7c5c3f6faaafe54355ea30d016ab47b5ac419b4466a27b0976bfdd60c89e9b4becf2aebc74a7937e25b9076e440f66fac65f141881d3e606c1257759f2a
+  data.tar.gz: 242d596166fc9beb1ca7380c1b9ae066d044e687ed9e783449c51788a6578e9f200178a04b6a63554f3576adab494800774d2694bbc3d9ab23820aad9223dc6d

data/.travis.yml

@@ -1,20 +1,24 @@
 sudo: false
 language: ruby
+services:
+  - mysql
 gemfile:
-  - gemfiles/rails_4.0.gemfile
-  - gemfiles/rails_4.1.gemfile
   - gemfiles/rails_4.2.gemfile
   - gemfiles/rails_5.0.gemfile
   - gemfiles/rails_5.1.gemfile
+  - gemfiles/rails_5.2.gemfile
+  - gemfiles/rails_6.0.gemfile
 rvm:
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
+  - 2.3.8
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
 matrix:
   exclude:
-    # Rails 4.0 and 4.1 doesn't support Ruby 2.4 (because of integer unification)
-    - rvm: 2.4.1
-      gemfile: gemfiles/rails_4.0.gemfile
-    - rvm: 2.4.1
-      gemfile: gemfiles/rails_4.1.gemfile
-before_install: gem install --no-document bundler
+    - rvm: 2.3.8
+      gemfile: gemfiles/rails_6.0.gemfile
+    - rvm: 2.4.6
+      gemfile: gemfiles/rails_6.0.gemfile
+before_install:
+  - "[[ $BUNDLE_GEMFILE =~ rails_4\\.2 ]] && gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true"
+  - "[[ $BUNDLE_GEMFILE =~ rails_4\\.2 ]] && gem install bundler -v '< 2' || true"

data/Appraisals

@@ -1,13 +1,3 @@
-appraise 'rails-4.0' do
-  gem 'rails', '~> 4.0.0'
-  gem 'mysql2', '~> 0.3.10'
-end
-
-appraise 'rails-4.1' do
-  gem 'rails', '~> 4.1.0'
-  gem 'mysql2', '~> 0.3.13'
-end
-
 appraise 'rails-4.2' do
   gem 'rails', '~> 4.2.0'
 end
@@ -20,4 +10,12 @@ appraise 'rails-5.1' do
   gem 'rails', '~> 5.1.0'
 end
 
+appraise 'rails-5.2' do
+  gem 'rails', '~> 5.2.0'
+end
+
+appraise 'rails-6.0' do
+  gem 'rails', '~> 6.0.0'
+end
+
 # vim: set ft=ruby:

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# 1.1.3 (2020-12-11)
+- Fix cookies not being filtered when used with Raven::Rack
+
+# 1.1.2 (2019-10-24)
+- Support Rails 6.0
+
+# 1.1.1 (2019-09-27)
+- Change to use ActiveSupport::LoggerSilence for thread safety #10
+
+# 1.1.0 (2019-08-09)
+- Add feature to filter sensitive mail logs.
+
+# 1.0.3 (2018-12-18)
+- Fix Blouson::SensitiveQueryFilter::StatementInvalidErrorFilter for exceptions created with no arguments (like ActiveRecord::NoDatabaseError)
+
 # 1.0.2 (2017-09-21)
 - Change Raven filter's secure_headers config to be case insensitive https://github.com/cookpad/blouson/pull/4
 

data/README.md

@@ -8,6 +8,7 @@ Blouson is a filter tool for Rails to conceal sensitive data from various logs.
 - SQL query in Rails log
 - Exception messages in `ActiveRecord::StatementInvalid`
 - Sentry Raven parameters
+- Mail parameters in Rails log
 
 ## Installation
 
@@ -75,11 +76,39 @@ secure_headers = %w(secret_token)
 
 Raven.configure do |config|
   ...
-  config.processors = [Blouson::RavenParameterFilterProcessor.create(filter_pattern, secure_headers)]
+  config.processors << Blouson::RavenParameterFilterProcessor.create(filter_pattern, secure_headers)
   ...
 end
 ```
 
+### SensitiveMailLogFilter
+ActionMailer outputs email address, all headers, and body text to the log when sending email.
+
+```
+D, [2019-08-08T08:40:15.939251 #67674] DEBUG -- : UserMailer#hello: processed outbound mail in 43.0ms
+I, [2019-08-08T08:40:15.946281 #67674]  INFO -- : Sent mail to xxx@example.com (6.3ms)
+D, [2019-08-08T08:40:15.946432 #67674] DEBUG -- : Date: Thu, 08 Aug 2019 08:40:15 +0900
+From: from@example.com
+To: xxx@example.com
+Message-ID: <xxx>
+Subject: Hello
+Mime-Version: 1.0
+Content-Type: text/plain; charset=UTF-8
+Content-Transfer-Encoding: 7bit
+
+Example mail.
+```
+
+Blouson filters such logs.
+
+Example:
+
+```
+D, [2019-08-08T08:47:06.524182 #67886] DEBUG -- : UserMailer#hello: processed outbound mail in 23.2ms
+I, [2019-08-08T08:47:06.530849 #67886]  INFO -- : Sent mail to [FILTERED] (6.4ms)
+D, [2019-08-08T08:47:06.530953 #67886] DEBUG -- : [Blouson::SensitiveMailLogFilter] Mail data is filtered for sensitive data
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/cookpad/blouson.

data/gemfiles/{rails_4.0.gemfile → rails_5.2.gemfile}

@@ -2,7 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 4.0.0"
-gem "mysql2", "~> 0.3.10"
+gem "rails", "~> 5.2.0"
 
 gemspec path: "../"

data/gemfiles/{rails_4.1.gemfile → rails_6.0.gemfile}

@@ -2,7 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 4.1.0"
-gem "mysql2", "~> 0.3.13"
+gem "rails", "~> 6.0.0"
 
 gemspec path: "../"

data/lib/blouson.rb

@@ -2,6 +2,7 @@ require "blouson/version"
 
 require 'blouson/sensitive_params_silener'
 require 'blouson/sensitive_query_filter'
+require 'blouson/sensitive_mail_log_filter'
 require 'blouson/engine'
 require 'blouson/tolerant_regexp'
 

data/lib/blouson/engine.rb

@@ -22,5 +22,13 @@ module Blouson
         end
       end
     end
+
+    initializer 'blouson.set_sensitive_mail_log_filter' do |app|
+      if Rails.env.production? || ENV['ENABLE_SENSITIVE_MAIL_LOG_FILTER'] == '1'
+        ActiveSupport.on_load(:action_mailer) do
+          ActionMailer::LogSubscriber.prepend Blouson::SensitiveMailLogFilter
+        end
+      end
+    end
   end
 end

data/lib/blouson/raven_parameter_filter_processor.rb

@@ -14,7 +14,13 @@ module Blouson
         end
 
         def initialize(client = nil)
-          @parameter_filter = ActionDispatch::Http::ParameterFilter.new(self.class.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(self.class.filters)
         end
 
         def process(value)
@@ -65,6 +71,10 @@ module Blouson
         end
 
         def process_cookie(value)
+          if (cookies = value.dig(:request, :cookies))
+            value[:request][:cookies] = @parameter_filter.filter(cookies)
+          end
+
           if value[:request] && value[:request][:headers] && value[:request][:headers]['Cookie']
             cookies  = Hash[value[:request][:headers]['Cookie'].split('; ').map { |pair| pair.split('=', 2) }]
             filtered = @parameter_filter.filter(cookies)

data/lib/blouson/sensitive_mail_log_filter.rb

@@ -0,0 +1,17 @@
+module Blouson
+  module SensitiveMailLogFilter
+    def deliver(event)
+      e = ActiveSupport::Notifications::Event.new(
+        event.name,
+        event.time,
+        event.end,
+        event.transaction_id,
+        event.payload.merge(
+          to: Blouson::FILTERED,
+          mail: "[Blouson::SensitiveMailLogFilter] Mail data is filtered for sensitive data"
+        )
+      )
+      super(e)
+    end
+  end
+end

data/lib/blouson/sensitive_query_filter.rb

@@ -15,9 +15,10 @@ module Blouson
     end
 
     module StatementInvalidErrorFilter
-      def initialize(message, original_exception = nil)
-        if SensitiveQueryFilter.contain_sensitive_query?(message)
-          message = SensitiveQueryFilter.filter_sensitive_words(message)
+      def initialize(message = nil, original_exception = nil, sql: nil, binds: nil)
+        if SensitiveQueryFilter.contain_sensitive_query?(message) || (SensitiveQueryFilter.contain_sensitive_query?(sql))
+          message = SensitiveQueryFilter.filter_sensitive_words(message) if message
+          sql = SensitiveQueryFilter.filter_sensitive_words(sql) if sql
           if defined?(Mysql2::Error)
             if original_exception.is_a?(Mysql2::Error)
               original_exception.extend(Mysql2Filter)
@@ -30,6 +31,11 @@ module Blouson
         if original_exception
           # Rails < 5.0
           super(message, original_exception)
+        elsif sql
+          # Rails >= 6.0
+          #
+          # - https://github.com/rails/rails/pull/34468
+          super(message, sql: sql, binds: binds)
         else
           # Rails >= 5.0
           #

data/lib/blouson/sensitive_table_query_log_silencer.rb

@@ -5,12 +5,9 @@ module Blouson
         return super(sql, name)
       end
 
-      begin
-        ActiveRecord::Base.logger.level = Logger::INFO
+      ActiveRecord::Base.logger.silence(Logger::INFO) do
         Rails.logger.info "  [Blouson::SensitiveTableQueryLogSilencer] SQL Log is skipped for sensitive table"
         super(sql, name)
-      ensure
-        ActiveRecord::Base.logger.level = Logger::DEBUG
       end
     end
   end

data/lib/blouson/version.rb

@@ -1,3 +1,3 @@
 module Blouson
-  VERSION = "1.0.2"
+  VERSION = "1.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blouson
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Cookpad Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-21 00:00:00.000000000 Z
+date: 2020-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -155,14 +155,15 @@ files:
 - bin/console
 - bin/setup
 - blouson.gemspec
-- gemfiles/rails_4.0.gemfile
-- gemfiles/rails_4.1.gemfile
 - gemfiles/rails_4.2.gemfile
 - gemfiles/rails_5.0.gemfile
 - gemfiles/rails_5.1.gemfile
+- gemfiles/rails_5.2.gemfile
+- gemfiles/rails_6.0.gemfile
 - lib/blouson.rb
 - lib/blouson/engine.rb
 - lib/blouson/raven_parameter_filter_processor.rb
+- lib/blouson/sensitive_mail_log_filter.rb
 - lib/blouson/sensitive_params_silener.rb
 - lib/blouson/sensitive_query_filter.rb
 - lib/blouson/sensitive_table_query_log_silencer.rb
@@ -187,8 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Filter tools to mask sensitive data in various logs