Prepare PasswordUpgraderInterface implementations for 6.0 signatures

chalasr · chalasr · commit 5ca94030e8d2 · 2021-07-06T14:55:30.000+02:00
diff --git a/src/Symfony/Bridge/Doctrine/Security/User/EntityUserProvider.php b/src/Symfony/Bridge/Doctrine/Security/User/EntityUserProvider.php
@@ -133,10 +133,14 @@ public function supportsClass(string $class)
      *
      * @final
      */
-    public function upgradePassword(UserInterface $user, string $newEncodedPassword): void
+    public function upgradePassword($user, string $newHashedPassword): void
     {
         if (!$user instanceof PasswordAuthenticatedUserInterface) {
             trigger_deprecation('symfony/doctrine-bridge', '5.3', 'The "%s::upgradePassword()" method expects an instance of "%s" as first argument, the "%s" class should implement it.', PasswordUpgraderInterface::class, PasswordAuthenticatedUserInterface::class, get_debug_type($user));
+
+            if (!$user instanceof UserInterface) {
+                throw new \TypeError(sprintf('The "%s::upgradePassword()" method expects an instance of "%s" as first argument, "%s" given.', PasswordAuthenticatedUserInterface::class, get_debug_type($user)));
+            }
         }
 
         $class = $this->getClass();
@@ -146,7 +150,7 @@ public function upgradePassword(UserInterface $user, string $newEncodedPassword)
 
         $repository = $this->getRepository();
         if ($repository instanceof PasswordUpgraderInterface) {
-            $repository->upgradePassword($user, $newEncodedPassword);
+            $repository->upgradePassword($user, $newHashedPassword);
         }
     }
 
diff --git a/src/Symfony/Component/Ldap/Security/LdapUserProvider.php b/src/Symfony/Component/Ldap/Security/LdapUserProvider.php
@@ -132,7 +132,7 @@ public function refreshUser(UserInterface $user)
      *
      * @final
      */
-    public function upgradePassword(UserInterface $user, string $newEncodedPassword): void
+    public function upgradePassword($user, string $newHashedPassword): void
     {
         if (!$user instanceof LdapUser) {
             throw new UnsupportedUserException(sprintf('Instances of "%s" are not supported.', get_debug_type($user)));
@@ -143,9 +143,9 @@ public function upgradePassword(UserInterface $user, string $newEncodedPassword)
         }
 
         try {
-            $user->getEntry()->setAttribute($this->passwordAttribute, [$newEncodedPassword]);
+            $user->getEntry()->setAttribute($this->passwordAttribute, [$newHashedPassword]);
             $this->ldap->getEntryManager()->update($user->getEntry());
-            $user->setPassword($newEncodedPassword);
+            $user->setPassword($newHashedPassword);
         } catch (ExceptionInterface $e) {
             // ignore failed password upgrades
         }
diff --git a/src/Symfony/Component/Security/Core/Tests/Authentication/Provider/DaoAuthenticationProviderTest.php b/src/Symfony/Component/Security/Core/Tests/Authentication/Provider/DaoAuthenticationProviderTest.php
@@ -384,7 +384,7 @@ public function eraseCredentials()
 }
 interface PasswordUpgraderProvider extends UserProviderInterface, PasswordUpgraderInterface
 {
-    public function upgradePassword(UserInterface $user, string $newHashedPassword): void;
+    public function upgradePassword($user, string $newHashedPassword): void;
 
     public function loadUserByIdentifier(string $identifier): UserInterface;
 }
diff --git a/src/Symfony/Component/Security/Core/User/ChainUserProvider.php b/src/Symfony/Component/Security/Core/User/ChainUserProvider.php
@@ -130,16 +130,20 @@ public function supportsClass(string $class)
      *
      * {@inheritdoc}
      */
