mrexox / sentry-sanitizer

Sanitizing middleware for sentry-ruby gem

sentry-sanitizer: sanitizing extension for sentry-ruby

This gem aimed to add sanitizing support to sentry-ruby gem.

sentry-raven gem had this apportunity but it is no longer supported. Moving from sentry-raven to sentry-ruby can surprise you with missing this ability. But you can still use sentry-sanitizer (with a little change to configuration).

Currently this gem provides following features

• Sanitizing POST params
• Sanitizing HTTP headers
• Sanitizing cookies
• Sanitizing query string
• Sanitizing extras (see Sentry.set_extras)

Installation

⚠️ Please, don't use 0.1.* version as it was experimental and not usable at all.

Add this line to your application's Gemfile:

gem 'sentry-sanitizer', '>= 0.2.0'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sentry-sanitizer

Usage

Add following lines to your Sentry configuration:

Sentry.init do |config|
  # ... your configuration

  # If using Rails
  config.sanitize.fields = Rails.application.config.filter_parameters

  # You can also pass custom array
  config.sanitize.fields = %w[password super_secret_token]

  # HTTP headers can be sanitized too (it is case insensitive)
  config.sanitize.http_headers = %w[Authorization X-Xsrf-Token]

  # You can sanitize all HTTP headers with setting `true` value
  config.sanitize.http_headers = true

  # 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

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/mrexox/sentry-sanitizer.

License

The gem is available as open source under the terms of the BSD-3-Clause License.

sentry-sanitizer's Issues

Cleaning of query params

It would be nice if sentry-sanitizer would be able to filter query params as well, as they obviously can contain sensitive data too.