Skip to contentSkip to navigationSkip to topbar
On this page

Two-Factor Authentication with Authy, Python and Flask


(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).

This Flask(link takes you to an external page) sample application is an example of typical login flow. To run this sample app yourself, download the code and follow the instructions on GitHub(link takes you to an external page).

Adding two-factor authentication (2FA) to your web application increases the security of your user's data. Multi-factor authentication(link takes you to an external page) determines the identity of a user by validating once by logging into the app, and then a second time with their mobile device using Authy(link takes you to an external page).

For the second factor, we will validate that the user has their mobile phone by either:

  • Sending them a OneTouch push notification to their mobile Authy app or
  • Sending them a token through their mobile Authy app or
  • Sending them a one-time token in a text message sent with Authy via Twilio.

See how VMware uses Authy 2FA to secure their enterprise mobility management solution.(link takes you to an external page)


Configuring Authy

configuring-authy page anchor

If you haven't already, now is the time to sign up for Authy(link takes you to an external page). Create your first application, naming it whatever you wish. After you create your application, your production API key will be visible on your dashboard(link takes you to an external page):

Once we have an Authy API key, we store it in our .env file, which helps us set the environment variables for our app.

You'll also want to set a callback URL for your application in the OneTouch section of the Authy dashboard. See the project README(link takes you to an external page) for more details.

Environment Variable Settings

environment-variable-settings page anchor

authy2fa-flask/.env_example

1
# Environment variables for authy2fa-flask
2
3
# Secret key (used for sessions)
4
SECRET_KEY=not-so-secret
5
6
# Authy API Key
7
# Found at https://dashboard.authy.com under your application
8
AUTHY_API_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
9

Now that we've configured our Flask app, let's take a look at how we register a user with Authy.


Register a User with Authy

register-a-user-with-authy page anchor

When a new user signs up for our website we call this helper function, which handles storing the user in the database as well as registering the user with Authy.

In order to get a user set up for your application you will need their email, phone number and country code. We have fields for each of these on our sign up form.

Once we register the user with Authy we can get the user's Authy id off the response. This is very important — it's how we will verify the identity of our user with Authy.

Create and Register a User with Authy

create-and-register-a-user-with-authy page anchor

twofa/utils.py

1
from authy.api import AuthyApiClient
2
from flask import current_app
3
from authy import AuthyApiException
4
5
6
def get_authy_client():
7
""" Return a configured Authy client. """
8
return AuthyApiClient(current_app.config['AUTHY_API_KEY'])
9
10
11
def create_user(form):
12
"""Creates an Authy user and then creates a database User"""
13
client = get_authy_client()
14
15
# Create a new Authy user with the data from our form
16
authy_user = client.users.create(
17
form.email.data, form.phone_number.data, form.country_code.data
18
)
19
20
# If the Authy user was created successfully, create a local User
21
# with the same information + the Authy user's id
22
if authy_user.ok():
23
return form.create_user(authy_user.id)
24
else:
25
raise AuthyApiException('', '', authy_user.errors()['message'])
26
27
28
def send_authy_token_request(authy_user_id):
29
"""
30
Sends a request to Authy to send a SMS verification code to a user's phone
31
"""
32
client = get_authy_client()
33
34
client.users.request_sms(authy_user_id)
35
36
37
def send_authy_one_touch_request(authy_user_id, email=None):
38
"""Initiates an Authy OneTouch request for a user"""
39
client = get_authy_client()
40
41
details = {}
42
43
if email:
44
details['Email'] = email
45
46
response = client.one_touch.send_request(
47
authy_user_id, 'Request to log in to Twilio demo app', details=details
48
)
49
50
if response.ok():
51
return response.content
52
53
54
def verify_authy_token(authy_user_id, user_entered_code):
55
"""Verifies a user-entered token with Authy"""
56
client = get_authy_client()
57
58
return client.tokens.verify(authy_user_id, user_entered_code)
59
60
61
def authy_user_has_app(authy_user_id):
62
"""Verifies a user has the Authy app installed"""
63
client = get_authy_client()
64
authy_user = client.users.status(authy_user_id)
65
try:
66
return authy_user.content['status']['registered']
67
except KeyError:
68
return False
69

Next up, let's take a look at the login.


Log in with Authy OneTouch

log-in-with-authy-onetouch page anchor

When a user attempts to log in to our website, we will ask them for a second form of identification. Let's take a look at OneTouch verification first.

