[PasswordHasher] Fix missing PasswordHasherAwareInterface allowed type in signatures

chalasr · chalasr · commit c1d40d3bd9c0 · 2021-06-11T15:08:28.000+02:00
diff --git a/src/Symfony/Component/PasswordHasher/Hasher/PasswordHasherFactoryInterface.php b/src/Symfony/Component/PasswordHasher/Hasher/PasswordHasherFactoryInterface.php
@@ -13,7 +13,6 @@
 
 use Symfony\Component\PasswordHasher\PasswordHasherInterface;
 use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
-use Symfony\Component\Security\Core\User\UserInterface;
 
 /**
  * PasswordHasherFactoryInterface to support different password hashers for different user accounts.
@@ -26,7 +25,7 @@ interface PasswordHasherFactoryInterface
     /**
      * Returns the password hasher to use for the given user.
      *
-     * @param PasswordAuthenticatedUserInterface|UserInterface|string $user A PasswordAuthenticatedUserInterface/UserInterface instance or a class name
+     * @param PasswordHasherAwareInterface|PasswordAuthenticatedUserInterface|string $user A PasswordAuthenticatedUserInterface/PasswordHasherAwareInterface instance or a class name
      *
      * @throws \RuntimeException When no password hasher could be found for the user
      */
diff --git a/src/Symfony/Component/PasswordHasher/Hasher/UserPasswordHasher.php b/src/Symfony/Component/PasswordHasher/Hasher/UserPasswordHasher.php
@@ -32,7 +32,7 @@ public function __construct(PasswordHasherFactoryInterface $hasherFactory)
     }
 
     /**
-     * @param PasswordAuthenticatedUserInterface $user
+     * @param PasswordAuthenticatedUserInterface|PasswordHasherAwareInterface $user
      */
     public function hashPassword($user, string $plainPassword): string
     {
@@ -54,7 +54,7 @@ public function hashPassword($user, string $plainPassword): string
     }
 
     /**
-     * @param PasswordAuthenticatedUserInterface $user
+     * @param PasswordAuthenticatedUserInterface|PasswordHasherAwareInterface $user
      */
     public function isPasswordValid($user, string $plainPassword): bool
     {
@@ -80,7 +80,7 @@ public function isPasswordValid($user, string $plainPassword): bool
     }
 
     /**
-     * @param PasswordAuthenticatedUserInterface $user
+     * @param PasswordAuthenticatedUserInterface|PasswordHasherAwareInterface $user
      */
     public function needsRehash($user): bool
     {
diff --git a/src/Symfony/Component/PasswordHasher/Hasher/UserPasswordHasherInterface.php b/src/Symfony/Component/PasswordHasher/Hasher/UserPasswordHasherInterface.php
@@ -18,9 +18,9 @@
  *
  * @author Ariel Ferrandini <arielferrandini@gmail.com>
  *
- * @method string hashPassword(PasswordAuthenticatedUserInterface $user, string $plainPassword)    Hashes the plain password for the given user.
- * @method bool   isPasswordValid(PasswordAuthenticatedUserInterface $user, string $plainPassword) Checks if the plaintext password matches the user's password.
- * @method bool   needsRehash(PasswordAuthenticatedUserInterface $user)                            Checks if an encoded password would benefit from rehashing.
+ * @method string hashPassword(PasswordAuthenticatedUserInterface|PasswordHasherAwareInterface $user, string $plainPassword)    Hashes the plain password for the given user.
+ * @method bool   isPasswordValid(PasswordAuthenticatedUserInterface|PasswordHasherAwareInterface $user, string $plainPassword) Checks if the plaintext password matches the user's password.
+ * @method bool   needsRehash(PasswordAuthenticatedUserInterface|PasswordHasherAwareInterface $user)                            Checks if an encoded password would benefit from rehashing.
  */
 interface UserPasswordHasherInterface
 {
diff --git a/src/Symfony/Component/PasswordHasher/Tests/Hasher/PasswordHasherFactoryTest.php b/src/Symfony/Component/PasswordHasher/Tests/Hasher/PasswordHasherFactoryTest.php
@@ -21,18 +21,18 @@
 use Symfony\Component\PasswordHasher\PasswordHasherInterface;
 use Symfony\Component\Security\Core\Encoder\PlaintextPasswordEncoder;
 use Symfony\Component\Security\Core\User\InMemoryUser;
-use Symfony\Component\Security\Core\User\UserInterface;
+use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
 
 class PasswordHasherFactoryTest extends TestCase
 {
     public function testGetHasherWithMessageDigestHasher()
     {
-        $factory = new PasswordHasherFactory([UserInterface::class => [
+        $factory = new PasswordHasherFactory([PasswordAuthenticatedUserInterface::class => [
             'class' => MessageDigestPasswordHasher::class,
             'arguments' => ['sha512', true, 5],
         ]]);
 
-        $hasher = $factory->getPasswordHasher($this->createMock(UserInterface::class));
+        $hasher = $factory->getPasswordHasher($this->createMock(PasswordAuthenticatedUserInterface::class));
         $expectedHasher = new MessageDigestPasswordHasher('sha512', true, 5);
 
         $this->assertEquals($expectedHasher->hash('foo', 'moo'), $hasher->hash('foo', 'moo'));
@@ -41,22 +41,18 @@ public function testGetHasherWithMessageDigestHasher()
     public function testGetHasherWithService()
     {
         $factory = new PasswordHasherFactory([
-            UserInterface::class => new MessageDigestPasswordHasher('sha1'),
+            PasswordAuthenticatedUserInterface::class => new MessageDigestPasswordHasher('sha1'),
         ]);
 
-        $hasher = $factory->getPasswordHasher($this->createMock(UserInterface::class));
-        $expectedHasher = new MessageDigestPasswordHasher('sha1');
-        $this->assertEquals($expectedHasher->hash('foo', ''), $hasher->hash('foo', ''));
-
-        $hasher = $factory->getPasswordHasher(new InMemoryUser('user', 'pass'));
+        $hasher = $factory->getPasswordHasher($this->createMock(PasswordAuthenticatedUserInterface::class));
         $expectedHasher = new MessageDigestPasswordHasher('sha1');
         $this->assertEquals($expectedHasher->hash('foo', ''), $hasher->hash('foo', ''));
     }
 
     public function testGetHasherWithClassName()
     {
         $factory = new PasswordHasherFactory([
-            UserInterface::class => new MessageDigestPasswordHasher('sha1'),
+            PasswordAuthenticatedUserInterface::class => new MessageDigestPasswordHasher('sha1'),
         ]);
 
         $hasher = $factory->getPasswordHasher(SomeChildUser::class);
@@ -208,7 +204,7 @@ public function testLegacyEncoderClass()
     }
 }
 
-class SomeUser implements UserInterface
+class SomeUser implements PasswordAuthenticatedUserInterface
 {
     public function getRoles(): array
     {

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,6 @@`
`13`	`13`
`14`	`14`	`use Symfony\Component\PasswordHasher\PasswordHasherInterface;`
`15`	`15`	`use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;`
`16`		`-use Symfony\Component\Security\Core\User\UserInterface;`
`17`	`16`
`18`	`17`	`/**`
`19`	`18`	`* PasswordHasherFactoryInterface to support different password hashers for different user accounts.`
`@@ -26,7 +25,7 @@ interface PasswordHasherFactoryInterface`
`26`	`25`	`/**`
`27`	`26`	`* Returns the password hasher to use for the given user.`
`28`	`27`	`*`
`29`		`- * @param PasswordAuthenticatedUserInterface\|UserInterface\|string $user A PasswordAuthenticatedUserInterface/UserInterface instance or a class name`
	`28`	`+ * @param PasswordHasherAwareInterface\|PasswordAuthenticatedUserInterface\|string $user A PasswordAuthenticatedUserInterface/PasswordHasherAwareInterface instance or a class name`
`30`	`29`	`*`
`31`	`30`	`* @throws \RuntimeException When no password hasher could be found for the user`
`32`	`31`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ public function __construct(PasswordHasherFactoryInterface $hasherFactory)`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`/**`
`35`		`- * @param PasswordAuthenticatedUserInterface $user`
	`35`	`+ * @param PasswordAuthenticatedUserInterface\|PasswordHasherAwareInterface $user`
`36`	`36`	`*/`
`37`	`37`	`public function hashPassword($user, string $plainPassword): string`
`38`	`38`	`{`
`@@ -54,7 +54,7 @@ public function hashPassword($user, string $plainPassword): string`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`/**`
`57`		`- * @param PasswordAuthenticatedUserInterface $user`
	`57`	`+ * @param PasswordAuthenticatedUserInterface\|PasswordHasherAwareInterface $user`
`58`	`58`	`*/`
`59`	`59`	`public function isPasswordValid($user, string $plainPassword): bool`
`60`	`60`	`{`
`@@ -80,7 +80,7 @@ public function isPasswordValid($user, string $plainPassword): bool`
`80`	`80`	`}`
`81`	`81`
`82`	`82`	`/**`
`83`		`- * @param PasswordAuthenticatedUserInterface $user`
	`83`	`+ * @param PasswordAuthenticatedUserInterface\|PasswordHasherAwareInterface $user`
`84`	`84`	`*/`
`85`	`85`	`public function needsRehash($user): bool`
`86`	`86`	`{`
Original file line number	Diff line number	Diff line change
`@@ -18,9 +18,9 @@`
`18`	`18`	`*`
`19`	`19`	`* @author Ariel Ferrandini <arielferrandini@gmail.com>`
`20`	`20`	`*`
`21`		`- * @method string hashPassword(PasswordAuthenticatedUserInterface $user, string $plainPassword) Hashes the plain password for the given user.`
`22`		`- * @method bool isPasswordValid(PasswordAuthenticatedUserInterface $user, string $plainPassword) Checks if the plaintext password matches the user's password.`
`23`		`- * @method bool needsRehash(PasswordAuthenticatedUserInterface $user) Checks if an encoded password would benefit from rehashing.`
	`21`	`+ * @method string hashPassword(PasswordAuthenticatedUserInterface\|PasswordHasherAwareInterface $user, string $plainPassword) Hashes the plain password for the given user.`
	`22`	`+ * @method bool isPasswordValid(PasswordAuthenticatedUserInterface\|PasswordHasherAwareInterface $user, string $plainPassword) Checks if the plaintext password matches the user's password.`
	`23`	`+ * @method bool needsRehash(PasswordAuthenticatedUserInterface\|PasswordHasherAwareInterface $user) Checks if an encoded password would benefit from rehashing.`
`24`	`24`	`*/`
`25`	`25`	`interface UserPasswordHasherInterface`
`26`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -21,18 +21,18 @@`
`21`	`21`	`use Symfony\Component\PasswordHasher\PasswordHasherInterface;`
`22`	`22`	`use Symfony\Component\Security\Core\Encoder\PlaintextPasswordEncoder;`
`23`	`23`	`use Symfony\Component\Security\Core\User\InMemoryUser;`
`24`		`-use Symfony\Component\Security\Core\User\UserInterface;`
	`24`	`+use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;`
`25`	`25`
`26`	`26`	`class PasswordHasherFactoryTest extends TestCase`
`27`	`27`	`{`
`28`	`28`	`public function testGetHasherWithMessageDigestHasher()`
`29`	`29`	`{`
`30`		`- $factory = new PasswordHasherFactory([UserInterface::class => [`
	`30`	`+ $factory = new PasswordHasherFactory([PasswordAuthenticatedUserInterface::class => [`
`31`	`31`	`'class' => MessageDigestPasswordHasher::class,`
`32`	`32`	`'arguments' => ['sha512', true, 5],`
`33`	`33`	`]]);`
`34`	`34`
`35`		`- $hasher = $factory->getPasswordHasher($this->createMock(UserInterface::class));`
	`35`	`+ $hasher = $factory->getPasswordHasher($this->createMock(PasswordAuthenticatedUserInterface::class));`
`36`	`36`	`$expectedHasher = new MessageDigestPasswordHasher('sha512', true, 5);`
`37`	`37`
`38`	`38`	`$this->assertEquals($expectedHasher->hash('foo', 'moo'), $hasher->hash('foo', 'moo'));`
`@@ -41,22 +41,18 @@ public function testGetHasherWithMessageDigestHasher()`
`41`	`41`	`public function testGetHasherWithService()`
`42`	`42`	`{`
`43`	`43`	`$factory = new PasswordHasherFactory([`
`44`		`- UserInterface::class => new MessageDigestPasswordHasher('sha1'),`
	`44`	`+ PasswordAuthenticatedUserInterface::class => new MessageDigestPasswordHasher('sha1'),`
`45`	`45`	`]);`
`46`	`46`
`47`		`- $hasher = $factory->getPasswordHasher($this->createMock(UserInterface::class));`
`48`		`- $expectedHasher = new MessageDigestPasswordHasher('sha1');`
`49`		`- $this->assertEquals($expectedHasher->hash('foo', ''), $hasher->hash('foo', ''));`
`50`		`-`
`51`		`- $hasher = $factory->getPasswordHasher(new InMemoryUser('user', 'pass'));`
	`47`	`+ $hasher = $factory->getPasswordHasher($this->createMock(PasswordAuthenticatedUserInterface::class));`
`52`	`48`	`$expectedHasher = new MessageDigestPasswordHasher('sha1');`
`53`	`49`	`$this->assertEquals($expectedHasher->hash('foo', ''), $hasher->hash('foo', ''));`
`54`	`50`	`}`
`55`	`51`
`56`	`52`	`public function testGetHasherWithClassName()`
`57`	`53`	`{`
`58`	`54`	`$factory = new PasswordHasherFactory([`
`59`		`- UserInterface::class => new MessageDigestPasswordHasher('sha1'),`
	`55`	`+ PasswordAuthenticatedUserInterface::class => new MessageDigestPasswordHasher('sha1'),`
`60`	`56`	`]);`
`61`	`57`
`62`	`58`	`$hasher = $factory->getPasswordHasher(SomeChildUser::class);`
`@@ -208,7 +204,7 @@ public function testLegacyEncoderClass()`
`208`	`204`	`}`
`209`	`205`	`}`
`210`	`206`
`211`		`-class SomeUser implements UserInterface`
	`207`	`+class SomeUser implements PasswordAuthenticatedUserInterface`
`212`	`208`	`{`
`213`	`209`	`public function getRoles(): array`
`214`	`210`	`{`