README

⚠ Unmaintained version

Please upgrade your project to a recent version. See version guidance on the default branch for maintained versions.

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

ℹ️ The repository contains bundle versions ≥ 5, which are compatible with Symfony 4.4 or later. The older (unsupported) versions are located in the scheb/two-factor-bundle repository.

The bundle is split into sub-packages, so you can choose the exact feature set you need and keep installed dependencies to a minimum.

Core features are provided by scheb/2fa-bundle:

• Interface for custom two-factor authentication methods
• Trusted IPs
• Multi-factor authentication (more than 2 steps)
• CSRF protection
• Whitelisted routes (accessible during two-factor authentication)
• Fully customizable conditions when to perform two-factor authentication
• Future proof: Supports the authenticator-based security system, which will replace the current system in Symfony 6

Additional features:

• Trusted devices (once passed, no more two-factor authentication on that device) (scheb/2fa-trusted-device)
• Single-use backup codes for when you don't have access to the second factor device (scheb/2fa-backup-code)
• QR codes to scan with your mobile device (scheb/2fa-qr-code)

Two-factor authentication methods:

• TOTP authentication (scheb/2fa-totp)
• Google Authenticator (scheb/2fa-google-authenticator)
• Authentication code via email (scheb/2fa-email)

Installation

Follow the installation instructions.

Documentation

Detailed documentation of all features can be found on the Symfony Bundles Documentation website.

Demo

This repository contains a small test application that can be quickly set-up locally to test two-factor authentication in a real Symfony environment. Check out the readme file in the app folder for more details.

Version Guidance

⚠ Version 5.x is no longer maintained.

Please upgrade your project to a recent version. See version guidance on the default branch for maintained versions.

License

This software is available under the MIT license.

Security

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

Contributing

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

Support Me

I'm developing this library since 2014. I love to hear from people using it, giving me the motivation to keep working on my open source projects.

If you want to let me know you're finding it useful, please consider giving it a star ⭐ on GitHub.

If you love my work and want to say thank you, you can help me out for a beer 🍻️ via PayPal.