blouson 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82794d470c5403b89c887eb9f7edbbafcc9c3ed8
+  data.tar.gz: e49d57431f07c117d82c11937c8b3ae54130ec5e
+SHA512:
+  metadata.gz: d4f78d3151d899f6cba3bf747a97ba7594e37234039a90257f45b47d6056e09192275edbc3e3b05b8d851a183465b1b23f52260188ddb3e88c097fcd2872afc5
+  data.tar.gz: e3c9c7621074f64028859a09f017d1dff0e53f26a350920beebb4ed17fc2d8dbde444e2fc98c09168968abc4f8e01034a88845ce8f7411abb19ab9c9f096afd4

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+  - 2.3.3
+  - 2.2.6
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in blouson.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Cookpad Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+# Blouson
+
+Blouson is a filter tool for Rails to conceal sensitive data from various logs.
+
+- HTTP Request parameters in Rails log
+- SQL query in Rails log
+- Exception messages in `ActiveRecord::StatementInvalid`
+- Sentry Raven parameters
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blouson'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blouson
+
+## Usage
+
+### SensitiveParamsSilencer
+If there is a HTTP request parameter prefixed with ```secure_```, Blouson conceals sensitive data from logging.
+Blouson enables this filter automatically.
+
+Example:
+```
+Started PUT "/employees/1" for 127.0.0.1 at Tue Jan 1 00:00:00 +0900 2013
+Processing by EmployeesController#update as HTML
+  Parameters: {"commit"=>"Update Employee", "id"=>"1", "employee"=>{"name"=>"", "secure_personal_information"=>"[FILTERED]"}, "utf8"=>"✓"}
+  [Blouson::SensitiveParamsSilencer] SQL Log is skipped for sensitive data
+```
+
+### SensitiveQueryFilter
+If there is a table prefixed with `secure_`, in exception message of `ActiveRecord::StatementInvalid`, Blouson conceals sensitive data from exception messages.
+Blouson enables this filter automatically.
+
+Example:
+
+```
+RuntimeError: error: SELECT  `secure_users`.* FROM `secure_users` WHERE `secure_users`.`email` = '[FILTERED]'  ORDER BY `secure_users`.`id` ASC LIMIT 1
+```
+
+### SensitiveTableQueryLogSilencer
+Blouson provides an [Arproxy](https://github.com/cookpad/arproxy) module to suppress query logs for secure_ prefix tables. If there is a query log for `secure_` prefix table, Blouson conceals it.
+This proxy does not works automatically, so that you have to set `Blouson::SensitiveTableQueryLogSilencer` in your Arproxy initializer.
+
+```ruby
+require 'blouson/sensitive_table_query_log_silencer'
+# your initializers
+
+Arproxy.configure do |config|
+  config.adapter = "mysql2"
+  config.use Blouson::SensitiveTableQueryLogSilencer
+end
+Arproxy.enable!
+```
+
+### 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.
+
+```ruby
+require 'blouson/raven_parameter_filter_processor'
+
+filter_pattern = Rails.application.config.filter_parameters
+secure_headers = %w(secret_token)
+
+Raven.configure do |config|
+  ...
+  config.processors = [Blouson::RavenParameterFilterProcessor.create(filter_pattern, secure_headers)]
+  ...
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cookpad/blouson.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "blouson"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/blouson.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blouson/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "blouson"
+  spec.version       = Blouson::VERSION
+  spec.authors       = ["Cookpad Inc."]
+  spec.email         = ["kaihatsu@cookpad.com"]
+
+  spec.summary       = %q{Filter tools to mask sensitive data in various logs}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/cookpad/blouson"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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 "bundler", ">= 1.14"
+  spec.add_development_dependency "rake", ">= 10.0"
+  spec.add_development_dependency "rspec", ">= 3.0"
+end

data/lib/blouson/engine.rb

@@ -0,0 +1,26 @@
+module Blouson
+  class Engine < Rails::Engine
+    initializer 'blouson.configure_rails_initialization' do |app|
+      app.config.filter_parameters << Blouson::SENSITIVE_PARAMS_REGEXP
+    end
+
+    # We have to prevent logging sensitive data in SQL if production mode and logger level is debug
+    initializer 'blouson.load_helpers' do |app|
+      if !Rails.env.development? && Rails.logger.level == Logger::DEBUG
+        ActiveSupport.on_load(:action_controller) do
+          around_action Blouson::SensitiveParamsSilencer
+        end
+      end
+    end
+
+    initializer 'blouson.set_sensitive_query_filter' do
+      if Rails.env.production? || Rails.env.staging? || ENV['ENABLE_SENSITIVE_QUERY_FILTER'] == '1'
+        ActiveSupport.on_load(:active_record) do
+          ActiveRecord::StatementInvalid.class_eval do
+            prepend Blouson::SensitiveQueryFilter::StatementInvalidErrorFilter
+          end
+        end
+      end
+    end
+  end
+end

data/lib/blouson/raven_parameter_filter_processor.rb

@@ -0,0 +1,78 @@
+module Blouson
+  class RavenParameterFilterProcessor
+    def self.create(filters, header_filters)
+      Class.new(Raven::Processor) do
+        @filters = filters
+        @header_filters = header_filters
+
+        def self.filters
+          @filters
+        end
+
+        def self.header_filters
+          @header_filters
+        end
+
+        def initialize(client = nil)
+          @parameter_filter = ActionDispatch::Http::ParameterFilter.new(self.class.filters)
+        end
+
+        def process(value)
+          process_query_string(value)
+          process_request_body(value)
+          process_request_header(value)
+          process_cookie(value)
+        ensure
+          return value
+        end
+
+        def process_request_body(value)
+          if value[:request] && value[:request][:data].present?
+            data = value[:request][:data]
+            if data.is_a?(String)
+              # Maybe JSON request
+              begin
+                data = JSON.parse(data)
+                value[:request][:data] = JSON.dump(@parameter_filter.filter(data))
+              rescue JSON::ParserError => e
+                # Record parser error to extra field
+                value[:extra]['BlousonError'] = e.message
+              end
+            else
+              value[:request][:data] = @parameter_filter.filter(data)
+            end
+          end
+        end
+
+        def process_query_string(value)
+          if value[:request] && value[:request][:query_string].present?
+            query    = Rack::Utils.parse_query(value[:request][:query_string])
+            filtered = @parameter_filter.filter(query)
+
+            value[:request][:query_string] = Rack::Utils.build_query(filtered)
+          end
+        end
+
+        def process_request_header(value)
+          if value[:request] && value[:request][:headers]
+            headers = value[:request][:headers]
+            headers.each_key do |k|
+              if self.class.header_filters.include?(k.downcase)
+                headers[k] = 'FILTERED'
+              end
+            end
+          end
+        end
+
+        def process_cookie(value)
+          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)
+
+            value[:request][:headers]['Cookie'] = filtered.map { |pair| pair.join('=') }.join('; ')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/blouson/sensitive_params_silener.rb

@@ -0,0 +1,40 @@
+module Blouson
+  class SensitiveParamsSilencer
+    class << self
+      def around(controller)
+        if include_sensitive_data?(controller)
+          begin
+            old_level = ActiveRecord::Base.logger.level
+            ActiveRecord::Base.logger.level = Logger::INFO
+            Rails.logger.info "  [Blouson::SensitiveParamsSilencer] SQL Log is skipped for sensitive data"
+            yield
+          ensure
+            ActiveRecord::Base.logger.level = old_level
+          end
+        else
+          yield
+        end
+      end
+
+      def include_sensitive_data?(controller)
+        nested_params_keys(controller.params).any? { |key, value| Blouson::SENSITIVE_PARAMS_REGEXP === key }
+      end
+
+      private :include_sensitive_data?
+
+      def nested_params_keys(params)
+        if params.respond_to?(:to_unsafe_h)
+          params = params.to_unsafe_h
+        end
+        user_params = params.reject { |key, value| 'controller' == key || 'action' == key }
+        user_params.inject([]) do |keys, pair|
+          keys << pair.first
+          keys += pair.last.keys if pair.last.kind_of? Hash
+          keys
+        end
+      end
+
+      private :nested_params_keys
+    end
+  end
+end

data/lib/blouson/sensitive_query_filter.rb

@@ -0,0 +1,39 @@
+module Blouson
+  module SensitiveQueryFilter
+    QUOTED_WORD_REGEXP = /
+      (?: '.+?(?<!\\)'
+        | ".+?(?<!\\)"
+      )
+    /x
+
+    def self.contain_sensitive_query?(message)
+      Blouson::SENSITIVE_TABLE_REGEXP === message
+    end
+
+    def self.filter_sensitive_words(message)
+      message.gsub(QUOTED_WORD_REGEXP, "'#{Blouson::FILTERED}'")
+    end
+
+    module StatementInvalidErrorFilter
+      def initialize(message, original_exception = nil)
+        if SensitiveQueryFilter.contain_sensitive_query?(message)
+          message = SensitiveQueryFilter.filter_sensitive_words(message)
+          if defined?(Mysql2::Error)
+            if original_exception.is_a?(Mysql2::Error)
+              original_exception.extend(Mysql2Filter)
+            elsif $!.is_a?(Mysql2::Error)
+              $!.extend(Mysql2Filter)
+            end
+          end
+        end
+        super(message, original_exception)
+      end
+    end
+
+    module Mysql2Filter
+      def message
+        SensitiveQueryFilter.filter_sensitive_words(super)
+      end
+    end
+  end
+end

data/lib/blouson/sensitive_table_query_log_silencer.rb

@@ -0,0 +1,17 @@
+module Blouson
+  class SensitiveTableQueryLogSilencer < Arproxy::Base
+    def execute(sql, name=nil)
+      if Rails.logger.level != Logger::DEBUG || !(Blouson::SENSITIVE_TABLE_REGEXP === sql)
+        return super(sql, name)
+      end
+
+      begin
+        ActiveRecord::Base.logger.level = Logger::INFO
+        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
+end

data/lib/blouson/tolerant_regexp.rb

@@ -0,0 +1,11 @@
+module Blouson
+  class TolerantRegexp < Regexp
+    def =~(str)
+      if str.respond_to?(:valid_encoding?) && !str.valid_encoding?
+        nil
+      else
+        super
+      end
+    end
+  end
+end

data/lib/blouson/version.rb

@@ -0,0 +1,3 @@
+module Blouson
+  VERSION = "1.0.0"
+end

data/lib/blouson.rb

@@ -0,0 +1,12 @@
+require "blouson/version"
+
+require 'blouson/sensitive_params_silener'
+require 'blouson/sensitive_query_filter'
+require 'blouson/engine'
+require 'blouson/tolerant_regexp'
+
+module Blouson
+  SENSITIVE_PARAMS_REGEXP = TolerantRegexp.new('\Asecure_').freeze
+  SENSITIVE_TABLE_REGEXP = /secure_/.freeze
+  FILTERED = '[FILTERED]'.freeze
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: blouson
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cookpad Inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: sentry-raven
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: arproxy
+  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: mysql2
+  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: pry
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Filter tools to mask sensitive data in various logs
+email:
+- kaihatsu@cookpad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- blouson.gemspec
+- lib/blouson.rb
+- lib/blouson/engine.rb
+- lib/blouson/raven_parameter_filter_processor.rb
+- lib/blouson/sensitive_params_silener.rb
+- lib/blouson/sensitive_query_filter.rb
+- lib/blouson/sensitive_table_query_log_silencer.rb
+- lib/blouson/tolerant_regexp.rb
+- lib/blouson/version.rb
+homepage: https://github.com/cookpad/blouson
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Filter tools to mask sensitive data in various logs
+test_files: []