Devise Google Authenticator 技术文档

1. 安装指南

首先，将以下内容添加到您的 Gemfile 中，并确保也添加了 Devise：

gem 'devise'
gem 'devise_google_authenticator', '0.3.16'

完成上述操作后，执行以下命令来安装依赖项：

bundle install

在安装 Devise Google Authenticator 之前，您需要先安装 Devise。以下为 Devise 的安装步骤：

rails g devise:install

接着配置您的用户或管理员模型：

rails g devise MODEL

在控制器中添加认证过滤：

before_filter :authenticate_user!

确保在 config/routes.rb 文件中配置了根路由。

自动安装

对于全新的应用程序，运行以下生成器以添加必要的配置选项到 Devise 的配置文件：

rails g devise_google_authenticator:install

创建 Devise 用户模型后，设置 Google Authenticator 的附加功能：

rails g devise_google_authenticator MODEL

如果您使用的是 ActiveRecord 而不是 Mongoid 作为数据库 ORM，请执行迁移命令：

rake db:migrate

对现有用户的安装

上述步骤完成后，您需要为每个用户生成密钥：

User.where(:gauth_secret => nil).find_each do |user|
  user.send(:assign_auth_secret)
  user.save!
end

默认情况下，用户无需执行两步验证。用户访问 /MODEL/displayqr（例如 /users/displayqr），并提交表单后，将启用两步验证（gauth_enabled=1），并在随后的登录中要求进行。

2. 项目使用说明

使用此扩展后，预期行为如下：

• 用户注册时，将自动跳转到 Display QR 页面（除非 ga_bypass_signup 设置为 true），用户可以将新“令牌”添加到移动设备，并启用或禁用功能。要启用/禁用功能，用户需要输入当前的令牌。
• 如果用户无法自行注册，他们依然可以通过访问 /MODEL/displayqr（例如 /users/displayqr）来访问该页面。
• 如果该功能对用户已启用，那么在登录时，用户需要输入密码（如正常情况），然后跳转到 Check QR 页面。用户需要从设备中输入令牌才能成功认证。
• 如果已配置（默认为 1 个月），用户将仅在该时间段内需要输入令牌。

3. 项目API使用文档

此项目的具体API使用文档未在readme中提供，通常这类扩展会包含用于用户认证和管理的API端点。详细的API文档通常在项目wiki或专门的文档文件中提供。

4. 项目安装方式

请参考上述“安装指南”部分，其中包括了通过 Gemfile 安装本项目和相关依赖项的详细步骤。