robthree/twofactorauth

Two Factor Authentication

Fund package maintenance!
RobThree
paypal.me/robiii

Installs: 5 379 976

Dependents: 49

Suggesters: 2

Security: 0

Stars: 1 015

Watchers: 49

Forks: 128

Open Issues: 5

v2.1.0 2023-11-14 12:50 UTC

README

Build status Latest Stable Version License Downloads PayPal donate button

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.

multifactorauthforeveryone.png

Warning:

By default, this package uses the lib/Providers/QRServerProvider.php as QR code generator. This provider is not suggested for applications where absolute security is needed, because it uses an external service for the QR code generation.

You can make use of the included Endroid or Bacon providers which generate locally.

Requirements

  • Requires PHP version >=8.2
  • cURL when using the provided QRServerProvider (default), ImageChartsQRCodeProvider or QRicketProvider but you can also provide your own QR-code provider.

Optionally, you may need:

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

License

Licensed under MIT license. See LICENSE for details.

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