rack-attack 5.0.1 → 5.4.2

data/spec/rack_attack_dalli_proxy_spec.rb

@@ -1,10 +1,8 @@
 require_relative 'spec_helper'
 
 describe Rack::Attack::StoreProxy::DalliProxy do
-
   it 'should stub Dalli::Client#with on older clients' do
     proxy = Rack::Attack::StoreProxy::DalliProxy.new(Class.new)
     proxy.with {} # will not raise an error
   end
-
 end

data/spec/rack_attack_request_spec.rb

@@ -14,6 +14,6 @@ describe 'Rack::Attack' do
       end
     end
 
-    allow_ok_requests
+    it_allows_ok_requests
   end
 end

data/spec/rack_attack_spec.rb

@@ -1,11 +1,11 @@
 require_relative 'spec_helper'
 
 describe 'Rack::Attack' do
-  allow_ok_requests
+  it_allows_ok_requests
 
   describe 'normalizing paths' do
     before do
-      Rack::Attack.blocklist("banned_path") {|req| req.path == '/foo' }
+      Rack::Attack.blocklist("banned_path") { |req| req.path == '/foo' }
     end
 
     it 'blocks requests with trailing slash' do
@@ -17,7 +17,7 @@ describe 'Rack::Attack' do
   describe 'blocklist' do
     before do
       @bad_ip = '1.2.3.4'
