Two-Factor Authentication with Authy, PHP and Laravel

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

Adding Two-Factor Authentication (2FA) to your web application increases the security of your user's data by requiring something your user has to be present for step-up transactions, log-ins, and other sensitive actions. Multi-factor authentication determines the identity of a user by validating once by logging into the app, and then by validating their mobile device.

This PHP Laravel sample application is an example of a typical login flow using Two-Factor Authentication. To run this sample app yourself, download the code and follow the instructions on GitHub.

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 Client app or
Sending them a token through their mobile Authy app or
Sending them a one-time token in a text message.

See how VMware uses Twilio Two-Factor Authentication to secure their enterprise mobility management solution.

Configuring Authy

If you haven't configured Authy already, now is the time to sign up for Authy. Create your first application naming it as you wish. After you create your application, your "production" API key will be visible on your dashboard

Once we have an Authy API key we can register it as an environment variable.

Configure Authy environment variables

.env.example

1APP_ENV=local
2APP_DEBUG=true
3APP_KEY=ufxhZiQcKxi1eHVmGq8MwfAcRgZHJ1Qq
4
5DB_HOST=localhost
6DB_DATABASE=authy_laravel
7DB_USERNAME=your_db_username
8DB_PASSWORD=your_db_password
9
10AUTHY_API_KEY=your_token

Let's take a look at how we register a user with Authy.

Register a User with Authy

When a new user signs up for our website, we will call this route. This will save our new user to the database and will register the user with Authy.

In order to set up your application, Authy only needs the user's email, phone number and country code. In order to do a two-factor authentication, we need to make sure we ask for this information at sign up.

Once we register the User with Authy we get an authy id back. This is very important since it's how we will verify the identity of our User with Authy.

Register a User with Authy

app/User.php

1<?php namespace App;
2
3use Illuminate\Auth\Authenticatable;
4use Illuminate\Database\Eloquent\Model;
5use Illuminate\Auth\Passwords\CanResetPassword;
6use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
7use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
8
9class User extends Model implements AuthenticatableContract, CanResetPasswordContract
10{
11
12    use Authenticatable, CanResetPassword;
13
14    /**
15     * The database table used by the model.
16     *
17     * @var string
18     */
19    protected $table = 'users';
20
21    /**
22     * The attributes that are mass assignable.
23     *
24     * @var array
25     */
26    protected $fillable = ['name', 'email', 'password', 'phone_number', 'country_code'];
27
28    /**
29     * The attributes excluded from the model's JSON form.
30     *
31     * @var array
32     */
33    protected $hidden = ['password', 'remember_token', 'authy_status', 'authy_id'];
34
35
36    /**
37     * @param $authy_id string
38     */
39    public function updateAuthyId($authy_id) {
40        if($this->authy_id != $authy_id) {
41            $this->authy_id = $authy_id;
42            $this->save();
43        }
44    }
45
46    /**
47     * @param $status string
48     */
49    public function updateVerificationStatus($status) {
50        // reset oneTouch status
51        if ($this->authy_status != $status) {
52            $this->authy_status = $status;
53            $this->save();
54        }
55    }
56
57    public function updateOneTouchUuid($uuid) {
58        if ($this->authy_one_touch_uuid != $uuid) {
59            $this->authy_one_touch_uuid = $uuid;
60            $this->save();
61        }
62    }
63}
64

Log in with Authy OneTouch

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 Authy's OneTouch verification first.

OneTouch works like this:

We attempt to send a User a OneTouch Approval Request.
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.

Log in with Authy OneTouch

app/Http/Controllers/Auth/AuthController.php

