百科.dev
全部条目在线工具AI 编程趋势榜开源项目技术资讯提交条目
登录
< 返回工具列表
A

authy-devise

> 编程语言
开源

Authy Devise 插件,用于添加双因素身份验证

198 stars0 点赞3 次浏览
访问官网GitHub

工具介绍

Authy Devise 插件,用于添加双因素身份验证

This library is no longer actively maintained. The Authy API has been replaced with the Twilio Verify API. Twilio will support the Authy API through November 1, 2022 for SMS/Voice. After this date, we’ll start to deprecate the service for SMS/Voice. Any requests sent to the API after May 1, 2023, will automatically receive an error. Push and TOTP will continue to be supported through July 2023.

Learn more about migrating from Authy to Verify.

Please visit the Twilio Docs for:

  • Verify + Ruby (Rails) quickstart
  • Twilio Ruby helper library
  • Verify API reference
  • Coming soon: Look out for a new Devise plugin to use Twilio Verify with Devise

Please direct any questions to Twilio Support. Thank you!


Authy Devise

This is a Devise extension to add Two-Factor Authentication with Authy to your Rails application.

  • Pre-requisites
  • Demo
  • Getting started
    • Configuring Models
      • With the generator
      • Manually
      • Final steps
  • Custom Views
    • Request a phone call
  • Custom Redirect Paths (eg. using modules)
  • I18n
  • Session variables
  • OneTouch support
  • Generic authenticator token support
  • Rails 5 CSRF protection
  • Running Tests
  • Notice: Twilio Authy API’s Sandbox feature will stop working on Sep 30, 2021
  • Copyright

Pre-requisites

To use the Authy API you will need a Twilio Account, sign up for a free Twilio account here.

Create an Authy Application in the Twilio console and take note of the API key.

Demo

See this repo for a full demo of using authy-devise.

Getting started

First get your Authy API key from the Twilio console. We recommend you store your API key as an environment variable.

bash
$ export AUTHY_API_KEY=YOUR_AUTHY_API_KEY

Next add the gem to your Gemfile:

ruby
gem 'devise'
gem 'devise-authy'

And then run bundle install

Add Devise Authy to your App:

rails g devise_authy:install

--haml: Generate the views in Haml
--sass: Generate the stylesheets in Sass

Configuring Models

You can add devise_authy to your user model in two ways.

With the generator

Run the following command:

bash
rails g devise_authy [MODEL_NAME]

To support account locking (recommended), you must add :authy_lockable to the devise :authy_authenticatable, ... configuration in your model as this is not yet supported by the generator.

Manually

Add :authy_authenticatable and :authy_lockable to the devise options in your Devise user model:

ruby
devise :authy_authenticatable, :authy_lockable, :database_authenticatable, :lockable

(Note, :authy_lockable is optional but recommended. It should be used with Devise's own :lockable module).

Also add a new migration. For example, if you are adding to the User model, use this migration:

ruby
class DeviseAuthyAddToUsers  false
    end

    add_index :users, :authy_id
  end

  def self.down
    change_table :users do |t|
      t.remove :authy_id, :last_sign_in_with_authy, :authy_enabled
    end
  end
end

Final steps

For either method above, run the migrations:

bash
rake db:migrate

[Optional] Update the default routes to point to something like:

ruby
devise_for :users, :path_names => {
	:verify_authy => "/verify-token",
	:enable_authy => "/enable-two-factor",
	:verify_authy_installation => "/verify-installation",
	:authy_onetouch_status => "/onetouch-status"
}

Now whenever a user wants to enable two-factor authentication they can go to:

http://your-app/users/enable-two-factor

And when the user logs in they will be redirected to:

http://your-app/users/verify-token

Custom Views

If you want to customise your views, you can modify the files that are located at:

app/views/devise/devise_authy/enable_authy.html.erb
app/views/devise/devise_authy/verify_authy.html.erb
app/views/devise/devise_authy/verify_authy_installation.html.erb

Request a phone call

The default views come with a button to force a request for an SMS message. You can also add a button that will request a phone call instead. Simply add the helper method to your view:

Custom Redirect Paths (eg. using modules)

If you want to customise the redirects you can override them within your own controller like this:

ruby
class MyCustomModule::DeviseAuthyController  **To use this feature, you need to enable it in your [Twilio Console](https://www.twilio.com/console/authy/applications)**

Once you have enabled generic authenticator tokens, you can enable this in devise-authy by modifying the Devise config file `config/initializers/devise.rb` and adding the configuration:

config.authy_enable_qr_code = true

…

ruby class ApplicationController < ActionController::Base protect_from_forgery with: :exception, prepend: true end


## Running Tests

Run the following command:

```bash
$ bundle exec rspec

Notice: Twilio Authy API’s Sandbox feature will stop working on Sep 30, 2021

Twilio is discontinuing the Authy API’s Sandbox, a feature that allows customers to run continuous integration tests against a mock Authy API for free. The Sandbox is no longer being maintained, so we will be taking the final deprecation step of shutting it down on September 30, 2021. The rest of the Authy API product will continue working as-is.

This repo previously used the sandbox API as part of the test suite, but that has been since removed.

You will only be affected if you are using the sandbox API in your own application or test suite.

For more information please read this article on how we are discontinuing the Twilio Authy sandbox API.

Copyright

Copyright (c) 2012-2021 Authy Inc. See LICENSE.txt for further details.

Issues· 0 开放

查看全部 Issues在 GitHub 打开

暂无开放 Issues,或尚未同步最近议题。

> 标签

Ruby

暂无评论,来聊聊你的看法吧

> 工具信息

发布日期2026年8月1日
最后更新2026年9月18日
分类编程语言
定价开源

> 相关工具

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言