sentry-sanitizer 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f83f2a0c9bb759f6f43b1b25f3219e403123d8bdade87f5aa8f6838269e432e7
-  data.tar.gz: 9230c77fb3a9a178d457068e2ca03f5e8491f0778ff1cb8d76e8c2a612b6c409
+  metadata.gz: 28b8d09f046de5bcc8a49a8d45bb6085fcd8cc7a75b45c124d3852ed10d0d6a8
+  data.tar.gz: 81ca424f2d0621de3145ce51e33b832eae035b0a47b3d1e34ef12405e9635682
 SHA512:
-  metadata.gz: b7ec44c8b25b101d9fb01ec0472e1e6338db2c9d5385599f91341c911c9754951005d574d86a868fb13a4120c2a517e91d2334e2b9e93e4253adff9d0d77babf
-  data.tar.gz: 52e91220a7cc128f9c02e20889187cf2c2fe23bd7061b2e01e359f12b9da175fdc2a8218891676513b8ccc280da4afc0c3bf39e95dfabfecfaf1416b422fea67
+  metadata.gz: 7d0071d14501f30602faf1a8f9cbd66616a5f8f466f452e0e6d2f7c60c6fc5728b8bfcf9a29fb114945096b90b1b8d62fe44c4379372f724884c9e8820f6b2ff
+  data.tar.gz: 7bc07680b68c911b4ac150a3aeb7896ed7494700d74f9d5f6da2a2476e682d5fad35609e517c1aee3097f2f9994a2f54600966c201bcc0263475de964f41ccb7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sentry-sanitizer (0.6.0)
+    sentry-sanitizer (0.6.1)
       sentry-ruby (~> 5.3)
 
 GEM

data/README.md

@@ -56,6 +56,9 @@ Sentry.init do |config|
   # You can sanitize all cookies with this setting
   config.sanitize.cookies = true
 
+  # You can sanitize query string params for GET requests
+  config.sanitize.query_string = true
+
   # ...
 end
 ```

data/lib/sentry/sanitizer/cleaner.rb

@@ -14,37 +14,38 @@ module Sentry
         @http_headers = config.http_headers || DEFAULT_SENSITIVE_HEADERS
         @do_cookies = config.cookies || false
         @do_query_string = config.query_string || false
+        @mask = config.mask || DEFAULT_MASK
       end
 
       def call(event)
         if event.is_a?(Sentry::Event)
-          sanitize_request(event, :object) if event.request
-          event.extra = sanitize_data(event.extra)
+          sanitize(event, :object) if event.request
         elsif event.is_a?(Hash)
-          sanitize_request(event, :stringified_hash) if event['request']
-          sanitize_request(event, :symbolized_hash) if event[:request]
-          event['extra'] = sanitize_data(event['extra']) if event['extra']
-          event[:extra] = sanitize_data(event[:extra]) if event[:extra]
+          sanitize(event, :stringified_hash) if event['request']
+          sanitize(event, :symbolized_hash) if event[:request]
         end
       end
 
-      def sanitize_request(event, type)
+      def sanitize(event, type)
         case type
         when :object
           event.request.data = sanitize_data(event.request.data)
           event.request.headers = sanitize_headers(event.request.headers)
           event.request.cookies = sanitize_cookies(event.request.cookies)
           event.request.query_string = sanitize_query_string(event.request.query_string)
+          event.extra = sanitize_data(event.extra)
         when :stringified_hash
           event['request']['data'] = sanitize_data(event['request']['data'])
           event['request']['headers'] = sanitize_headers(event['request']['headers'])
           event['request']['cookies'] = sanitize_cookies(event['request']['cookies'])
           event['request']['query_string'] = sanitize_query_string(event['request']['query_string'])
+          event['extra'] = sanitize_data(event['extra'])
         when :symbolized_hash
           event[:request][:data] = sanitize_data(event[:request][:data])
           event[:request][:headers] = sanitize_headers(event[:request][:headers])
           event[:request][:cookies] = sanitize_cookies(event[:request][:cookies])
           event[:request][:query_string] = sanitize_query_string(event[:request][:query_string])
+          event[:extra] = sanitize_data(event[:extra])
         end
       end
 
@@ -57,19 +58,23 @@ module Sentry
 
       private
 
-      attr_reader :fields, :http_headers, :do_cookies, :do_query_string
+      attr_reader :fields,
+                  :http_headers,
+                  :do_cookies,
+                  :do_query_string,
+                  :mask
 
       # Sanitize specified headers
       def sanitize_headers(headers)
         case http_headers
         when TrueClass
-          headers.transform_values { DEFAULT_MASK }
+          headers.transform_values { mask }
         when Array
           return headers unless http_headers.size.positive?
           http_headers_regex = sensitive_regexp(http_headers)
 
           headers.keys.select { |key| key.match?(http_headers_regex) }.each do |key|
-            headers[key] = DEFAULT_MASK
+            headers[key] = mask
           end
 
           headers
@@ -83,7 +88,7 @@ module Sentry
         return cookies unless do_cookies
         return cookies unless cookies.is_a? Hash
 
-        cookies.transform_values { DEFAULT_MASK }
+        cookies.transform_values { mask }
       end
 
       def sanitize_query_string(query_string)
@@ -115,7 +120,7 @@ module Sentry
 
       def sanitize_hash(key, value)
         if key&.match?(sensitive_fields)
-          DEFAULT_MASK
+          mask
         elsif value.frozen?
           value.merge(value) { |k, v| sanitize_value(v, k) }
         else
@@ -132,7 +137,7 @@ module Sentry
       end
 
       def sanitize_string(key, value)
-        key&.match?(sensitive_fields) ? DEFAULT_MASK : value
+        key&.match?(sensitive_fields) ? mask : value
       end
 
       def sensitive_fields

data/lib/sentry/sanitizer/configuration.rb

@@ -24,10 +24,19 @@ module Sentry
 
   module Sanitizer
     class Configuration
-      attr_accessor :fields, :http_headers, :cookies, :query_string
+      attr_accessor :fields,
+                    :http_headers,
+                    :cookies,
+                    :query_string,
+                    :mask
 
       def configured?
-        [fields, http_headers, cookies, query_string].any? { |setting| !setting.nil? }
+        [
+          fields,
+          http_headers,
+          cookies,
+          query_string
+        ].any? { |setting| !setting.nil? }
       end
 
       def fields=(fields)
@@ -61,6 +70,14 @@ module Sentry
 
         @query_string = query_string
       end
+
+      def mask=(mask)
+        unless mask.is_a?(String)
+          raise ArgumentError, 'mask must be string'
+        end
+
+        @mask = mask
+      end
     end
   end
 end

data/lib/sentry/sanitizer/configuration_mixin.rb

@@ -2,12 +2,15 @@ module Sentry
   module Sanitizer
     module ConfigurationMixin
       # Allow adding multiple hooks for this extension
+      #
+      # @param [nil, false, #call] value
+      #
       def before_send=(value)
-        unless value == nil || value.respond_to?(:call)
+        unless value == nil || value == false || value.respond_to?(:call)
           raise ArgumentError, "before_send must be callable (or false to disable)"
         end
 
-        return if value == nil
+        return unless value
 
         @before_send_hook_list ||= []
         @before_send_hook_list << value

data/lib/sentry/sanitizer/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module Sanitizer
-    VERSION = '0.6.0'
+    VERSION = '0.6.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-sanitizer
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Valentine Kiselev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-19 00:00:00.000000000 Z
+date: 2022-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codecov
@@ -156,7 +156,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: Sanitizing middleware for sentry-ruby gem