OneTouch works like so:

  • We attempt to send a OneTouch Approval Request to the user
  • If the user has OneTouch enabled, we will get a success message back
  • The user hits Approve in their Authy app
  • Authy makes a POST request to our app with an approved status
  • We log the user in

twofa/auth/views.py

1
from authy import AuthyApiException
2
from flask import flash, jsonify, redirect, render_template, request, session, url_for
3
4
from . import auth
5
from .forms import LoginForm, SignUpForm, VerifyForm
6
from ..database import db
7
from ..decorators import login_required, verify_authy_request
8
from ..models import User
9
from ..utils import create_user, send_authy_token_request, verify_authy_token
10
11
12
@auth.route('/sign-up', methods=['GET', 'POST'])
13
def sign_up():
14
"""Powers the new user form"""
15
form = SignUpForm(request.form)
16
17
if form.validate_on_submit():
18
try:
19
user = create_user(form)
20
session['user_id'] = user.id
21
22
return redirect(url_for('main.account'))
23
24
except AuthyApiException as e:
25
form.errors['Authy API'] = [
26
'There was an error creating the Authy user',
27
e.msg,
28
]
29
30
return render_template('signup.html', form=form)
31
32
33
@auth.route('/login', methods=['GET', 'POST'])
34
def log_in():
35
"""
36
Powers the main login form.
37
38
- GET requests render the username / password form
39
- POST requests process the form data via an AJAX request triggered in the
40
user's browser
41
"""
42
form = LoginForm(request.form)
43
44
if form.validate_on_submit():
45
user = User.query.filter_by(email=form.email.data).first()
46
if user is not None and user.verify_password(form.password.data):
47
session['user_id'] = user.id
48
49
if user.has_authy_app:
50
# Send a request to verify this user's login with OneTouch
51
one_touch_response = user.send_one_touch_request()
52
return jsonify(one_touch_response)
53
else:
54
return jsonify({'success': False})
55
else:
56
# The username and password weren't valid
57
form.email.errors.append(
58
'The username and password combination you entered are invalid'
59
)
60
61
if request.method == 'POST':
62
# This was an AJAX request, and we should return any errors as JSON
63
return jsonify(
64
{'error': render_template('_login_error.html', form=form)}
65
) # noqa: E501
66
else:
67
return render_template('login.html', form=form)
68
69
70
@auth.route('/authy/callback', methods=['POST'])
71
@verify_authy_request
72
def authy_callback():
73
"""Authy uses this endpoint to tell us the result of a OneTouch request"""
74
authy_id = request.json.get('authy_id')
75
# When you're configuring your Endpoint/URL under OneTouch settings '1234'
76
# is the preset 'authy_id'
77
if authy_id != 1234:
78
user = User.query.filter_by(authy_id=authy_id).one()
79
80
if not user:
81
return ('', 404)
82
83
user.authy_status = request.json.get('status')
84
db.session.add(user)
85
db.session.commit()
86
87
return ('', 200)
88
89
90
@auth.route('/login/status')
91
def login_status():
92
"""
93
Used by AJAX requests to check the OneTouch verification status of a user
94
"""
95
user = User.query.get(session['user_id'])
96
return user.authy_status
97
98
99
@auth.route('/verify', methods=['GET', 'POST'])
100
@login_required
101
def verify():
102
"""Powers token validation (not using OneTouch)"""
103
form = VerifyForm(request.form)
104
user = User.query.get(session['user_id'])
105
106
# Send a token to our user when they GET this page
107
if request.method == 'GET':
108
send_authy_token_request(user.authy_id)
109
110
if form.validate_on_submit():
111
user_entered_code = form.verification_code.data
112
113
verified = verify_authy_token(user.authy_id, str(user_entered_code))
114
if verified.ok():
115
user.authy_status = 'approved'
116
db.session.add(user)
117
db.session.commit()
118
119
flash(
120
"You're logged in! Thanks for using two factor verification.", 'success'
121
) # noqa: E501
122
return redirect(url_for('main.account'))
123
else:
124
form.errors['verification_code'] = ['Code invalid - please try again.']
125
126
return render_template('verify.html', form=form)
127
128
129
@auth.route('/resend', methods=['POST'])
130
@login_required
131
def resend():
132
"""Resends a verification token to a user"""
133
user = User.query.get(session.get('user_id'))
134
send_authy_token_request(user.authy_id)
135
flash('I just re-sent your verification code - enter it below.', 'info')
136
return redirect(url_for('auth.verify'))
137
138
139
@auth.route('/logout')
140
def log_out():
141
"""Log out a user, clearing their session variables"""
142
user_id = session.pop('user_id', None)
143
user = User.query.get(user_id)
144
user.authy_status = 'unverified'
145
db.session.add(user)
146
db.session.commit()
147
148
flash("You're now logged out! Thanks for visiting.", 'info')
149
return redirect(url_for('main.home'))

