sentry-sanitizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2531529a81144119d0073bb8cadf32b44b98bf7704e78e5bdb7005db626a57b
+  data.tar.gz: 0cad872dcaff97f50a97739794b9c625bcad81aad616c6fb2f59b568fd3b938c
+SHA512:
+  metadata.gz: 9ecae6a901360c2a74f81e4d682ce6531bd98bf411aa6a68b84617b85dec1d90bcec41c730a4dfecc2e534afc8676ddeb3247c24b5f33e5dbb6f0e230bbed354
+  data.tar.gz: ec6e59364de9fd75d8a02f879c4449259ecbd4e895f9bcfe35d3be8cde4b5907aab4e9f3af634b5deee2c8137e2fd50c624c7960bf0978005ee30a4f22f38ffb

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sentry-sanitizer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Valentine Kiselev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Sentry::Sanitizer
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sentry/sanitizer`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sentry-sanitizer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sentry-sanitizer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sentry-sanitizer.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+require "bundler/gem_helper"
+Bundler::GemHelper.install_tasks(name: "sentry-sanitizer")
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sentry/sanitizer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sentry-sanitizer.rb

@@ -0,0 +1,2 @@
+require 'sentry/sanitizer/version'
+require 'sentry/sanitizer'

data/lib/sentry/sanitizer.rb

@@ -0,0 +1,11 @@
+require 'sentry-ruby'
+require 'sentry/integrable'
+require 'sentry/sanitizer/configuration'
+
+module Sentry
+  module Sanitizer
+    extend Integrable
+
+    register_integration name: 'sanitizer', version: Sentry::Sanitizer::VERSION
+  end
+end

data/lib/sentry/sanitizer/cleaner.rb

@@ -0,0 +1,109 @@
+module Sentry
+  module Sanitizer
+    class Cleaner
+      HOOK = ->(event, hint) do
+        Sentry::Sanitizer::Cleaner.new(Sentry.configuration.sanitize).call(event)
+
+        event
+      end.freeze
+
+      DEFAULT_MASK = '[FILTERED]'.freeze
+      DEFAULT_SENSITIVE_HEADERS = %w[
+        Authorization
+        X-Xsrf-Token
+      ].freeze
+
+      private_constant :SENSITIVE_HEADERS
+
+      def initialize(config)
+        @fields = config.fields || []
+        @http_headers = config.http_headers || []
+        @cookies = config.cookies || false
+      end
+
+      def call(event)
+        if event.is_a?(Sentry::Event)
+          event.request = sanitize_request(event.request) if event.request
+          event.extra = sanitize_hash(event.extra) if event.extra
+        end
+      end
+
+      def sanitize_request(request)
+        request.data = sanitize_hash(request.data) if fields
+        request.headers = sanitize_headers(request.headers) if http_headers
+        request.cookies = sanitize_cookies(request.cookies) if cookies
+      end
+
+      def sanitize_hash(hash)
+        return if hash.blank?
+
+        sanitize_value(hash, nil)
+      end
+
+      private
+
+      attr_reader :fields, :http_headers, :cookies
+
+      # Sanitize specified headers
+      def sanitize_headers(headers)
+        headers.keys.select { |key| key.match?(sensitive_headers) }.each do |key|
+          headers[key] = DEFAULT_MASK
+        end
+
+        headers
+      end
+
+      # Sanitize all cookies
+      def sanitize_cookies(cookies)
+        cookies.transform_values { DEFAULT_MASK }
+      end
+
+      def sanitize_value(value, key)
+        case value
+        when Hash
+          sanitize_hash(key, value)
+        when Array
+          sanitize_array(key, value)
+        when String
+          sanitize_string(key, value)
+        else
+          value
+        end
+      end
+
+      def sanitize_hash(key, value)
+        if key&.match?(sensitive_fields)
+          DEFAULT_MASK
+        elsif value.frozen?
+          value.merge(value) { |k, v| sanitize_value(v, k) }
+        else
+          value.merge!(value) { |k, v| sanitize_value(v, k) }
+        end
+      end
+
+      def sanitize_array(key, value)
+        if value.frozen?
+          value.map { |val| sanitize_value(val, key) }
+        else
+          value.map! { |val| sanitize_value(val, key) }
+        end
+      end
+
+      def sanitize_string(key, value)
+        key&.match?(sensitive_fields) ? DEFAULT_MASK : value
+      end
+
+      def sensitive_fields
+        @sensitive_fields ||= sensitive_regexp(fields)
+      end
+
+      def sensitive_headers
+        @sensitive_headers ||= sensitive_regexp(DEFAULT_SENSITIVE_HEADERS | http_headers)
+      end
+
+      def sensitive_regexp(fields)
+        Regexp.new(fields.map { |field| "\\b#{field}\\b" }.join('|'), 'i')
+      end
+    end
+  end
+end

data/lib/sentry/sanitizer/configuration.rb

@@ -0,0 +1,64 @@
+require 'sentry/sanitizer/cleaner'
+
+module Sentry
+  # Monkey-patching Sentry::Configuration
+  class Configuration
+    # Allow adding multiple hooks for this extension
+    def before_send=(value)
+      super
+
+      return value if value == false
+
+      @before_send_hook_list ||= []
+      @before_send_hook_list << value
+
+      @before_send = ->(event, hint) {
+        @before_send_hook_list.each do |hook|
+          event = hook.call(event, hint)
+        end
+      }
+    end
+
+    def sanitize
+      @sanitize ||= Sentry::Sanitizer::Configuration.new
+    end
+
+    def sanitize_fields=(fields)
+      unless fields.is_a? Array
+        raise ArgumentError, 'sanitize_fields must be array'
+      end
+
+      sanitize.fields = fields
+    end
+
+    def sanitize_http_headers(headers)
+      unless headers.is_a? Array
+        raise ArgumentError, 'sanitize_http_headers must be array'
+      end
+
+      sanitize.http_headers = headers
+    end
+
+    def sanitize_cookies(cookies)
+      unless [TrueClass, FalseClass].include?(cookies.class)
+        raise ArgumentError, 'sanitize_cookies must be boolean'
+      end
+
+      sanitize.cookies = cookies
+    end
+
+    add_post_initialization_callback do
+      self.before_send = Sentry::Sanitizer::Cleaner::HOOK if sanitize.configured?
+    end
+  end
+
+  module Sanitizer
+    class Configuration
+      attr_accessor :fields, :http_headers, :cookies
+
+      def configured?
+        [fields, http_headers, cookies].any? { |setting| !setting.nil? }
+      end
+    end
+  end
+end

data/lib/sentry/sanitizer/version.rb

@@ -0,0 +1,5 @@
+module Sentry
+  module Sanitizer
+    VERSION = "0.1.0"
+  end
+end

data/sentry-sanitizer.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sentry/sanitizer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sentry-sanitizer'
+  spec.version       = Sentry::Sanitizer::VERSION
+  spec.authors       = ['Valentine Kiselev']
+  spec.email         = ['mrexox@outlook.com']
+
+  spec.summary       = %q{Sanitizing middleware for sentry-ruby gem}
+  spec.description   = %q{Add missing sanitizing support for sentry-ruby (previous sentry-rav)}
+  spec.homepage      = 'https://github.com/mrexox/sentry-sanitizer'
+  spec.license       = 'BSD'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '>= 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_runtime_dependency 'sentry-ruby', '~> 4.2.0'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: sentry-sanitizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Valentine Kiselev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sentry-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+description: Add missing sanitizing support for sentry-ruby (previous sentry-rav)
+email:
+- mrexox@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sentry-sanitizer.rb
+- lib/sentry/sanitizer.rb
+- lib/sentry/sanitizer/cleaner.rb
+- lib/sentry/sanitizer/configuration.rb
+- lib/sentry/sanitizer/version.rb
+- sentry-sanitizer.gemspec
+homepage: https://github.com/mrexox/sentry-sanitizer
+licenses:
+- BSD
+metadata:
+  homepage_uri: https://github.com/mrexox/sentry-sanitizer
+  source_code_uri: https://github.com/mrexox/sentry-sanitizer
+  changelog_uri: https://github.com/mrexox/sentry-sanitizer
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Sanitizing middleware for sentry-ruby gem
+test_files: []