scan-suppressing-logger 0.1.0.pre.alpha1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e9f9d834c0af78e56cc626c86638d206fc270525668e806a18154727ffb525f4
+  data.tar.gz: 603d7db833b4ec1b90ba8e1f4630883dbdd5578cab22ece613191252ab334f0e
+SHA512:
+  metadata.gz: 867aeda2ef35dbc82ed1250f444bb0621798ed2c1d1433c18ef4e602008ec16948e80709af013ce23a50bef1115e2427bde52e5e5b0cfba1caf08db2ca8bfacb
+  data.tar.gz: a2fce6dd56b4e31aece5c8e86c1db6003c1b279aa9ae4a162f7e81e12b5f4d90673876498bd27ff1095a1b937efaa0106d4a5cbcf90f1f429848757fb2f45bad

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/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 team@pixielabs.io. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org [version]:
+http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in scan-suppressing-logger.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,142 @@
+PATH
+  remote: .
+  specs:
+    scan-suppressing-logger (0.1.0.pre.alpha.1)
+      rails (>= 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.3)
+      actionpack (= 5.2.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.3)
+      activesupport (= 5.2.3)
+      globalid (>= 0.3.6)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activestorage (5.2.3)
+      actionpack (= 5.2.3)
+      activerecord (= 5.2.3)
+      marcel (~> 0.3.1)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubi (1.8.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.3)
+    mini_mime (1.0.1)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nio4r (2.3.1)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.3)
+      actioncable (= 5.2.3)
+      actionmailer (= 5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      activemodel (= 5.2.3)
+      activerecord (= 5.2.3)
+      activestorage (= 5.2.3)
+      activesupport (= 5.2.3)
+      bundler (>= 1.3.0)
+      railties (= 5.2.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.1)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  scan-suppressing-logger!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Pixie Labs
+
+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,87 @@
+# ScanSuppressingLogger
+
+Rails middleware to suppress logging and exception reporting for certain IP
+addresses or IP address ranges. Useful if your application is the target of
+automated security scans (e.g. a scheduled penetration test) that fills your
+logs with garbage errors and requests.
+
+Suppresses the standard Rails logging, and also suppresses exception reporting
+for:
+
+ - [Rollbar](https://rollbar.com)
+ - _Sentry & more coming soon!_
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'scan-suppressing-logger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scan-suppressing-logger
+
+## Usage
+
+Add to your `config/environments/production.rb`:
+
+```ruby
+# config/environments/production.rb
+config.middleware.swap Rails::Rack::Logger, ScanSuppressingLogger::Middleware, {
+  networks: ['123.0.2.2/24', '86.54.222.1/16']
+}
+```
+
+Pass an array of IP addresses or networks as strings to suppress logging for.
+These should be parseable by
+[IPAddr](https://ruby-doc.org/stdlib-2.6.3/libdoc/ipaddr/rdoc/IPAddr.html).
+
+### Help! `No such middleware to insert before: Rails::Rack::Logger`
+
+If you get this error it might be because something else is replacing the
+standard logger, or expecting it to be there. For example, if you have
+`config.assets.quiet = true` in your configuration, Sprockets tries to
+`insert_before` the standard logging middleware in an initializer. You'll need
+to configure this gem in an initializer too:
+
+```ruby
+# config/initializer/suppressing_logger.rb
+Rails.application.config.middleware.swap Rails::Rack::Logger, ScanSuppressingLogger::Middleware, {
+  networks: ['123.0.2.2/24', '86.54.222.1/16']
+}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+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/pixielabs/scan-suppressing-logger. This project is intended to
+be a safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](http://contributor-covenant.org) code of
+conduct.
+
+## 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 ScanSuppressingLogger project’s codebases, issue
+trackers, chat rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/jalada/scan-suppressing-logger/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/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/scan_suppressing_logger.rb

@@ -0,0 +1,8 @@
+require 'rails'
+
+module ScanSuppressingLogger; end
+
+require_relative 'scan_suppressing_logger/version'
+require_relative 'scan_suppressing_logger/rails_wrapper'
+require_relative 'scan_suppressing_logger/rollbar_wrapper'
+require_relative 'scan_suppressing_logger/middleware'

data/lib/scan_suppressing_logger/middleware.rb

@@ -0,0 +1,64 @@
+# Public: Suppresses Rails logs and exception reporting from automated scan
+# requests.
+#
+# Use it by replacing the default Rails::Rack::Logger in config/application.rb:
+#
+# config.middleware.swap Rails::Rack::Logger, ScanSuppressingLogger::Middleware, {
+#   networks: ['123.0.2.2/24', '86.54.222.1/16'],
+# }
+module ScanSuppressingLogger
+  class Middleware < Rails::Rack::Logger
+    def initialize(app, options = {})
+      @app = app
+      @options = options
+      @wrappers = [ScanSuppressingLogger::RailsWrapper]
+
+      configure_networks!
+      find_error_trackers!
+
+      super
+    end
+
+    def call(env)
+      return super(env) unless @configured
+
+      request = ActionDispatch::Request.new env
+      if automated_scan? request
+        Rails.logger.tagged('ScanSuppressingLogger') { Rails.logger.info "Suppressed for #{request.remote_ip}" }
+
+        # Combine all the wrappers we need.
+        @wrappers.inject(proc { @app.call env }) do |acc, wrapper|
+          proc { wrapper.call(&acc) }
+        end.call
+      else
+        super env
+      end
+    end
+
+    def automated_scan?(request)
+      # Check if the request source IP comes from any of the network ranges
+      # in config.
+      ip = IPAddr.new request.remote_ip
+      @networks.any?{|network| network.include? ip }
+    end
+
+    private
+    def configure_networks!
+      @networks = @options.delete(:networks)
+
+      if @networks && @networks.is_a?(Array)
+        @configured = true
+        @networks = @networks.
+          map{|network| IPAddr.new network } 
+      else
+        puts "You need to pass a networks option to ScanSuppressingLogger."
+        puts "For more info, check the README: https://github.com/pixielabs/scan-suppressing-logger"
+      end
+    end
+
+    # Internal: Find loaded error trackers and build up a list of wrappers.
+    def find_error_trackers!
+      @wrappers << ScanSuppressingLogger::RollbarWrapper if defined?(::Rollbar)
+    end
+  end
+end

data/lib/scan_suppressing_logger/rails_wrapper.rb

@@ -0,0 +1,9 @@
+module ScanSuppressingLogger
+  class RailsWrapper
+    def self.call
+      Rails.logger.silence do
+        yield
+      end
+    end
+  end
+end

data/lib/scan_suppressing_logger/rollbar_wrapper.rb

@@ -0,0 +1,9 @@
+module ScanSuppressingLogger
+  class RollbarWrapper
+    def self.call
+      Rollbar.with_config(enabled: false) do
+        yield
+      end
+    end
+  end
+end

data/lib/scan_suppressing_logger/version.rb

@@ -0,0 +1,3 @@
+module ScanSuppressingLogger
+  VERSION = "0.1.0-alpha1"
+end

data/scan-suppressing-logger.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "scan_suppressing_logger/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "scan-suppressing-logger"
+  spec.version       = ScanSuppressingLogger::VERSION
+  spec.authors       = ["David Somers"]
+  spec.email         = ["team@pixielabs.io"]
+
+  spec.summary       = %q{Suppress Rails logs and exceptions from automated scan requests.}
+  spec.homepage      = "https://github.com/pixielabs/scan-suppressing-logger"
+  spec.license       = "MIT"
+
+  # 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"]
+
+  spec.add_dependency "rails", ">= 4.2"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: scan-suppressing-logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.alpha1
+platform: ruby
+authors:
+- David Somers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+description: 
+email:
+- team@pixielabs.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/setup
+- lib/scan_suppressing_logger.rb
+- lib/scan_suppressing_logger/middleware.rb
+- lib/scan_suppressing_logger/rails_wrapper.rb
+- lib/scan_suppressing_logger/rollbar_wrapper.rb
+- lib/scan_suppressing_logger/version.rb
+- scan-suppressing-logger.gemspec
+homepage: https://github.com/pixielabs/scan-suppressing-logger
+licenses:
+- MIT
+metadata: {}
+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: 1.3.1
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Suppress Rails logs and exceptions from automated scan requests.
+test_files: []