Send the OneTouch Request

send-the-onetouch-request page anchor

When our user logs in we immediately attempt to verify their identity with OneTouch. We will fall back gracefully if they don't have a OneTouch device, but we don't know until we try.

Authy lets us pass extra details with our OneTouch request including a message, a logo, and any other details we want to send. We could send any number of details by appending details[some_detail] to our POST request. You could imagine a scenario where we send a OneTouch request to approve a money transfer:

1
data = {
2
'api_key': client.api_key,
3
'message': "Request to send money to Jarod's vault",
4
'details[Request From]': 'Jarod',
5
'details[Amount Requested]': '1,000,000',
6
'details[Currency]': 'Galleons'
7
}

twofa/models.py

1
from werkzeug.security import generate_password_hash, check_password_hash
2
3
from . import db
4
from .utils import authy_user_has_app, send_authy_one_touch_request
5
6
7
class User(db.Model):
8
"""
9
Represents a single user in the system.
10
"""
11
12
__tablename__ = 'users'
13
14
AUTHY_STATUSES = ('unverified', 'onetouch', 'sms', 'token', 'approved', 'denied')
15
16
id = db.Column(db.Integer, primary_key=True)
17
email = db.Column(db.String(64), unique=True, index=True)
18
password_hash = db.Column(db.String(128))
19
full_name = db.Column(db.String(256))
20
country_code = db.Column(db.Integer)
21
phone = db.Column(db.String(30))
22
authy_id = db.Column(db.Integer)
23
authy_status = db.Column(db.Enum(*AUTHY_STATUSES, name='authy_statuses'))
24
25
def __init__(
26
self,
27
email,
28
password,
29
full_name,
30
country_code,
31
phone,
32
authy_id,
33
authy_status='approved',
34
):
35
self.email = email
36
self.password = password
37
self.full_name = full_name
38
self.country_code = country_code
39
self.phone = phone
40
self.authy_id = authy_id
41
self.authy_status = authy_status
42
43
def __repr__(self):
44
return '<User %r>' % self.email
45
46
@property
47
def password(self):
48
raise AttributeError('password is not readable')
49
50
@property
51
def has_authy_app(self):
52
return authy_user_has_app(self.authy_id)
53
54
@password.setter
55
def password(self, password):
56
self.password_hash = generate_password_hash(password)
57
58
def verify_password(self, password):
59
return check_password_hash(self.password_hash, password)
60
61
def send_one_touch_request(self):
62
return send_authy_one_touch_request(self.authy_id, self.email)

Once we send the request we update our user's authy_status based on the response. This lets us know which method Authy will try first to verify this request with our user. But first we have to register a OneTouch callback endpoint.


Configure the OneTouch callback

configure-the-onetouch-callback page anchor

In order for our app to know what the user did after we sent the OneTouch request, we need to register a callback endpoint with Authy.

Note: In order to verify that the request is coming from Authy we've written a decorator, @verify_authy_request,(link takes you to an external page) that will halt the request if we cannot verify that it actually came from Authy*.*

Here in our callback, we look up the user using the authy_id sent with the Authy POST request. In a production application we might use a websocket to let our client know that we received a response from Authy. For this version, we update the authy_status on the user. Our client-side code will check that field before completing the login.

Update user status using Authy Callback

update-user-status-using-authy-callback page anchor

twofa/auth/views.py

