logstop 0.2.8 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 270d72c3e5f7b204ba2cacce902adf8593dc6d5cab26d4470182aa41b14f3b5b
-  data.tar.gz: 8d5608be8b5b507e8cd640ee0303731b0608a25affed828a0ece5e3b13424afe
+  metadata.gz: 2c789572d82afc9bd20c1c8414bf450cf23ba224cbee9c19d05175681c3e64ca
+  data.tar.gz: ec27ac10131118d95ef04c1646b43ba6244b132934d4d51dfaa4cb66d6da5291
 SHA512:
-  metadata.gz: c4fc28afee3a1c604bf1af432ef8563bebba765f2e1f47dd44c6d6c0b335b3be28698432b8a1ff57eb707e27f396a841f67efb7adba46cc028d9388421db4eef
-  data.tar.gz: 30b74692def2afe3ab7a48cc4235eafbc79660aa98ad3adf4e73ce7adf0c82873b62f42ffc196610e2f61f3acbf5c0bc03aed3c7bb428fd51744db8e2b6a33db
+  metadata.gz: 74785a1b621085024a1e8267a01f4cc0f2d886edcb0a3a31a6f2f3c6c9eb5f326014420e60381ef6e5d48ccc318014fe6b3ab57e8b08f92eb536de960c91841d
+  data.tar.gz: 946b1c80aa52a3c77f2cdb3193a4a3ac48db93cc7849ed5ac8f602c6278f2d9f8f25138153d8e63f64888ce10b1aced1424466f2b81f5604513835cca53efe2e

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.3.1 (2023-07-02)
+
+- Reduced false matches for URL passwords
+
+## 0.3.0 (2022-09-06)
+
+- Added support for international phone numbers
+- Added support for MAC addresses
+- Dropped support for Ruby < 2.7
+
 ## 0.2.8 (2021-11-30)
 
 - Added support for disabling default rules

data/README.md

@@ -1,6 +1,6 @@
 # Logstop
 
-:fire: Keep personally identifiable information (PII) out of your logs
+:fire: Keep personal data out of your logs
 
 ```ruby
 logger.info "Hi test@example.org!"
@@ -30,7 +30,7 @@ Works even when sensitive data is URL-encoded with plus encoding
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'logstop'
+gem "logstop"
 ```
 
 And add it to your logger:
@@ -55,6 +55,12 @@ To scrub IP addresses (IPv4), use:
 Logstop.guard(logger, ip: true)
 ```
 
+To scrub MAC addresses, use:
+
+```ruby
+Logstop.guard(logger, mac: true)
+```
+
 Add custom rules with:
 
 ```ruby

data/lib/logstop/formatter.rb

@@ -2,7 +2,7 @@ require "logger"
 
 module Logstop
   class Formatter < ::Logger::Formatter
-    def initialize(formatter = nil, url_password: true, email: true, credit_card: true, phone: true, ssn: true, ip: false, scrubber: nil)
+    def initialize(formatter = nil, url_password: true, email: true, credit_card: true, phone: true, ssn: true, ip: false, mac: false, scrubber: nil)
       @formatter = formatter || ::Logger::Formatter.new
       @url_password = url_password
       @email = email
@@ -10,6 +10,7 @@ module Logstop
       @phone = phone
       @ssn = ssn
       @ip = ip
+      @mac = mac
       @scrubber = scrubber
     end
 
@@ -22,6 +23,7 @@ module Logstop
         phone: @phone,
         ssn: @ssn,
         ip: @ip,
+        mac: @mac,
         scrubber: @scrubber
       )
     end

data/lib/logstop/version.rb

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

data/lib/logstop.rb

@@ -1,6 +1,6 @@
-require "logstop/formatter"
-require "logstop/railtie" if defined?(Rails)
-require "logstop/version"
+require_relative "logstop/formatter"
+require_relative "logstop/railtie" if defined?(Rails)
+require_relative "logstop/version"
 
 module Logstop
   FILTERED_STR = "[FILTERED]".freeze
@@ -11,10 +11,12 @@ module Logstop
   EMAIL_REGEX = /\b[\w]([\w+.-]|%2B)+(?:@|%40)[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/
+  E164_PHONE_REGEX = /(?:\+|%2B)[1-9]\d{6,14}\b/
   SSN_REGEX = /\b\d{3}[\s+-]\d{2}[\s+-]\d{4}\b/
-  URL_PASSWORD_REGEX = /((?:\/\/|%2F%2F)\S+(?::|%3A))\S+(@|%40)/
+  URL_PASSWORD_REGEX = /((?:\/\/|%2F%2F)[^\s\/]+(?::|%3A))[^\s\/]+(@|%40)/
+  MAC_REGEX = /\b[0-9a-f]{2}(?:(?::|%3A)[0-9a-f]{2}){5}\b/i
 
-  def self.scrub(msg, url_password: true, email: true, credit_card: true, phone: true, ssn: true, ip: false, scrubber: nil)
+  def self.scrub(msg, url_password: true, email: true, credit_card: true, phone: true, ssn: true, ip: false, mac: false, scrubber: nil)
     msg = msg.to_s.dup
 
     # order filters are applied is important
@@ -24,9 +26,13 @@ module Logstop
       msg.gsub!(CREDIT_CARD_REGEX, FILTERED_STR)
       msg.gsub!(CREDIT_CARD_REGEX_DELIMITERS, FILTERED_STR)
     end
-    msg.gsub!(PHONE_REGEX, FILTERED_STR) if phone
+    if phone
+      msg.gsub!(E164_PHONE_REGEX, FILTERED_STR)
+      msg.gsub!(PHONE_REGEX, FILTERED_STR)
+    end
     msg.gsub!(SSN_REGEX, FILTERED_STR) if ssn
     msg.gsub!(IP_REGEX, FILTERED_STR) if ip
+    msg.gsub!(MAC_REGEX, FILTERED_STR) if mac
 
     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.8
+  version: 0.3.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-30 00:00:00.000000000 Z
+date: 2023-07-02 00:00:00.000000000 Z
 dependencies: []
 description:
 email: andrew@ankane.org
@@ -35,15 +35,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: Keep personally identifiable information (PII) out of your logs
+summary: Keep personal data out of your logs
 test_files: []