# frozen_string_literal: true require 'rack' require 'forwardable' require 'rack/attack/path_normalizer' require 'rack/attack/request' require "ipaddr" module Rack class Attack class MisconfiguredStoreError < StandardError; end class MissingStoreError < StandardError; end autoload :Cache, 'rack/attack/cache' autoload :Check, 'rack/attack/check' autoload :Throttle, 'rack/attack/throttle' autoload :Safelist, 'rack/attack/safelist' autoload :Blocklist, 'rack/attack/blocklist' autoload :Track, 'rack/attack/track' autoload :StoreProxy, 'rack/attack/store_proxy' autoload :DalliProxy, 'rack/attack/store_proxy/dalli_proxy' autoload :MemCacheStoreProxy, 'rack/attack/store_proxy/mem_cache_store_proxy' autoload :RedisProxy, 'rack/attack/store_proxy/redis_proxy' autoload :RedisStoreProxy, 'rack/attack/store_proxy/redis_store_proxy' autoload :RedisCacheStoreProxy, 'rack/attack/store_proxy/redis_cache_store_proxy' autoload :ActiveSupportRedisStoreProxy, 'rack/attack/store_proxy/active_support_redis_store_proxy' autoload :Fail2Ban, 'rack/attack/fail2ban' autoload :Allow2Ban, 'rack/attack/allow2ban' class << self attr_accessor :notifier, :blocklisted_response, :throttled_response, :anonymous_blocklists, :anonymous_safelists def safelist(name = nil, &block) safelist = Safelist.new(name, &block) if name safelists[name] = safelist else anonymous_safelists << safelist end end def blocklist(name = nil, &block) blocklist = Blocklist.new(name, &block) if name blocklists[name] = blocklist else anonymous_blocklists << blocklist end end def blocklist_ip(ip_address) anonymous_blocklists << Blocklist.new { |request| IPAddr.new(ip_address).include?(IPAddr.new(request.ip)) } end def safelist_ip(ip_address) anonymous_safelists << Safelist.new { |request| IPAddr.new(ip_address).include?(IPAddr.new(request.ip)) } end def throttle(name, options, &block) throttles[name] = Throttle.new(name, options, &block) end def track(name, options = {}, &block) tracks[name] = Track.new(name, options, &block) end def safelists @safelists ||= {} end def blocklists @blocklists ||= {} end def throttles @throttles ||= {} end def tracks @tracks ||= {} end def safelisted?(request) anonymous_safelists.any? { |safelist| safelist.matched_by?(request) } || safelists.any? { |_name, safelist| safelist.matched_by?(request) } end def blocklisted?(request) anonymous_blocklists.any? { |blocklist| blocklist.matched_by?(request) } || blocklists.any? { |_name, blocklist| blocklist.matched_by?(request) } end def throttled?(request) throttles.any? do |_name, throttle| throttle.matched_by?(request) end end def tracked?(request) tracks.each_value do |track| track.matched_by?(request) end end def instrument(request) if notifier event_type = request.env["rack.attack.match_type"] notifier.instrument("#{event_type}.rack_attack", request: request) # Deprecated: Keeping just for backwards compatibility notifier.instrument("rack.attack", request: request) end end def cache @cache ||= Cache.new end def clear_configuration @safelists, @blocklists, @throttles, @tracks = {}, {}, {}, {} self.anonymous_blocklists = [] self.anonymous_safelists = [] end def clear! warn "[DEPRECATION] Rack::Attack.clear! is deprecated. Please use Rack::Attack.clear_configuration instead" clear_configuration end end # Set defaults @anonymous_blocklists = [] @anonymous_safelists = [] @notifier = ActiveSupport::Notifications if defined?(ActiveSupport::Notifications) @blocklisted_response = lambda { |_env| [403, { 'Content-Type' => 'text/plain' }, ["Forbidden\n"]] } @throttled_response = lambda { |env| retry_after = (env['rack.attack.match_data'] || {})[:period] [429, { 'Content-Type' => 'text/plain', 'Retry-After' => retry_after.to_s }, ["Retry later\n"]] } def initialize(app) @app = app end def call(env) env['PATH_INFO'] = PathNormalizer.normalize_path(env['PATH_INFO']) request = Rack::Attack::Request.new(env) if safelisted?(request) @app.call(env) elsif blocklisted?(request) self.class.blocklisted_response.call(env) elsif throttled?(request) self.class.throttled_response.call(env) else tracked?(request) @app.call(env) end end extend Forwardable def_delegators self, :safelisted?, :blocklisted?, :throttled?, :tracked? end end