1
from authy import AuthyApiException
2
from flask import flash, jsonify, redirect, render_template, request, session, url_for
3
4
from . import auth
5
from .forms import LoginForm, SignUpForm, VerifyForm
6
from ..database import db
7
from ..decorators import login_required, verify_authy_request
8
from ..models import User
9
from ..utils import create_user, send_authy_token_request, verify_authy_token
10
11
12
@auth.route('/sign-up', methods=['GET', 'POST'])
13
def sign_up():
14
"""Powers the new user form"""
15
form = SignUpForm(request.form)
16
17
if form.validate_on_submit():
18
try:
19
user = create_user(form)
20
session['user_id'] = user.id
21
22
return redirect(url_for('main.account'))
23
24
except AuthyApiException as e:
25
form.errors['Authy API'] = [
26
'There was an error creating the Authy user',
27
e.msg,
28
]
29
30
return render_template('signup.html', form=form)
31
32
33
@auth.route('/login', methods=['GET', 'POST'])
34
def log_in():
35
"""
36
Powers the main login form.
37
38
- GET requests render the username / password form
39
- POST requests process the form data via an AJAX request triggered in the
40
user's browser
41
"""
42
form = LoginForm(request.form)
43
44
if form.validate_on_submit():
45
user = User.query.filter_by(email=form.email.data).first()
46
if user is not None and user.verify_password(form.password.data):
47
session['user_id'] = user.id
48
49
if user.has_authy_app:
50
# Send a request to verify this user's login with OneTouch
51
one_touch_response = user.send_one_touch_request()
52
return jsonify(one_touch_response)
53
else:
54
return jsonify({'success': False})
55
else:
56
# The username and password weren't valid
57
form.email.errors.append(
58
'The username and password combination you entered are invalid'
59
)
60
61
if request.method == 'POST':
62
# This was an AJAX request, and we should return any errors as JSON
63
return jsonify(
64
{'error': render_template('_login_error.html', form=form)}
65
) # noqa: E501
66
else:
67
return render_template('login.html', form=form)
68
69
70
@auth.route('/authy/callback', methods=['POST'])
71
@verify_authy_request
72
def authy_callback():
73
"""Authy uses this endpoint to tell us the result of a OneTouch request"""
74
authy_id = request.json.get('authy_id')
75
# When you're configuring your Endpoint/URL under OneTouch settings '1234'
76
# is the preset 'authy_id'
77
if authy_id != 1234:
78
user = User.query.filter_by(authy_id=authy_id).one()
79
80
if not user:
81
return ('', 404)
82
83
user.authy_status = request.json.get('status')
84
db.session.add(user)
85
db.session.commit()
86
87
return ('', 200)
88
89
90
@auth.route('/login/status')
91
def login_status():
92
"""
93
Used by AJAX requests to check the OneTouch verification status of a user
94
"""
95
user = User.query.get(session['user_id'])
96
return user.authy_status
97
98
99
@auth.route('/verify', methods=['GET', 'POST'])
100
@login_required
101
def verify():
102
"""Powers token validation (not using OneTouch)"""
103
form = VerifyForm(request.form)
104
user = User.query.get(session['user_id'])
105
106
# Send a token to our user when they GET this page
107
if request.method == 'GET':
108
send_authy_token_request(user.authy_id)
109
110
if form.validate_on_submit():
111
user_entered_code = form.verification_code.data
112
113
verified = verify_authy_token(user.authy_id, str(user_entered_code))
114
if verified.ok():
115
user.authy_status = 'approved'
116
db.session.add(user)
117
db.session.commit()
118
119
flash(
120
"You're logged in! Thanks for using two factor verification.", 'success'
121
) # noqa: E501
122
return redirect(url_for('main.account'))
123
else:
124
form.errors['verification_code'] = ['Code invalid - please try again.']
125
126
return render_template('verify.html', form=form)
127
128
129
@auth.route('/resend', methods=['POST'])
130
@login_required
131
def resend():
132
"""Resends a verification token to a user"""
133
user = User.query.get(session.get('user_id'))
134
send_authy_token_request(user.authy_id)
135
flash('I just re-sent your verification code - enter it below.', 'info')
136
return redirect(url_for('auth.verify'))
137
138
139
@auth.route('/logout')
140
def log_out():
141
"""Log out a user, clearing their session variables"""
142
user_id = session.pop('user_id', None)
143
user = User.query.get(user_id)
144
user.authy_status = 'unverified'
145
db.session.add(user)
146
db.session.commit()
147
148
flash("You're now logged out! Thanks for visiting.", 'info')
149
return redirect(url_for('main.home'))
150

Let's take a look at that client-side code now.


Disabling Unsuccessful Callbacks

disabling-unsuccessful-callbacks page anchor

Scenario: The OneTouch callback URL provided by you is no longer active.

