invalid_utf8_rejector 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - "1.9.3"

data/Gemfile

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

data/LICENCE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alex Tomlins
+
+MIT License
+
+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,33 @@
+# InvalidUtf8Rejector
+
+[![Build Status](https://travis-ci.org/alext/invalid_utf8_rejector.png?branch=master)](https://travis-ci.org/alext/invalid_utf8_rejector)
+
+Simple Rack middleware that rejects requests containing invalid UTF-8 byte
+sequences in their path or query params.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'invalid_utf8_rejector'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install invalid_utf8_rejector
+
+## Usage
+
+If you are using Rails, the middleware will automatically be inserted. If not,
+you will need to manually insert it into your middleware stack.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/invalid_utf8_rejector.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'invalid_utf8_rejector/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "invalid_utf8_rejector"
+  spec.version       = InvalidUTF8Rejector::VERSION
+  spec.authors       = ["Alex Tomlins"]
+  spec.email         = ["alex@tomlins.org.uk"]
+  spec.description   = %q{rack middleware to reject invalid UTF8 in requests.  It will return a 400 if the decoded path or query string contain invalid UTF-8 chars.}
+  spec.summary       = %q{rack middleware to reject invalid UTF8 in requests}
+  spec.homepage      = ""
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack", "~> 1.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test", "0.6.2"
+  spec.add_development_dependency "rspec", "2.14.1"
+end

data/lib/invalid_utf8_rejector/middleware.rb

@@ -0,0 +1,27 @@
+require 'cgi'
+
+module InvalidUTF8Rejector
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if request_uri_clean?(env)
+        @app.call(env)
+      else
+        [400, {}, [""]]
+      end
+    end
+
+    private
+
+    def request_uri_clean?(env)
+      clean_utf8?(env["PATH_INFO"]) and clean_utf8?(env["QUERY_STRING"])
+    end
+
+    def clean_utf8?(str)
+      CGI.unescape(str).force_encoding('UTF-8').valid_encoding?
+    end
+  end
+end

data/lib/invalid_utf8_rejector/railtie.rb

@@ -0,0 +1,7 @@
+module InvalidUTF8Rejector
+  class Railtie < Rails::Railtie
+    initializer "invalid_utf8_rejector.insert_middleware" do |app|
+      app.config.middleware.insert_before 0, "InvalidUTF8Rejector::Middleware"
+    end
+  end
+end

data/lib/invalid_utf8_rejector/version.rb

@@ -0,0 +1,3 @@
+module InvalidUTF8Rejector
+  VERSION = "0.0.1"
+end

data/lib/invalid_utf8_rejector.rb

@@ -0,0 +1,3 @@
+require "invalid_utf8_rejector/version"
+require "invalid_utf8_rejector/middleware"
+require "invalid_utf8_rejector/railtie" if defined? Rails

data/spec/middleware_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'rack/test'
+
+require 'invalid_utf8_rejector'
+
+describe InvalidUTF8Rejector::Middleware do
+  include Rack::Test::Methods
+
+  def app
+    InvalidUTF8Rejector::Middleware.new( proc {|env| @inner_app_called = true; [200, {}, "Inner app response for env:\n#{env.inspect}"]} )
+  end
+
+  before :each do
+    @inner_app_called = false
+  end
+  
+  it "should pass a valid request to the inner app" do
+    get "/foo?bar=baz"
+    expect(last_response.status).to eq(200)
+    expect(last_response.body).to match(/Inner app response/)
+    expect(@inner_app_called).to be_true
+  end
+
+  it "should reject invalid UTF-8 chars in the path without calling the app" do
+    get "/foo%A0bar"
+    expect(last_response.status).to eq(400)
+    expect(@inner_app_called).to be_false
+  end
+
+  it "should reject malformed UTF-8 chars in the path without calling the app" do
+    get "/br54ba%9CAQ%C4%FD%928owse"
+    expect(last_response.status).to eq(400)
+    expect(@inner_app_called).to be_false
+  end
+
+  it "should reject invalid UTF-8 chars in the query_string without calling the app" do
+    # Set params to nil.  Without this, it defaults to empty hash, and rack-test tries to merge this with 
+    # the given params which blows up with an invalid UTF-8 error before reaching our code
+    get "/foo?ba%a0r", nil
+    expect(last_response.status).to eq(400)
+    expect(@inner_app_called).to be_false
+  end
+
+  it "should reject malformed UTF-8 chars in the query_string without calling the app" do
+    # Set params to nil.  Without this, it defaults to empty hash, and rack-test tries to merge this with 
+    # the given params which blows up with an invalid UTF-8 error before reaching our code
+    get "/foo?bar=br54ba%9CAQ%C4%FD%928owse", nil
+    expect(last_response.status).to eq(400)
+    expect(@inner_app_called).to be_false
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: invalid_utf8_rejector
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alex Tomlins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+description: rack middleware to reject invalid UTF8 in requests.  It will return a
+  400 if the decoded path or query string contain invalid UTF-8 chars.
+email:
+- alex@tomlins.org.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENCE.txt
+- README.md
+- Rakefile
+- invalid_utf8_rejector.gemspec
+- lib/invalid_utf8_rejector.rb
+- lib/invalid_utf8_rejector/middleware.rb
+- lib/invalid_utf8_rejector/railtie.rb
+- lib/invalid_utf8_rejector/version.rb
+- spec/middleware_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4593929028848301
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4593929028848301
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: rack middleware to reject invalid UTF8 in requests
+test_files:
+- spec/middleware_spec.rb
+- spec/spec_helper.rb