-    public function upgradePassword($user, string $newEncodedPassword): void
+    public function upgradePassword($user, string $newHashedPassword): void
     {
         if (!$user instanceof PasswordAuthenticatedUserInterface) {
             trigger_deprecation('symfony/security-core', '5.3', 'The "%s::upgradePassword()" method expects an instance of "%s" as first argument, the "%s" class should implement it.', PasswordUpgraderInterface::class, PasswordAuthenticatedUserInterface::class, get_debug_type($user));
+
+            if (!$user instanceof UserInterface) {
+                throw new \TypeError(sprintf('The "%s::upgradePassword()" method expects an instance of "%s" as first argument, "%s" given.', PasswordAuthenticatedUserInterface::class, get_debug_type($user)));
+            }
         }
 
         foreach ($this->providers as $provider) {
             if ($provider instanceof PasswordUpgraderInterface) {
                 try {
-                    $provider->upgradePassword($user, $newEncodedPassword);
+                    $provider->upgradePassword($user, $newHashedPassword);
                 } catch (UnsupportedUserException $e) {
                     // ignore: password upgrades are opportunistic
                 }
diff --git a/src/Symfony/Component/Security/Http/Tests/Authenticator/Fixtures/PasswordUpgraderProvider.php b/src/Symfony/Component/Security/Http/Tests/Authenticator/Fixtures/PasswordUpgraderProvider.php
@@ -18,7 +18,7 @@
 
 class PasswordUpgraderProvider extends InMemoryUserProvider implements PasswordUpgraderInterface
 {
-    public function upgradePassword(UserInterface $user, string $newEncodedPassword): void
+    public function upgradePassword($user, string $newHashedPassword): void
     {
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -133,10 +133,14 @@ public function supportsClass(string $class)`
`133`	`133`	`*`
`134`	`134`	`* @final`
`135`	`135`	`*/`
`136`		`- public function upgradePassword(UserInterface $user, string $newEncodedPassword): void`
	`136`	`+ public function upgradePassword($user, string $newHashedPassword): void`
`137`	`137`	`{`
`138`	`138`	`if (!$user instanceof PasswordAuthenticatedUserInterface) {`
`139`	`139`	`trigger_deprecation('symfony/doctrine-bridge', '5.3', 'The "%s::upgradePassword()" method expects an instance of "%s" as first argument, the "%s" class should implement it.', PasswordUpgraderInterface::class, PasswordAuthenticatedUserInterface::class, get_debug_type($user));`
	`140`	`+`
	`141`	`+ if (!$user instanceof UserInterface) {`
	`142`	`+ throw new \TypeError(sprintf('The "%s::upgradePassword()" method expects an instance of "%s" as first argument, "%s" given.', PasswordAuthenticatedUserInterface::class, get_debug_type($user)));`
	`143`	`+ }`
`140`	`144`	`}`
`141`	`145`
`142`	`146`	`$class = $this->getClass();`
`@@ -146,7 +150,7 @@ public function upgradePassword(UserInterface $user, string $newEncodedPassword)`
`146`	`150`
`147`	`151`	`$repository = $this->getRepository();`
`148`	`152`	`if ($repository instanceof PasswordUpgraderInterface) {`
`149`		`- $repository->upgradePassword($user, $newEncodedPassword);`
	`153`	`+ $repository->upgradePassword($user, $newHashedPassword);`
`150`	`154`	`}`
`151`	`155`	`}`
`152`	`156`
Original file line number	Diff line number	Diff line change
`@@ -132,7 +132,7 @@ public function refreshUser(UserInterface $user)`
`132`	`132`	`*`
`133`	`133`	`* @final`
`134`	`134`	`*/`
`135`		`- public function upgradePassword(UserInterface $user, string $newEncodedPassword): void`
	`135`	`+ public function upgradePassword($user, string $newHashedPassword): void`
`136`	`136`	`{`
`137`	`137`	`if (!$user instanceof LdapUser) {`
`138`	`138`	`throw new UnsupportedUserException(sprintf('Instances of "%s" are not supported.', get_debug_type($user)));`
`@@ -143,9 +143,9 @@ public function upgradePassword(UserInterface $user, string $newEncodedPassword)`
`143`	`143`	`}`
`144`	`144`
`145`	`145`	`try {`
`146`		`- $user->getEntry()->setAttribute($this->passwordAttribute, [$newEncodedPassword]);`
	`146`	`+ $user->getEntry()->setAttribute($this->passwordAttribute, [$newHashedPassword]);`
`147`	`147`	`$this->ldap->getEntryManager()->update($user->getEntry());`
`148`		`- $user->setPassword($newEncodedPassword);`
	`148`	`+ $user->setPassword($newHashedPassword);`
`149`	`149`	`} catch (ExceptionInterface $e) {`
`150`	`150`	`// ignore failed password upgrades`
`151`	`151`	`}`
Original file line number	Diff line number	Diff line change
`@@ -384,7 +384,7 @@ public function eraseCredentials()`
`384`	`384`	`}`
`385`	`385`	`interface PasswordUpgraderProvider extends UserProviderInterface, PasswordUpgraderInterface`
`386`	`386`	`{`
`387`		`- public function upgradePassword(UserInterface $user, string $newHashedPassword): void;`
	`387`	`+ public function upgradePassword($user, string $newHashedPassword): void;`
`388`	`388`
`389`	`389`	`public function loadUserByIdentifier(string $identifier): UserInterface;`
`390`	`390`	`}`
Original file line number	Diff line number	Diff line change
`@@ -130,16 +130,20 @@ public function supportsClass(string $class)`
`130`	`130`	`*`
`131`	`131`	`* {@inheritdoc}`
`132`	`132`	`*/`
`133`		`- public function upgradePassword($user, string $newEncodedPassword): void`
	`133`	`+ public function upgradePassword($user, string $newHashedPassword): void`
`134`	`134`	`{`
`135`	`135`	`if (!$user instanceof PasswordAuthenticatedUserInterface) {`
`136`	`136`	`trigger_deprecation('symfony/security-core', '5.3', 'The "%s::upgradePassword()" method expects an instance of "%s" as first argument, the "%s" class should implement it.', PasswordUpgraderInterface::class, PasswordAuthenticatedUserInterface::class, get_debug_type($user));`
	`137`	`+`
	`138`	`+ if (!$user instanceof UserInterface) {`
	`139`	`+ throw new \TypeError(sprintf('The "%s::upgradePassword()" method expects an instance of "%s" as first argument, "%s" given.', PasswordAuthenticatedUserInterface::class, get_debug_type($user)));`
	`140`	`+ }`
`137`	`141`	`}`
`138`	`142`
`139`	`143`	`foreach ($this->providers as $provider) {`
`140`	`144`	`if ($provider instanceof PasswordUpgraderInterface) {`
`141`	`145`	`try {`
`142`		`- $provider->upgradePassword($user, $newEncodedPassword);`
	`146`	`+ $provider->upgradePassword($user, $newHashedPassword);`
`143`	`147`	`} catch (UnsupportedUserException $e) {`
`144`	`148`	`// ignore: password upgrades are opportunistic`
`145`	`149`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`
`19`	`19`	`class PasswordUpgraderProvider extends InMemoryUserProvider implements PasswordUpgraderInterface`
`20`	`20`	`{`
`21`		`- public function upgradePassword(UserInterface $user, string $newEncodedPassword): void`
	`21`	`+ public function upgradePassword($user, string $newHashedPassword): void`
`22`	`22`	`{`
`23`	`23`	`}`
`24`	`24`	`}`