Action: We will disable the OneTouch callback after 3 consecutive HTTP error responses. We will also

  • Set the OneTouch callback URL to blank.
  • Send an email notifying you that the OneTouch callback is disabled with details on how to enable the OneTouch callback.

How to enable OneTouch callback? You need to update the OneTouch callback endpoint, which will allow the OneTouch callback.

Visit the Twilio Console: Console > Authy > Applications > {ApplicationName} > Push Authentication > Webhooks > Endpoint/URL to update the Endpoint/URL with a valid OneTouch callback URL.


Handle Two-Factor Asynchronously

handle-two-factor-asynchronously page anchor

In order for two-factor authentication to be seamless, it is best done asynchronously so that the user doesn't even know it's happening.

We've already taken a look at what's happening on the server side, so let's step in front of the cameras now and see how our JavaScript is interacting with those server endpoints.

First we hijack the login form submit and pass the data to our sessions/create controller using Ajax. Depending on how that endpoint responds, we will either wait for a OneTouch response or ask the user to enter a token.

If we expect a OneTouch response, we will begin polling /login/status until we see the OneTouch login was either approved or denied.

Handle Two-Factor Asynchronously

handle-two-factor-asynchronously-1 page anchor

twofa/static/js/sessions.js

1
$(document).ready(function() {
2
3
$('#login-form').submit(function(e) {
4
e.preventDefault();
5
const formData = $(e.currentTarget).serialize();
6
attemptOneTouchVerification(formData);
7
});
8
9
const attemptOneTouchVerification = function(form) {
10
$.post( "/login", form, function(data) {
11
$('.form-errors').remove();
12
// Check first if we successfully authenticated the username and password
13
if (data.hasOwnProperty('error')) {
14
$('#login-form').prepend(data.error);
15
return;
16
}
17
18
if (data.success) {
19
$('#authy-modal').modal({backdrop:'static'},'show');
20
$('.auth-ot').fadeIn();
21
checkForOneTouch();
22
} else {
23
redirectToTokenForm();
24
}
25
});
26
};
27
28
const checkForOneTouch = function() {
29
$.get( "/login/status", function(data) {
30
31
if (data === 'approved') {
32
window.location.href = "/account";
33
} else if (data === 'denied') {
34
redirectToTokenForm();
35
} else {
36
setTimeout(checkForOneTouch, 2000);
37
}
38
});
39
};
40
41
const redirectToTokenForm = function() {
42
window.location.href = "/verify";
43
};
44
});
45

Now let's see how to handle the case where we receive a denied OneTouch response.


This is the endpoint that our JavaScript is polling. It is waiting for the user's authy_status to be either approved or denied. If the user approves the OneTouch request, our JavaScript code from the previous step will redirect their browser to their account screen.

If the OneTouch request was denied, we will ask the user to log in with a token instead.

twofa/auth/views.py

