Warning: You are browsing the documentation for Symfony 3.4, which is no longer maintained.

Read the updated version of this page for Symfony 5.3 (the current stable version).

How to Manually Encode a Password

3.4 version

Maintained

4.4 5.3 current 5.4 dev 6.0

Unmaintained

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

How to Manually Encode a Password¶

Note

For historical reasons, Symfony uses the term “password encoding” when it should really refer to “password hashing”. The “encoders” are in fact cryptographic hash functions.

If, for example, you’re storing users in the database, you’ll need to encode the users’ passwords before inserting them. No matter what algorithm you configure for your user object, the hashed password can always be determined in the following way from a controller:

use Symfony\Component\Security\Core\Encoder\UserPasswordEncoderInterface;

public function registerAction(UserPasswordEncoderInterface $encoder)
{
    // whatever *your* User object is
    $user = new AppBundle\Entity\User();
    $plainPassword = 'ryanpass';
    $encoded = $encoder->encodePassword($user, $plainPassword);

    $user->setPassword($encoded);
}

In order for this to work, just make sure that you have the encoder for your user class (e.g. AppBundle\Entity\User) configured under the encoders key in app/config/security.yml.

The $encoder object also has an isPasswordValid() method, which takes the User object as the first argument and the plain password to check as the second argument.

Caution

When you allow a user to submit a plaintext password (e.g. registration form, change password form), you must have validation that guarantees that the password is 4096 characters or fewer. Read more details in How to implement a simple Registration Form.

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