minor #15279 [Security] Removed some deprecated features related to User::getUsername() (javiereguiluz)

javiereguiluz · javiereguiluz · commit def171d70ac5 · 2021-04-30T15:17:22.000+02:00
This PR was squashed before being merged into the 5.3-dev branch. Discussion ---------- [Security] Removed some deprecated features related to User::getUsername() Fixes #15164. The only occurrence of `getUsername()` left in the docs is in this file: https://github.com/symfony/symfony-docs/blob/5.x/components/messenger.rst Please help me to know how should I proceed to remove it. Thanks! Commits ------- ce457e0 [Security] Removed some deprecated features related to User::getUsername()
diff --git a/controller/argument_value_resolver.rst b/controller/argument_value_resolver.rst
@@ -75,7 +75,7 @@ with the ``User`` class::
     {
         public function index(User $user)
         {
-            return new Response('Hello '.$user->getUsername().'!');
+            return new Response('Hello '.$user->getUserIdentifier().'!');
         }
     }
 
diff --git a/reference/configuration/security.rst b/reference/configuration/security.rst
@@ -89,8 +89,8 @@ If ``true``, when a user is not found a generic exception of type
 is thrown with the message "Bad credentials".
 
 If ``false``, the exception thrown is of type
-:class:`Symfony\\Component\\Security\\Core\\Exception\\UsernameNotFoundException`
-and it includes the given not found username.
+:class:`Symfony\\Component\\Security\\Core\\Exception\\UserNotFoundException`
+and it includes the given not found user identifier.
 
 session_fixation_strategy
 ~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/routing.rst b/routing.rst
@@ -2402,7 +2402,7 @@ use the ``generateUrl()`` helper::
 
             // generate a URL with route arguments
             $userProfilePage = $this->generateUrl('user_profile', [
-                'username' => $user->getUsername(),
+                'username' => $user->getUserIdentifier(),
             ]);
 
             // generated URLs are "absolute paths" by default. Pass a third optional
@@ -2472,7 +2472,7 @@ the :class:`Symfony\\Component\\Routing\\Generator\\UrlGeneratorInterface` class
 
             // generate a URL with route arguments
             $userProfilePage = $this->router->generate('user_profile', [
-                'username' => $user->getUsername(),
+                'username' => $user->getUserIdentifier(),
             ]);
 
             // generated URLs are "absolute paths" by default. Pass a third optional
@@ -2595,7 +2595,7 @@ Now you'll get the expected results when generating URLs in your commands::
 
             // generate a URL with route arguments
             $userProfilePage = $this->router->generate('user_profile', [
-                'username' => $user->getUsername(),
+                'username' => $user->getUserIdentifier(),
             ]);
 
             // generated URLs are "absolute paths" by default. Pass a third optional
diff --git a/security/custom_authentication_provider.rst b/security/custom_authentication_provider.rst
@@ -218,7 +218,10 @@ the ``PasswordDigest`` header value matches with the user's password::
 
         public function authenticate(TokenInterface $token): WsseUserToken
         {
-            $user = $this->userProvider->loadUserByUsername($token->getUsername());
+            // The loadUserByIdentifier() and getUserIdentifier() methods were
+            // introduced in Symfony 5.3. In previous versions they were called
+            // loadUserByUsername() and getUsername() respectively
+            $user = $this->userProvider->loadUserByIdentifier($token->getUserIdentifier());
 
             if ($user && $this->validateDigest($token->digest, $token->nonce, $token->created, $user->getPassword())) {
                 $authenticatedToken = new WsseUserToken($user->getRoles());
diff --git a/security/experimental_authenticators.rst b/security/experimental_authenticators.rst
@@ -456,7 +456,7 @@ using :ref:`the user provider <security-user-providers>`::
     You can optionally pass a user loader as second argument to the
     ``UserBadge``. This callable receives the ``$userIdentifier``
     and must return a ``UserInterface`` object (otherwise a
-    ``UsernameNotFoundException`` is thrown)::
+    ``UserNotFoundException`` is thrown)::
 
         // src/Security/CustomAuthenticator.php
         namespace App\Security;
diff --git a/security/guard_authentication.rst b/security/guard_authentication.rst
@@ -172,10 +172,10 @@ This requires you to implement several methods::
                 return null;
             }
 
-            // The "username" in this case is the apiToken, see the key `property`
+            // The user identifier in this case is the apiToken, see the key `property`
             // of `your_db_provider` in `security.yaml`.
             // If this returns a user, checkCredentials() is called next:
-            return $userProvider->loadUserByUsername($credentials);
+            return $userProvider->loadUserByIdentifier($credentials);
         }
 
         public function checkCredentials($credentials, UserInterface $user): bool
diff --git a/security/json_login_setup.rst b/security/json_login_setup.rst
@@ -85,7 +85,9 @@ The next step is to configure a route in your app matching this path:
                 $user = $this->getUser();
 
                 return $this->json([
-                    'username' => $user->getUsername(),
+                    // The getUserIdentifier() method was introduced in Symfony 5.3.
+                    // In previous versions it was called getUsername()
+                    'username' => $user->getUserIdentifier(),
                     'roles' => $user->getRoles(),
                 ]);
             }
diff --git a/security/login_link.rst b/security/login_link.rst
@@ -401,7 +401,7 @@ The signed URL contains 3 parameters:
     The UNIX timestamp when the link expires.
 
 ``user``
-    The value returned from ``$user->getUsername()`` for this user.
+    The value returned from ``$user->getUserIdentifier()`` for this user.
 
 ``hash``
     A hash of ``expires``, ``user`` and any configured signature
