handle_invalid_percent_encoding_requests 1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 56cab74c5a0e7f605b50f13c78b65b8269195089
-  data.tar.gz: b1565f7d1b34e9d0af3956294cc0d73494fde8f7
+SHA256:
+  metadata.gz: 55d974e3fa4170de9c984b121d1e51f2c044206745fee018792503f0f0a14731
+  data.tar.gz: e90ccf94c95c2dda14a2e0702d14fe3c61c1956cf09f3b7251d77145247343b4
 SHA512:
-  metadata.gz: ce964bf003c3381d3910e6b31ac100211a2359d1478294db128b6605ac9b6e10e0b6f0dfe6818ff939d1db4aaff25a4ceafc18c92553778bdc96731997c4d999
-  data.tar.gz: 8a4bbeb963cf8e7478ef1053f332a99b07af08b6015af8af7a282797105849f5d900afdeb355fa9611f29ac9f2ed0d0a1335720b6034ea366e6f1314d56d7112
+  metadata.gz: b3ca91d7033ad2490901c33446e5457fd7c27920187efd241677e1478715e3e7fd3c3ce9c0c9817d9087604f94b4dec9335877e00e300920e4c6f2c1ef114304
+  data.tar.gz: 153849e5a033d14ecac4afc94fcff4d6b90094acad14246c17a2a143d35d01d51f0872070791c20ef98f5965106cf7559130c199054775c9d7d33f718343e9ac

data/README.md

@@ -1,9 +1,28 @@
 Handle Invalid Percent Encoding Requests
 =======================================
 
-Rails Engine that renders 400 error whenever a request's
-percent-encoding is malformed.
+Rails Engine that protects your app against malformed requests.
 
-This happens notably a lot for the chinese [EasouSpider](http://www.easou.com/search/spider.html).
+This middleware renders a 400 error instead of raising exceptions for the
+following errors:
 
-See http://stackoverflow.com/q/24648206/311657
+- `invalid byte sequence in UTF-8`
+- `string contains null byte`
+
+Installation
+------------
+
+In your Rails app, add these lines to your `Gemfile`:
+
+```rb
+# Helps against "invalid byte sequence" exceptions.
+gem "handle_invalid_percent_encoding_requests"
+```
+
+Then type `bundle install`.
+
+See also
+--------
+
+See also [Ruby on Rails “invalid byte sequence in UTF-8” due to
+bot](http://stackoverflow.com/q/24648206/311657) on StackOverflow.

data/lib/handle_invalid_percent_encoding_requests/engine.rb

@@ -2,6 +2,7 @@ require "rack/utf8_sanitizer"
 
 module HandleInvalidPercentEncodingRequests
 
+  # Rails Engine that inserts the Middleware at the top of the Rack queue
   class Engine < Rails::Engine
     initializer "handle_invalid_percent_encoding_requests.add_middleware" do |app|
       # Via http://stackoverflow.com/a/24727310/311657

data/lib/handle_invalid_percent_encoding_requests/middleware.rb

@@ -1,13 +1,35 @@
 # Via https://gist.github.com/bf4/d26259acfa29f3b9882b#file-exception_app-rb
-
 module HandleInvalidPercentEncodingRequests
+  module InvalidPercentEncodingErrorMatcher
+    def self.===(error)
+      error.is_a?(ArgumentError) &&
+        error.message =~ /invalid %-encoding/
+    end
+  end
 
+  module InvalidByteSequenceErrorMatcher
+    def self.===(error)
+      error.is_a?(ArgumentError) &&
+        error.message == "invalid byte sequence in UTF-8"
+    end
+  end
+
+  module NullByteErrorMatcher
+    def self.===(error)
+      error.is_a?(ArgumentError) &&
+        error.message == "string contains null byte"
+    end
+  end
+
+  # Rack Middleware inserted before the request that detects an encoding error
+  # and returns an appropriate response.
   class Middleware
-    def initialize(app, stdout=STDOUT)
+    def initialize(app, stdout = STDOUT)
       @app = app
       @logger = defined?(Rails.logger) ? Rails.logger : Logger.new(stdout)
     end
 
+    # Called by Rack when a request comes through
     def call(env)
       # calling env.dup here prevents bad things from happening
       request = Rack::Request.new(env.dup)
@@ -15,11 +37,16 @@ module HandleInvalidPercentEncodingRequests
       # calling request.params is sufficient to trigger the error see
       # https://github.com/rack/rack/issues/337#issuecomment-46453404
       request.params
+
       @app.call(env)
 
-    # Rescue from that specific ArgumentError
-    rescue ArgumentError => e
-      raise unless e.message =~ /invalid %-encoding/
+    rescue InvalidPercentEncodingErrorMatcher,
+           InvalidByteSequenceErrorMatcher,
+           NullByteErrorMatcher => e
+
+      @logger.info "Bad request. Returning 400 due to #{e.class.name} " \
+                   "#{e.message.inspect} from request with env " \
+                   "#{request.inspect}"
       error_response
     end
 
@@ -27,13 +54,9 @@ module HandleInvalidPercentEncodingRequests
     private
 
     def error_response
-      @logger.info "Bad request. Returning 400 due to #{e.message}" + \
-                  " from request with env #{request.inspect}"
-
-      headers = { 'Content-Type' => "text/plain; charset=utf-8" }
+      headers = { "Content-Type" => "text/plain; charset=utf-8" }
       text = "Bad Request"
       [400, headers, [text]]
     end
   end
-
 end

data/lib/handle_invalid_percent_encoding_requests/version.rb

@@ -1,3 +1,4 @@
+# Uses Semantic Versionning
 module HandleInvalidPercentEncodingRequests
-  VERSION = 1.0
+  VERSION = "1.1.1"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: handle_invalid_percent_encoding_requests
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.1.1
 platform: ruby
 authors:
 - Sunny Ripert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-22 00:00:00.000000000 Z
+date: 2022-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.4
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.4
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rack-utf8_sanitizer
   requirement: !ruby/object:Gem::Requirement
@@ -59,13 +59,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/handle_invalid_percent_encoding_requests.rb
 - lib/handle_invalid_percent_encoding_requests/engine.rb
 - lib/handle_invalid_percent_encoding_requests/middleware.rb
 - lib/handle_invalid_percent_encoding_requests/version.rb
-- lib/handle_invalid_percent_encoding_requests.rb
-- MIT-LICENSE
-- Rakefile
-- README.md
 homepage: http://github.com/sunny/handle_invalid_percent_encoding_requests
 licenses:
 - MIT
@@ -85,8 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Handle invalid percent in encoding from requests in Rails