bug #41678 [PasswordHasher] Fix missing PasswordHasherAwareInterface allowed type (chalasr)

chalasr · chalasr · commit 4988db2cad74 · 2021-06-11T15:30:06.000+02:00
This PR was merged into the 5.3 branch. Discussion ---------- [PasswordHasher] Fix missing PasswordHasherAwareInterface allowed type | Q | A | ------------- | --- | Branch? | 5.3 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - Also backports test changes from #41640 Commits ------- 8d3bea5 [PasswordHasher] Fix missing PasswordHasherAwareInterface allowed type in signatures
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
      *
      * @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
     {