1<?php namespace App\Http\Controllers\Auth;
2
3use App\Authy\Service;
4use App\OneTouch;
5use Auth;
6use Session;
7use App\User;
8use App\Http\Controllers\Controller;
9use Illuminate\Http\Request;
10use Illuminate\Contracts\Auth\Guard;
11use Illuminate\Contracts\Auth\Registrar;
12use Illuminate\Foundation\Auth\AuthenticatesAndRegistersUsers;
13use function Stringy\create;
14
15
16class AuthController extends Controller
17{
18
19    /*
20    |--------------------------------------------------------------------------
21    | Registration & Login Controller
22    |--------------------------------------------------------------------------
23    |
24    | This controller handles the registration of new users, as well as the
25    | authentication of existing users. By default, this controller uses
26    | a simple trait to add these behaviors. Why don't you explore it?
27    |
28    */
29
30    use AuthenticatesAndRegistersUsers;
31
32    /**
33     * Create a new authentication controller instance.
34     *
35     * @param  \Illuminate\Contracts\Auth\Guard $auth
36     * @param  \Illuminate\Contracts\Auth\Registrar $registrar
37     * @param  \App\Authy\Service $authy
38     */
39    public function __construct(Guard $auth, Registrar $registrar, Service $authy)
40    {
41        $this->auth = $auth;
42        $this->registrar = $registrar;
43        $this->authy = $authy;
44
45        $this->middleware('guest', ['except' => 'getLogout']);
46    }
47
48    public function postLogin(Request $request)
49    {
50        $credentials = $request->only('email', 'password');
51        if (Auth::validate($credentials)) {
52            $user = User::where('email', '=', $request->input('email'))->firstOrFail();
53
54            Session::set('password_validated', true);
55            Session::set('id', $user->id);
56
57            if ($this->authy->verifyUserStatus($user->authy_id)->registered) {
58                $uuid = $this->authy->sendOneTouch($user->authy_id, 'Request to Login to Twilio demo app');
59
60                OneTouch::create(['uuid' => $uuid]);
61
62                Session::set('one_touch_uuid', $uuid);
63
64                return response()->json(['status' => 'ok']);
65            } else
66                return response()->json(['status' => 'verify']);
67
68        } else {
69            return response()->json(['status' => 'failed',
70                'message' => 'The email and password combination you entered is incorrect.']);
71        }
72    }
73
74    public function getTwoFactor()
75    {
76        $message = Session::get('message');
77
78        return view('auth/two-factor', ['message' => $message]);
79    }
80
81    public function postTwoFactor(Request $request)
82    {
83        if (!Session::get('password_validated') || !Session::get('id')) {
84            return redirect('/auth/login');
85        }
86
87        if (isset($_POST['token'])) {
88            $user = User::find(Session::get('id'));
89            if ($this->authy->verifyToken($user->authy_id, $request->input('token'))) {
90                Auth::login($user);
91                return redirect()->intended('/home');
92            } else {
93                return redirect('/auth/two-factor')->withErrors([
94                    'token' => 'The token you entered is incorrect',
95                ]);
96            }
97        }
98    }
99
100    public function postRegister(Request $request)
101    {
102        $validator = $this->registrar->validator($request->all());
103        if ($validator->fails()) {
104            $this->throwValidationException(
105                $request, $validator
106            );
107        }
108        $user = $this->registrar->create($request->all());
109
110        Session::set('password_validated', true);
111        Session::set('id', $user->id);
112
113        $authy_id = $this->authy->register($user->email, $user->phone_number, $user->country_code);
114
115        $user->updateAuthyId($authy_id);
116
117        if ($this->authy->verifyUserStatus($authy_id)->registered)
118            $message = "Open Authy app in your phone to see the verification code";
119        else {
120            $this->authy->sendToken($authy_id);
121            $message = "You will receive an SMS with the verification code";
122        }
123
124        return redirect('/auth/two-factor')->with('message', $message);
125    }
126}
127

Send the OneTouch Request

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

Authy allows us to input details with our OneTouch request, including a message, a logo and so on. We could send any amount of details by appending details['some_detail']. You could imagine a scenario where we send a OneTouch request to approve a money transfer.

1$params = array(
2  'message' => "Request to send money to Jarod's vault",
3  'details[From]' => "Jarod",
4  'details[Amount]' => "1,000,000",
5  'details[Currency]' => "Galleons",
6)
7

Once we send the request we need to update our User's authy_status based on the response.

Send the OneTouch Request

app/User.php

1<?php namespace App;
2
3use Illuminate\Auth\Authenticatable;
4use Illuminate\Database\Eloquent\Model;
5use Illuminate\Auth\Passwords\CanResetPassword;
6use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
7use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
8
9class User extends Model implements AuthenticatableContract, CanResetPasswordContract
10{
11
12    use Authenticatable, CanResetPassword;
13
14    /**
15     * The database table used by the model.
16     *
17     * @var string
18     */
19    protected $table = 'users';
20
21    /**
22     * The attributes that are mass assignable.
23     *
24     * @var array
25     */
26    protected $fillable = ['name', 'email', 'password', 'phone_number', 'country_code'];
27
28    /**
29     * The attributes excluded from the model's JSON form.
30     *
31     * @var array
32     */
33    protected $hidden = ['password', 'remember_token', 'authy_status', 'authy_id'];
34
35
36    /**
37     * @param $authy_id string
38     */
39    public function updateAuthyId($authy_id) {
40        if($this->authy_id != $authy_id) {
41            $this->authy_id = $authy_id;
42            $this->save();
43        }
44    }
45
46    /**
47     * @param $status string
48     */
49    public function updateVerificationStatus($status) {
50        // reset oneTouch status
51        if ($this->authy_status != $status) {
52            $this->authy_status = $status;
53            $this->save();
54        }
55    }
56
57    public function updateOneTouchUuid($uuid) {
58        if ($this->authy_one_touch_uuid != $uuid) {
59            $this->authy_one_touch_uuid = $uuid;
60            $this->save();
61        }
62    }
63}
64

Configure the OneTouch callback

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.

Here in our callback, we look up the user using the authy_id sent with the Authy POST request. Ideally at this point we would probably use a websocket to let our client know that we received a response from Authy. However, for this version we're going to just update the authy_status on the User.

Update user status using Authy Callback

app/Http/Controllers/Auth/AuthyController.php

