logstop 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 996c1a6196492b32af2c6671404af889a1c42240a4e1e7d7b2047faa25f2ca0b
+  data.tar.gz: 2874a85dd249f9c9355dc17f7984b5d1fac26977cf98a74a478aafb19849f1b7
+SHA512:
+  metadata.gz: af055d4cb224519ec8a68e5f34f7cac6a7dc91afc0df233fb1fa03890401a04c6af9c1e6b6c118995e3b6b115d337d0e84a60f32037a3b993ae873afc2784c19
+  data.tar.gz: 55878748c919f917afa735ed3e8c010e8598037ed21786e7ea225d6770ed21aef70fef75efb719b52b8fc42f1eda8619394c8bf5088fe1c951cb12c51c72f58f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+- First release

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in logstop.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrew
+
+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,64 @@
+# Logstop
+
+:fire: Keep personally identifiable information (PII) out of your logs
+
+```ruby
+logger.info "Hi test@test.com!"
+# => Hi [FILTERED]!
+```
+
+By default, scrubs:
+
+- email addresses
+- phone numbers
+- credit card numbers
+- Social Security numbers (SSNs)
+
+Works with all types of logging - Ruby, ActiveRecord, ActiveJob, and more
+
+```
+User Load (0.1ms) SELECT "users".* FROM "users" WHERE "users"."email" = ? [["email", "[FILTERED]"]]
+```
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'logstop'
+```
+
+And add it to your logger:
+
+```ruby
+logger.formatter = Logstop::Formatter.new(logger.formatter)
+```
+
+## Options
+
+To scrub IP addresses, use:
+
+```ruby
+Logstop::Formatter.new(formatter, ip: true)
+```
+
+## Note
+
+This should be used in addition to `config.filtered_parameters`, not as a replacement.
+
+## Resources
+
+- [List of PII, as defined by NIST](https://en.wikipedia.org/wiki/Personally_identifiable_information#NIST_definition)
+
+## History
+
+View the [changelog](CHANGELOG.md)
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/logstop/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/logstop/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

@@ -0,0 +1,33 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test
+
+task :benchmark do
+  require "bundler/setup"
+  Bundler.require
+  require "benchmark/ips"
+
+  str = StringIO.new
+  logger = ::Logger.new(str)
+
+  str2 = StringIO.new
+  logger2 = ::Logger.new(str2)
+  logger2.formatter = Logstop::Formatter.new
+
+  Benchmark.ips do |x|
+    x.report "logger" do
+      logger.info "This is a string: test@test.com"
+    end
+
+    x.report "logger2" do
+      logger2.info "This is a string: test@test.com"
+    end
+  end
+end

data/lib/logstop.rb

@@ -0,0 +1,31 @@
+require "logstop/version"
+require "logger"
+
+module Logstop
+  class Formatter < ::Logger::Formatter
+    FILTERED_STR = "[FILTERED]".freeze
+
+    CREDIT_CARD_REGEX = /\b\d{4}[\s-]?\d{4}[\s-]?\d{4}[\s-]?\d{4}\b/
+    EMAIL_REGEX = /\b[\w+\-.]+@[a-z\d\-]+(\.[a-z\d\-]+)*\.[a-z]+\b/i
+    IP_REGEX = /\b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b/
+    PHONE_REGEX = /\b(\+\d{1,2}\s)?\(?\d{3}\)?[\s.-]?\d{3}[\s.-]?\d{4}\b/i
+    SSN_REGEX = /\b\d{3}[\s-]?\d{2}[\s-]?\d{4}\b/i
+
+    def initialize(formatter = nil, ip: false)
+      @formatter = formatter || ::Logger::Formatter.new
+      @ip = ip
+    end
+
+    def call(severity, timestamp, progname, msg)
+      output = @formatter.call(severity, timestamp, progname, msg)
+      output = output.gsub(IP_REGEX, FILTERED_STR) if @ip
+
+      # order filters are applied is important
+      output
+        .gsub(CREDIT_CARD_REGEX, FILTERED_STR)
+        .gsub(PHONE_REGEX, FILTERED_STR)
+        .gsub(SSN_REGEX, FILTERED_STR)
+        .gsub(EMAIL_REGEX, FILTERED_STR)
+    end
+  end
+end

data/lib/logstop/version.rb

@@ -0,0 +1,3 @@
+module Logstop
+  VERSION = "0.1.0"
+end

data/logstop.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "logstop/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "logstop"
+  spec.version       = Logstop::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@chartkick.com"]
+
+  spec.summary       = "Keep personally identifiable information (PII) out of your logs"
+  spec.homepage      = "https://github.com/ankane/logstop"
+  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_development_dependency "benchmark-ips"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: logstop
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  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: '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: 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'
+description: 
+email:
+- andrew@chartkick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/logstop.rb
+- lib/logstop/version.rb
+- logstop.gemspec
+homepage: https://github.com/ankane/logstop
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Keep personally identifiable information (PII) out of your logs
+test_files: []