sentry-sanitize 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f15481201515e0e87778ada1e44fd5851379d7ae4e8897a0b23a28892ac500ac
+  data.tar.gz: 0f0af15d52b8894b5ba4ec9a37f3fd8134c721dab38009a888ce32a14d1c363f
+SHA512:
+  metadata.gz: f4c5f936a5e0e4d3a08461ba2ce0db9b56668266f850f541a6a6c769238a04382ce7f9bf2e4070874b1b9bb3374c3abeba393788e216788bc67662449ec352f3
+  data.tar.gz: 911aa9c502d8fcef4fe2e9457ce1028148d282c3d99d514bffe8cd54c72ddf383a14cc9298a3029732e20b9566a2e6564365c389a6c5560bd1c8be55691dbd20

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.3
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at niko@tasboa.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sentry-sanitize.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    sentry-sanitize (0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    rake (12.3.3)
+    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.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  sentry-sanitize!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Niko Roberts
+
+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,65 @@
+# Sentry::Sanitize
+
+This gem is extracting the old Raven client side sanitization helpers that existed pre-4.0 of the `sentry-ruby` gem.
+
+https://github.com/getsentry/sentry-ruby/issues/1140
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sentry-sanitize'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sentry-sanitize
+
+## Usage
+
+Inside your Sentry initializer you should add this:
+
+```
+Sentry.init do |config|
+    # your other Sentry config options go here
+
+    sanitizer = Sentry::Sanitize::Processor::CustomSanitizeData.new(Rails.application.config.filter_parameters.map(&:to_s))
+
+    config.before_send = lambda do |event, hint|
+      # Overrides the event level with custom level based on exception raised
+      event.level = ErrorReporting.level(hint[:exception], event.level)
+
+      event.to_hash.tap do |event_hash| # event needs to be a Hash for sanitizer to work
+        if (request = event_hash[:request]).present?
+          request[:cookies] = nil
+          sanitizer.process(request)
+        end
+      end
+    end
+end
+```
+
+
+## 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/airtasker/sentry-sanitize. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/airtasker/sentry-sanitize/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sentry::Sanitize project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/airtasker/sentry-sanitize/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sentry/sanitize"
+
+# 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/README

@@ -0,0 +1,6 @@
+In a major version upgrade of the Sentry gem they removed out-of-the-box
+support for sanitizing fields client-side.
+
+The files contained in this directory were downloaded from the Raven gem (except for custom_sanitize_data.rb)
+https://github.com/getsentry/sentry-ruby/tree/82e1ffe711af287ddc23e8517bdb8275beff94d5/sentry-raven/lib/raven/processor
+

data/lib/sentry/sanitize/processor/custom_sanitize_data.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'sentry/sanitize/processor'
+require 'sentry/sanitize/processor/sanitize_data'
+require 'sentry/sanitize/processor/utf8conversion'
+
+module Sentry
+  class Processor::CustomSanitizeData < Processor::SanitizeData
+    def initialize(sanitize_fields)
+      self.sanitize_fields = sanitize_fields
+      self.sanitize_credit_cards = true
+      self.sanitize_fields_excluded = []
+    end
+  end
+end

data/lib/sentry/sanitize/processor/sanitize_data.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Sentry
+  class Processor::SanitizeData < Processor
+    DEFAULT_FIELDS = %w(authorization password passwd secret ssn social(.*)?sec).freeze
+    CREDIT_CARD_RE = /\b(?:3[47]\d|(?:4\d|5[1-5]|65)\d{2}|6011)\d{12}\b/.freeze
+    QUERY_STRING = ['query_string', :query_string].freeze
+    JSON_STARTS_WITH = ["[", "{"].freeze
+
+    attr_accessor :sanitize_fields, :sanitize_credit_cards, :sanitize_fields_excluded
+
+    def initialize(client)
+      super
+      self.sanitize_fields = client.configuration.sanitize_fields
+      self.sanitize_credit_cards = client.configuration.sanitize_credit_cards
+      self.sanitize_fields_excluded = client.configuration.sanitize_fields_excluded
+    end
+
+    def process(value, key = nil)
+      case value
+      when Hash
+        sanitize_hash_value(key, value)
+      when Array
+        sanitize_array_value(key, value)
+      when Integer
+        matches_regexes?(key, value.to_s) ? INT_MASK : value
+      when String
+        sanitize_string_value(key, value)
+      else
+        value
+      end
+    end
+
+    private
+
+    # CGI.parse takes our nice UTF-8 strings and converts them back to ASCII,
+    # so we have to convert them back, again.
+    def utf8_processor
+      @utf8_processor ||= Processor::UTF8Conversion.new
+    end
+
+    def sanitize_hash_value(key, value)
+      if key =~ sensitive_fields
+        STRING_MASK
+      elsif value.frozen?
+        value.merge(value) { |k, v| process v, k }
+      else
+        value.merge!(value) { |k, v| process v, k }
+      end
+    end
+
+    def sanitize_array_value(key, value)
+      if value.frozen?
+        value.map { |v| process v, key }
+      else
+        value.map! { |v| process v, key }
+      end
+    end
+
+    def sanitize_string_value(key, value)
+      if value =~ sensitive_fields && (json = parse_json_or_nil(value))
+        # if this string is actually a json obj, convert and sanitize
+        process(json).to_json
+      elsif matches_regexes?(key, value)
+        STRING_MASK
+      elsif QUERY_STRING.include?(key)
+        sanitize_query_string(value)
+      elsif value =~ sensitive_fields
+        sanitize_sensitive_string_content(value)
+      else
+        value
+      end
+    end
+
+    def sanitize_query_string(query_string)
+      query_hash = CGI.parse(query_string)
+      sanitized = utf8_processor.process(query_hash)
+      processed_query_hash = process(sanitized)
+      URI.encode_www_form(processed_query_hash)
+    end
+
+    # this scrubs some sensitive info from the string content. for example:
+    #
+    # ```
+    # unexpected token at '{
+    # "role": "admin","password": "Abc@123","foo": "bar"
+    # }'
+    # ```
+    #
+    # will become
+    #
+    # ```
+    # unexpected token at '{
+    # "role": "admin","password": *******,"foo": "bar"
+    # }'
+    # ```
+    #
+    # it's particularly useful in hash or param-parsing related errors
+    def sanitize_sensitive_string_content(value)
+      value.gsub(/(#{sensitive_fields}['":]\s?(:|=>)?\s?)(".*?"|'.*?')/, '\1' + STRING_MASK)
+    end
+
+    def matches_regexes?(k, v)
+      (sanitize_credit_cards && v =~ CREDIT_CARD_RE) ||
+        k =~ sensitive_fields
+    end
+
+    def sensitive_fields
+      return @sensitive_fields if instance_variable_defined?(:@sensitive_fields)
+
+      fields = DEFAULT_FIELDS | sanitize_fields
+      fields -= sanitize_fields_excluded
+      @sensitive_fields = /#{fields.map do |f|
+        use_boundary?(f) ? "\\b#{f}\\b" : f
+      end.join("|")}/i
+    end
+
+    def use_boundary?(string)
+      !DEFAULT_FIELDS.include?(string) && !special_characters?(string)
+    end
+
+    def special_characters?(string)
+      REGEX_SPECIAL_CHARACTERS.select { |r| string.include?(r) }.any?
+    end
+
+    def parse_json_or_nil(string)
+      return unless string.start_with?(*JSON_STARTS_WITH)
+
+      JSON.parse(string)
+    rescue JSON::ParserError, NoMethodError
+      nil
+    end
+  end
+end

data/lib/sentry/sanitize/processor/utf8conversion.rb

@@ -0,0 +1,54 @@
+module Sentry
+  class Processor::UTF8Conversion < Processor
+    # Slightly misnamed - actually just removes any bytes with invalid encoding
+    # Previously, our JSON backend required UTF-8. Since we now use the built-in
+    # JSON, we can use any encoding, but it must be valid anyway so we can do
+    # things like call #match and #slice on strings
+    REPLACE = "".freeze
+
+    def process(value)
+      case value
+      when Hash
+        !value.frozen? ? value.merge!(value) { |_, v| process v } : value.merge(value) { |_, v| process v }
+      when Array
+        !value.frozen? ? value.map! { |v| process v } : value.map { |v| process v }
+      when Exception
+        return value if value.message.valid_encoding?
+
+        clean_exc = value.class.new(remove_invalid_bytes(value.message))
+        clean_exc.set_backtrace(value.backtrace)
+        clean_exc
+      when String
+        # Encoding::BINARY / Encoding::ASCII_8BIT is a special binary encoding.
+        # valid_encoding? will always return true because it contains all codepoints,
+        # so instead we check if it only contains actual ASCII codepoints, and if
+        # not we assume it's actually just UTF8 and scrub accordingly.
+        if value.encoding == Encoding::BINARY && !value.ascii_only?
+          value = value.dup
+          value.force_encoding(Encoding::UTF_8)
+        end
+        return value if value.valid_encoding?
+
+        remove_invalid_bytes(value)
+      else
+        value
+      end
+    end
+
+    private
+
+    # Stolen from RSpec
+    # https://github.com/rspec/rspec-support/blob/f0af3fd74a94ff7bb700f6ba06dbdc67bba17fbf/lib/rspec/support/encoded_string.rb#L120-L139
+    if String.method_defined?(:scrub) # 2.1+
+      def remove_invalid_bytes(string)
+        string.scrub(REPLACE)
+      end
+    else
+      def remove_invalid_bytes(string)
+        string.chars.map do |char|
+          char.valid_encoding? ? char : REPLACE
+        end.join
+      end
+    end
+  end
+end

data/lib/sentry/sanitize/processor.rb

@@ -0,0 +1,15 @@
+module Raven
+  class Processor
+    STRING_MASK = '********'.freeze
+    INT_MASK = 0
+    REGEX_SPECIAL_CHARACTERS = %w(. $ ^ { [ ( | ) * + ?).freeze
+
+    def initialize(client = nil)
+      @client = client
+    end
+
+    def process(_data)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/sentry/sanitize/version.rb

@@ -0,0 +1,5 @@
+module Sentry
+  module Sanitize
+    VERSION = "0.3.0"
+  end
+end

data/lib/sentry/sanitize.rb

@@ -0,0 +1,8 @@
+require "sentry/sanitize/version"
+require "sentry/sanitize/processor/custom_sanitize_data"
+
+module Sentry
+  module Sanitize
+    class Error < StandardError; end
+  end
+end

data/sentry-sanitize.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/sentry/sanitize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sentry-sanitize"
+  spec.version       = Sentry::Sanitize::VERSION
+  spec.authors       = ["Niko Roberts"]
+  spec.email         = ["niko@tasboa.com"]
+
+  spec.summary       = "Client side sanitizer for Sentry"
+  spec.description   = "Client side sanitizer for Sentry. Replicating the Raven sanitization from pre 4.0"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = "https://github.com/airtasker/sentry-sanitize/"
+  spec.metadata["source_code_uri"] = "https://github.com/airtasker/sentry-sanitize/"
+  spec.metadata["changelog_uri"] = "https://github.com/airtasker/sentry-sanitize/blob/master/CHANGELOG.md"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: sentry-sanitize
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Niko Roberts
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-11 00:00:00.000000000 Z
+dependencies: []
+description: Client side sanitizer for Sentry. Replicating the Raven sanitization
+  from pre 4.0
+email:
+- niko@tasboa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sentry/.DS_Store
+- lib/sentry/README
+- lib/sentry/sanitize.rb
+- lib/sentry/sanitize/processor.rb
+- lib/sentry/sanitize/processor/custom_sanitize_data.rb
+- lib/sentry/sanitize/processor/sanitize_data.rb
+- lib/sentry/sanitize/processor/utf8conversion.rb
+- lib/sentry/sanitize/version.rb
+- sentry-sanitize.gemspec
+homepage:
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/airtasker/sentry-sanitize/
+  source_code_uri: https://github.com/airtasker/sentry-sanitize/
+  changelog_uri: https://github.com/airtasker/sentry-sanitize/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Client side sanitizer for Sentry
+test_files: []