PHP-Laravel Quickstart for Twilio Authy Two-factor Authentication
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 to your application is the easiest way to increase security and trust in your product without unnecessarily burdening your users. This quickstart guides you through building a PHP, Laravel and AngularJS application that restricts access to a URL. Four Authy two-factor authentication channels are demoed: SMS, Voice, Soft Tokens and Push Notifications.
Ready to protect your toy app's users from nefarious balaclava wearing hackers? Dive in!
Create a new Twilio account (you can sign up for a free Twilio trial), or sign into an existing Twilio account.
Once logged in, visit the Authy Console. Click on the red 'Create New Aplication' (or big red plus ('+') if you already created one) to create a new Authy application then name it something memorable.
You'll automatically be transported to the Settings page next. Click the eyeball icon to reveal your Production API Key.
Copy your Production API Key to a safe place, you will use it during application setup.
This Authy two-factor authentication quickstart demos two channels which require an installed Authy Client to test: Soft Tokens and Push Notifications. While SMS and Voice channels will work without the client, to try out all four authentication channels download and install Authy Client for Desktop or Mobile:
To complete the quickstart today we'll use PHP 7.0+, Composer, MySQL, and the Twilio PHP Helper Library. Let's walk through installation below. Skip ahead if you have already installed one.
When doing PHP web development, we strongly suggest using Composer for package management. This quickstart relies on Composer to install the Twilio PHP Helper library. You can find manual installation instructions on the PHP Helper Library page.
You'll need a database for storing Authy IDs when a user registers in this quickstart. For this demo, we built our user database on top of MySQL 5.x.
If you haven't yet installed MySQL, here are instructions for your platform:
When installed, start it. If you're using the default MySQL credentials (as below), create schema account_security with an admin user homestead and password secret.
Clone our PHP repository locally, then enter the directory.
_10git clone git@github.com:TwilioDevEd/account-security-quickstart-php.git_10cd account-security-quickstart-php_10composer install
cp .env.example .env
Next, copy your Authy API Key from the Authy Dashboard and set the API_KEY variable in your .env file.
Enter the API Key from the Account Security console and optionally change the port.
_25# Get your API key here: https://www.twilio.com/console/authy/getting-started_25API_KEY=your-authy-api-key_25_25APP_DEBUG=true_25APP_ENV=development_25APP_KEY=_25APP_LOG=errorlog_25_25# By default, if you'd like to match this install MySQL locally._25# host: localhost:3306_25# DB user: homestead_25# DB pass: secret_25# DB name: account_security_25_25DB_DATABASE=account_security_25DB_HOST=localhost_25DB_PASSWORD=secret_25DB_PORT=3306_25DB_USERNAME=homestead_25MYSQL_DATABASE=account_security_25MYSQL_PASSWORD=secret_25MYSQL_PORT=3306_25MYSQL_ROOT_PASSWORD=secret_25MYSQL_USER=homestead_25SECRET=your-account-secret
Once you have added your API Key, you are ready to run! Launch the app with:
_10php artisan key:generate_10php artisan migrate_10php artisan serve --port 8081
You should get a message your new app is running!
With your phone (optionally with the Authy client installed) nearby, open a new browser tab and navigate to http://localhost:8081/register/index.html
Enter your information and invent a password, then hit 'Register'. Your information is passed to Twilio (you will be able to see your user immediately in the console), and the application is returned a user_id.
Now visit http://localhost:8081/login/index.html and login. You'll be presented with a happy screen:
If your phone has the Authy Client installed, you can immediately enter a Soft Token from the client to Verify. Additionally, you can try a Push Notification simply by pushing the labeled button.
If you do not have the Authy Client installed, the SMS and Voice channels will also work in providing a token. To try different channels, you can logout to start the process again.
_141<?php_141_141namespace App\Http\Controllers\Auth;_141_141use \Exception;_141use App\Http\Controllers\Controller;_141use App\Library\Services\OneTouch;_141use App\User;_141use Authy\AuthyApi;_141use Illuminate\Http\Request;_141use Illuminate\Support\Facades\Validator;_141_141class AccountSecurityController extends Controller_141{_141 /*_141 |--------------------------------------------------------------------------_141 | Account Security Controller_141 |--------------------------------------------------------------------------_141 |_141 | Uses Authy to verify a users phone via voice, sms or notifications._141 |_141 */_141_141 /**_141 * Create a new controller instance._141 *_141 * @return void_141 */_141 public function __construct()_141 {_141 $this->middleware('auth');_141 }_141_141 /**_141 * send verification code via SMS._141 *_141 * @param Illuminate\Support\Facades\Request $request;_141 * @return Illuminate\Support\Facades\Response;_141 */_141 protected function sendVerificationCodeSMS(_141 Request $request,_141 AuthyApi $authyApi_141 ) {_141 $user_id = session('user_id');_141 $user = User::find($user_id);_141 $authyID = $user['authyID'];_141 $authyApi->requestSms($authyID, ['force' => 'true']);_141_141 return response()->json(['message' => 'Verification Code sent via SMS succesfully.']);_141 }_141_141_141 /**_141 * send verification code via Voice Call._141 *_141 * @param Illuminate\Support\Facades\Request $request;_141 * @return Illuminate\Support\Facades\Response;_141 */_141 protected function sendVerificationCodeVoice(_141 Request $request,_141 AuthyApi $authyApi_141 ) {_141 $user_id = session('user_id');_141 $user = User::find($user_id);_141 $authyID = $user['authyID'];_141 $authyApi->phoneCall($authyID, ['force' => 'true']);_141_141 return response()->json(['message' => 'Verification Code sent via Voice Call succesfully.']);_141 }_141_141 /**_141 * verify token._141 *_141 * @param Illuminate\Support\Facades\Request $request;_141 * @return Illuminate\Support\Facades\Response;_141 */_141 protected function verifyToken(_141 Request $request,_141 AuthyApi $authyApi_141 ) {_141 $data = $request->all();_141 $token = $data['token'];_141 $user_id = session('user_id');_141 $user = User::find($user_id);_141 $authyID = $user['authyID'];_141 $authyApi->verifyToken($authyID, $token);_141_141 return response()->json(['message' => 'Token verified successfully.']);_141 }_141_141 /**_141 * Create One Touch Approval Request._141 *_141 * @param Illuminate\Support\Facades\Request $request;_141 * @return Illuminate\Support\Facades\Response;_141 */_141 protected function createOneTouch(_141 Request $request,_141 OneTouch $oneTouch_141 ) {_141 $data = $request->all();_141 $user_id = session('user_id');_141 $user = User::find($user_id);_141 $authyID = $user['authyID'];_141 $username =$user['username'];_141_141 $data = [_141 'message' => 'Twilio Account Security Quickstart wants authentication approval.',_141 'hidden' => 'this is a hidden value',_141 'visible' => [_141 'username' => $username,_141 'AuthyID' => $authyID,_141 'Location' => 'San Francisco, CA',_141 'Reason' => 'Demo by Account Security'_141 ],_141 'seconds_to_expire' => 120_141 ];_141_141 $onetouch_uuid = $oneTouch->createApprovalRequest($data);_141 session(['onetouch_uuid' => $onetouch_uuid]);_141_141 return response()->json(['message' => 'Token verified successfully.']);_141 }_141_141 /**_141 * Get OneTouch Status._141 *_141 * @param Illuminate\Support\Facades\Request $request;_141 * @return Illuminate\Support\Facades\Response;_141 */_141 protected function checkOneTouchStatus(_141 Request $request,_141 OneTouch $oneTouch_141 ) {_141 $response = $oneTouch->oneTouchStatus(session('onetouch_uuid'));_141_141 session(['authy' => $body['approval_request']['status']]);_141_141 return response()->json($response, 200);_141 }_141}
And there you go, Authy two-factor authentication is on and your PHP/Laravel app is protected!
Now that you are keeping the hackers out of this demo app using Authy two-factor authentication, you can find all of the detailed descriptions for options and API calls in our Two-factor Authentication API Reference. If you're also building a registration flow, also check out our Phone Verification product and the Verify Quickstart which uses this codebase.
For additional guides and tutorials on account security and other products, in PHP and in our other languages, take a look at the Docs.