sentry-sanitizer 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb6c212971a72b8442ab45d9a20b59329e9f96f8c08225659158b6a06c879b59
-  data.tar.gz: 2c84a79a9f0f2935b52261deef3ab6440e98a1885441c9d5fbb935a50c29574c
+  metadata.gz: f83f2a0c9bb759f6f43b1b25f3219e403123d8bdade87f5aa8f6838269e432e7
+  data.tar.gz: 9230c77fb3a9a178d457068e2ca03f5e8491f0778ff1cb8d76e8c2a612b6c409
 SHA512:
-  metadata.gz: c818383927f7313cacfd3df2b747e5e30949f7821fe4c8268234b65dd73d562792bbbddef7290f8c831bddf9049808d64d13524a003563c6b65b929688c7b259
-  data.tar.gz: a41a5b9bc70822f4fbec12ad4de89c7e7b0bfaca5a048f4feb30a3538093a5a9883552dcae2efa3169da60afe8b5eae8066d450247acb143485f323315a62cf9
+  metadata.gz: b7ec44c8b25b101d9fb01ec0472e1e6338db2c9d5385599f91341c911c9754951005d574d86a868fb13a4120c2a517e91d2334e2b9e93e4253adff9d0d77babf
+  data.tar.gz: 52e91220a7cc128f9c02e20889187cf2c2fe23bd7061b2e01e359f12b9da175fdc2a8218891676513b8ccc280da4afc0c3bf39e95dfabfecfaf1416b422fea67

data/.github/workflows/ci.yml

@@ -12,11 +12,10 @@ jobs:
     strategy:
       matrix:
         include:
-          - { ruby_version: 2.4 }
           - { ruby_version: 2.5 }
-          - { ruby_version: 2.4 }
           - { ruby_version: 2.7 }
           - { ruby_version: 3.0 }
+          - { ruby_version: 3.1 }
           - { ruby_version: jruby }
     steps:
       - uses: actions/checkout@v1

data/Gemfile.lock

@@ -1,37 +1,34 @@
 PATH
   remote: .
   specs:
-    sentry-sanitizer (0.5.0)
-      sentry-ruby (~> 5.3.0)
+    sentry-sanitizer (0.6.0)
+      sentry-ruby (~> 5.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    codecov (0.4.3)
+    codecov (0.6.0)
       simplecov (>= 0.15, < 0.22)
     concurrent-ruby (1.1.10)
-    diff-lcs (1.4.4)
-    docile (1.3.5)
-    rack (2.2.3)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    rack (2.2.3.1)
     rake (10.5.0)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    sentry-ruby (5.3.1)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    sentry-ruby (5.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      sentry-ruby-core (= 5.3.1)
-    sentry-ruby-core (5.3.1)
-      concurrent-ruby
     simplecov (0.18.5)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -50,4 +47,4 @@ DEPENDENCIES
   simplecov (~> 0.18.5)
 
 BUNDLED WITH
-   2.2.14
+   2.3.16

data/README.md

@@ -12,6 +12,7 @@ Currently this gem provides following features
 - [x] Sanitizing POST params
 - [x] Sanitizing HTTP headers
 - [x] Sanitizing cookies
+- [x] Sanitizing query string
 - [x] Sanitizing extras ([see](https://docs.sentry.io/platforms/ruby/enriching-events/context/#additional-data) `Sentry.set_extras`)
 
 ## Installation

data/lib/sentry/sanitizer/cleaner.rb

@@ -13,6 +13,7 @@ module Sentry
         @fields = config.fields || []
         @http_headers = config.http_headers || DEFAULT_SENSITIVE_HEADERS
         @do_cookies = config.cookies || false
+        @do_query_string = config.query_string || false
       end
 
       def call(event)
@@ -33,14 +34,17 @@ module Sentry
           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)
         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'])
         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])
         end
       end
 
@@ -53,7 +57,7 @@ module Sentry
 
       private
 
-      attr_reader :fields, :http_headers, :do_cookies
+      attr_reader :fields, :http_headers, :do_cookies, :do_query_string
 
       # Sanitize specified headers
       def sanitize_headers(headers)
@@ -76,12 +80,26 @@ module Sentry
 
       # Sanitize all cookies
       def sanitize_cookies(cookies)
-        return cookies unless cookies.is_a? Hash
         return cookies unless do_cookies
+        return cookies unless cookies.is_a? Hash
 
         cookies.transform_values { DEFAULT_MASK }
       end
 
+      def sanitize_query_string(query_string)
+        return query_string unless do_query_string
+        return query_string unless query_string.is_a? String
+
+        sanitized_array = query_string.split('&').map do |kv_pair|
+          k, v = kv_pair.split('=')
+          new_v = sanitize_string(k, v)
+
+          "#{k}=#{new_v}"
+        end
+
+        sanitized_array.join('&')
+      end
+
       def sanitize_value(value, key)
         case value
         when Hash

data/lib/sentry/sanitizer/configuration.rb

@@ -24,10 +24,10 @@ module Sentry
 
   module Sanitizer
     class Configuration
-      attr_accessor :fields, :http_headers, :cookies
+      attr_accessor :fields, :http_headers, :cookies, :query_string
 
       def configured?
-        [fields, http_headers, cookies].any? { |setting| !setting.nil? }
+        [fields, http_headers, cookies, query_string].any? { |setting| !setting.nil? }
       end
 
       def fields=(fields)
@@ -48,11 +48,19 @@ module Sentry
 
       def cookies=(cookies)
         unless [TrueClass, FalseClass].include?(cookies.class)
-          raise ArgumentError, 'sanitize_cookies must be boolean'
+          raise ArgumentError, 'cookies must be boolean'
         end
 
         @cookies = cookies
       end
+
+      def query_string=(query_string)
+        unless [TrueClass, FalseClass].include?(query_string.class)
+          raise ArgumentError, 'query_string must be boolean'
+        end
+
+        @query_string = query_string
+      end
     end
   end
 end

data/lib/sentry/sanitizer/version.rb

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

data/sentry-sanitizer.gemspec

@@ -36,5 +36,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rack'
 
-  spec.add_runtime_dependency 'sentry-ruby', '~> 5.3.0'
+  spec.add_runtime_dependency 'sentry-ruby', '~> 5.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-sanitizer
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Valentine Kiselev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-26 00:00:00.000000000 Z
+date: 2022-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codecov
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.3.0
+        version: '5.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.3.0
+        version: '5.3'
 description: Add missing sanitizing support for sentry-ruby (previous sentry-raven)
 email:
 - mrexox@outlook.com
@@ -156,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Sanitizing middleware for sentry-ruby gem