sentry-raven 3.0.0 → 3.1.1

data/lib/raven/processor/sanitizedata.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
+
 require 'json'
 
 module Raven
   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/
+    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
 
@@ -20,22 +21,13 @@ module Raven
     def process(value, key = nil)
       case value
       when Hash
-        !value.frozen? ? value.merge!(value) { |k, v| process v, k } : value.merge(value) { |k, v| process v, k }
+        sanitize_hash_value(key, value)
       when Array
-        !value.frozen? ? value.map! { |v| process v, key } : value.map { |v| process v, key }
+        sanitize_array_value(key, value)
       when Integer
         matches_regexes?(key, value.to_s) ? INT_MASK : value
       when String
-        if value =~ fields_re && (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)
-        else
-          value
-        end
+        sanitize_string_value(key, value)
       else
         value
       end
@@ -49,6 +41,39 @@ module Raven
       @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)
@@ -56,16 +81,38 @@ module Raven
       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 =~ fields_re
+        k =~ sensitive_fields
     end
 
-    def fields_re
-      return @fields_re if instance_variable_defined?(:@fields_re)
+    def sensitive_fields
+      return @sensitive_fields if instance_variable_defined?(:@sensitive_fields)
+
       fields = DEFAULT_FIELDS | sanitize_fields
       fields -= sanitize_fields_excluded
-      @fields_re = /#{fields.map do |f|
+      @sensitive_fields = /#{fields.map do |f|
         use_boundary?(f) ? "\\b#{f}\\b" : f
       end.join("|")}/i
     end
@@ -80,6 +127,7 @@ module Raven
 
     def parse_json_or_nil(string)
       return unless string.start_with?(*JSON_STARTS_WITH)
+
       JSON.parse(string)
     rescue JSON::ParserError, NoMethodError
       nil

data/lib/raven/processor/utf8conversion.rb

@@ -14,6 +14,7 @@ module Raven
         !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
@@ -27,6 +28,7 @@ module Raven
           value.force_encoding(Encoding::UTF_8)
         end
         return value if value.valid_encoding?
+
         remove_invalid_bytes(value)
       else
         value

data/lib/raven/transports.rb

@@ -13,3 +13,7 @@ module Raven
     end
   end
 end
+
+require "raven/transports/dummy"
+require "raven/transports/http"
+require "raven/transports/stdout"

data/lib/raven/transports/http.rb

@@ -1,7 +1,5 @@
 require 'faraday'
 
-require 'raven/transports'
-
 module Raven
   module Transports
     class HTTP < Transport
@@ -26,10 +24,10 @@ module Raven
           req.headers['X-Sentry-Auth'] = auth_header
           req.body = data
         end
-      rescue Faraday::Error => ex
-        error_info = ex.message
-        if ex.response && ex.response[:headers]['x-sentry-error']
-          error_info += " Error in headers is: #{ex.response[:headers]['x-sentry-error']}"
+      rescue Faraday::Error => e
+        error_info = e.message
+        if e.response && e.response[:headers]['x-sentry-error']
+          error_info += " Error in headers is: #{e.response[:headers]['x-sentry-error']}"
         end
         raise Raven::Error, error_info
       end
@@ -42,7 +40,7 @@ module Raven
         proxy = configuration.public_send(:proxy)
 
         Faraday.new(configuration.server, :ssl => ssl_configuration, :proxy => proxy) do |builder|
-          configuration.faraday_builder.call(builder) if configuration.faraday_builder
+          configuration.faraday_builder&.call(builder)
           builder.response :raise_error
           builder.options.merge! faraday_opts
           builder.headers[:user_agent] = "sentry-ruby/#{Raven::VERSION}"

data/lib/raven/utils/context_filter.rb

@@ -0,0 +1,42 @@
+module Raven
+  module Utils
+    module ContextFilter
+      class << self
+        ACTIVEJOB_RESERVED_PREFIX_REGEX = /^_aj_/.freeze
+        HAS_GLOBALID = const_defined?('GlobalID')
+
+        # Once an ActiveJob is queued, ActiveRecord references get serialized into
+        # some internal reserved keys, such as _aj_globalid.
+        #
+        # The problem is, if this job in turn gets queued back into ActiveJob with
+        # these magic reserved keys, ActiveJob will throw up and error. We want to
+        # capture these and mutate the keys so we can sanely report it.
+        def filter_context(context)
+          case context
+          when Array
+            context.map { |arg| filter_context(arg) }
+          when Hash
+            Hash[context.map { |key, value| filter_context_hash(key, value) }]
+          else
+            format_globalid(context)
+          end
+        end
+
+        private
+
+        def filter_context_hash(key, value)
+          key = key.to_s.sub(ACTIVEJOB_RESERVED_PREFIX_REGEX, "") if key.match(ACTIVEJOB_RESERVED_PREFIX_REGEX)
+          [key, filter_context(value)]
+        end
+
+        def format_globalid(context)
+          if HAS_GLOBALID && context.is_a?(GlobalID)
+            context.to_s
+          else
+            context
+          end
+        end
+      end
+    end
+  end
+end

data/lib/raven/utils/exception_cause_chain.rb

@@ -7,6 +7,7 @@ module Raven
           while exception.cause
             exception = exception.cause
             break if exceptions.any? { |e| e.object_id == exception.object_id }
+
             exceptions << exception
           end
           exceptions

data/lib/raven/utils/real_ip.rb

@@ -13,7 +13,7 @@ module Raven
         "fc00::/7",       # private IPv6 range fc00::/7
         "10.0.0.0/8",     # private IPv4 range 10.x.x.x
         "172.16.0.0/12",  # private IPv4 range 172.16.0.0 .. 172.31.255.255
-        "192.168.0.0/16", # private IPv4 range 192.168.x.x
+        "192.168.0.0/16" # private IPv4 range 192.168.x.x
       ].map { |proxy| IPAddr.new(proxy) }
 
       attr_accessor :ip, :ip_addresses

data/lib/raven/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
+
 module Raven
-  # Freezing this constant breaks in 1.9.x
-  VERSION = "3.0.0" # rubocop:disable Style/MutableConstant
+  VERSION = "3.1.1"
 end

data/lib/sentry-raven-without-integrations.rb

@@ -1 +1,6 @@
-require 'raven/base'
+require "raven/helpers/deprecation_helper"
+
+filename = "sentry_raven_without_integrations"
+DeprecationHelper.deprecate_dasherized_filename(filename)
+
+require filename

data/lib/sentry_raven_without_integrations.rb

@@ -0,0 +1 @@
+require 'raven/base'

data/sentry-ruby/.gitignore

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

data/sentry-ruby/.rspec

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

data/sentry-ruby/.travis.yml

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

data/sentry-ruby/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 stan001212@gmail.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/sentry-ruby/Gemfile

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

data/sentry-ruby/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 st0012
+
+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/sentry-ruby/README.md

@@ -0,0 +1,44 @@
+# Sentry::Ruby
+
+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/ruby`. 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-ruby'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sentry-ruby
+
+## 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-ruby. 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/[USERNAME]/sentry-ruby/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::Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sentry-ruby/blob/master/CODE_OF_CONDUCT.md).

data/sentry-ruby/Rakefile

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