Devise OTP 项目使用教程

Devise OTP 项目使用教程

devise-otp Two Factors authentication for Devise using Time Based OTP/rfc6238 tokens. 项目地址: https://gitcode.com/gh_mirrors/de/devise-otp

1. 项目介绍

Devise OTP 是一个为 Devise 框架提供的双因素认证（Two-Factor Authentication, 2FA）扩展。它使用基于时间的一次性密码（Time-Based One-Time Password, TOTP）作为第二因素认证，符合 RFC 6238 标准。TOTP 由 rotp 库实现，支持多种 OTP 设备，如 Google Authenticator 和 FreeOTP。

主要功能

• 可选和强制 OTP 启用：用户可以选择启用 OTP，或者系统强制要求用户启用。
• 信任浏览器设置：用户可以设置浏览器为“信任”状态，减少 OTP 验证频率。
• 生成二维码：支持生成二维码，方便用户在 OTP 设备上扫描配置。

2. 项目快速启动

安装

1. 添加 Gem 到 Gemfile：

   gem "devise-otp"
   

2. 执行安装命令：

   bundle install
   

3. 生成配置文件：

   rails g devise_otp:install
   

4. 为 Devise 用户模型添加 OTP 支持：

   rails g devise_otp MODEL
   

5. 运行数据库迁移：

   rake db:migrate
   

6. 添加 JavaScript 支持： 在 application.js 中添加：

   //= require devise-otp
   

配置

在 config/initializers/devise.rb 中添加以下配置：

config.otp_mandatory = true # 强制启用 OTP
config.otp_authentication_timeout = 3.minutes # OTP 验证超时时间
config.otp_drift_window = 3 # 时间漂移窗口
config.otp_credentials_refresh = 15.minutes # 刷新凭证时间
config.otp_recovery_tokens = 10 # 恢复令牌数量
config.otp_trust_persistence = 1.month # 浏览器信任持续时间
config.otp_issuer = "YourAppName" # 令牌发行者名称

3. 应用案例和最佳实践

应用案例

• 企业内部系统：在企业内部系统中，强制启用 OTP 可以显著提高账户安全性，防止内部人员滥用权限。
• 金融交易平台：在涉及资金交易的平台上，使用 OTP 可以有效防止账户被盗用，保护用户资金安全。

最佳实践

• 定期更新 OTP 设备：建议用户定期更新 OTP 设备，避免设备丢失或损坏导致无法登录。
• 备份恢复令牌：为用户提供恢复令牌，以便在 OTP 设备丢失时仍能登录账户。
• 监控 OTP 使用情况：定期监控 OTP 的使用情况，发现异常及时处理。

4. 典型生态项目

• Devise：Devise OTP 是基于 Devise 框架的扩展，Devise 是一个强大的 Ruby on Rails 认证解决方案。
• rotp：rotp 是一个 Ruby 库，用于生成基于时间的 OTP，是 Devise OTP 的核心依赖。
• Google Authenticator：Google Authenticator 是一个广泛使用的 OTP 设备，支持 TOTP 标准。

通过以上步骤，您可以快速在 Rails 项目中集成 Devise OTP，提升系统的安全性。

devise-otp Two Factors authentication for Devise using Time Based OTP/rfc6238 tokens. 项目地址: https://gitcode.com/gh_mirrors/de/devise-otp