1
from authy import AuthyApiException
2
from flask import flash, jsonify, redirect, render_template, request, session, url_for
3
4
from . import auth
5
from .forms import LoginForm, SignUpForm, VerifyForm
6
from ..database import db
7
from ..decorators import login_required, verify_authy_request
8
from ..models import User
9
from ..utils import create_user, send_authy_token_request, verify_authy_token
10
11
12
@auth.route('/sign-up', methods=['GET', 'POST'])
13
def sign_up():
14
"""Powers the new user form"""
15
form = SignUpForm(request.form)
16
17
if form.validate_on_submit():
18
try:
19
user = create_user(form)
20
session['user_id'] = user.id
21
22
return redirect(url_for('main.account'))
23
24
except AuthyApiException as e:
25
form.errors['Authy API'] = [
26
'There was an error creating the Authy user',
27
e.msg,
28
]
29
30
return render_template('signup.html', form=form)
31
32
33
@auth.route('/login', methods=['GET', 'POST'])
34
def log_in():
35
"""
36
Powers the main login form.
37
38
- GET requests render the username / password form
39
- POST requests process the form data via an AJAX request triggered in the
40
user's browser
41
"""
42
form = LoginForm(request.form)
43
44
if form.validate_on_submit():
45
user = User.query.filter_by(email=form.email.data).first()
46
if user is not None and user.verify_password(form.password.data):
47
session['user_id'] = user.id
48
49
if user.has_authy_app:
50
# Send a request to verify this user's login with OneTouch
51
one_touch_response = user.send_one_touch_request()
52
return jsonify(one_touch_response)
53
else:
54
return jsonify({'success': False})
55
else:
56
# The username and password weren't valid
57
form.email.errors.append(
58
'The username and password combination you entered are invalid'
59
)
60
61
if request.method == 'POST':
62
# This was an AJAX request, and we should return any errors as JSON
63
return jsonify(
64
{'error': render_template('_login_error.html', form=form)}
65
) # noqa: E501
66
else:
67
return render_template('login.html', form=form)
68
69
70
@auth.route('/authy/callback', methods=['POST'])
71
@verify_authy_request
72
def authy_callback():
73
"""Authy uses this endpoint to tell us the result of a OneTouch request"""
74
authy_id = request.json.get('authy_id')
75
# When you're configuring your Endpoint/URL under OneTouch settings '1234'
76
# is the preset 'authy_id'
77
if authy_id != 1234:
78
user = User.query.filter_by(authy_id=authy_id).one()
79
80
if not user:
81
return ('', 404)
82
83
user.authy_status = request.json.get('status')
84
db.session.add(user)
85
db.session.commit()
86
87
return ('', 200)
88
89
90
@auth.route('/login/status')
91
def login_status():
92
"""
93
Used by AJAX requests to check the OneTouch verification status of a user
94
"""
95
user = User.query.get(session['user_id'])
96
return user.authy_status
97
98
99
@auth.route('/verify', methods=['GET', 'POST'])
100
@login_required
101
def verify():
102
"""Powers token validation (not using OneTouch)"""
103
form = VerifyForm(request.form)
104
user = User.query.get(session['user_id'])
105
106
# Send a token to our user when they GET this page
107
if request.method == 'GET':
108
send_authy_token_request(user.authy_id)
109
110
if form.validate_on_submit():
111
user_entered_code = form.verification_code.data
112
113
verified = verify_authy_token(user.authy_id, str(user_entered_code))
114
if verified.ok():
115
user.authy_status = 'approved'
116
db.session.add(user)
117
db.session.commit()
118
119
flash(
120
"You're logged in! Thanks for using two factor verification.", 'success'
121
) # noqa: E501
122
return redirect(url_for('main.account'))
123
else:
124
form.errors['verification_code'] = ['Code invalid - please try again.']
125
126
return render_template('verify.html', form=form)
127
128
129
@auth.route('/resend', methods=['POST'])
130
@login_required
131
def resend():
132
"""Resends a verification token to a user"""
133
user = User.query.get(session.get('user_id'))
134
send_authy_token_request(user.authy_id)
135
flash('I just re-sent your verification code - enter it below.', 'info')
136
return redirect(url_for('auth.verify'))
137
138
139
@auth.route('/logout')
140
def log_out():
141
"""Log out a user, clearing their session variables"""
142
user_id = session.pop('user_id', None)
143
user = User.query.get(user_id)
144
user.authy_status = 'unverified'
145
db.session.add(user)
146
db.session.commit()
147
148
flash("You're now logged out! Thanks for visiting.", 'info')
149
return redirect(url_for('main.home'))
150

Now let's see how to send a token to the user.


This view is responsible for sending the token and then validating the code that our user enters.

In the case where our user already has the Authy app but is not enabled for OneTouch, this same method will trigger a push notification that will be sent to their phone with a code inside the Authy app.

The user will see a verification form.

A POST request to this view validates the code our user enters. First, we grab the User model by the ID we stored in the session. Next, we use the Authy API to validate the code our user entered against the one Authy sent them.

If the two match, our login process is complete! We mark the user's authy_status as approved and thank them for using two-factor authentication.

Verify users via Authy Token

verify-users-via-authy-token page anchor

twofa/auth/views.py

