roadiz/two-factor-bundle

Provides two-factor authentication system for Roadiz CMS

v2.3.31 2024-10-25 09:47 UTC

Requires

• php: >=8.1
• doctrine/orm: ~2.19.0
• endroid/qr-code: ^4.0
• roadiz/core-bundle: 2.3.*
• roadiz/rozier: 2.3.*
• roadiz/rozier-bundle: 2.3.*
• scheb/2fa-backup-code: ^6.8
• scheb/2fa-bundle: ^6.8
• scheb/2fa-google-authenticator: ^6.8
• scheb/2fa-totp: ^6.8
• scheb/2fa-trusted-device: ^6.8
• sensio/framework-extra-bundle: ^6.1
• symfony/framework-bundle: 6.4.*

Requires (Dev)

• php-coveralls/php-coveralls: ^2.4
• phpstan/phpstan: ^1.5.3
• phpstan/phpstan-doctrine: ^1.3
• phpunit/phpunit: ^9.5
• roadiz/doc-generator: 2.3.*
• roadiz/entity-generator: 2.3.*
• roadiz/jwt: 2.3.*
• roadiz/random: 2.3.*
• squizlabs/php_codesniffer: ^3.5
• symfony/stopwatch: 6.4.*

MIT

• Ambroise Maupate

• cms
• backoffice
• rezo zero
• roadiz

README

This bundle provides a two-factor authentication system for Roadiz CMS. Based on scheb/two-factor-bundle bundle.

• OTP (One Time Password) authentication with Google Authenticator
• Backup codes (hashed and stored in database)
• Trusted devices (remembered for a configurable amount of time)
• Use APP_NAMESPACE, APP_TITLE and APP_SECRET environment variables

Installation

Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.

Applications that use Symfony Flex

Open a command console, enter your project directory and execute:

$ composer require roadiz/two-factor-bundle

Applications that don't use Symfony Flex

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require roadiz/two-factor-bundle

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the config/bundles.php file of your project:

// config/bundles.php

return [
    // ...
    \RZ\Roadiz\TwoFactorBundle\RoadizTwoFactorBundle::class => ['all' => true],
];

Configuration

• Copy and merge @RoadizTwoFactor/config/packages/scheb_2fa.yaml files into your project config/packages folder
• Add this bundle routes to your project config/routes.yaml file:

# config/routes.yaml
roadiz_two_factor:
    resource: "@RoadizTwoFactorBundle/config/routing.yaml"

Contributing

Report issues and send Pull Requests in the main Roadiz repository