How to Use Multiple Guard Authenticators

3.4 version

Maintained

4.4 5.2 current 5.3 dev

Unmaintained

2.8 3.0 3.1 3.2 3.3 3.4 4.0 4.1 4.2 4.3 5.0 5.1

How to Use Multiple Guard Authenticators
- Multiple Authenticators with Shared Entry Point
- Multiple Authenticators with Separate Entry Points

How to Use Multiple Guard Authenticators¶

The Guard authentication component allows you to use many different authenticators at a time.

An entry point is a service id (of one of your authenticators) whose start() method is called to start the authentication process.

Multiple Authenticators with Shared Entry Point¶

Sometimes you want to offer your users different authentication mechanisms like a form login and a Facebook login while both entry points redirect the user to the same login page. However, in your configuration you have to explicitly say which entry point you want to use.

This is how your security configuration can look in action:

YAML

# app/config/security.yml
security:
    # ...
    firewalls:
        default:
            anonymous: ~
            guard:
                authenticators:
                    - AppBundle\Security\LoginFormAuthenticator
                    - AppBundle\Security\FacebookConnectAuthenticator
                entry_point: AppBundle\Security\LoginFormAuthenticator

XML

<!-- app/config/security.xml -->
<?xml version="1.0" encoding="UTF-8"?>
<srv:container xmlns="http://symfony.com/schema/dic/security"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:srv="http://symfony.com/schema/dic/services"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd">

    <config>
        <!-- ... -->
        <firewall name="default">
            <anonymous/>
            <guard entry-point="AppBundle\Security\LoginFormAuthenticator">
                <authenticator>AppBundle\Security\LoginFormAuthenticator</authenticator>
                <authenticator>AppBundle\Security\FacebookConnectAuthenticator</authenticator>
            </guard>
        </firewall>
    </config>
</srv:container>

PHP

// app/config/security.php
use AppBundle\Security\FacebookConnectAuthenticator;
use AppBundle\Security\LoginFormAuthenticator;

$container->loadFromExtension('security', [
    // ...
    'firewalls' => [
        'default' => [
            'anonymous' => null,
            'guard' => [
                'entry_point' => LoginFormAuthenticator::class,
                'authenticators' => [
                    LoginFormAuthenticator::class,
                    FacebookConnectAuthenticator::class,
                ],
            ],
        ],
    ],
]);

There is one limitation with this approach - you have to use exactly one entry point.

Multiple Authenticators with Separate Entry Points¶

However, there are use cases where you have authenticators that protect different parts of your application. For example, you have a login form that protects the secured area of your application front-end and API end points that are protected with API tokens. As you can only configure one entry point per firewall, the solution is to split the configuration into two separate firewalls:

YAML

# app/config/security.yml
security:
    # ...
    firewalls:
        api:
            pattern: ^/api/
            guard:
                authenticators:
                    - AppBundle\Security\ApiTokenAuthenticator
        default:
            anonymous: ~
            guard:
                authenticators:
                    - AppBundle\Security\LoginFormAuthenticator
    access_control:
        - { path: '^/login', roles: IS_AUTHENTICATED_ANONYMOUSLY }
        - { path: '^/api', roles: ROLE_API_USER }
        - { path: '^/', roles: ROLE_USER }

XML

<!-- app/config/security.xml -->
<?xml version="1.0" encoding="UTF-8"?>
<srv:container xmlns="http://symfony.com/schema/dic/security"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:srv="http://symfony.com/schema/dic/services"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd">

    <config>
        <!-- ... -->
        <firewall name="api" pattern="^/api/">
            <guard>
                <authenticator>AppBundle\Security\ApiTokenAuthenticator</authenticator>
            </guard>
        </firewall>
        <firewall name="default">
            <anonymous/>
            <guard>
                <authenticator>AppBundle\Security\LoginFormAuthenticator</authenticator>
            </guard>
        </firewall>
        <rule path="^/login" role="IS_AUTHENTICATED_ANONYMOUSLY"/>
        <rule path="^/api" role="ROLE_API_USER"/>
        <rule path="^/" role="ROLE_USER"/>
    </config>
</srv:container>

PHP

// app/config/security.php
use AppBundle\Security\ApiTokenAuthenticator;
use AppBundle\Security\LoginFormAuthenticator;

$container->loadFromExtension('security', [
    // ...
    'firewalls' => [
        'api' => [
            'pattern' => '^/api',
            'guard' => [
                'authenticators' => [
                    ApiTokenAuthenticator::class,
                ],
            ],
        ],
        'default' => [
            'anonymous' => null,
            'guard' => [
                'authenticators' => [
                    LoginFormAuthenticator::class,
                ],
            ],
        ],
    ],
    'access_control' => [
        ['path' => '^/login', 'roles' => 'IS_AUTHENTICATED_ANONYMOUSLY'],
        ['path' => '^/api', 'roles' => 'ROLE_API_USER'],
        ['path' => '^/', 'roles' => 'ROLE_USER'],
    ],
]);

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.