diff --git a/README.md b/README.md index 5a0fa25..d6ae610 100644 --- a/README.md +++ b/README.md @@ -315,13 +315,13 @@ Note that `Rack::Attack.cache` is only used for throttling, allow2ban and fail2b 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'], @@ -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..67bcc61 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,22 @@ 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) + def blocklisted_response=(responder) # TODO: uncomment in 7.0 # warn "[DEPRECATION] Rack::Attack.blocklisted_response is deprecated. "\ - # "Please use Rack::Attack.blocklisted_callback instead." - @blocklisted_response = callback + # "Please use Rack::Attack.blocklisted_responder instead." + @blocklisted_response = responder end - def throttled_response=(callback) + def throttled_response=(responder) # TODO: uncomment in 7.0 # warn "[DEPRECATION] Rack::Attack.throttled_response is deprecated. "\ - # "Please use Rack::Attack.throttled_callback instead" - @throttled_response = callback + # "Please use Rack::Attack.throttled_responder instead" + @throttled_response = responder end def initialize @@ -115,8 +115,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/spec/acceptance/customizing_blocked_response_spec.rb b/spec/acceptance/customizing_blocked_response_spec.rb index 9a53862..86fcd02 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'] diff --git a/spec/acceptance/customizing_throttled_response_spec.rb b/spec/acceptance/customizing_throttled_response_spec.rb index df875ec..39a3950 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'] 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