feature #30932 [Validator] Add an option to disable NotCompromisedPasswordValidator (lyrixx)

fabpot · fabpot · commit f80df4cea5ec · 2019-04-06T21:23:33.000+02:00
This PR was merged into the 4.3-dev branch. Discussion ---------- [Validator] Add an option to disable NotCompromisedPasswordValidator | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #30871 | License | MIT | Doc PR | symfony/symfony-docs#11327 EUFOSSA Commits ------- 9a2787e [Validator] Add an option to disable NotCompromisedPasswordValidator
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -834,6 +834,10 @@ private function addValidationSection(ArrayNodeDefinition $rootNode)
                                 ->end()
                             ->end()
                         ->end()
+                        ->booleanNode('disable_not_compromised_password')
+                            ->defaultFalse()
+                            ->info('Disable NotCompromisedPassword Validator: the value will always be valid.')
+                        ->end()
                         ->arrayNode('auto_mapping')
                             ->useAttributeAsKey('namespace')
                             ->normalizeKeys(false)
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -1241,6 +1241,11 @@ private function registerValidationConfiguration(array $config, ContainerBuilder
         if (!$propertyInfoEnabled || !$config['auto_mapping'] || !class_exists(PropertyInfoLoader::class)) {
             $container->removeDefinition('validator.property_info_loader');
         }
+
+        $container
+            ->getDefinition('validator.not_compromised_password')
+            ->setArgument(2, $config['disable_not_compromised_password'])
+        ;
     }
 
     private function registerValidatorMapping(ContainerBuilder $container, array $config, array &$files)
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/validator.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/validator.xml
@@ -64,6 +64,7 @@
         <service id="validator.not_compromised_password" class="Symfony\Component\Validator\Constraints\NotCompromisedPasswordValidator">
             <argument type="service" id="http_client" on-invalid="null" />
             <argument>%kernel.charset%</argument>
+            <argument type="constant">false</argument>
             <tag name="validator.constraint_validator" alias="Symfony\Component\Validator\Constraints\NotCompromisedPasswordValidator" />
         </service>
 
diff --git a/src/Symfony/Component/Validator/Constraints/NotCompromisedPasswordValidator.php b/src/Symfony/Component/Validator/Constraints/NotCompromisedPasswordValidator.php
@@ -32,15 +32,17 @@ class NotCompromisedPasswordValidator extends ConstraintValidator
 
     private $httpClient;
     private $charset;
+    private $disabled;
 
-    public function __construct(HttpClientInterface $httpClient = null, string $charset = 'UTF-8')
+    public function __construct(HttpClientInterface $httpClient = null, string $charset = 'UTF-8', bool $disabled = false)
     {
         if (null === $httpClient && !class_exists(HttpClient::class)) {
             throw new \LogicException(sprintf('The "%s" class requires the "HttpClient" component. Try running "composer require symfony/http-client".', self::class));
         }
 
         $this->httpClient = $httpClient ?? HttpClient::create();
         $this->charset = $charset;
+        $this->disabled = $disabled;
     }
 
     /**
@@ -54,6 +56,10 @@ public function validate($value, Constraint $constraint)
             throw new UnexpectedTypeException($constraint, NotCompromisedPassword::class);
         }
 
+        if ($this->disabled) {
+            return;
+        }
+
         if (null !== $value && !is_scalar($value) && !(\is_object($value) && method_exists($value, '__toString'))) {
             throw new UnexpectedTypeException($value, 'string');
         }
diff --git a/src/Symfony/Component/Validator/Tests/Constraints/NotCompromisedPasswordValidatorTest.php b/src/Symfony/Component/Validator/Tests/Constraints/NotCompromisedPasswordValidatorTest.php
@@ -60,6 +60,17 @@ public function testEmptyStringIsValid()
         $this->assertNoViolation();
     }
 
+    public function testInvalidPasswordButDisabled()
+    {
+        $r = new \ReflectionProperty($this->validator, 'disabled');
+        $r->setAccessible(true);
+        $r->setValue($this->validator, true);
+
+        $this->validator->validate(self::PASSWORD_LEAKED, new NotCompromisedPassword());
+
+        $this->assertNoViolation();
+    }
+
     public function testInvalidPassword()
     {
         $constraint = new NotCompromisedPassword();

Original file line number	Diff line number	Diff line change
`@@ -1241,6 +1241,11 @@ private function registerValidationConfiguration(array $config, ContainerBuilder`
`1241`	`1241`	`if (!$propertyInfoEnabled \|\| !$config['auto_mapping'] \|\| !class_exists(PropertyInfoLoader::class)) {`
`1242`	`1242`	`$container->removeDefinition('validator.property_info_loader');`
`1243`	`1243`	`}`
	`1244`	`+`
	`1245`	`+ $container`
	`1246`	`+ ->getDefinition('validator.not_compromised_password')`
	`1247`	`+ ->setArgument(2, $config['disable_not_compromised_password'])`
	`1248`	`+ ;`
`1244`	`1249`	`}`
`1245`	`1250`
`1246`	`1251`	`private function registerValidatorMapping(ContainerBuilder $container, array $config, array &$files)`
Original file line number	Diff line number	Diff line change
`@@ -32,15 +32,17 @@ class NotCompromisedPasswordValidator extends ConstraintValidator`
`32`	`32`
`33`	`33`	`private $httpClient;`
`34`	`34`	`private $charset;`
	`35`	`+ private $disabled;`
`35`	`36`
`36`		`- public function __construct(HttpClientInterface $httpClient = null, string $charset = 'UTF-8')`
	`37`	`+ public function __construct(HttpClientInterface $httpClient = null, string $charset = 'UTF-8', bool $disabled = false)`
`37`	`38`	`{`
`38`	`39`	`if (null === $httpClient && !class_exists(HttpClient::class)) {`
`39`	`40`	`throw new \LogicException(sprintf('The "%s" class requires the "HttpClient" component. Try running "composer require symfony/http-client".', self::class));`
`40`	`41`	`}`
`41`	`42`
`42`	`43`	`$this->httpClient = $httpClient ?? HttpClient::create();`
`43`	`44`	`$this->charset = $charset;`
	`45`	`+ $this->disabled = $disabled;`
`44`	`46`	`}`
`45`	`47`
`46`	`48`	`/**`
`@@ -54,6 +56,10 @@ public function validate($value, Constraint $constraint)`
`54`	`56`	`throw new UnexpectedTypeException($constraint, NotCompromisedPassword::class);`
`55`	`57`	`}`
`56`	`58`
	`59`	`+ if ($this->disabled) {`
	`60`	`+ return;`
	`61`	`+ }`
	`62`	`+`
`57`	`63`	`if (null !== $value && !is_scalar($value) && !(\is_object($value) && method_exists($value, '__toString'))) {`
`58`	`64`	`throw new UnexpectedTypeException($value, 'string');`
`59`	`65`	`}`