logstop 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06f0dd3d6fdaab9b3b43855f0cfca8d282be00b92b7ca0cce0fca78563e15942
-  data.tar.gz: f6c531bedfc8fff417f150c81ea3c16b0fffcfa2d11a322113f4e46f34061c28
+  metadata.gz: 270d72c3e5f7b204ba2cacce902adf8593dc6d5cab26d4470182aa41b14f3b5b
+  data.tar.gz: 8d5608be8b5b507e8cd640ee0303731b0608a25affed828a0ece5e3b13424afe
 SHA512:
-  metadata.gz: cf0546107ba926046989f0962817ddfcd9f5f1b43ed569bdd50982702388a4c4f76ef41bcb74515973a7b4346e11c49c7727a5468c8bf1baabdadbf259284c5c
-  data.tar.gz: ff895c82dd97a3c7977fd30ed360185c05e78cf0db601c548cf39733b37a8367a1934870d2144acf40829896da38bc46a747fc9c1957ff3b635be3a5975d8d43
+  metadata.gz: c4fc28afee3a1c604bf1af432ef8563bebba765f2e1f47dd44c6d6c0b335b3be28698432b8a1ff57eb707e27f396a841f67efb7adba46cc028d9388421db4eef
+  data.tar.gz: 30b74692def2afe3ab7a48cc4235eafbc79660aa98ad3adf4e73ce7adf0c82873b62f42ffc196610e2f61f3acbf5c0bc03aed3c7bb428fd51744db8e2b6a33db

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.8 (2021-11-30)
+
+- Added support for disabling default rules
+
 ## 0.2.7 (2021-02-08)
 
 - Fixed filtering for URL-encoded emails with `+`

data/README.md

@@ -21,7 +21,7 @@ Works with all types of logging - Ruby, Active Record, Active Job, and more
 User Load (0.1ms)  SELECT "users".* FROM "users" WHERE "users"."email" = ?  [["email", "[FILTERED]"]]
 ```
 
-Works even when sensitive data is URL-encoded
+Works even when sensitive data is URL-encoded with plus encoding
 
 [![Build Status](https://github.com/ankane/logstop/workflows/build/badge.svg?branch=master)](https://github.com/ankane/logstop/actions)
 
@@ -49,7 +49,7 @@ Logstop.guard(Rails.logger)
 
 ## Options
 
-To scrub IP addresses, use:
+To scrub IP addresses (IPv4), use:
 
 ```ruby
 Logstop.guard(logger, ip: true)
@@ -65,6 +65,18 @@ end
 Logstop.guard(logger, scrubber: scrubber)
 ```
 
+Disable default rules with:
+
+```ruby
+Logstop.guard(logger,
+  email: false,
+  phone: false,
+  credit_card: false,
+  ssn: false,
+  url_password: false
+)
+```
+
 To scrub outside of logging, use:
 
 ```ruby

data/lib/logstop/formatter.rb

@@ -2,14 +2,28 @@ require "logger"
 
 module Logstop
   class Formatter < ::Logger::Formatter
-    def initialize(formatter = nil, ip: false, scrubber: nil)
+    def initialize(formatter = nil, url_password: true, email: true, credit_card: true, phone: true, ssn: true, ip: false, scrubber: nil)
       @formatter = formatter || ::Logger::Formatter.new
+      @url_password = url_password
+      @email = email
+      @credit_card = credit_card
+      @phone = phone
+      @ssn = ssn
       @ip = ip
       @scrubber = scrubber
     end
 
     def call(severity, timestamp, progname, msg)
-      Logstop.scrub(@formatter.call(severity, timestamp, progname, msg), ip: @ip, scrubber: @scrubber)
+      Logstop.scrub(
+        @formatter.call(severity, timestamp, progname, msg),
+        url_password: @url_password,
+        email: @email,
+        credit_card: @credit_card,
+        phone: @phone,
+        ssn: @ssn,
+        ip: @ip,
+        scrubber: @scrubber
+      )
     end
 
     # for tagged logging

data/lib/logstop/version.rb

@@ -1,3 +1,3 @@
 module Logstop
-  VERSION = "0.2.7"
+  VERSION = "0.2.8"
 end

data/lib/logstop.rb

@@ -14,17 +14,18 @@ module Logstop
   SSN_REGEX = /\b\d{3}[\s+-]\d{2}[\s+-]\d{4}\b/
   URL_PASSWORD_REGEX = /((?:\/\/|%2F%2F)\S+(?::|%3A))\S+(@|%40)/
 
-  def self.scrub(msg, ip: false, scrubber: nil)
+  def self.scrub(msg, url_password: true, email: true, credit_card: true, phone: true, ssn: true, ip: false, scrubber: nil)
     msg = msg.to_s.dup
 
     # order filters are applied is important
-    msg.gsub!(URL_PASSWORD_REGEX, FILTERED_URL_STR)
-    msg.gsub!(EMAIL_REGEX, FILTERED_STR)
-    msg.gsub!(CREDIT_CARD_REGEX, FILTERED_STR)
-    msg.gsub!(CREDIT_CARD_REGEX_DELIMITERS, FILTERED_STR)
-    msg.gsub!(PHONE_REGEX, FILTERED_STR)
-    msg.gsub!(SSN_REGEX, FILTERED_STR)
-
+    msg.gsub!(URL_PASSWORD_REGEX, FILTERED_URL_STR) if url_password
+    msg.gsub!(EMAIL_REGEX, FILTERED_STR) if email
+    if credit_card
+      msg.gsub!(CREDIT_CARD_REGEX, FILTERED_STR)
+      msg.gsub!(CREDIT_CARD_REGEX_DELIMITERS, FILTERED_STR)
+    end
+    msg.gsub!(PHONE_REGEX, FILTERED_STR) if phone
+    msg.gsub!(SSN_REGEX, FILTERED_STR) if ssn
     msg.gsub!(IP_REGEX, FILTERED_STR) if ip
 
     msg = scrubber.call(msg) if scrubber

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstop
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-08 00:00:00.000000000 Z
+date: 2021-11-30 00:00:00.000000000 Z
 dependencies: []
 description:
 email: andrew@ankane.org
@@ -42,7 +42,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Keep personally identifiable information (PII) out of your logs