Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Authy TOTP Ruby Quickstart


(warning)

Warning

As of November 2022, Twilio no longer provides support for Authy SMS/Voice-only customers. Customers who were also using Authy TOTP or Push prior to March 1, 2023 are still supported. The Authy API is now closed to new customers and will be fully deprecated in the future.

For new development, we encourage you to use the Verify v2 API.

Existing customers will not be impacted at this time until Authy API has reached End of Life. For more information about migration, see Migrating from Authy to Verify for SMS(link takes you to an external page).


Overview

overview page anchor

Authy is a simple REST API that does all the heavy lifting, so you can add two-factor authentication to your website or app in just a few hours. We have a number of resources, such as JavaScript helpers and API libraries for most languages. This guide will make use of these resources as we build a simple web app using the Authy API.

Full source code for this app can be found here(link takes you to an external page)


You will find everything you need in on github(link takes you to an external page)


There are two main parts to implement an Authy API integration:

  • Adding new users: involves creating an html form that takes the user's phone number / email and submits it to the Authy API.
  • Verifying users: involves adding a field to the login form were the user enters the token which is in turn submitted to Authy for verification.

Part 1: Adding a new user

part-1-adding-a-new-user page anchor

First we are going to create a page in the users control panel (we will call it /enableauthy). In this page we'll create a simple form that collects the phone number and area code.

This form uses the Authy JavaScript samples found here(link takes you to an external page). The html IDs authy-cellphone and authy-countries are special IDs recognized by this JavaScript.


_10
%label
_10
Cellphone
_10
= text_field "cellphone", :placeholder => "Enter your cellphone", :id => "authy-cellphone"
_10
_10
%label
_10
Country
_10
= text_field "country_code", :id => "authy-countries", :placeholder => "Enter your country"
_10
_10
= submit "Submit", :class => "btn"

JavaScript ID tag helpers

javascript-id-tag-helpers page anchor

The scripts use ID s to help you easily build this form. These are the id's used

  • authy-cellphone: If set on the text-field were the user inputs his cellphone, it will automatically run phone validations on the client-side.
  • authy-countries: If set on the text-field were the user inputs his area code, it will produce an auto-complete drop down with a list of countries and their area-codes. This simplifies the user entering his area-code.

At this point you can send the users email, phone number and country code to Authy.


_15
def register_authy
_15
@authy_user = Authy::API.register_user(
_15
:email => current_user.email,
_15
:cellphone => params[:user][:cellphone],
_15
:country_code => params[:user][:country_code]
_15
)
_15
_15
if @authy_user.ok?
_15
current_user.authy_id = @authy_user.id
_15
current_user.save
_15
else
_15
@errors = @authy_user.errors
_15
render 'enable_authy'
_15
end
_15
end

If everything goes well, the API will return the user's Authy ID. This is represented as an integer which you need to store in your users database or directory. In the case of an error, a hash in plain English is returned. The language used is designed for you to display to the user to help them resolve the situation.

Part 2: Verifying users

part-2-verifying-users page anchor

After you have registered the user in the Authy service and stored the resulting Authy ID against the user's profile in your application, the next time you process the user login, you use the Authy ID to verify the two-factor token they should provide.

Implementing the request for a second factor during the login can vary depending on the design of your application and the end user experience you wish to create. In this example we plan to support users who opt-in for two-factor authentication. Therefore there will be a mix of user accounts that are enabled and some that are not. The easiest way to implement this is to separate the authentication process across two screens.

  1. The first screen is your usual login form where the user inputs username and password.
  2. The second screen the user inputs the Authy token, assuming they have opt-ed into Authy and they've gone through the user registration process.

Remember you need to manage the link between your user identities and the Authy user. Your database or user directory should ensure the AuthyID is stored with each user profile that has been registered.

Here's the function from our sample application that validates username and password and redirects to the two-factor authentication page if authy is enabled:


_23
def create
_23
@user = User.find_by_email(params[:user][:email])
_23
_23
if @user && @user.authenticate(params[:user][:password])
_23
# username and password is correct
_23
if(@user.authy_id != 0) #user is using two-factor
_23
Authy::API.request_sms(:id => @user.authy_id) # request the API to send and sms.
_23
_23
# Rails sessions are tamper proof. We can store the ID and that the password was already validated
_23
session[:password_validated] = true
_23
session[:id] = @user.id
_23
redirect_to url_for(:controller => "sessions", :action => "two_factor_auth")
_23
else
_23
sign_in(@user)
_23
flash[:notice] = "Successfully authenticated without two-factor"
_23
redirect_to @user
_23
end
_23
else
_23
flash[:error] = "Wrong username, password."
_23
@user = User.new
_23
render 'new'
_23
end
_23
end

When the user wants to login, you use their email (or whatever user identifier you are using) to locate their user profile in the database or directory. The authenticate function will check username and password and if the user has been Authy enabled. If so, redirect the user to the second page were they enter the token and complete the authentication. Here's the function for the second factor authentication:


_16
def create_two_factor_auth
_16
@user = User.find(session[:id])
_16
token = params[:token]
_16
if @user && session[:password_validated] && @user.verify_token(token)
_16
sign_in(@user)
_16
@user.authy_used = true
_16
@user.save(:validate => false)
_16
session[:password_validated] = nil
_16
session[:id] = nil
_16
flash[:success] = "Securely signed in using Authy"
_16
redirect_to @user
_16
else
_16
flash[:error] = "Wrong token"
_16
redirect_to new_session_path
_16
end
_16
end

Token verification involves sending the token and the id. Authy will respond HTTP status 200 if the token is correct.


_10
def verify_token(token)
_10
token = Authy::API.verify(:id => self.id, :token => token)
_10
_10
token.ok?
_10
end

The function simply passes the authy_id and the token the user entered. Then it check if the response is HTTP status 200, if so it returns true.

To prevent users account getting locked down, Authy won't check the tokens until we are certain the user has completed the registration process. If you want to verify token's anyway, you can pass ?force=true to verify.


Rate this page: