auth-sanitizer 0.1.4 → 0.2.1

data/lib/auth/sanitizer/filtered_attributes.rb

@@ -34,10 +34,10 @@ module Auth
       # the current {Auth::Sanitizer.filtered_label} value.
       module InitializerMethods
         def initialize(*args, &block)
-          super(*args, &block)
+          super
           @thing_filter = ThingFilter.new(
             self.class.filtered_attribute_names,
-            label: Auth::Sanitizer.filtered_label,
+            label: Auth::Sanitizer.filtered_label
           )
         end
       end
@@ -93,16 +93,34 @@ module Auth
       #
       # @return [String]
       def inspect
-        return super if thing_filter.things.empty?
+        inspected = super
+        return inspected if thing_filter.things.empty?
 
-        inspected_vars = instance_variables.map do |var|
-          if thing_filter.filtered?(var)
-            "#{var}=#{thing_filter.label}"
-          else
-            "#{var}=#{instance_variable_get(var).inspect}"
+        redact_inspected_values(inspected.dup)
+      end
+
+      private
+
+      INSPECTED_STRING_VALUE = /"(?:(?:\\.)|[^"\\])*"/
+      INSPECTED_REDACTABLE_VALUE = /
+        (?:
+          (@([A-Za-z_]\w*[!?=]?)=) |
+          ([,{]\s*([A-Za-z_]\w*[!?=]?):\s*) |
+          ([,{]\s*:([A-Za-z_]\w*[!?=]?)\s*=>\s*) |
+          ([,{]\s*"([A-Za-z_]\w*[!?=]?)"\s*=>\s*)
+        )
+        #{INSPECTED_STRING_VALUE}
+      /x
+      private_constant :INSPECTED_STRING_VALUE, :INSPECTED_REDACTABLE_VALUE
+
+      def redact_inspected_values(inspected)
+        inspected.gsub(INSPECTED_REDACTABLE_VALUE) do |match|
+          captures = Regexp.last_match.captures
+          prefix, = captures.each_slice(2).detect do |(_candidate_prefix, candidate_key)|
+            thing_filter.things.include?(candidate_key)
           end
+          prefix ? "#{prefix}#{thing_filter.label}" : match
         end
-        "#<#{self.class}:#{object_id} #{inspected_vars.join(", ")}>"
       end
     end
   end

data/lib/auth/sanitizer/sanitized_logger.rb

@@ -219,7 +219,7 @@ module Auth
       # @param [String] message Logger message
       # @return [String] Sanitized logger message
       def sanitize_authorization_header(message)
-        message.gsub(/(Authorization:\s*)(?:\"[^\"]*\"|[^\r\n]+)/i, "\\1\"#{thing_filter.label}\"")
+        message.gsub(/(Authorization:\s*)(?:"[^"]*"|[^\r\n]+)/i, "\\1\"#{thing_filter.label}\"")
       end
 
       # Redact JSON-style values for configured sensitive key names.
@@ -227,7 +227,7 @@ module Auth
       # @param [String] message Logger message
       # @return [String] Sanitized logger message
       def sanitize_json_pairs(message)
-        message.gsub(/([\"'])(#{thing_filter.pattern_source})\1(\s*:\s*)([\"'])(.*?)\4/i) do
+        message.gsub(/(["'])(#{thing_filter.pattern_source})\1(\s*:\s*)(["'])(.*?)\4/i) do
           %(#{$1}#{$2}#{$1}#{$3}#{$4}#{thing_filter.label}#{$4})
         end
       end
@@ -237,7 +237,7 @@ module Auth
       # @param [String] message Logger message
       # @return [String] Sanitized logger message
       def sanitize_form_and_query_pairs(message)
-        message.gsub(/(\b(?:#{thing_filter.pattern_source})=)([^&\s\"]+)/i, "\\1#{thing_filter.label}")
+        message.gsub(/(\b(?:#{thing_filter.pattern_source})=)([^&\s"]+)/i, "\\1#{thing_filter.label}")
       end
     end
   end

data/lib/auth/sanitizer/version.rb

@@ -3,7 +3,7 @@
 module Auth
   module Sanitizer
     module Version
-      VERSION = "0.1.4"
+      VERSION = "0.2.1"
     end
     VERSION = Version::VERSION # Traditional Constant Location
   end

data/lib/auth/sanitizer.rb

@@ -1,7 +1,13 @@
 # frozen_string_literal: true
 
+require "version_gem"
+
 require_relative "sanitizer/version"
 require_relative "sanitizer/thing_filter"
 require_relative "sanitizer/core"
 require_relative "sanitizer/filtered_attributes"
 require_relative "sanitizer/sanitized_logger"
+
+Auth::Sanitizer::Version.class_eval do
+  extend VersionGem::Basic
+end

data/lib/auth_sanitizer/loader.rb

@@ -22,12 +22,38 @@ module AuthSanitizer
       # @return [Module] isolated Auth::Sanitizer module
       def load_isolated
         namespace = Module.new
+        auth_namespace = Module.new
+        namespace.const_set(:Auth, auth_namespace)
+
         FILES.each do |relative_path|
           path = File.expand_path("../#{relative_path}", __dir__)
-          namespace.module_eval(File.read(path), path, 1)
+          auth_namespace.module_eval(isolated_source(path), path, 1)
         end
+
         namespace.const_get(:Auth).const_get(:Sanitizer)
       end
+
+      private
+
+      # Remove the public top-level Auth wrapper before evaluating a file inside
+      # the anonymous Auth namespace. This keeps the normal files unchanged while
+      # avoiding Object::Auth leakage on runtimes where Module#module_eval still
+      # resolves nested module declarations through Object.
+      def isolated_source(path)
+        lines = File.readlines(path)
+        wrapper_index = lines.index("module Auth\n")
+        return lines.join.split("Auth::Sanitizer").join("Sanitizer") unless wrapper_index
+
+        lines.delete_at(wrapper_index)
+        closing_index = lines.rindex("end\n")
+        lines.delete_at(closing_index) if closing_index
+
+        wrapper_index.upto(lines.length - 1) do |index|
+          line = lines[index]
+          lines[index] = line.start_with?("  ") ? line[2..-1] : line
+        end
+        lines.join.split("Auth::Sanitizer").join("Sanitizer")
+      end
     end
   end
 end

data/sig/auth/sanitizer/version.rbs

@@ -0,0 +1,8 @@
+module Auth
+  module Sanitizer
+    module Version
+      VERSION: String
+    end
+    VERSION: String
+  end
+end

data/sig/auth/sanitizer.rbs

@@ -1,10 +1,3 @@
-module Auth
-  module Sanitizer
-    VERSION: String
-    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-  end
-end
-
 module AuthSanitizer
   module Loader
     FILES: Array[String]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: auth-sanitizer
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.1
 platform: ruby
 authors:
 - Peter H. Boling
@@ -46,7 +46,7 @@ dependencies:
         version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.9
+        version: 1.1.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -56,21 +56,27 @@ dependencies:
         version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.9
+        version: 1.1.10
 - !ruby/object:Gem::Dependency
   name: kettle-dev
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -125,40 +131,60 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.6
+        version: 3.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.6
+        version: 3.1.1
 - !ruby/object:Gem::Dependency
   name: kettle-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.10
+        version: 2.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.10
+        version: 2.0.3
+- !ruby/object:Gem::Dependency
+  name: turbo_tests2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.1
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
@@ -199,21 +225,21 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.3
+        version: 2.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.3
-description: "\U0001F7E5 Configurable KV output redaction. Sanitize/filter your secrets."
+        version: 2.0.1
+description: "\U0001F48E Configurable KV output redaction. Sanitize/filter your secrets."
 email:
 - floss@galtzo.com
 executables: []
@@ -224,8 +250,8 @@ extra_rdoc_files:
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - FUNDING.md
+- LICENSE.md
 - README.md
-- REEK
 - RUBOCOP.md
 - SECURITY.md
 files:
@@ -234,10 +260,11 @@ files:
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - FUNDING.md
+- LICENSE.md
 - README.md
-- REEK
 - RUBOCOP.md
 - SECURITY.md
+- certs/pboling.pem
 - lib/auth/sanitizer.rb
 - lib/auth/sanitizer/core.rb
 - lib/auth/sanitizer/filtered_attributes.rb
@@ -246,15 +273,16 @@ files:
 - lib/auth/sanitizer/version.rb
 - lib/auth_sanitizer/loader.rb
 - sig/auth/sanitizer.rbs
+- sig/auth/sanitizer/version.rbs
 homepage: https://github.com/ruby-oauth/auth-sanitizer
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://auth-sanitizer.galtzo.com/
-  source_code_uri: https://github.com/ruby-oauth/auth-sanitizer/tree/v0.1.4
-  changelog_uri: https://github.com/ruby-oauth/auth-sanitizer/blob/v0.1.4/CHANGELOG.md
+  homepage_uri: https://auth-sanitizer.galtzo.com
+  source_code_uri: https://github.com/ruby-oauth/auth-sanitizer/tree/v0.2.1
+  changelog_uri: https://github.com/ruby-oauth/auth-sanitizer/blob/v0.2.1/CHANGELOG.md
   bug_tracker_uri: https://github.com/ruby-oauth/auth-sanitizer/issues
-  documentation_uri: https://www.rubydoc.info/gems/auth-sanitizer/0.1.4
+  documentation_uri: https://www.rubydoc.info/gems/auth-sanitizer/0.2.1
   funding_uri: https://github.com/sponsors/pboling
   wiki_uri: https://github.com/ruby-oauth/auth-sanitizer/wiki
   news_uri: https://www.railsbling.com/tags/auth-sanitizer
@@ -262,7 +290,7 @@ metadata:
   rubygems_mfa_required: 'true'
 rdoc_options:
 - "--title"
-- "auth-sanitizer - \U0001F7E5 Configurable KV output redaction"
+- "auth-sanitizer - \U0001F48E Configurable KV output redaction"
 - "--main"
 - README.md
 - "--exclude"
@@ -283,7 +311,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.11
+rubygems_version: 4.0.10
 specification_version: 4
-summary: "\U0001F7E5 Configurable KV output redaction"
+summary: "\U0001F48E Configurable KV output redaction"
 test_files: []