How to Create and Enable Custom User Checkers

5.2 version

Maintained

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

edit this page

How to Create and Enable Custom User Checkers
- Creating a Custom User Checker
- Enabling the Custom User Checker

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 Symfony\Component\Security\Core\User\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, throw an exception which extends the Symfony\Component\Security\Core\Exception\AccountStatusException class. Consider using Symfony\Component\Security\Core\Exception\CustomUserMessageAccountStatusException, which extends AccountStatusException and allows to customize the error message displayed to the user:

namespace App\Security;

use App\Entity\User as AppUser;
use App\Exception\AccountDeletedException;
use Symfony\Component\Security\Core\Exception\AccountExpiredException;
use Symfony\Component\Security\Core\Exception\CustomUserMessageAccountStatusException;
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;
        }

        if ($user->isDeleted()) {
            // the message passed to this exception is meant to be displayed to the user
            throw new CustomUserMessageAccountStatusException('Your user account no longer exists.');
        }
    }

    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('...');
        }
    }
}

New in version 5.1: The CustomUserMessageAccountStatusException class was introduced in Symfony 5.1.

Enabling the Custom User Checker¶

Next, make sure your user checker is registered as a service. If you’re using the default services.yaml configuration, the service is registered automatically.

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

# config/packages/security.yaml

# ...
security:
    firewalls:
        main:
            pattern: ^/
            user_checker: App\Security\UserChecker
            # ...

XML

<!-- config/packages/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
        http://symfony.com/schema/dic/security
        https://symfony.com/schema/dic/security/security-1.0.xsd">

    <config>
        <!-- ... -->
        <firewall name="main"
                pattern="^/"
                user-checker="App\Security\UserChecker">
            <!-- ... -->
        </firewall>
    </config>
</srv:container>

PHP

// config/packages/security.php
use App\Security\UserChecker;

$container->loadFromExtension('security', [
    // ...
    'firewalls' => [
        'main' => [
            'pattern' => '^/',
            'user_checker' => UserChecker::class,
            // ...
        ],
    ],
]);

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