1
from authy import AuthyApiException
2
from flask import flash, jsonify, redirect, render_template, request, session, url_for
3
4
from . import auth
5
from .forms import LoginForm, SignUpForm, VerifyForm
6
from ..database import db
7
from ..decorators import login_required, verify_authy_request
8
from ..models import User
9
from ..utils import create_user, send_authy_token_request, verify_authy_token
10
11
12
@auth.route('/sign-up', methods=['GET', 'POST'])
13
def sign_up():
14
"""Powers the new user form"""
15
form = SignUpForm(request.form)
16
17
if form.validate_on_submit():
18
try:
19
user = create_user(form)
20
session['user_id'] = user.id
21
22
return redirect(url_for('main.account'))
23
24
except AuthyApiException as e:
25
form.errors['Authy API'] = [
26
'There was an error creating the Authy user',
27
e.msg,
28
]
29
30
return render_template('signup.html', form=form)
31
32
33
@auth.route('/login', methods=['GET', 'POST'])
34
def log_in():
35
"""
36
Powers the main login form.
37
38
- GET requests render the username / password form
39
- POST requests process the form data via an AJAX request triggered in the
40
user's browser
41
"""
42
form = LoginForm(request.form)
43
44
if form.validate_on_submit():
45
user = User.query.filter_by(email=form.email.data).first()
46
if user is not None and user.verify_password(form.password.data):
47
session['user_id'] = user.id
48
49
if user.has_authy_app:
50
# Send a request to verify this user's login with OneTouch
51
one_touch_response = user.send_one_touch_request()
52
return jsonify(one_touch_response)
53
else:
54
return jsonify({'success': False})
55
else:
56
# The username and password weren't valid
57
form.email.errors.append(
58
'The username and password combination you entered are invalid'
59
)
60
61
if request.method == 'POST':
62
# This was an AJAX request, and we should return any errors as JSON
63
return jsonify(
64
{'error': render_template('_login_error.html', form=form)}
65
) # noqa: E501
66
else:
67
return render_template('login.html', form=form)
68
69
70
@auth.route('/authy/callback', methods=['POST'])
71
@verify_authy_request
72
def authy_callback():
73
"""Authy uses this endpoint to tell us the result of a OneTouch request"""
74
authy_id = request.json.get('authy_id')
75
# When you're configuring your Endpoint/URL under OneTouch settings '1234'
76
# is the preset 'authy_id'
77
if authy_id != 1234:
78
user = User.query.filter_by(authy_id=authy_id).one()
79
80
if not user:
81
return ('', 404)
82
83
user.authy_status = request.json.get('status')
84
db.session.add(user)
85
db.session.commit()
86
87
return ('', 200)
88
89
90
@auth.route('/login/status')
91
def login_status():
92
"""
93
Used by AJAX requests to check the OneTouch verification status of a user
94
"""
95
user = User.query.get(session['user_id'])
96
return user.authy_status
97
98
99
@auth.route('/verify', methods=['GET', 'POST'])
100
@login_required
101
def verify():
102
"""Powers token validation (not using OneTouch)"""
103
form = VerifyForm(request.form)
104
user = User.query.get(session['user_id'])
105
106
# Send a token to our user when they GET this page
107
if request.method == 'GET':
108
send_authy_token_request(user.authy_id)
109
110
if form.validate_on_submit():
111
user_entered_code = form.verification_code.data
112
113
verified = verify_authy_token(user.authy_id, str(user_entered_code))
114
if verified.ok():
115
user.authy_status = 'approved'
116
db.session.add(user)
117
db.session.commit()
118
119
flash(
120
"You're logged in! Thanks for using two factor verification.", 'success'
121
) # noqa: E501
122
return redirect(url_for('main.account'))
123
else:
124
form.errors['verification_code'] = ['Code invalid - please try again.']
125
126
return render_template('verify.html', form=form)
127
128
129
@auth.route('/resend', methods=['POST'])
130
@login_required
131
def resend():
132
"""Resends a verification token to a user"""
133
user = User.query.get(session.get('user_id'))
134
send_authy_token_request(user.authy_id)
135
flash('I just re-sent your verification code - enter it below.', 'info')
136
return redirect(url_for('auth.verify'))
137
138
139
@auth.route('/logout')
140
def log_out():
141
"""Log out a user, clearing their session variables"""
142
user_id = session.pop('user_id', None)
143
user = User.query.get(user_id)
144
user.authy_status = 'unverified'
145
db.session.add(user)
146
db.session.commit()
147
148
flash("You're now logged out! Thanks for visiting.", 'info')
149
return redirect(url_for('main.home'))
150

That's it! We've just implemented two-factor auth using three different methods and the latest in Authy technology.


If you're a Python developer working with Twilio, you might enjoy these other tutorials:

SMS and MMS Notifications

Faster than email and less likely to get blocked, text messages are great for timely alerts and notifications. Learn how to send out SMS (and MMS) notifications to a list of server administrators.

Call Tracking

Call Tracking helps you measure the effectiveness of different marketing campaigns. By assigning a unique phone number to different advertisements, you can track which ones have the best call rates and get some data about the callers themselves.

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.