NotCompromisedPassword

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

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

Validates that the given password has not been compromised by checking that it is not included in any of the public data breaches tracked by haveibeenpwned.com.

Applies to	property or method
Class	NotCompromisedPassword
Validator	NotCompromisedPasswordValidator

Basic Usage

The following constraint ensures that the rawPassword property of the User class doesn't store a compromised password:

        1
2
3
4
5
6
7
8
9
10
        // src/Entity/User.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class User
{
    #[Assert\NotCompromisedPassword]
    protected string $rawPassword;
}
    

        1
2
3
4
5
        # config/validator/validation.yaml
App\Entity\User:
    properties:
        rawPassword:
            - NotCompromisedPassword
    

        1
2
3
4
5
6
7
8
9
10
11
12
        <!-- config/validator/validation.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

    <class name="App\Entity\User">
        <property name="rawPassword">
            <constraint name="NotCompromisedPassword"></constraint>
        </property>
    </class>
</constraint-mapping>
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
        // src/Entity/User.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\Mapping\ClassMetadata;

class User
{
    // ...

    public static function loadValidatorMetadata(ClassMetadata $metadata): void
    {
        $metadata->addPropertyConstraint('rawPassword', new Assert\NotCompromisedPassword());
    }
}
    

In order to make the password validation, this constraint doesn't send the raw password value to the haveibeenpwned.com API. Instead, it follows a secure process known as k-anonymity password validation.

In practice, the raw password is hashed using SHA-1 and only the first bytes of the hash are sent. Then, the haveibeenpwned.com API compares those bytes with the SHA-1 hashes of all leaked passwords and returns the list of hashes that start with those same bytes. That's how the constraint can check if the password has been compromised without fully disclosing it.

For example, if the password is test, the entire SHA-1 hash is a94a8fe5ccb19ba61c4c0873d391e987982fbbd3 but the validator only sends a94a8 to the haveibeenpwned.com API.

Available Options

`groups`

type: array | string default: null

It defines the validation group or groups of this constraint. Read more about validation groups.

`message`

type: string default: This password has been leaked in a data breach, it must not be used. Please use another password.

The default message supplied when the password has been compromised.

`payload`

type: mixed default: null

This option can be used to attach arbitrary domain-specific data to a constraint. The configured payload is not used by the Validator component, but its processing is completely up to you.

For example, you may want to use several error levels to present failed constraints differently in the front-end depending on the severity of the error.

`skipOnError`

type: boolean default: false

When the HTTP request made to the haveibeenpwned.com API fails for any reason, an exception is thrown (no validation error is displayed). Set this option to true to not throw the exception and consider the password valid.

`threshold`

type: integer default: 1

This value defines the number of times a password should have been leaked publicly to consider it compromised. Think carefully before setting this option to a higher value because it could decrease the security of your application.

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

TOC

Version