/two-factor-bundle

Two-factor authentication for Symfony applications

Primary LanguagePHPMIT LicenseMIT

scheb/two-factor-bundle

⚠ Outdated version. Please use versions ≥ 5 from scheb/2fa.


This bundle provides two-factor authentication for your Symfony application.

Build Status Scrutinizer Code Quality Code Coverage Latest Stable Version Total Downloads License

Logo


It comes with the following two-factor authentication methods:

Additional features you will like:

  • Interface for custom two-factor authentication methods
  • Trusted IPs
  • Trusted devices (once passed, no more two-factor authentication on that device)
  • Single-use backup codes for when you don't have access to the second factor device
  • Multi-factor authentication (more than 2 steps)
  • CSRF protection
  • Whitelisted routes (accessible during two-factor authentication)

Installation

composer require scheb/two-factor-bundle

... and follow the installation instructions.

Documentation

Detailed documentation of all features can be found in the Resources/doc directory.

Version Guidance

If you have Symfony ≥ 4.4 and start using the bundle, please use bundle version 5, which is available as scheb/2fa-bundle from the scheb/2fa repository.

Version Status Symfony Version
1.x EOL >= 2.1, < 2.7
2.x EOL ^2.6, ^3.0, ^4.0
3.x EOL 3.4, ^4.0, ^5.0
4.x Security fixes until Nov 2021 3.4, ^4.0, ^5.0
5.x New features + Bug fixes 4.4, ^5.0

Security

For information about the security policy and know security issues, see SECURITY.md.

Contributing

Want to contribute to this project? See CONTRIBUTING.md.

License

This bundle is available under the MIT license.