logstop 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93f5e4b3e017604cc89a5f5cbf9760c58fc620f07a212771604a1f7e87782457
-  data.tar.gz: 6f5e11712af3bf0fc6f8b38f2783ec9f9df2fb4efe415c726f8e64433ceacfc9
+  metadata.gz: a53f7c35dc4fa281960cb1d890c9bfc2f884b2624ecd9939946d000b5cedac7f
+  data.tar.gz: 2efd9b35e4d069224e8093d54c78101e40265191b8d588a6ac79694e41638da7
 SHA512:
-  metadata.gz: cc638ced43a86d26b3f777cd3e52d8cc22d42b1ed390c691751db88871aa618dba5df657909b328e6fbecbfcf0a424623d7ee544ec56879abeb93db4f8615f38
-  data.tar.gz: 9b32e7b7fce161e2b39c4c62f79f8a2efcb1bf4eab0d917df5e2a804e6419c2681ff21c22ca8d6819c1c83dbcfa5f0db17baa98a41506eb6436bd42a99963a2e
+  metadata.gz: 5ee9bd48289258b6678492aa84da9777c8ee579416736dddf91b86f5cb57bdd0db64ba7402e1b83b4d4992437f87be467714ba1d397a5e4a7e656bf1746b731b
+  data.tar.gz: cf5c437b6bdb8819b9a717f307b53cdf0225ae86df78c270c919993deb36afd3493dc2b9734508a99eebafd28797ac5c3abfd7c08e979384f3d3559c00206ce6

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 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
+
+## 0.2.7 (2021-02-08)
+
+- Fixed filtering for URL-encoded emails with `+`
+
 ## 0.2.6 (2020-04-10)
 
 - Reduced allocations

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018-2020 Andrew Kane
+Copyright (c) 2018-2021 Andrew Kane
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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!"
@@ -15,22 +15,22 @@ By default, scrubs:
 - Social Security numbers (SSNs)
 - passwords in URLs
 
-Works with all types of logging - Ruby, ActiveRecord, ActiveJob, and more
+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://travis-ci.org/ankane/logstop.svg?branch=master)](https://travis-ci.org/ankane/logstop)
+[![Build Status](https://github.com/ankane/logstop/workflows/build/badge.svg?branch=master)](https://github.com/ankane/logstop/actions)
 
 ## Installation
 
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'logstop'
+gem "logstop"
 ```
 
 And add it to your logger:
@@ -49,12 +49,18 @@ Logstop.guard(Rails.logger)
 
 ## Options
 
-To scrub IP addresses, use:
+To scrub IP addresses (IPv4), use:
 
 ```ruby
 Logstop.guard(logger, ip: true)
 ```
 
+To scrub MAC addresses, use: [unreleased]
+
+```ruby
+Logstop.guard(logger, mac: true)
+```
+
 Add custom rules with:
 
 ```ruby
@@ -65,6 +71,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
@@ -75,7 +93,7 @@ It supports the same options as `guard`.
 
 ## Notes
 
-This should be used in addition to `config.filtered_parameters`, not as a replacement.
+This should be used in addition to `config.filter_parameters`, not as a replacement.
 
 Learn more about [securing sensitive data in Rails](https://ankane.org/sensitive-data-rails).
 

data/lib/logstop/formatter.rb

@@ -2,14 +2,30 @@ 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, mac: false, scrubber: nil)
       @formatter = formatter || ::Logger::Formatter.new
+      @url_password = url_password
+      @email = email
+      @credit_card = credit_card
+      @phone = phone
+      @ssn = ssn
       @ip = ip
+      @mac = mac
       @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,
+        mac: @mac,
+        scrubber: @scrubber
+      )
     end
 
     # for tagged logging

data/lib/logstop/version.rb

@@ -1,3 +1,3 @@
 module Logstop
-  VERSION = "0.2.6"
+  VERSION = "0.3.0"
 end

data/lib/logstop.rb

@@ -4,28 +4,35 @@ require "logstop/version"
 
 module Logstop
   FILTERED_STR = "[FILTERED]".freeze
-  FILTERED_URL_STR = "\\1[FILTERED]@".freeze
+  FILTERED_URL_STR = "\\1[FILTERED]\\2".freeze
 
   CREDIT_CARD_REGEX = /\b[3456]\d{15}\b/
   CREDIT_CARD_REGEX_DELIMITERS = /\b[3456]\d{3}[\s+-]\d{4}[\s+-]\d{4}[\s+-]\d{4}\b/
-  EMAIL_REGEX = /\b[\w][\w+.-]+(@|%40)[a-z\d-]+(\.[a-z\d-]+)*\.[a-z]+\b/i
+  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/
+  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, 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
-    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
+    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,101 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: logstop
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-11 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  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: 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: memory_profiler
-  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
+date: 2022-09-06 00:00:00.000000000 Z
+dependencies: []
+description:
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -111,7 +27,7 @@ homepage: https://github.com/ankane/logstop
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -119,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.1.2
-signing_key: 
+rubygems_version: 3.3.7
+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: []