diff --git a/security/user_provider.rst b/security/user_provider.rst
@@ -124,7 +124,7 @@ the ``property`` config key. If you want a bit more control over this - e.g. you
 want to find a user by ``email`` *or* ``username``, you can do that by making
 your ``UserRepository`` implement the
 :class:`Symfony\\Bridge\\Doctrine\\Security\\User\\UserLoaderInterface`. This
-interface only requires one method: ``loadUserByUsername($username)``::
+interface only requires one method: ``loadUserByIdentifier($identifier)``::
 
     // src/Repository/UserRepository.php
     namespace App\Repository;
@@ -137,7 +137,9 @@ interface only requires one method: ``loadUserByUsername($username)``::
     {
         // ...
 
-        public function loadUserByUsername(string $usernameOrEmail): ?User
+        // The loadUserByIdentifier() method was introduced in Symfony 5.3.
+        // In previous versions it was called loadUserByUsername()
+        public function loadUserByIdentifier(string $usernameOrEmail): ?User
         {
             $entityManager = $this->getEntityManager();
 
@@ -209,7 +211,7 @@ To finish this, remove the ``property`` key from the user provider in
 This tells Symfony to *not* query automatically for the User. Instead, when
 needed (e.g. because :doc:`user impersonation </security/impersonating_user>`,
 :doc:`Remember Me </security/remember_me>`, or some other security feature is
-activated), the ``loadUserByUsername()`` method on ``UserRepository`` will be called.
+activated), the ``loadUserByIdentifier()`` method on ``UserRepository`` will be called.
 
 .. _security-memory-user-provider:
 
@@ -367,31 +369,29 @@ command will generate a nice skeleton to get you started::
     namespace App\Security;
 
     use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
-    use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;
+    use Symfony\Component\Security\Core\Exception\UserNotFoundException;
     use Symfony\Component\Security\Core\User\PasswordUpgraderInterface;
     use Symfony\Component\Security\Core\User\UserInterface;
     use Symfony\Component\Security\Core\User\UserProviderInterface;
 
     class UserProvider implements UserProviderInterface, PasswordUpgraderInterface
     {
         /**
-         * Symfony calls this method if you use features like switch_user
-         * or remember_me.
-         *
-         * If you're not using these features, you do not need to implement
-         * this method.
+         * The loadUserByIdentifier() method was introduced in Symfony 5.3.
+         * In previous versions it was called loadUserByUsername()
          *
-         * @return UserInterface
+         * Symfony calls this method if you use features like switch_user
+         * or remember_me. If you're not using these features, you do not
+         * need to implement this method.
          *
-         * @throws UsernameNotFoundException if the user is not found
+         * @throws UserNotFoundException if the user is not found
          */
-        public function loadUserByUsername(string $username)
+        public function loadUserByIdentifier(string $identifier): UserInterface
         {
-            // Load a User object from your data source or throw UsernameNotFoundException.
-            // The $username argument may not actually be a username:
-            // it is whatever value is being returned by the getUsername()
-            // method in your User class.
-            throw new \Exception('TODO: fill in loadUserByUsername() inside '.__FILE__);
+            // Load a User object from your data source or throw UserNotFoundException.
+            // The $identifier argument is whatever value is being returned by the
+            // getUserIdentifier() method in your User class.
+            throw new \Exception('TODO: fill in loadUserByIdentifier() inside '.__FILE__);
         }
 
         /**
@@ -414,7 +414,7 @@ command will generate a nice skeleton to get you started::
             }
 
             // Return a User object after making sure its data is "fresh".
-            // Or throw a UsernameNotFoundException if the user no longer exists.
+            // Or throw a UserNotFoundException if the user no longer exists.
             throw new \Exception('TODO: fill in refreshUser() inside '.__FILE__);
         }
 
@@ -467,8 +467,8 @@ request, it's deserialized and then passed to your user provider to "refresh" it
 Then, the two User objects (the original from the session and the refreshed User
 object) are "compared" to see if they are "equal". By default, the core
 ``AbstractToken`` class compares the return values of the ``getPassword()``,
-``getSalt()`` and ``getUsername()`` methods. If any of these are different, your
-user will be logged out. This is a security measure to make sure that malicious
+``getSalt()`` and ``getUserIdentifier()`` methods. If any of these are different,
+your user will be logged out. This is a security measure to make sure that malicious
 users can be de-authenticated if core user data changes.
 
 However, in some cases, this process can cause unexpected authentication problems.

Original file line number	Diff line number	Diff line change
@@ -75,7 +75,7 @@ with the ``User`` class::
`75`	`75`	`{`
`76`	`76`	`public function index(User $user)`
`77`	`77`	`{`
`78`		`- return new Response('Hello '.$user->getUsername().'!');`
	`78`	`+ return new Response('Hello '.$user->getUserIdentifier().'!');`
`79`	`79`	`}`
`80`	`80`	`}`
`81`	`81`
Original file line number	Diff line number	Diff line change
`@@ -172,10 +172,10 @@ This requires you to implement several methods::`
`172`	`172`	`return null;`
`173`	`173`	`}`
`174`	`174`
`175`		- // The "username" in this case is the apiToken, see the key `property`
	`175`	+ // The user identifier in this case is the apiToken, see the key `property`
`176`	`176`	// of `your_db_provider` in `security.yaml`.
`177`	`177`	`// If this returns a user, checkCredentials() is called next:`
`178`		`- return $userProvider->loadUserByUsername($credentials);`
	`178`	`+ return $userProvider->loadUserByIdentifier($credentials);`
`179`	`179`	`}`
`180`	`180`
`181`	`181`	`public function checkCredentials($credentials, UserInterface $user): bool`