[Security] Minor fixes

wouterj · wouterj · commit 0b59bc293221 · 2021-08-17T17:47:21.000+02:00
diff --git a/UPGRADE-5.4.md b/UPGRADE-5.4.md
@@ -66,6 +66,7 @@ SecurityBundle
 Security
 --------
 
+ * Deprecate `AuthenticationEvents::AUTHENTICATION_FAILURE`, use the `LoginFailureEvent` instead
  * Deprecate the `$authenticationEntryPoint` argument of `ChannelListener`, and add `$httpPort` and `$httpsPort` arguments
  * Deprecate `RetryAuthenticationEntryPoint`, this code is now inlined in the `ChannelListener`
  * Deprecate `FormAuthenticationEntryPoint` and `BasicAuthenticationEntryPoint`, in the new system the `FormLoginAuthenticator`
diff --git a/UPGRADE-6.0.md b/UPGRADE-6.0.md
@@ -208,6 +208,7 @@ Routing
 Security
 --------
 
+ * Remove `AuthenticationEvents::AUTHENTICATION_FAILURE`, use the `LoginFailureEvent` instead
  * Remove the `$authenticationEntryPoint` argument of `ChannelListener`
  * Remove `RetryAuthenticationEntryPoint`, this code was inlined in the `ChannelListener`
  * Remove `FormAuthenticationEntryPoint` and `BasicAuthenticationEntryPoint`, the `FormLoginAuthenticator` and `HttpBasicAuthenticator` should be used instead.
diff --git a/src/Symfony/Component/Security/Core/AuthenticationEvents.php b/src/Symfony/Component/Security/Core/AuthenticationEvents.php
@@ -29,6 +29,8 @@ final class AuthenticationEvents
      * authenticated by any of the providers.
      *
      * @Event("Symfony\Component\Security\Core\Event\AuthenticationFailureEvent")
+     *
+     * @deprecated since Symfony 5.4, use {@see Event\LoginFailureEvent} instead
      */
     public const AUTHENTICATION_FAILURE = 'security.authentication.failure';
 
diff --git a/src/Symfony/Component/Security/Core/CHANGELOG.md b/src/Symfony/Component/Security/Core/CHANGELOG.md
@@ -4,6 +4,7 @@ CHANGELOG
 5.4
 ---
 
+ * Deprecate `AuthenticationEvents::AUTHENTICATION_FAILURE`, use the `LoginFailureEvent` instead
  * Deprecate `AnonymousToken`, as the related authenticator was deprecated in 5.3
  * Deprecate `Token::getCredentials()`, tokens should no longer contain credentials (as they represent authenticated sessions)
  * Deprecate returning `string|\Stringable` from `Token::getUser()` (it must return a `UserInterface`)
diff --git a/src/Symfony/Component/Security/Core/User/ChainUserProvider.php b/src/Symfony/Component/Security/Core/User/ChainUserProvider.php
@@ -56,25 +56,25 @@ public function loadUserByUsername(string $username)
         return $this->loadUserByIdentifier($username);
     }
 
-    public function loadUserByIdentifier(string $userIdentifier): UserInterface
+    public function loadUserByIdentifier(string $identifier): UserInterface
     {
         foreach ($this->providers as $provider) {
             try {
                 // @deprecated since Symfony 5.3, change to $provider->loadUserByIdentifier() in 6.0
                 if (!method_exists($provider, 'loadUserByIdentifier')) {
                     trigger_deprecation('symfony/security-core', '5.3', 'Not implementing method "loadUserByIdentifier()" in user provider "%s" is deprecated. This method will replace "loadUserByUsername()" in Symfony 6.0.', get_debug_type($provider));
 
-                    return $provider->loadUserByUsername($userIdentifier);
+                    return $provider->loadUserByUsername($identifier);
                 }
 
-                return $provider->loadUserByIdentifier($userIdentifier);
+                return $provider->loadUserByIdentifier($identifier);
             } catch (UserNotFoundException $e) {
                 // try next one
             }
         }
 
-        $ex = new UserNotFoundException(sprintf('There is no user with identifier "%s".', $userIdentifier));
-        $ex->setUserIdentifier($userIdentifier);
+        $ex = new UserNotFoundException(sprintf('There is no user with identifier "%s".', $identifier));
+        $ex->setUserIdentifier($identifier);
         throw $ex;
     }
 
diff --git a/src/Symfony/Component/Security/Http/Authenticator/AbstractPreAuthenticatedAuthenticator.php b/src/Symfony/Component/Security/Http/Authenticator/AbstractPreAuthenticatedAuthenticator.php
@@ -113,7 +113,7 @@ public function createAuthenticatedToken(PassportInterface $passport, string $fi
 
     public function createToken(Passport $passport, string $firewallName): TokenInterface
     {
-        return new PreAuthenticatedToken($passport->getUser(), null, $firewallName, $passport->getUser()->getRoles());
+        return new PreAuthenticatedToken($passport->getUser(), $firewallName, $passport->getUser()->getRoles());
     }
 
     public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName): ?Response
