pass the current token to the checkPostAuth() method of user checkers

xabbuh · xabbuh · commit e1bd3ad2e136 · 2024-07-19T09:46:34.000+02:00
diff --git a/UPGRADE-7.2.md b/UPGRADE-7.2.md
@@ -11,6 +11,7 @@ If you're upgrading from a version below 7.1, follow the [7.1 upgrade guide](UPG
 Security
 --------
 
+ * Add `$token` argument to `UserCheckerInterface::checkPostAuth()`
  * Deprecate argument `$secret` of `RememberMeToken` and `RememberMeAuthenticator`
 
 String
diff --git a/src/Symfony/Component/Security/Core/CHANGELOG.md b/src/Symfony/Component/Security/Core/CHANGELOG.md
@@ -4,6 +4,7 @@ CHANGELOG
 7.2
 ---
 
+ * Add `$token` argument to `UserCheckerInterface::checkPostAuth()`
  * Deprecate argument `$secret` of `RememberMeToken`
 
 7.0
diff --git a/src/Symfony/Component/Security/Core/User/ChainUserChecker.php b/src/Symfony/Component/Security/Core/User/ChainUserChecker.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Security\Core\User;
 
+use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
+
 final class ChainUserChecker implements UserCheckerInterface
 {
     /**
@@ -27,10 +29,16 @@ public function checkPreAuth(UserInterface $user): void
         }
     }
 
-    public function checkPostAuth(UserInterface $user): void
+    public function checkPostAuth(UserInterface $user /*, TokenInterface $token*/): void
     {
+        $token = 1 < \func_num_args() ? func_get_arg(1) : 1;
+
         foreach ($this->checkers as $checker) {
-            $checker->checkPostAuth($user);
+            if ($token instanceof TokenInterface) {
+                $checker->checkPostAuth($user, $token);
+            } else {
+                $checker->checkPostAuth($user);
+            }
         }
     }
 }
diff --git a/src/Symfony/Component/Security/Core/User/UserCheckerInterface.php b/src/Symfony/Component/Security/Core/User/UserCheckerInterface.php
@@ -35,5 +35,5 @@ public function checkPreAuth(UserInterface $user): void;
      *
      * @throws AccountStatusException
      */
-    public function checkPostAuth(UserInterface $user): void;
+    public function checkPostAuth(UserInterface $user /*, TokenInterface $token*/): void;
 }
diff --git a/src/Symfony/Component/Security/Http/CHANGELOG.md b/src/Symfony/Component/Security/Http/CHANGELOG.md
@@ -4,6 +4,7 @@ CHANGELOG
 7.2
 ---
 
+ * Pass the current token to the checkPostAuth() method of user checkers
  * Deprecate argument `$secret` of `RememberMeAuthenticator`
 
 7.1
diff --git a/src/Symfony/Component/Security/Http/EventListener/UserCheckerListener.php b/src/Symfony/Component/Security/Http/EventListener/UserCheckerListener.php
@@ -47,7 +47,7 @@ public function postCheckCredentials(AuthenticationSuccessEvent $event): void
             return;
         }
 
-        $this->userChecker->checkPostAuth($user);
+        $this->userChecker->checkPostAuth($user, $event->getAuthenticationToken());
     }
 
     public static function getSubscribedEvents(): array
diff --git a/src/Symfony/Component/Security/Http/Firewall/SwitchUserListener.php b/src/Symfony/Component/Security/Http/Firewall/SwitchUserListener.php
@@ -163,7 +163,7 @@ private function attemptSwitchUser(Request $request, string $username): ?TokenIn
 
         $this->logger?->info('Attempting to switch to user.', ['username' => $username]);
 
-        $this->userChecker->checkPostAuth($user);
+        $this->userChecker->checkPostAuth($user, $token);
 
         $roles = $user->getRoles();
         $originatedFromUri = str_replace('/&', '/?', preg_replace('#[&?]'.$this->usernameParameter.'=[^&]*#', '', $request->getRequestUri()));

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Security\Core\User;`
`13`	`13`
	`14`	`+use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;`
	`15`	`+`
`14`	`16`	`final class ChainUserChecker implements UserCheckerInterface`
`15`	`17`	`{`
`16`	`18`	`/**`
`@@ -27,10 +29,16 @@ public function checkPreAuth(UserInterface $user): void`
`27`	`29`	`}`
`28`	`30`	`}`
`29`	`31`
`30`		`- public function checkPostAuth(UserInterface $user): void`
	`32`	`+ public function checkPostAuth(UserInterface $user /, TokenInterface $token/): void`
`31`	`33`	`{`
	`34`	`+ $token = 1 < \func_num_args() ? func_get_arg(1) : 1;`
	`35`	`+`
`32`	`36`	`foreach ($this->checkers as $checker) {`
`33`		`- $checker->checkPostAuth($user);`
	`37`	`+ if ($token instanceof TokenInterface) {`
	`38`	`+ $checker->checkPostAuth($user, $token);`
	`39`	`+ } else {`
	`40`	`+ $checker->checkPostAuth($user);`
	`41`	`+ }`
`34`	`42`	`}`
`35`	`43`	`}`
`36`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,5 +35,5 @@ public function checkPreAuth(UserInterface $user): void;`
`35`	`35`	`*`
`36`	`36`	`* @throws AccountStatusException`
`37`	`37`	`*/`
`38`		`- public function checkPostAuth(UserInterface $user): void;`
	`38`	`+ public function checkPostAuth(UserInterface $user /, TokenInterface $token/): void;`
`39`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ public function postCheckCredentials(AuthenticationSuccessEvent $event): void`
`47`	`47`	`return;`
`48`	`48`	`}`
`49`	`49`
`50`		`- $this->userChecker->checkPostAuth($user);`
	`50`	`+ $this->userChecker->checkPostAuth($user, $event->getAuthenticationToken());`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`public static function getSubscribedEvents(): array`