1<?php namespace App\Http\Controllers\Auth;
2
3use App\OneTouch;
4use Auth;
5use Session;
6use App\User;
7use App\Http\Controllers\Controller;
8use Illuminate\Http\Request;
9
10class AuthyController extends Controller
11{
12    /**
13     * Create a new controller instance.
14     *
15     * @return void
16     */
17    public function __construct()
18    {
19        $this->middleware('guest');
20    }
21
22    /**
23     * Check One Touch authorization status
24     *
25     * @param Request $request
26     * @return \Illuminate\Http\JsonResponse
27     */
28    public function status(Request $request)
29    {
30        $oneTouch = OneTouch::where('uuid', '=', Session::get('one_touch_uuid'))->firstOrFail();
31        $status = $oneTouch->status;
32        if ($status == 'approved') {
33            Auth::login(User::find(Session::get('id')));
34        }
35        return response()->json(['status' => $status]);
36    }
37
38    /**
39     * Public webhook for Authy
40     *
41     * @param Request $request
42     * @return string
43     */
44    public function callback(Request $request)
45    {
46        $uuid = $request->input('uuid');
47        $oneTouch = OneTouch::where('uuid', '=', $uuid)->first();
48        if ($oneTouch != null) {
49            $oneTouch->status = $request->input('status');
50            $oneTouch->save();
51            return "ok";
52        }
53        return "invalid uuid: $uuid";
54    }
55
56}
57

Let's take a look at the client-side code that will be handling this.

Disabling Unsuccessful Callbacks

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 in the Browser

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

When we expect a OneTouch response, we will begin by polling /authy/status until we see an Authy status is not empty. Let's take a look at this controller and see what is happening.

Handle Two-Factor in the Browser

public/js/sessions.js

1$(document).ready(function() {
2  console.log('loaded');
3  $('#login-form').submit(function(e) {
4    e.preventDefault();
5    formData = $(e.currentTarget).serialize();
6    attemptOneTouchVerification(formData);
7  });
8
9  var attemptOneTouchVerification = function(form) {
10      $('#ajax-error').addClass('hidden');
11      $.post( "/auth/login", form, function(data) {
12      if (data.status === 'ok') {
13        $('#authy-modal').modal({backdrop:'static'},'show');
14        $('.auth-ot').fadeIn();
15        checkForOneTouch();
16      } else if (data.status === 'verify') {
17        $('#authy-modal').modal({backdrop:'static'},'show');
18        $('.auth-token').fadeIn()
19      } else if (data.status === 'failed') {
20        $('#ajax-error').html(data.message);
21        $('#ajax-error').removeClass('hidden');
22      }
23    });
24  };
25
26  var checkForOneTouch = function() {
27    $.get("/authy/status", function (data) {
28      if (data.status === 'approved') {
29        window.location.href = "/home";
30      } else if (data.status === 'denied') {
31        showTokenForm();
32        triggerSMSToken();
33      } else {
34        setTimeout(checkForOneTouch, 5000);
35      }
36    });
37  };
38
39  var showTokenForm = function() {
40    $('.auth-ot').fadeOut(function() {
41      $('.auth-token').fadeIn('slow')
42    })
43  };
44
45  var triggerSMSToken = function() {
46    $.get("/authy/send_token")
47  };
48});
49

Finishing the 2FA Step

If authy_status is approved the user will be redirected to the protected content, otherwise we'll show the login form with a message that indicates the request was denied.

Redirect user to the correct page based based on authentication status

app/Http/Controllers/Auth/AuthyController.php

1<?php namespace App\Http\Controllers\Auth;
2
3use App\OneTouch;
4use Auth;
5use Session;
6use App\User;
7use App\Http\Controllers\Controller;
8use Illuminate\Http\Request;
9
10class AuthyController extends Controller
11{
12    /**
13     * Create a new controller instance.
14     *
15     * @return void
16     */
17    public function __construct()
18    {
19        $this->middleware('guest');
20    }
21
22    /**
23     * Check One Touch authorization status
24     *
25     * @param Request $request
26     * @return \Illuminate\Http\JsonResponse
27     */
28    public function status(Request $request)
29    {
30        $oneTouch = OneTouch::where('uuid', '=', Session::get('one_touch_uuid'))->firstOrFail();
31        $status = $oneTouch->status;
32        if ($status == 'approved') {
33            Auth::login(User::find(Session::get('id')));
34        }
35        return response()->json(['status' => $status]);
36    }
37
38    /**
39     * Public webhook for Authy
40     *
41     * @param Request $request
42     * @return string
43     */
44    public function callback(Request $request)
45    {
46        $uuid = $request->input('uuid');
47        $oneTouch = OneTouch::where('uuid', '=', $uuid)->first();
48        if ($oneTouch != null) {
49            $oneTouch->status = $request->input('status');
50            $oneTouch->save();
51            return "ok";
52        }
53        return "invalid uuid: $uuid";
54    }
55
56}
57

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

Where to next?

If you're a PHP developer working with Twilio, you might want to check out these other tutorials.

Call Tracking

Measure the effectiveness of different marketing campaigns with unique phone numbers.

Server Notifications via SMS

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.