Authenticating Users by their Username and Password¶

An authentication provider will attempt to authenticate a user based on the credentials they provided. Usually these are a username and a password. Most web applications store their user’s username and a hash of the user’s password combined with a randomly generated salt. This means that the average authentication would consist of fetching the salt and the hashed password from the user data storage, hash the password the user has just provided (e.g. using a login form) with the salt and compare both to determine if the given password is valid.

This functionality is offered by the Symfony\Component\Security\Core\Authentication\Provider\DaoAuthenticationProvider. It fetches the user’s data from a Symfony\Component\Security\Core\User\UserProviderInterface, uses a Symfony\Component\Security\Core\Encoder\PasswordEncoderInterface to create a hash of the password and returns an authenticated token if the password was valid:

use Symfony\Component\Security\Core\Authentication\Provider\DaoAuthenticationProvider;
use Symfony\Component\Security\Core\User\UserChecker;
use Symfony\Component\Security\Core\User\InMemoryUserProvider;
use Symfony\Component\Security\Core\Encoder\EncoderFactory;

$userProvider = new InMemoryUserProvider(
    array(
        'admin' => array(
            // password is "foo"
            'password' => '5FZ2Z8QIkA7UTZ4BYkoC+GsReLf569mSKDsfods6LYQ8t+a8EW9oaircfMpmaLbPBh4FOBiiFyLfuZmTSUwzZg==',
            'roles'    => array('ROLE_ADMIN'),
        ),
    )
);

// for some extra checks: is account enabled, locked, expired, etc.?
$userChecker = new UserChecker();

// an array of password encoders (see below)
$encoderFactory = new EncoderFactory(...);

$provider = new DaoAuthenticationProvider(
    $userProvider,
    $userChecker,
    'secured_area',
    $encoderFactory
);

$provider->authenticate($unauthenticatedToken);

The Password Encoder Factory¶

The Symfony\Component\Security\Core\Authentication\Provider\DaoAuthenticationProvider uses an encoder factory to create a password encoder for a given type of user. This allows you to use different encoding strategies for different types of users. The default Symfony\Component\Security\Core\Encoder\EncoderFactory receives an array of encoders:

use Symfony\Component\Security\Core\Encoder\EncoderFactory;
use Symfony\Component\Security\Core\Encoder\MessageDigestPasswordEncoder;

$defaultEncoder = new MessageDigestPasswordEncoder('sha512', true, 5000);
$weakEncoder = new MessageDigestPasswordEncoder('md5', true, 1);

$encoders = array(
    'Symfony\\Component\\Security\\Core\\User\\User' => $defaultEncoder,
    'Acme\\Entity\\LegacyUser'                       => $weakEncoder,

    // ...
);

$encoderFactory = new EncoderFactory($encoders);

Each encoder should implement Symfony\Component\Security\Core\Encoder\PasswordEncoderInterface or be an array with a class and an arguments key, which allows the encoder factory to construct the encoder only when it is needed.

Creating a custom Password Encoder¶

There are many built-in password encoders. But if you need to create your own, it just needs to follow these rules:

1. The class must implement Symfony\Component\Security\Core\Encoder\PasswordEncoderInterface;

2. The implementations of encodePassword() and isPasswordValid() must first of all make sure the password is not too long, i.e. the password length is no longer than 4096 characters. This is for security reasons (see CVE-2013-5750), and you can use the isPasswordTooLong() method for this check:

   use Symfony\Component\Security\Core\Exception\BadCredentialsException;
   
   class FoobarEncoder extends BasePasswordEncoder
   {
       public function encodePassword($raw, $salt)
       {
           if ($this->isPasswordTooLong($raw)) {
               throw new BadCredentialsException('Invalid password.');
           }
   
           // ...
       }
   
       public function isPasswordValid($encoded, $raw, $salt)
       {
           if ($this->isPasswordTooLong($raw)) {
               return false;
           }
   
           // ...
   }
   

Using Password Encoders¶

When the getEncoder() method of the password encoder factory is called with the user object as its first argument, it will return an encoder of type Symfony\Component\Security\Core\Encoder\PasswordEncoderInterface which should be used to encode this user’s password:

// a Acme\Entity\LegacyUser instance
$user = ...;

// the password that was submitted, e.g. when registering
$plainPassword = ...;

$encoder = $encoderFactory->getEncoder($user);

// will return $weakEncoder (see above)
$encodedPassword = $encoder->encodePassword($plainPassword, $user->getSalt());

$user->setPassword($encodedPassword);

// ... save the user

Now, when you want to check if the submitted password (e.g. when trying to log in) is correct, you can use:

// fetch the Acme\Entity\LegacyUser
$user = ...;

// the submitted password, e.g. from the login form
$plainPassword = ...;

$validPassword = $encoder->isPasswordValid(
    $user->getPassword(), // the encoded password
    $plainPassword,       // the submitted password
    $user->getSalt()
);