Module: Rack::Attack

Defined in:
lib/rack/attack/cache.rb,
lib/rack/attack/check.rb,
lib/rack/attack/track.rb,
lib/rack/attack/version.rb,
lib/rack/attack/throttle.rb,
lib/rack/attack/blacklist.rb,
lib/rack/attack/whitelist.rb,
lib/rack/attack.rb

Defined Under Namespace

Classes: Blacklist, Cache, Check, Throttle, Track, Whitelist

Constant Summary collapse

VERSION = 
'2.0.0'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.blacklisted_response ⇒ Object

Returns the value of attribute blacklisted_response.



12
13
14
 
# File 'lib/rack/attack.rb', line 12

def blacklisted_response
  @blacklisted_response
end

.notifier ⇒ Object

Returns the value of attribute notifier.



12
13
14
 
# File 'lib/rack/attack.rb', line 12

def notifier
  @notifier
end

.throttled_response ⇒ Object

Returns the value of attribute throttled_response.



12
13
14
 
# File 'lib/rack/attack.rb', line 12

def throttled_response
  @throttled_response
end

Class Method Details

.blacklist(name, &block) ⇒ Object 



18
19
20
 
# File 'lib/rack/attack.rb', line 18

def blacklist(name, &block)
  self.blacklists[name] = Blacklist.new(name, block)
end

.blacklisted?(req) ⇒ Boolean

Returns:

  • (Boolean) 


72
73
74
75
76
 
# File 'lib/rack/attack.rb', line 72

def blacklisted?(req)
  blacklists.any? do |name, blacklist|
    blacklist[req]
  end
end

.blacklists ⇒ Object 



31
 
# File 'lib/rack/attack.rb', line 31

def blacklists; @blacklists ||= {}; end

.cache ⇒ Object 



94
95
96
 
# File 'lib/rack/attack.rb', line 94

def cache
  @cache ||= Cache.new
end

.call(env) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/rack/attack.rb', line 49

def call(env)
  req = Rack::Request.new(env)

  if whitelisted?(req)
    return @app.call(env)
  end

  if blacklisted?(req)
    blacklisted_response[env]
  elsif throttled?(req)
    throttled_response[env]
  else
    tracked?(req)
    @app.call(env)
  end
end

.clear! ⇒ Object 



98
99
100
 
# File 'lib/rack/attack.rb', line 98

def clear!
  @whitelists, @blacklists, @throttles = {}, {}, {}
end

.instrument(req) ⇒ Object 



90
91
92
 
# File 'lib/rack/attack.rb', line 90

def instrument(req)
  notifier.instrument('rack.attack', req) if notifier
end

.new(app) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/rack/attack.rb', line 35

def new(app)
  @app = app

  # Set defaults
  @notifier ||= ActiveSupport::Notifications if defined?(ActiveSupport::Notifications)
  @blacklisted_response ||= lambda {|env| [503, {}, ['Blocked']] }
  @throttled_response   ||= lambda {|env|
    retry_after = env['rack.attack.match_data'][:period] rescue nil
    [503, {'Retry-After' => retry_after.to_s}, ['Retry later']]
  }

  self
end

.throttle(name, options, &block) ⇒ Object 



22
23
24
 
# File 'lib/rack/attack.rb', line 22

def throttle(name, options, &block)
  self.throttles[name] = Throttle.new(name, options, block)
end

.throttled?(req) ⇒ Boolean

Returns:

  • (Boolean) 


78
79
80
81
82
 
# File 'lib/rack/attack.rb', line 78

def throttled?(req)
  throttles.any? do |name, throttle|
    throttle[req]
  end
end

.throttles ⇒ Object 



32
 
# File 'lib/rack/attack.rb', line 32

def throttles;  @throttles  ||= {}; end

.track(name, &block) ⇒ Object 



26
27
28
 
# File 'lib/rack/attack.rb', line 26

def track(name, &block)
  self.tracks[name] = Track.new(name, block)
end

.tracked?(req) ⇒ Boolean

Returns:

  • (Boolean) 


84
85
86
87
88
 
# File 'lib/rack/attack.rb', line 84

def tracked?(req)
  tracks.each_value do |tracker|
    tracker[req]
  end
end

.tracks ⇒ Object 



33
 
# File 'lib/rack/attack.rb', line 33

def tracks;     @tracks     ||= {}; end

.whitelist(name, &block) ⇒ Object 



14
15
16
 
# File 'lib/rack/attack.rb', line 14

def whitelist(name, &block)
  self.whitelists[name] = Whitelist.new(name, block)
end

.whitelisted?(req) ⇒ Boolean

Returns:

  • (Boolean) 


66
67
68
69
70
 
# File 'lib/rack/attack.rb', line 66

def whitelisted?(req)
  whitelists.any? do |name, whitelist|
    whitelist[req]
  end
end

.whitelists ⇒ Object 



30
 
# File 'lib/rack/attack.rb', line 30

def whitelists; @whitelists ||= {}; end