Rack::Attack 开源项目教程

1. 项目的目录结构及介绍

Rack::Attack 是一个用于防止恶意请求的 Rack 中间件。以下是其基本的目录结构：

rack-attack/
├── Gemfile
├── Gemfile.lock
├── LICENSE.txt
├── README.md
├── Rakefile
├── lib/
│   ├── rack/
│   │   ├── attack.rb
│   │   └── attack/
│   │       ├── cached_store.rb
│   │       ├── check.rb
│   │       ├── configuration.rb
│   │       ├── defaults.rb
│   │       ├── middleware.rb
│   │       ├── rule.rb
│   │       ├── store_proxy.rb
│   │       └── version.rb
│   └── rack-attack.rb
├── rack-attack.gemspec
└── test/
    ├── rack/
    │   └── attack/
    │       ├── cached_store_test.rb
    │       ├── check_test.rb
    │       ├── configuration_test.rb
    │       ├── defaults_test.rb
    │       ├── middleware_test.rb
    │       ├── rule_test.rb
    │       ├── store_proxy_test.rb
    │       └── version_test.rb
    └── test_helper.rb

目录结构介绍

• Gemfile 和 Gemfile.lock：定义了项目的依赖关系。
• LICENSE.txt：项目的许可证。
• README.md：项目的说明文档。
• Rakefile：用于定义 Rake 任务。
• lib/：包含项目的主要代码。
  • rack/attack.rb：Rack::Attack 的主文件。
  • rack/attack/：包含各种模块和辅助文件。
• rack-attack.gemspec：Gem 的规范文件。
• test/：包含项目的测试文件。

2. 项目的启动文件介绍

Rack::Attack 的启动文件是 lib/rack/attack.rb。这个文件定义了 Rack::Attack 的主要功能和配置。

require "rack/attack/version"
require "rack/attack/configuration"
require "rack/attack/middleware"
require "rack/attack/store_proxy"
require "rack/attack/cached_store"
require "rack/attack/check"
require "rack/attack/rule"
require "rack/attack/defaults"

module Rack
  class Attack
    def self.new(*)
      Middleware.new(nil)
    end
  end
end

启动文件介绍

• require "rack/attack/version"：引入版本信息。
• require "rack/attack/configuration"：引入配置模块。
• require "rack/attack/middleware"：引入中间件模块。
• require "rack/attack/store_proxy"：引入存储代理模块。
• require "rack/attack/cached_store"：引入缓存存储模块。
• require "rack/attack/check"：引入检查模块。
• require "rack/attack/rule"：引入规则模块。
• require "rack/attack/defaults"：引入默认配置模块。
• Rack::Attack.new(*)：定义了 Rack::Attack 的初始化方法。

3. 项目的配置文件介绍

Rack::Attack 的配置文件主要是通过代码进行配置的。以下是一个基本的配置示例：

Rack::Attack.cache.store = Rack::Attack::StoreProxy::RedisStoreProxy.new($redis)

Rack::Attack.throttle('requests by ip', limit: 5, period: 1.minute) do |req|
  req.ip
end

Rack::Attack.blocklist('block bad ips') do |req|
  bad_ips = ['1.2.3.4', '5.6.7.8']
  bad_ips.include?(req.ip)
end

配置文件介绍

• Rack::Attack.cache.store：定义了缓存存储的代理。
• Rack::Attack.throttle：定义了请求的限速规则。
• Rack::Attack.blocklist：定义了阻止恶意 IP 的规则。

通过这些配置，可以有效地防止恶意请求和攻击。