scheb/2fa

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

ℹ️ The repository contains bundle versions ≥ 5, versions 1-4 are located in scheb/two-factor-bundle.

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

Core features 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)

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 in the doc directory.

Version Guidance

| 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 software is available under the MIT license.