rack-headers_filter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e94f67fc75befa98bd6f8cb63d027f11821d8d58
+  data.tar.gz: 59a2aa9bd0b1ef58d8a05ca09ac197e0f0ebfa67
+SHA512:
+  metadata.gz: 9ada28c5d3f476f3c22b3aba6f07ae3fc2f0bc1477a5660ef12cb1f85a3445df9141cbd7812b39ffd5477c6eaf625b45cc20c4273dfc3f9545abc81dc8f85685
+  data.tar.gz: c56a4f8fde21147350419ce5876bc766ee3a7a488abd531f8f699c6e09345ab0cad5ae363a274829bc5a7f23f7b5b3e2a453b71db0004aedbfdf4ae6e386b40e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-headers_filter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Pusher Ltd.
+
+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,79 @@
+# Rack::HeadersFilter
+
+Sanitizes some of the "trusted" headers. Useful when you don't control your
+frontend router like on Heroku. This is the next best thing.
+
+The are some funky heuristics happening inside of Rack::Request. For example
+`request.ip` and `request.host_with_port` use HTTP_X_FORWARDED_HOST which is
+forgeable by the client on Heroku. This is then trusted by other code like
+`ActionController::ForceSSL` as a canonical source of truth. The result is
+that if something can set the `X-Forwarded-Host` header, and `config.force_ssl
+= true` is set in rails, the user gets redirected to that random host.
+
+This middleware creates a list of "dangerous" headers that are used by
+`Rack::Request` and filters out the ones that are not controlled by the
+router. By default it is configured to be deployed on Heroku.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-headers_filter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-headers_filter
+
+## Usage
+
+This middleware is designed to be installed first in the chain. Either add
+this to the `config.ru`:
+
+```ruby
+require 'rack/headers_filter'
+use Rack::HeadersFilter
+```
+
+Or in `config/environments/production.rb`:
+
+```ruby
+# First thing, filter out bad headers (0 == first)
+config.middleware.insert_before(0, Rack::HeadersFilter)
+```
+
+By default it is configured with the Heroku router headers. It's also possible
+to specify them manually:
+
+```ruby
+require 'rack/headers_filter'
+use Rack::HeadersFilter, trusted_headers: %[HTTP_HOST]
+```
+
+## Development
+
+After checking out the repo, run `script/setup` to install dependencies. Then,
+run `rake spec` to run the tests. You can also run `script/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/pusher/rack-headers_filter.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/lib/rack/headers_filter.rb

@@ -0,0 +1,39 @@
+module Rack
+  class HeadersFilter
+    SENSITIVE_HEADERS = %w[
+      HTTP_X_FORWARDED_FOR
+      HTTP_X_FORWARDED_HOST
+      HTTP_X_FORWARDED_PORT
+      HTTP_X_FORWARDED_PROTO
+      HTTP_X_FORWARDED_SCHEME
+      HTTP_X_FORWARDED_SSL
+    ]
+
+    # Headers sent by the Heroku router
+    HEROKU_HEADERS = %w[
+      HTTP_CONNECTION
+      HTTP_CONNECT_TIME
+      HTTP_HOST
+      HTTP_TOTAL_ROUTE_TIME
+      HTTP_UPGRADE_INSECURE_REQUESTS
+      HTTP_VIA
+      HTTP_X_FORWARDED_FOR
+      HTTP_X_FORWARDED_PROTO
+      HTTP_X_FORWARDED_PROTO
+      HTTP_X_REQUEST_ID
+      HTTP_X_REQUEST_START
+    ]
+
+    attr_reader :remove_headers
+
+    def initialize(app, trusted_headers: HEROKU_HEADERS)
+      @remove_headers = SENSITIVE_HEADERS - trusted_headers
+      @app = app
+    end
+
+    def call(env)
+      @remove_headers.each(&env.method(:delete))
+      @app.call(env)
+    end
+  end
+end

data/rack-headers_filter.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = "rack-headers_filter"
+  spec.version       = '0.0.1'
+  spec.authors       = ["zimbatm"]
+  spec.email         = ["zimbatm@zimbatm.com"]
+
+  spec.summary       = %q{Removes sensitive untrusted headers from the request}
+  spec.description   = %q{
+    The goal of this gem is to avoid depending on potentially forgeable
+    headers down the line by configuring the deploy target properly.
+  }
+  spec.homepage      = "https://github.com/pusher/rack-headers_filter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rack", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/script/console

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

data/script/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

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: rack-headers_filter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- zimbatm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: "\n    The goal of this gem is to avoid depending on potentially forgeable\n
+  \   headers down the line by configuring the deploy target properly.\n  "
+email:
+- zimbatm@zimbatm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/headers_filter.rb
+- rack-headers_filter.gemspec
+- script/console
+- script/setup
+homepage: https://github.com/pusher/rack-headers_filter
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.2
+signing_key: 
+specification_version: 4
+summary: Removes sensitive untrusted headers from the request
+test_files: []