diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index f4d8d4b..3ae67c4 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -17,9 +17,10 @@ jobs: strategy: matrix: ruby: - - 3.0.2 - - 2.7.4 - - 2.6.8 + - 3.1.0 + - 3.0.3 + - 2.7.5 + - 2.6.9 - 2.5.8 gemfile: - rack_2 @@ -40,19 +41,27 @@ jobs: - active_support_redis_store exclude: - gemfile: rack_1 - ruby: 3.0.2 + ruby: 3.1.0 - gemfile: rails_5_2 - ruby: 3.0.2 + ruby: 3.1.0 - gemfile: rails_4_2 - ruby: 3.0.2 + ruby: 3.1.0 - gemfile: dalli2 - ruby: 3.0.2 + ruby: 3.1.0 - gemfile: rack_1 - ruby: 2.7.4 + ruby: 3.0.3 + - gemfile: rails_5_2 + ruby: 3.0.3 - gemfile: rails_4_2 - ruby: 2.7.4 + ruby: 3.0.3 + - gemfile: dalli2 + ruby: 3.0.3 + - gemfile: rack_1 + ruby: 2.7.5 + - gemfile: rails_4_2 + ruby: 2.7.5 - gemfile: rails_7_0 - ruby: 2.6.8 + ruby: 2.6.9 - gemfile: rails_7_0 ruby: 2.5.8 env: diff --git a/README.md b/README.md index a2658d2..d6ae610 100644 --- a/README.md +++ b/README.md @@ -312,16 +312,16 @@ Note that `Rack::Attack.cache` is only used for throttling, allow2ban and fail2b ## Customizing responses -Customize the response of blocklisted and throttled requests using an object that adheres to the [Rack app interface](http://www.rubydoc.info/github/rack/rack/file/SPEC). +Customize the response of blocklisted and throttled requests using an object that adheres to the [Rack app interface](http://www.rubydoc.info/github/rack/rack/file/SPEC.rdoc). ```ruby -Rack::Attack.blocklisted_callback = lambda do |request| +Rack::Attack.blocklisted_responder = lambda do |request| # Using 503 because it may make attacker think that they have successfully # DOSed the site. Rack::Attack returns 403 for blocklists by default [ 503, {}, ['Blocked']] end -Rack::Attack.throttled_callback = lambda do |request| +Rack::Attack.throttled_responder = lambda do |request| # NB: you have access to the name and other data about the matched throttle # request.env['rack.attack.matched'], # request.env['rack.attack.match_type'], @@ -407,7 +407,7 @@ for more on how to do this. ### Test case isolation -`Rack::Attack.reset!` can be used in your test suite to clear any Rack::Attack state between different test cases. +`Rack::Attack.reset!` can be used in your test suite to clear any Rack::Attack state between different test cases. If you're testing blocklist and safelist configurations, consider using `Rack::Attack.clear_configuration` to unset the values for those lists between test cases. ## How it works @@ -427,10 +427,9 @@ def call(env) if safelisted?(req) @app.call(env) elsif blocklisted?(req) - self.class.blocklisted_callback.call(req) + self.class.blocklisted_responder.call(req) elsif throttled?(req) - self.class.throttled_response.call(env) - self.class.throttled_callback.call(req) + self.class.throttled_responder.call(req) else tracked?(req) @app.call(env) diff --git a/lib/rack/attack.rb b/lib/rack/attack.rb index bc9dbed..9b13416 100644 --- a/lib/rack/attack.rb +++ b/lib/rack/attack.rb @@ -66,10 +66,10 @@ module Rack :safelist_ip, :throttle, :track, - :throttled_callback, - :throttled_callback=, - :blocklisted_callback, - :blocklisted_callback=, + :throttled_responder, + :throttled_responder=, + :blocklisted_responder, + :blocklisted_responder=, :blocklisted_response, :blocklisted_response=, :throttled_response, @@ -113,14 +113,14 @@ module Rack if configuration.blocklisted_response configuration.blocklisted_response.call(env) else - configuration.blocklisted_callback.call(request) + configuration.blocklisted_responder.call(request) end elsif configuration.throttled?(request) # Deprecated: Keeping throttled_response for backwards compatibility if configuration.throttled_response configuration.throttled_response.call(env) else - configuration.throttled_callback.call(request) + configuration.throttled_responder.call(request) end else configuration.tracked?(request) diff --git a/lib/rack/attack/configuration.rb b/lib/rack/attack/configuration.rb index c609310..ba353ab 100644 --- a/lib/rack/attack/configuration.rb +++ b/lib/rack/attack/configuration.rb @@ -5,9 +5,9 @@ require "ipaddr" module Rack class Attack class Configuration - DEFAULT_BLOCKLISTED_CALLBACK = lambda { |_req| [403, { 'Content-Type' => 'text/plain' }, ["Forbidden\n"]] } + DEFAULT_BLOCKLISTED_RESPONDER = lambda { |_req| [403, { 'Content-Type' => 'text/plain' }, ["Forbidden\n"]] } - DEFAULT_THROTTLED_CALLBACK = lambda do |req| + DEFAULT_THROTTLED_RESPONDER = lambda do |req| if Rack::Attack.configuration.throttled_response_retry_after_header match_data = req.env['rack.attack.match_data'] now = match_data[:epoch_time] @@ -20,22 +20,20 @@ module Rack end attr_reader :safelists, :blocklists, :throttles, :anonymous_blocklists, :anonymous_safelists - attr_accessor :blocklisted_callback, :throttled_callback, :throttled_response_retry_after_header + attr_accessor :blocklisted_responder, :throttled_responder, :throttled_response_retry_after_header attr_reader :blocklisted_response, :throttled_response # Keeping these for backwards compatibility - def blocklisted_response=(callback) - # TODO: uncomment in 7.0 - # warn "[DEPRECATION] Rack::Attack.blocklisted_response is deprecated. "\ - # "Please use Rack::Attack.blocklisted_callback instead." - @blocklisted_response = callback + def blocklisted_response=(responder) + warn "[DEPRECATION] Rack::Attack.blocklisted_response is deprecated. "\ + "Please use Rack::Attack.blocklisted_responder instead." + @blocklisted_response = responder end - def throttled_response=(callback) - # TODO: uncomment in 7.0 - # warn "[DEPRECATION] Rack::Attack.throttled_response is deprecated. "\ - # "Please use Rack::Attack.throttled_callback instead" - @throttled_response = callback + def throttled_response=(responder) + warn "[DEPRECATION] Rack::Attack.throttled_response is deprecated. "\ + "Please use Rack::Attack.throttled_responder instead" + @throttled_response = responder end def initialize @@ -115,8 +113,8 @@ module Rack @anonymous_safelists = [] @throttled_response_retry_after_header = false - @blocklisted_callback = DEFAULT_BLOCKLISTED_CALLBACK - @throttled_callback = DEFAULT_THROTTLED_CALLBACK + @blocklisted_responder = DEFAULT_BLOCKLISTED_RESPONDER + @throttled_responder = DEFAULT_THROTTLED_RESPONDER # Deprecated: Keeping these for backwards compatibility @blocklisted_response = nil diff --git a/rack-attack.gemspec b/rack-attack.gemspec index 11e72f9..25669f1 100644 --- a/rack-attack.gemspec +++ b/rack-attack.gemspec @@ -14,7 +14,7 @@ Gem::Specification.new do |s| s.description = "A rack middleware for throttling and blocking abusive requests" s.email = "aaron@ktheory.com" - s.files = Dir.glob("{bin,lib}/**/*") + %w(Rakefile README.md) + s.files = Dir.glob("{bin,lib}/**/*") + %w(Rakefile README.md LICENSE) s.homepage = 'https://github.com/rack/rack-attack' s.rdoc_options = ["--charset=UTF-8"] s.require_paths = ["lib"] diff --git a/spec/acceptance/customizing_blocked_response_spec.rb b/spec/acceptance/customizing_blocked_response_spec.rb index 9a53862..1ca127c 100644 --- a/spec/acceptance/customizing_blocked_response_spec.rb +++ b/spec/acceptance/customizing_blocked_response_spec.rb @@ -14,7 +14,7 @@ describe "Customizing block responses" do assert_equal 403, last_response.status - Rack::Attack.blocklisted_callback = lambda do |_req| + Rack::Attack.blocklisted_responder = lambda do |_req| [503, {}, ["Blocked"]] end @@ -28,7 +28,7 @@ describe "Customizing block responses" do matched = nil match_type = nil - Rack::Attack.blocklisted_callback = lambda do |req| + Rack::Attack.blocklisted_responder = lambda do |req| matched = req.env['rack.attack.matched'] match_type = req.env['rack.attack.match_type'] @@ -46,8 +46,10 @@ describe "Customizing block responses" do assert_equal 403, last_response.status - Rack::Attack.blocklisted_response = lambda do |_env| - [503, {}, ["Blocked"]] + silence_warnings do + Rack::Attack.blocklisted_response = lambda do |_env| + [503, {}, ["Blocked"]] + end end get "/", {}, "REMOTE_ADDR" => "1.2.3.4" diff --git a/spec/acceptance/customizing_throttled_response_spec.rb b/spec/acceptance/customizing_throttled_response_spec.rb index df875ec..0990975 100644 --- a/spec/acceptance/customizing_throttled_response_spec.rb +++ b/spec/acceptance/customizing_throttled_response_spec.rb @@ -20,7 +20,7 @@ describe "Customizing throttled response" do assert_equal 429, last_response.status - Rack::Attack.throttled_callback = lambda do |_req| + Rack::Attack.throttled_responder = lambda do |_req| [503, {}, ["Throttled"]] end @@ -36,7 +36,7 @@ describe "Customizing throttled response" do match_data = nil match_discriminator = nil - Rack::Attack.throttled_callback = lambda do |req| + Rack::Attack.throttled_responder = lambda do |req| matched = req.env['rack.attack.matched'] match_type = req.env['rack.attack.match_type'] match_data = req.env['rack.attack.match_data'] @@ -68,8 +68,10 @@ describe "Customizing throttled response" do assert_equal 429, last_response.status - Rack::Attack.throttled_response = lambda do |_req| - [503, {}, ["Throttled"]] + silence_warnings do + Rack::Attack.throttled_response = lambda do |_req| + [503, {}, ["Throttled"]] + end end get "/", {}, "REMOTE_ADDR" => "1.2.3.4" diff --git a/spec/rack_attack_spec.rb b/spec/rack_attack_spec.rb index c55fa20..c835835 100644 --- a/spec/rack_attack_spec.rb +++ b/spec/rack_attack_spec.rb @@ -64,15 +64,15 @@ describe 'Rack::Attack' do end end - describe '#blocklisted_callback' do + describe '#blocklisted_responder' do it 'should exist' do - _(Rack::Attack.blocklisted_callback).must_respond_to :call + _(Rack::Attack.blocklisted_responder).must_respond_to :call end end - describe '#throttled_callback' do + describe '#throttled_responder' do it 'should exist' do - _(Rack::Attack.throttled_callback).must_respond_to :call + _(Rack::Attack.throttled_responder).must_respond_to :call end end end