robthree/twofactorauth

Two Factor Authentication

v3.0.2 2024-10-24 15:14 UTC

Requires

• php: >=8.2.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.13
• phpstan/phpstan: ^1.9
• phpunit/phpunit: ^9

Suggests

• bacon/bacon-qr-code: Needed for BaconQrCodeProvider provider
• endroid/qr-code: Needed for EndroidQrCodeProvider

MIT

• Rob Janssen
• Nicolas CARPi
• Will Power

• php
• Authentication
• authy
• authenticator
• tfa
• Two Factor Authentication
• Multi Factor Authentication
• MFA

README

PHP library for two-factor (or multi-factor) authentication using TOTP and QR-codes. Inspired by, based on but most importantly an improvement on 'PHPGangsta/GoogleAuthenticator'. There's a .Net implementation of this library as well.

Requirements

• Requires PHP version >=8.2

Optionally, you may need:

• sockets if you are using NTPTimeProvider
• endroid/qr-code if using EndroidQrCodeProvider or EndroidQrCodeWithLogoProvider.
• bacon/bacon-qr-code if using BaconQrCodeProvider.
• php-curl library when using an external QR Code provider such as QRServerProvider, ImageChartsQRCodeProvider, QRicketProvider or any other custom provider connecting to an external service.

Installation

The best way of installing this library is with composer:

php composer.phar require robthree/twofactorauth

Usage

For a quick start, have a look at the getting started page or try out the demo.

If you need more in-depth information about the configuration available then you can read through the rest of documentation.

Integrations

• CakePHP 3
• CI4-Auth: a user, group, role and permission management library for Codeigniter 4

License

Licensed under MIT license. See LICENSE for details.

Logo / icon under CC0 1.0 Universal (CC0 1.0) Public Domain Dedication (Archived page)