Removed all mentions of 'guard' in the new system

This to remove confusion between the new system and Guard. When using the new
system, guard should not be installed. Guard did however influence the idea
behind the new system. Thus keeping the mentions of "guard" makes it confusing
to use the new system.

Author: wouterj

Authentication/GuardAuthenticatorHandler.php renamed to Authentication/AuthenticatorHandler.php

@@ -13,7 +13,7 @@
 
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\Security\Http\Authentication\Authenticator\AuthenticatorInterface;
+use Symfony\Component\Security\Http\Authenticator\AuthenticatorInterface;
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 use Symfony\Component\Security\Core\Exception\AuthenticationException;
@@ -25,7 +25,7 @@
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
 /**
- * A utility class that does much of the *work* during the guard authentication process.
+ * A utility class that does much of the *work* during the authentication process.
  *
  * By having the logic here instead of the listener, more of the process
  * can be called directly (e.g. for manual authentication) or overridden.
@@ -34,7 +34,7 @@
  *
  * @internal
  */
-class GuardAuthenticatorHandler
+class AuthenticatorHandler
 {
     private $tokenStorage;
     private $dispatcher;
@@ -66,24 +66,24 @@ public function authenticateWithToken(TokenInterface $token, Request $request, s
     }
 
     /**
-     * Returns the "on success" response for the given GuardAuthenticator.
+     * Returns the "on success" response for the given Authenticator.
      *
-     * @param AuthenticatorInterface|GuardAuthenticatorInterface $guardAuthenticator
+     * @param AuthenticatorInterface|GuardAuthenticatorInterface $authenticator
      */
-    public function handleAuthenticationSuccess(TokenInterface $token, Request $request, $guardAuthenticator, string $providerKey): ?Response
+    public function handleAuthenticationSuccess(TokenInterface $token, Request $request, $authenticator, string $providerKey): ?Response
     {
-        if (!$guardAuthenticator instanceof AuthenticatorInterface && !$guardAuthenticator instanceof GuardAuthenticatorInterface) {
-            throw new \UnexpectedValueException('Invalid guard authenticator passed to '.__METHOD__.'. Expected AuthenticatorInterface of either Security Core or Security Guard.');
+        if (!$authenticator instanceof AuthenticatorInterface && !$authenticator instanceof GuardAuthenticatorInterface) {
+            throw new \UnexpectedValueException('Invalid authenticator passed to '.__METHOD__.'. Expected AuthenticatorInterface of either Security Core or Security Guard.');
         }
 
-        $response = $guardAuthenticator->onAuthenticationSuccess($request, $token, $providerKey);
+        $response = $authenticator->onAuthenticationSuccess($request, $token, $providerKey);
 
         // check that it's a Response or null
         if ($response instanceof Response || null === $response) {
             return $response;
         }
 
-        throw new \UnexpectedValueException(sprintf('The "%s::onAuthenticationSuccess()" method must return null or a Response object. You returned "%s".', \get_class($guardAuthenticator), get_debug_type($response)));
+        throw new \UnexpectedValueException(sprintf('The "%s::onAuthenticationSuccess()" method must return null or a Response object. You returned "%s".', \get_class($authenticator), \is_object($response) ? \get_class($response) : \gettype($response)));
     }
 
     /**
@@ -95,7 +95,7 @@ public function handleAuthenticationSuccess(TokenInterface $token, Request $requ
     public function authenticateUserAndHandleSuccess(UserInterface $user, Request $request, $authenticator, string $providerKey): ?Response
     {
         if (!$authenticator instanceof AuthenticatorInterface && !$authenticator instanceof GuardAuthenticatorInterface) {
-            throw new \UnexpectedValueException('Invalid guard authenticator passed to '.__METHOD__.'. Expected AuthenticatorInterface of either Security Core or Security Guard.');
+            throw new \UnexpectedValueException('Invalid authenticator passed to '.__METHOD__.'. Expected AuthenticatorInterface of either Security Core or Security Guard.');
         }
 
         // create an authenticated token for the User
@@ -111,21 +111,21 @@ public function authenticateUserAndHandleSuccess(UserInterface $user, Request $r
      * Handles an authentication failure and returns the Response for the
      * GuardAuthenticator.
      *
-     * @param AuthenticatorInterface|GuardAuthenticatorInterface $guardAuthenticator
+     * @param AuthenticatorInterface|GuardAuthenticatorInterface $authenticator
      */
-    public function handleAuthenticationFailure(AuthenticationException $authenticationException, Request $request, $guardAuthenticator, string $providerKey): ?Response
+    public function handleAuthenticationFailure(AuthenticationException $authenticationException, Request $request, $authenticator, string $providerKey): ?Response
     {
-        if (!$guardAuthenticator instanceof AuthenticatorInterface && !$guardAuthenticator instanceof GuardAuthenticatorInterface) {
-            throw new \UnexpectedValueException('Invalid guard authenticator passed to '.__METHOD__.'. Expected AuthenticatorInterface of either Security Core or Security Guard.');
+        if (!$authenticator instanceof AuthenticatorInterface && !$authenticator instanceof GuardAuthenticatorInterface) {
+            throw new \UnexpectedValueException('Invalid authenticator passed to '.__METHOD__.'. Expected AuthenticatorInterface of either Security Core or Security Guard.');
         }
 
-        $response = $guardAuthenticator->onAuthenticationFailure($request, $authenticationException);
+        $response = $authenticator->onAuthenticationFailure($request, $authenticationException);
         if ($response instanceof Response || null === $response) {
             // returning null is ok, it means they want the request to continue
             return $response;
         }
 
-        throw new \UnexpectedValueException(sprintf('The "%s::onAuthenticationFailure()" method must return null or a Response object. You returned "%s".', \get_class($guardAuthenticator), get_debug_type($response)));
+        throw new \UnexpectedValueException(sprintf('The "%s::onAuthenticationFailure()" method must return null or a Response object. You returned "%s".', \get_class($authenticator), get_debug_type($response)));
     }
 
     /**

Authentication/GuardAuthenticationManager.php renamed to Authentication/AuthenticatorManager.php

@@ -15,8 +15,8 @@
 use Symfony\Component\Security\Core\Exception\BadCredentialsException;
 use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;
 use Symfony\Component\Security\Core\User\UserInterface;
-use Symfony\Component\Security\Http\Authentication\Authenticator\AuthenticatorInterface;
-use Symfony\Component\Security\Core\Authentication\Token\PreAuthenticationGuardToken;
+use Symfony\Component\Security\Http\Authenticator\AuthenticatorInterface;
+use Symfony\Component\Security\Http\Authenticator\Token\PreAuthenticationToken;
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 use Symfony\Component\Security\Core\AuthenticationEvents;
 use Symfony\Component\Security\Core\Event\AuthenticationFailureEvent;
@@ -33,20 +33,20 @@
  *
  * @experimental in 5.1
  */
-class GuardAuthenticationManager implements AuthenticationManagerInterface
+class AuthenticatorManager implements AuthenticationManagerInterface
 {
-    use GuardAuthenticationManagerTrait;
+    use AuthenticatorManagerTrait;
 
-    private $guardAuthenticators;
+    private $authenticators;
     private $eventDispatcher;
     private $eraseCredentials;
 
     /**
-     * @param iterable|AuthenticatorInterface[] $guardAuthenticators The authenticators, with keys that match what's passed to GuardAuthenticationListener
+     * @param AuthenticatorInterface[] $authenticators The authenticators, with keys that match what's passed to AuthenticatorManagerListener
      */
-    public function __construct(iterable $guardAuthenticators, EventDispatcherInterface $eventDispatcher, bool $eraseCredentials = true)
+    public function __construct(iterable $authenticators, EventDispatcherInterface $eventDispatcher, bool $eraseCredentials = true)
     {
-        $this->guardAuthenticators = $guardAuthenticators;
+        $this->authenticators = $authenticators;
         $this->eventDispatcher = $eventDispatcher;
         $this->eraseCredentials = $eraseCredentials;
     }
@@ -58,10 +58,10 @@ public function setEventDispatcher(EventDispatcherInterface $dispatcher)
 
     public function authenticate(TokenInterface $token)
     {
-        if (!$token instanceof PreAuthenticationGuardToken) {
+        if (!$token instanceof PreAuthenticationToken) {
             /*
-             * The listener *only* passes PreAuthenticationGuardToken instances.
-             * This means that an authenticated token (e.g. PostAuthenticationGuardToken)
+             * The listener *only* passes PreAuthenticationToken instances.
+             * This means that an authenticated token (e.g. PostAuthenticationToken)
              * is being passed here, which happens if that token becomes
              * "not authenticated" (e.g. happens if the user changes between
              * requests). In this case, the user should be logged out.
@@ -77,13 +77,13 @@ public function authenticate(TokenInterface $token)
             throw new AuthenticationExpiredException();
         }
 
-        $guard = $this->findOriginatingAuthenticator($token);
-        if (null === $guard) {
-            $this->handleFailure(new ProviderNotFoundException(sprintf('Token with provider key "%s" did not originate from any of the guard authenticators.', $token->getGuardProviderKey())), $token);
+        $authenticator = $this->findOriginatingAuthenticator($token);
+        if (null === $authenticator) {
+            $this->handleFailure(new ProviderNotFoundException(sprintf('Token with provider key "%s" did not originate from any of the authenticators.', $token->getAuthenticatorKey())), $token);
         }
 
         try {
-            $result = $this->authenticateViaGuard($guard, $token, $token->getProviderKey());
+            $result = $this->authenticateViaAuthenticator($authenticator, $token, $token->getProviderKey());
         } catch (AuthenticationException $exception) {
             $this->handleFailure($exception, $token);
         }
@@ -101,14 +101,14 @@ public function authenticate(TokenInterface $token)
         return $result;
     }
 
-    protected function getGuardKey(string $key): string
+    protected function getAuthenticatorKey(string $key): string
     {
-        // Guard authenticators in the GuardAuthenticationManager are already indexed
+        // Authenticators in the AuthenticatorManager are already indexed
         // by an unique key
         return $key;
     }
 
-    private function authenticateViaGuard(AuthenticatorInterface $authenticator, PreAuthenticationGuardToken $token, string $providerKey): TokenInterface
+    private function authenticateViaAuthenticator(AuthenticatorInterface $authenticator, PreAuthenticationToken $token, string $providerKey): TokenInterface
     {
         // get the user from the Authenticator
         $user = $authenticator->getUser($token->getCredentials());

Authentication/AuthenticatorManagerTrait.php

@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Security\Http\Authentication;
+
+use Symfony\Component\Security\Guard\AuthenticatorInterface as GuardAuthenticatorInterface;
+use Symfony\Component\Security\Http\Authenticator\AuthenticatorInterface as CoreAuthenticatorInterface;
+use Symfony\Component\Security\Http\Authenticator\Token\PreAuthenticationToken;
+
+/**
+ * @author Ryan Weaver <ryan@knpuniversity.com>
+ *
+ * @internal
+ */
+trait AuthenticatorManagerTrait
+{
+    /**
+     * @return CoreAuthenticatorInterface|GuardAuthenticatorInterface|null
+     */
+    private function findOriginatingAuthenticator(PreAuthenticationToken $token)
+    {
+        // find the *one* Authenticator that this token originated from
+        foreach ($this->authenticators as $key => $authenticator) {
+            // get a key that's unique to *this* authenticator
+            // this MUST be the same as AuthenticatorManagerListener
+            $uniqueAuthenticatorKey = $this->getAuthenticatorKey($key);
+
+            if ($uniqueAuthenticatorKey === $token->getAuthenticatorKey()) {
+                return $authenticator;
+            }
+        }
+
+        // no matching authenticator found
+        return null;
+    }
+
+    abstract protected function getAuthenticatorKey(string $key): string;
+}

Authentication/GuardAuthenticationManagerTrait.php

@@ -9,11 +9,11 @@
  * file that was distributed with this source code.
  */
 
-namespace Symfony\Component\Security\Http\Authentication\Authenticator;
+namespace Symfony\Component\Security\Http\Authenticator;
 
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 use Symfony\Component\Security\Core\User\UserInterface;
-use Symfony\Component\Security\Guard\Token\PostAuthenticationGuardToken;
+use Symfony\Component\Security\Http\Authenticator\Token\PostAuthenticationToken;
 
 /**
  * An optional base class that creates the necessary tokens for you.
@@ -25,13 +25,13 @@
 abstract class AbstractAuthenticator implements AuthenticatorInterface
 {
     /**
-     * Shortcut to create a PostAuthenticationGuardToken for you, if you don't really
+     * Shortcut to create a PostAuthenticationToken for you, if you don't really
      * care about which authenticated token you're using.
      *
-     * @return PostAuthenticationGuardToken
+     * @return PostAuthenticationToken
      */
     public function createAuthenticatedToken(UserInterface $user, string $providerKey): TokenInterface
     {
-        return new PostAuthenticationGuardToken($user, $providerKey, $user->getRoles());
+        return new PostAuthenticationToken($user, $providerKey, $user->getRoles());
     }
 }

Authentication/Authenticator/AbstractAuthenticator.php renamed to Authenticator/AbstractAuthenticator.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Symfony\Component\Security\Http\Authentication\Authenticator;
+namespace Symfony\Component\Security\Http\Authenticator;
 
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
@@ -25,7 +25,7 @@
  *
  * @experimental in 5.1
  */
-abstract class AbstractFormLoginAuthenticator extends AbstractAuthenticator implements AuthenticationEntryPointInterface
+abstract class AbstractLoginFormAuthenticator extends AbstractAuthenticator implements AuthenticationEntryPointInterface
 {
     /**
      * Return the URL to the login page.

Authentication/Authenticator/AbstractFormLoginAuthenticator.php renamed to Authenticator/AbstractLoginFormAuthenticator.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Symfony\Component\Security\Http\Authentication\Authenticator;
+namespace Symfony\Component\Security\Http\Authenticator;
 
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;

Authentication/Authenticator/AnonymousAuthenticator.php renamed to Authenticator/AnonymousAuthenticator.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Symfony\Component\Security\Http\Authentication\Authenticator;
+namespace Symfony\Component\Security\Http\Authenticator;
 
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;

Authentication/Authenticator/AuthenticatorInterface.php renamed to Authenticator/AuthenticatorInterface.php

@@ -1,6 +1,15 @@
 <?php
 
-namespace Symfony\Component\Security\Http\Authentication\Authenticator;
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Security\Http\Authenticator;
 
 use Symfony\Component\Security\Core\Exception\AuthenticationException;
 use Symfony\Component\Security\Core\User\UserInterface;