WARNING: You are browsing the documentation for Symfony 3.0 which is not maintained anymore. Consider upgrading your projects to Symfony 4.2.

How to Create and Enable Custom User Checkers

3.0 version

How to Create and Enable Custom User Checkers

During the authentication of a user, additional checks might be required to verify if the identified user is allowed to log in. By defining a custom user checker, you can define per firewall which checker should be used.

Creating a Custom User Checker

User checkers are classes that must implement the UserCheckerInterface. This interface defines two methods called checkPreAuth() and checkPostAuth() to perform checks before and after user authentication. If one or more conditions are not met, an exception should be thrown which extends the AccountStatusException.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
namespace AppBundle\Security;

use AppBundle\Exception\AccountDeletedException;
use AppBundle\Security\User as AppUser;
use Symfony\Component\Security\Core\Exception\AccountExpiredException;
use Symfony\Component\Security\Core\User\UserCheckerInterface;
use Symfony\Component\Security\Core\User\UserInterface;

class UserChecker implements UserCheckerInterface
{
    public function checkPreAuth(UserInterface $user)
    {
        if (!$user instanceof AppUser) {
            return;
        }

        // user is deleted, show a generic Account Not Found message.
        if ($user->isDeleted()) {
            throw new AccountDeletedException('...');
        }
    }

    public function checkPostAuth(UserInterface $user)
    {
        if (!$user instanceof AppUser) {
            return;
        }

        // user account is expired, the user may be notified
        if ($user->isExpired()) {
            throw new AccountExpiredException('...');
        }
    }
}

Enabling the Custom User Checker

All that's left to be done is creating a service definition and configuring this in the firewall configuration. Configuring the service is done like any other service:

  • YAML
    1
    2
    3
    4
    # app/config/services.yml
    services:
        app.user_checker:
            class: AppBundle\Security\UserChecker
    
  • XML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    <!-- app/config/services.xml -->
    <?xml version="1.0" encoding="UTF-8" ?>
    <container xmlns="http://symfony.com/schema/dic/services"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
    
        <services>
            <service id="app.user_checker" class="AppBundle\Security\UserChecker" />
        </services>
    </container>
    
  • PHP
    1
    2
    // app/config/services.php
    $container->register('app.user_checker', 'AppBundle\Security\UserChecker');
    

All that's left to do is add the checker to the desired firewall where the value is the service id of your user checker:

  • YAML
    1
    2
    3
    4
    5
    6
    7
    8
    9
    # app/config/security.yml
    
    # ...
    security:
        firewalls:
            secured_area:
                pattern: ^/
                user_checker: app.user_checker
                # ...
    
  • XML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    <!-- 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
            http://symfony.com/schema/dic/services/services-1.0.xsd">
    
        <config>
            <!-- ... -->
            <firewall name="secured_area" pattern="^/">
                <user-checker>app.user_checker</user-checker>
                <!-- ... -->
            </firewall>
        </config>
    </srv:container>
    
  • PHP
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    // app/config/security.php
    
    // ...
    $container->loadFromExtension('security', array(
        'firewalls' => array(
            'secured_area' => array(
                'pattern' => '^/',
                'user_checker' => 'app.user_checker',
                // ...
            ),
        ),
    ));
    

Additional Configurations

It's possible to have a different user checker per firewall.

  • YAML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    # app/config/security.yml
    
    # ...
    security:
        firewalls:
            admin:
                pattern: ^/admin
                user_checker: app.admin_user_checker
                # ...
            secured_area:
                pattern: ^/
                user_checker: app.user_checker
    
  • XML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    <!-- 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
            http://symfony.com/schema/dic/services/services-1.0.xsd">
    
        <config>
            <!-- ... -->
            <firewall name="admin" pattern="^/admin">
                <user-checker>app.admin_user_checker</user-checker>
                <!-- ... -->
            </firewall>
            <firewall name="secured_area" pattern="^/">
                <user-checker>app.user_checker</user-checker>
                <!-- ... -->
            </firewall>
        </config>
    </srv:container>
    
  • PHP
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    // app/config/security.php
    
    // ...
    $container->loadFromExtension('security', array(
        'firewalls' => array(
            'admin' => array(
                'pattern' => '^/admin',
                'user_checkers' => 'app.admin_user_checker'
                // ...
            ),
            'secured_area' => array(
                'pattern' => '^/',
                'user_checker' => 'app.user_checker',
                // ...
            ),
        ),
    ));
    

Note

Internally the user checkers are aliased per firewall. For secured_area the alias security.user_checker.secured_area would point to app.user_checker.

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