Rack::SslEnforcer 技术文档

1. 安装指南

Rack::SslEnforcer 的安装非常简单，可以使用 Bundler 来进行安装。首先，需要在 Gemfile 中添加 Rack::SslEnforcer：

gem 'rack-ssl-enforcer'

然后执行 bundle install 命令安装 gem。

如果不在使用 Bundler，也可以手动 require Rack::SslEnforcer：

require 'rack/ssl-enforcer'

2. 项目使用说明

Rack::SslEnforcer 是一个简单的 Rack 中间件，用于强制使用 SSL 连接。它可以在你的 web 应用程序中插入，以确保所有的请求都通过安全的 SSL 连接进行。

在 Rails 应用中使用

要在 Rails 应用程序中使用 Rack::SslEnforcer，需要在应用配置文件中添加以下代码：

对于 Rails 3 及以上版本：

config.middleware.insert_before ActionDispatch::Cookies, Rack::SslEnforcer

对于 Rails 2 版本：

config.middleware.use Rack::SslEnforcer

在 Sinatra 或 Padrino 应用中使用

在 Sinatra 或 Padrino 应用中，确保 Rack::SslEnforcer 在 Rack 中间件的顶部。如果使用 enable :session，它会导致 Rack::Session::Cookie 在 Rack::SslEnforcer 之前加载，从而阻止标记 cookies 为安全。

解决这个问题，不要使用 enable :session，而是在 Rack::SslEnforcer 之后添加 Rack::Session::Cookie。

例如：

use Rack::SslEnforcer
set :session_secret, 'your_session_secret'

# 启用 sinatra sessions
use Rack::Session::Cookie, key: '_rack_session', path: '/', expire_after: 2592000, secret: settings.session_secret

3. 项目 API 使用文档

Rack::SslEnforcer 提供了多种配置选项来强制 SSL 连接，以下是一些常用的 API 选项：

• :only_hosts：仅对特定主机强制 SSL 连接。
• :except_hosts：防止特定主机被强制 SSL 连接。
• :only：仅对特定路径强制 SSL 连接。
• :except：防止特定路径被强制 SSL 连接。
• :only_methods：仅对特定的 HTTP 方法强制 SSL 连接。
• :except_methods：防止特定的 HTTP 方法被强制 SSL 连接。
• :only_environments：仅在某些环境中强制 SSL 连接。
• :except_environments：在某些环境中防止强制 SSL 连接。
• :hsts：设置 HTTP 严格传输安全（HSTS）。

更多配置选项和示例，请参考项目的 README 文件。

4. 项目安装方式

通过 Bundler 安装

1. 将 Rack::SslEnforcer 添加到 Gemfile：

   gem 'rack-ssl-enforcer'
   

2. 运行 bundle install 命令。

手动安装

1. 手动 require Rack::SslEnforcer 在你的应用程序代码中：

   require 'rack/ssl-enforcer'
   

2. 使用 use Rack::SslEnforcer 在你的 Rack 应用程序中启用中间件。

确保在你的应用程序中正确配置和使用 Rack::SslEnforcer，以保证安全性和正确的行为。