-      Rack::Attack.blocklist("ip #{@bad_ip}") {|req| req.ip == @bad_ip }
+      Rack::Attack.blocklist("ip #{@bad_ip}") { |req| req.ip == @bad_ip }
     end
 
     it('has a blocklist') {
@@ -25,7 +25,7 @@ describe 'Rack::Attack' do
     }
 
     it('has a blacklist with a deprication warning') {
-      _, stderror  = capture_io do
+      _, stderror = capture_io do
         Rack::Attack.blacklists.key?("ip #{@bad_ip}").must_equal true
       end
       assert_match "[DEPRECATION] 'Rack::Attack.blacklists' is deprecated.  Please use 'blocklists' instead.", stderror
@@ -33,29 +33,30 @@ describe 'Rack::Attack' do
 
     describe "a bad request" do
       before { get '/', {}, 'REMOTE_ADDR' => @bad_ip }
+
       it "should return a blocklist response" do
-        get '/', {}, 'REMOTE_ADDR' => @bad_ip
         last_response.status.must_equal 403
         last_response.body.must_equal "Forbidden\n"
       end
+
       it "should tag the env" do
         last_request.env['rack.attack.matched'].must_equal "ip #{@bad_ip}"
         last_request.env['rack.attack.match_type'].must_equal :blocklist
       end
 
-      allow_ok_requests
+      it_allows_ok_requests
     end
 
     describe "and safelist" do
       before do
         @good_ua = 'GoodUA'
-        Rack::Attack.safelist("good ua") {|req| req.user_agent == @good_ua }
+        Rack::Attack.safelist("good ua") { |req| req.user_agent == @good_ua }
       end
 
-      it('has a safelist'){ Rack::Attack.safelists.key?("good ua") }
+      it('has a safelist') { Rack::Attack.safelists.key?("good ua") }
 
       it('has a whitelist with a deprication warning') {
-        _, stderror  = capture_io do
+        _, stderror = capture_io do
           Rack::Attack.whitelists.key?("good ua")
         end
         assert_match "[DEPRECATION] 'Rack::Attack.whitelists' is deprecated.  Please use 'safelists' instead.", stderror
@@ -63,10 +64,11 @@ describe 'Rack::Attack' do
 
       describe "with a request match both safelist & blocklist" do
         before { get '/', {}, 'REMOTE_ADDR' => @bad_ip, 'HTTP_USER_AGENT' => @good_ua }
+
         it "should allow safelists before blocklists" do
-          get '/', {}, 'REMOTE_ADDR' => @bad_ip, 'HTTP_USER_AGENT' => @good_ua
           last_response.status.must_equal 200
         end
+
         it "should tag the env" do
           last_request.env['rack.attack.matched'].must_equal 'good ua'
           last_request.env['rack.attack.match_type'].must_equal :safelist
@@ -80,11 +82,10 @@ describe 'Rack::Attack' do
       end
 
       it 'should give a deprication warning for blacklisted_response' do
-        _, stderror  = capture_io do
+        _, stderror = capture_io do
           Rack::Attack.blacklisted_response
         end
         assert_match "[DEPRECATION] 'Rack::Attack.blacklisted_response' is deprecated.  Please use 'blocklisted_response' instead.", stderror
-
       end
     end
 
@@ -93,7 +94,5 @@ describe 'Rack::Attack' do
         Rack::Attack.throttled_response.must_respond_to :call
       end
     end
-
   end
-
 end

data/spec/rack_attack_throttle_spec.rb

@@ -1,4 +1,5 @@
 require_relative 'spec_helper'
+
 describe 'Rack::Attack.throttle' do
   before do
     @period = 60 # Use a long period; failures due to cache key rotation less likely
@@ -6,34 +7,40 @@ describe 'Rack::Attack.throttle' do
     Rack::Attack.throttle('ip/sec', :limit => 1, :period => @period) { |req| req.ip }
   end
 
-  it('should have a throttle'){ Rack::Attack.throttles.key?('ip/sec') }
-  allow_ok_requests
+  it('should have a throttle') { Rack::Attack.throttles.key?('ip/sec') }
+
+  it_allows_ok_requests
 
   describe 'a single request' do
     before { get '/', {}, 'REMOTE_ADDR' => '1.2.3.4' }
+
     it 'should set the counter for one request' do
-      key = "rack::attack:#{Time.now.to_i/@period}:ip/sec:1.2.3.4"
+      key = "rack::attack:#{Time.now.to_i / @period}:ip/sec:1.2.3.4"
       Rack::Attack.cache.store.read(key).must_equal 1
     end
 
     it 'should populate throttle data' do
-      data = { :count => 1, :limit => 1, :period => @period }
+      data = { :count => 1, :limit => 1, :period => @period, epoch_time: Rack::Attack.cache.last_epoch_time.to_i }
       last_request.env['rack.attack.throttle_data']['ip/sec'].must_equal data
     end
   end
+
   describe "with 2 requests" do
     before do
       2.times { get '/', {}, 'REMOTE_ADDR' => '1.2.3.4' }
     end
+
     it 'should block the last request' do
       last_response.status.must_equal 429
     end
+
     it 'should tag the env' do
       last_request.env['rack.attack.matched'].must_equal 'ip/sec'
       last_request.env['rack.attack.match_type'].must_equal :throttle
-      last_request.env['rack.attack.match_data'].must_equal({:count => 2, :limit => 1, :period => @period})
+      last_request.env['rack.attack.match_data'].must_equal(:count => 2, :limit => 1, :period => @period, epoch_time: Rack::Attack.cache.last_epoch_time.to_i)
       last_request.env['rack.attack.match_discriminator'].must_equal('1.2.3.4')
     end
+
     it 'should set a Retry-After header' do
       last_response.headers['Retry-After'].must_equal @period.to_s
     end
@@ -44,20 +51,21 @@ describe 'Rack::Attack.throttle with limit as proc' do
   before do
     @period = 60 # Use a long period; failures due to cache key rotation less likely
     Rack::Attack.cache.store = ActiveSupport::Cache::MemoryStore.new
-    Rack::Attack.throttle('ip/sec', :limit => lambda { |req| 1 }, :period => @period) { |req| req.ip }
+    Rack::Attack.throttle('ip/sec', :limit => lambda { |_req| 1 }, :period => @period) { |req| req.ip }
   end
 
-  allow_ok_requests
+  it_allows_ok_requests
 
   describe 'a single request' do
     before { get '/', {}, 'REMOTE_ADDR' => '1.2.3.4' }
+
     it 'should set the counter for one request' do
-      key = "rack::attack:#{Time.now.to_i/@period}:ip/sec:1.2.3.4"
+      key = "rack::attack:#{Time.now.to_i / @period}:ip/sec:1.2.3.4"
       Rack::Attack.cache.store.read(key).must_equal 1
     end
 
     it 'should populate throttle data' do
-      data = { :count => 1, :limit => 1, :period => @period }
+      data = { :count => 1, :limit => 1, :period => @period, epoch_time: Rack::Attack.cache.last_epoch_time.to_i }
       last_request.env['rack.attack.throttle_data']['ip/sec'].must_equal data
     end
   end
@@ -67,20 +75,21 @@ describe 'Rack::Attack.throttle with period as proc' do
   before do
     @period = 60 # Use a long period; failures due to cache key rotation less likely
     Rack::Attack.cache.store = ActiveSupport::Cache::MemoryStore.new
-    Rack::Attack.throttle('ip/sec', :limit => lambda { |req| 1 }, :period => lambda { |req| @period }) { |req| req.ip }
+    Rack::Attack.throttle('ip/sec', :limit => lambda { |_req| 1 }, :period => lambda { |_req| @period }) { |req| req.ip }
   end
 
-  allow_ok_requests
+  it_allows_ok_requests
 
   describe 'a single request' do
     before { get '/', {}, 'REMOTE_ADDR' => '1.2.3.4' }
+
     it 'should set the counter for one request' do
-      key = "rack::attack:#{Time.now.to_i/@period}:ip/sec:1.2.3.4"
+      key = "rack::attack:#{Time.now.to_i / @period}:ip/sec:1.2.3.4"
       Rack::Attack.cache.store.read(key).must_equal 1
     end
 
     it 'should populate throttle data' do
-      data = { :count => 1, :limit => 1, :period => @period }
+      data = { :count => 1, :limit => 1, :period => @period, epoch_time: Rack::Attack.cache.last_epoch_time.to_i }
       last_request.env['rack.attack.throttle_data']['ip/sec'].must_equal data
     end
   end
@@ -93,17 +102,18 @@ describe 'Rack::Attack.throttle with block retuning nil' do
     Rack::Attack.throttle('ip/sec', :limit => 1, :period => @period) { |_| nil }
   end
 
-  allow_ok_requests
+  it_allows_ok_requests
 
   describe 'a single request' do
     before { get '/', {}, 'REMOTE_ADDR' => '1.2.3.4' }
+
     it 'should not set the counter' do
-      key = "rack::attack:#{Time.now.to_i/@period}:ip/sec:1.2.3.4"
-      Rack::Attack.cache.store.read(key).must_equal nil
+      key = "rack::attack:#{Time.now.to_i / @period}:ip/sec:1.2.3.4"
+      assert_nil Rack::Attack.cache.store.read(key)
     end
 
     it 'should not populate throttle data' do
-      last_request.env['rack.attack.throttle_data'].must_equal nil
+      assert_nil last_request.env['rack.attack.throttle_data']
     end
   end
-end
+end

data/spec/rack_attack_track_spec.rb

@@ -16,9 +16,11 @@ describe 'Rack::Attack.track' do
   end
 
   before do
-    Rack::Attack.track("everything"){ |req| true }
+    Rack::Attack.track("everything") { |_req| true }
   end
-  allow_ok_requests
+
+  it_allows_ok_requests
+
   it "should tag the env" do
     get '/'
     last_request.env['rack.attack.matched'].must_equal 'everything'
@@ -29,11 +31,12 @@ describe 'Rack::Attack.track' do
     before do
       Counter.reset
       # A second track
-      Rack::Attack.track("homepage"){ |req| req.path == "/"}
+      Rack::Attack.track("homepage") { |req| req.path == "/" }
 
-      ActiveSupport::Notifications.subscribe("rack.attack") do |*args|
+      ActiveSupport::Notifications.subscribe("rack.attack") do |*_args|
         Counter.incr
       end
+
       get "/"
     end
 
@@ -44,15 +47,15 @@ describe 'Rack::Attack.track' do
 
   describe "without limit and period options" do
     it "should assign the track filter to a Check instance" do
-      tracker = Rack::Attack.track("homepage") { |req| req.path == "/"}
-      tracker.filter.class.must_equal Rack::Attack::Check
+      track = Rack::Attack.track("homepage") { |req| req.path == "/" }
+      track.filter.class.must_equal Rack::Attack::Check
     end
   end
 
   describe "with limit and period options" do
     it "should assign the track filter to a Throttle instance" do
-      tracker = Rack::Attack.track("homepage", :limit => 10, :period => 10) { |req| req.path == "/"}
-      tracker.filter.class.must_equal Rack::Attack::Throttle
+      track = Rack::Attack.track("homepage", :limit => 10, :period => 10) { |req| req.path == "/" }
+      track.filter.class.must_equal Rack::Attack::Throttle
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,3 @@
-require "rubygems"
 require "bundler/setup"
 
 require "minitest/autorun"
@@ -7,31 +6,53 @@ require "rack/test"
 require 'active_support'
 require 'action_dispatch'
 
-# Load Journey for Rails 3.2
-require 'journey' if ActionPack::VERSION::MAJOR == 3
-
 require "rack/attack"
 
-begin
-  require 'pry'
-rescue LoadError
-  #nothing to do here
+if RUBY_ENGINE == "ruby"
+  require "byebug"
 end
 
-class MiniTest::Spec
+def safe_require(name)
+  begin
+    require name
+  rescue LoadError
+  end
+end
+
+safe_require "connection_pool"
+safe_require "dalli"
+safe_require "redis"
+safe_require "redis-activesupport"
+safe_require "redis-store"
 
+class MiniTest::Spec
   include Rack::Test::Methods
 
-  after { Rack::Attack.clear! }
+  before do
+    @_original_throttled_response = Rack::Attack.throttled_response
+    @_original_blocklisted_response = Rack::Attack.blocklisted_response
+  end
+
+  after do
+    Rack::Attack.clear_configuration
+    Rack::Attack.instance_variable_set(:@cache, nil)
+
+    Rack::Attack.throttled_response = @_original_throttled_response
+    Rack::Attack.blocklisted_response = @_original_blocklisted_response
+  end
 
   def app
-    Rack::Builder.new {
+    Rack::Builder.new do
+      # Use Rack::Lint to test that rack-attack is complying with the rack spec
+      use Rack::Lint
       use Rack::Attack
-      run lambda {|env| [200, {}, ['Hello World']]}
-    }.to_app
+      use Rack::Lint
+
+      run lambda { |_env| [200, {}, ['Hello World']] }
+    end.to_app
   end
 
-  def self.allow_ok_requests
+  def self.it_allows_ok_requests
     it "must allow ok requests" do
       get '/', {}, 'REMOTE_ADDR' => '127.0.0.1'
       last_response.status.must_equal 200

data/spec/support/cache_store_helper.rb

@@ -0,0 +1,82 @@
+class Minitest::Spec
+  def self.it_works_for_cache_backed_features(options)
+    fetch_from_store = options.fetch(:fetch_from_store)
+
+    it "works for throttle" do
+      Rack::Attack.throttle("by ip", limit: 1, period: 60) do |request|
+        request.ip
+      end
+
+      get "/", {}, "REMOTE_ADDR" => "1.2.3.4"
+      assert_equal 200, last_response.status
+
+      get "/", {}, "REMOTE_ADDR" => "1.2.3.4"
+      assert_equal 429, last_response.status
+    end
+
+    it "works for fail2ban" do
+      Rack::Attack.blocklist("fail2ban pentesters") do |request|
+        Rack::Attack::Fail2Ban.filter(request.ip, maxretry: 2, findtime: 30, bantime: 60) do
+          request.path.include?("private-place")
+        end
+      end
+
+      get "/"
+      assert_equal 200, last_response.status
+
+      get "/private-place"
+      assert_equal 403, last_response.status
+
+      get "/private-place"
+      assert_equal 403, last_response.status
+
+      get "/"
+      assert_equal 403, last_response.status
+    end
+
+    it "works for allow2ban" do
+      Rack::Attack.blocklist("allow2ban pentesters") do |request|
+        Rack::Attack::Allow2Ban.filter(request.ip, maxretry: 2, findtime: 30, bantime: 60) do
+          request.path.include?("scarce-resource")
+        end
+      end
+
+      get "/"
+      assert_equal 200, last_response.status
+
+      get "/scarce-resource"
+      assert_equal 200, last_response.status
+
+      get "/scarce-resource"
+      assert_equal 200, last_response.status
+
+      get "/scarce-resource"
+      assert_equal 403, last_response.status
+
+      get "/"
+      assert_equal 403, last_response.status
+    end
+
+    it "doesn't leak keys" do
+      Rack::Attack.throttle("by ip", limit: 1, period: 1) do |request|
+        request.ip
+      end
+
+      key = nil
+
+      # Freeze time during these statement to be sure that the key used by rack attack is the same
+      # we pre-calculate in local variable `key`
+      Timecop.freeze do
+        key = "rack::attack:#{Time.now.to_i}:by ip:1.2.3.4"
+
+        get "/", {}, "REMOTE_ADDR" => "1.2.3.4"
+      end
+
+      assert fetch_from_store.call(key)
+
+      sleep 2.1
+
+      assert_nil fetch_from_store.call(key)
+    end
+  end
+end