diff --git a/src/Symfony/Component/Security/Http/Authenticator/HttpBasicAuthenticator.php b/src/Symfony/Component/Security/Http/Authenticator/HttpBasicAuthenticator.php
@@ -95,7 +95,7 @@ public function createAuthenticatedToken(PassportInterface $passport, string $fi
 
     public function createToken(Passport $passport, string $firewallName): TokenInterface
     {
-        return new UsernamePasswordToken($passport->getUser(), null, $firewallName, $passport->getUser()->getRoles());
+        return new UsernamePasswordToken($passport->getUser(), $firewallName, $passport->getUser()->getRoles());
     }
 
     public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName): ?Response

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,8 @@ final class AuthenticationEvents`
`29`	`29`	`* authenticated by any of the providers.`
`30`	`30`	`*`
`31`	`31`	`* @Event("Symfony\Component\Security\Core\Event\AuthenticationFailureEvent")`
	`32`	`+ *`
	`33`	`+ * @deprecated since Symfony 5.4, use {@see Event\LoginFailureEvent} instead`
`32`	`34`	`*/`
`33`	`35`	`public const AUTHENTICATION_FAILURE = 'security.authentication.failure';`
`34`	`36`
Original file line number	Diff line number	Diff line change
`@@ -56,25 +56,25 @@ public function loadUserByUsername(string $username)`
`56`	`56`	`return $this->loadUserByIdentifier($username);`
`57`	`57`	`}`
`58`	`58`
`59`		`- public function loadUserByIdentifier(string $userIdentifier): UserInterface`
	`59`	`+ public function loadUserByIdentifier(string $identifier): UserInterface`
`60`	`60`	`{`
`61`	`61`	`foreach ($this->providers as $provider) {`
`62`	`62`	`try {`
`63`	`63`	`// @deprecated since Symfony 5.3, change to $provider->loadUserByIdentifier() in 6.0`
`64`	`64`	`if (!method_exists($provider, 'loadUserByIdentifier')) {`
`65`	`65`	`trigger_deprecation('symfony/security-core', '5.3', 'Not implementing method "loadUserByIdentifier()" in user provider "%s" is deprecated. This method will replace "loadUserByUsername()" in Symfony 6.0.', get_debug_type($provider));`
`66`	`66`
`67`		`- return $provider->loadUserByUsername($userIdentifier);`
	`67`	`+ return $provider->loadUserByUsername($identifier);`
`68`	`68`	`}`
`69`	`69`
`70`		`- return $provider->loadUserByIdentifier($userIdentifier);`
	`70`	`+ return $provider->loadUserByIdentifier($identifier);`
`71`	`71`	`} catch (UserNotFoundException $e) {`
`72`	`72`	`// try next one`
`73`	`73`	`}`
`74`	`74`	`}`
`75`	`75`
`76`		`- $ex = new UserNotFoundException(sprintf('There is no user with identifier "%s".', $userIdentifier));`
`77`		`- $ex->setUserIdentifier($userIdentifier);`
	`76`	`+ $ex = new UserNotFoundException(sprintf('There is no user with identifier "%s".', $identifier));`
	`77`	`+ $ex->setUserIdentifier($identifier);`
`78`	`78`	`throw $ex;`
`79`	`79`	`}`
`80`	`80`
Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ public function createAuthenticatedToken(PassportInterface $passport, string $fi`
`113`	`113`
`114`	`114`	`public function createToken(Passport $passport, string $firewallName): TokenInterface`
`115`	`115`	`{`
`116`		`- return new PreAuthenticatedToken($passport->getUser(), null, $firewallName, $passport->getUser()->getRoles());`
	`116`	`+ return new PreAuthenticatedToken($passport->getUser(), $firewallName, $passport->getUser()->getRoles());`
`117`	`117`	`}`
`118`	`118`
`119`	`119`	`public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName): ?Response`
Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ public function createAuthenticatedToken(PassportInterface $passport, string $fi`
`95`	`95`
`96`	`96`	`public function createToken(Passport $passport, string $firewallName): TokenInterface`
`97`	`97`	`{`
`98`		`- return new UsernamePasswordToken($passport->getUser(), null, $firewallName, $passport->getUser()->getRoles());`
	`98`	`+ return new UsernamePasswordToken($passport->getUser(), $firewallName, $passport->getUser()->getRoles());`
`99`	`99`	`}`
`100`	`100`
`101`	`101`	`public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName): ?Response`