Fix BC layer

Author: chalasr

UPGRADE-3.4.md

@@ -295,16 +295,16 @@ Security
  * Deprecated the HTTP digest authentication: `NonceExpiredException`,
    `DigestAuthenticationListener` and `DigestAuthenticationEntryPoint` will be
    removed in 4.0. Use another authentication system like `http_basic` instead.
+   
+ * The `GuardAuthenticatorInterface` has been deprecated and will be removed in 4.0.
+   Use `AuthenticatorInterface` instead.
 
 SecurityBundle
 --------------
 
  * Using voters that do not implement the `VoterInterface`is now deprecated in
    the `AccessDecisionManager` and this functionality will be removed in 4.0.
 
- * Using guard authenticator that implement the `GuardAuthenticatorInterface` is now
-   deprecated, this will be removed in 4.0. `AuthenticatorInterface` must be used now.
-
  * `FirewallContext::getListeners()` now returns `\Traversable|array`
 
  * `InitAclCommand::__construct()` now takes an instance of

UPGRADE-4.0.md

@@ -659,9 +659,6 @@ Security
  * The `RoleInterface` has been removed. Extend the `Symfony\Component\Security\Core\Role\Role`
    class instead.
 
- * The `GuardAuthenticatorInterface` has been removed. Implement
-   `Symfony\Component\Security\Guard\AuthenticatorInterface` class instead.
-
  * The `LogoutUrlGenerator::registerListener()` method expects a 6th `string $context = null` argument.
 
  * The `AccessDecisionManager::setVoters()` method has been removed. Pass the
@@ -676,6 +673,9 @@ Security
    `DigestAuthenticationListener` and `DigestAuthenticationEntryPoint` classes
    have been removed. Use another authentication system like `http_basic` instead.
 
+ * The `GuardAuthenticatorInterface` interface has been removed.
+   Use `AuthenticatorInterface` instead.
+
 SecurityBundle
 --------------
 

src/Symfony/Component/Security/CHANGELOG.md

@@ -15,6 +15,7 @@ CHANGELOG
    requests.
  * deprecated HTTP digest authentication
  * Added a new password encoder for the Argon2i hashing algorithm
+ * deprecated `GuardAuthenticatorInterface` in favor of `AuthenticatorInterface`
 
 3.3.0
 -----

src/Symfony/Component/Security/Guard/AbstractGuardAuthenticator.php

@@ -23,17 +23,13 @@
 abstract class AbstractGuardAuthenticator implements AuthenticatorInterface
 {
     /**
-     * Default implementation of the AuthenticatorInterface::supports method
-     * As we still have the deprecated GuardAuthenticatorInterface, this method must be implemented here
-     * Once GuardAuthenticatorInterface will be removed, this method should be removed too.
+     * {@inheritdoc}
      *
-     * @param Request $request
-     *
-     * @return bool
+     * @deprecated since version 3.4, to be removed in 4.0
      */
     public function supports(Request $request)
     {
-        @trigger_error('The Symfony\Component\Security\Guard\AbstractGuardAuthenticator::supports default implementation is used. This is provided for backward compatibility on GuardAuthenticationInterface that is deprecated since version 3.1 and will be removed in 4.0. Provide your own implementation of the supports method instead.', E_USER_DEPRECATED);
+        @trigger_error(sprintf('The "%s()" method is deprecated since version 3.4 and will be removed in 4.0. Implement the "%s::supports()" method in class "%s" instead.', __METHOD__, AuthenticatorInterface::class, get_class($this)), E_USER_DEPRECATED);
 
         return true;
     }

src/Symfony/Component/Security/Guard/AuthenticatorInterface.php

@@ -12,13 +12,6 @@
 namespace Symfony\Component\Security\Guard;
 
 use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
-use Symfony\Component\Security\Core\Exception\AuthenticationException;
-use Symfony\Component\Security\Core\User\UserInterface;
-use Symfony\Component\Security\Core\User\UserProviderInterface;
-use Symfony\Component\Security\Guard\Token\GuardTokenInterface;
-use Symfony\Component\Security\Http\EntryPoint\AuthenticationEntryPointInterface;
 
 /**
  * The interface for all "guard" authenticators.
@@ -30,14 +23,12 @@
  * @author Ryan Weaver <[email protected]>
  * @author Amaury Leroux de Lens <[email protected]>
  */
-interface AuthenticatorInterface extends AuthenticationEntryPointInterface
+interface AuthenticatorInterface extends GuardAuthenticatorInterface
 {
     /**
-     * Does the authenticator support the given Request ?
+     * Does the authenticator support the given Request?
      *
-     * If this returns true, authentication will continue (e.g. getCredentials() will be called).
-     * If false, this authenticator is done. The next (if any) authenticators will be called and
-     * may authenticate the user, or leave the user as anonymous.
+     * If this returns false, the authenticator will be skipped.
      *
      * @param Request $request
      *
@@ -47,8 +38,7 @@ public function supports(Request $request);
 
     /**
      * Get the authentication credentials from the request and return them
-     * as any type (e.g. an associate array). If you return null, authentication
-     * will be skipped.
+     * as any type (e.g. an associate array).
      *
      * Whatever value you return here will be passed to getUser() and checkCredentials()
      *
@@ -65,106 +55,9 @@ public function supports(Request $request);
      *
      * @param Request $request
      *
-     * @return mixed|null
-     */
-    public function getCredentials(Request $request);
-
-    /**
-     * Return a UserInterface object based on the credentials.
-     *
-     * The *credentials* are the return value from getCredentials()
-     *
-     * You may throw an AuthenticationException if you wish. If you return
-     * null, then a UsernameNotFoundException is thrown for you.
+     * @return mixed Any non-null value
      *
-     * @param mixed                 $credentials
-     * @param UserProviderInterface $userProvider
-     *
-     * @throws AuthenticationException
-     *
-     * @return UserInterface|null
+     * @throws \UnexpectedValueException If null is returned
      */
-    public function getUser($credentials, UserProviderInterface $userProvider);
-
-    /**
-     * Returns true if the credentials are valid.
-     *
-     * If any value other than true is returned, authentication will
-     * fail. You may also throw an AuthenticationException if you wish
-     * to cause authentication to fail.
-     *
-     * The *credentials* are the return value from getCredentials()
-     *
-     * @param mixed         $credentials
-     * @param UserInterface $user
-     *
-     * @return bool
-     *
-     * @throws AuthenticationException
-     */
-    public function checkCredentials($credentials, UserInterface $user);
-
-    /**
-     * Creates an authenticated token for the given user.
-     *
-     * If you don't care about which token class is used or don't really
-     * understand what a "token" is, you can skip this method by extending
-     * the AbstractGuardAuthenticator class from your authenticator.
-     *
-     * @see AbstractGuardAuthenticator
-     *
-     * @param UserInterface $user
-     * @param string        $providerKey The provider (i.e. firewall) key
-     *
-     * @return GuardTokenInterface
-     */
-    public function createAuthenticatedToken(UserInterface $user, $providerKey);
-
-    /**
-     * Called when authentication executed, but failed (e.g. wrong username password).
-     *
-     * This should return the Response sent back to the user, like a
-     * RedirectResponse to the login page or a 403 response.
-     *
-     * If you return null, the request will continue, but the user will
-     * not be authenticated. This is probably not what you want to do.
-     *
-     * @param Request                 $request
-     * @param AuthenticationException $exception
-     *
-     * @return Response|null
-     */
-    public function onAuthenticationFailure(Request $request, AuthenticationException $exception);
-
-    /**
-     * Called when authentication executed and was successful!
-     *
-     * This should return the Response sent back to the user, like a
-     * RedirectResponse to the last page they visited.
-     *
-     * If you return null, the current request will continue, and the user
-     * will be authenticated. This makes sense, for example, with an API.
-     *
-     * @param Request        $request
-     * @param TokenInterface $token
-     * @param string         $providerKey The provider (i.e. firewall) key
-     *
-     * @return Response|null
-     */
-    public function onAuthenticationSuccess(Request $request, TokenInterface $token, $providerKey);
-
-    /**
-     * Does this method support remember me cookies?
-     *
-     * Remember me cookie will be set if *all* of the following are met:
-     *  A) This method returns true
-     *  B) The remember_me key under your firewall is configured
-     *  C) The "remember me" functionality is activated. This is usually
-     *      done by having a _remember_me checkbox in your form, but
-     *      can be configured by the "always_remember_me" and "remember_me_parameter"
-     *      parameters under the "remember_me" firewall key
-     *
-     * @return bool
-     */
-    public function supportsRememberMe();
+    public function getCredentials(Request $request);
 }

src/Symfony/Component/Security/Guard/Firewall/GuardAuthenticationListener.php

@@ -15,9 +15,9 @@
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Event\GetResponseEvent;
 use Symfony\Component\Security\Guard\GuardAuthenticatorHandler;
+use Symfony\Component\Security\Guard\GuardAuthenticatorInterface;
 use Symfony\Component\Security\Guard\Token\PreAuthenticationGuardToken;
 use Symfony\Component\Security\Core\Authentication\AuthenticationManagerInterface;
-use Symfony\Component\Security\Guard\GuardAuthenticatorInterface;
 use Symfony\Component\Security\Guard\AuthenticatorInterface;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
@@ -94,46 +94,37 @@ public function handle(GetResponseEvent $event)
         }
     }
 
-    private function executeGuardAuthenticator($uniqueGuardKey, AuthenticatorInterface $guardAuthenticator, GetResponseEvent $event)
+    private function executeGuardAuthenticator($uniqueGuardKey, GuardAuthenticatorInterface $guardAuthenticator, GetResponseEvent $event)
     {
         $request = $event->getRequest();
         try {
             if (null !== $this->logger) {
                 $this->logger->debug('Calling getCredentials() on guard configurator.', array('firewall_key' => $this->providerKey, 'authenticator' => get_class($guardAuthenticator)));
             }
 
-            // abort the execution of the authenticator if it doesn't support the request.
-            if ($guardAuthenticator instanceof GuardAuthenticatorInterface) {
-                // it's a GuardAuthenticatorInterface
-                // we support the previous behaviour to avoid BC break.
-                $credentialsCanBeNull = true;
-                @trigger_error('The Symfony\Component\Security\Guard\GuardAuthenticatorInterface interface is deprecated since version 3.1 and will be removed in 4.0. Use Symfony\Component\Security\Guard\Authenticator\GuardAuthenticatorInterface instead.', E_USER_DEPRECATED);
-            } else {
-                if (true !== $guardAuthenticator->supports($request)) {
+            // abort the execution of the authenticator if it doesn't support the request
+            if ($guardAuthenticator instanceof AuthenticatorInterface) {
+                if (!$guardAuthenticator->supports($request)) {
                     return;
                 }
                 // as there was a support for given request,
                 // authenticator is expected to give not-null credentials.
                 $credentialsCanBeNull = false;
+            } else {
+                // deprecated since version 3.4, to be removed in 4.0
+                $credentialsCanBeNull = true;
             }
 
             // allow the authenticator to fetch authentication info from the request
             $credentials = $guardAuthenticator->getCredentials($request);
 
             if (null === $credentials) {
-                // if GuardAuthenticatorInterface is used
-                // allow null to skip authentication.
+                // deprecated since version 3.4, to be removed in 4.0
                 if ($credentialsCanBeNull) {
                     return;
                 }
 
-                // otherwise something went wrong and the authentication must fail
-                throw new \UnexpectedValueException(sprintf(
-                    'You must return some credentials from %s:getCredentials().
-                    To skip authentication, return false from %s::supports().',
-                    get_class($guardAuthenticator),
-                    get_class($guardAuthenticator)
-                ));
+                throw new \UnexpectedValueException(sprintf('The return value of "%s::getCredentials()" must not be null. Return false from "%s::supports()" instead.', get_class($guardAuthenticator), get_class($guardAuthenticator)));
             }
 
             // create a token with the unique key, so that the provider knows which authenticator to use
@@ -205,7 +196,7 @@ public function setRememberMeServices(RememberMeServicesInterface $rememberMeSer
      * @param TokenInterface         $token
      * @param Response               $response
      */
-    private function triggerRememberMe(AuthenticatorInterface $guardAuthenticator, Request $request, TokenInterface $token, Response $response = null)
+    private function triggerRememberMe(GuardAuthenticatorInterface $guardAuthenticator, Request $request, TokenInterface $token, Response $response = null)
     {
         if (null === $this->rememberMeServices) {
             if (null !== $this->logger) {

src/Symfony/Component/Security/Guard/GuardAuthenticatorHandler.php

@@ -29,6 +29,8 @@
  * can be called directly (e.g. for manual authentication) or overridden.
  *
  * @author Ryan Weaver <[email protected]>
+ *
+ * @final since version 3.4
  */
 class GuardAuthenticatorHandler
 {
@@ -68,7 +70,7 @@ public function authenticateWithToken(TokenInterface $token, Request $request)
      *
      * @return null|Response
      */
-    public function handleAuthenticationSuccess(TokenInterface $token, Request $request, AuthenticatorInterface $guardAuthenticator, $providerKey)
+    public function handleAuthenticationSuccess(TokenInterface $token, Request $request, GuardAuthenticatorInterface $guardAuthenticator, $providerKey)
     {
         $response = $guardAuthenticator->onAuthenticationSuccess($request, $token, $providerKey);
 
@@ -95,7 +97,7 @@ public function handleAuthenticationSuccess(TokenInterface $token, Request $requ
      *
      * @return Response|null
      */
-    public function authenticateUserAndHandleSuccess(UserInterface $user, Request $request, AuthenticatorInterface $authenticator, $providerKey)
+    public function authenticateUserAndHandleSuccess(UserInterface $user, Request $request, GuardAuthenticatorInterface $authenticator, $providerKey)
     {
         // create an authenticated token for the User
         $token = $authenticator->createAuthenticatedToken($user, $providerKey);
@@ -117,7 +119,7 @@ public function authenticateUserAndHandleSuccess(UserInterface $user, Request $r
      *
      * @return null|Response
      */
-    public function handleAuthenticationFailure(AuthenticationException $authenticationException, Request $request, AuthenticatorInterface $guardAuthenticator, $providerKey)
+    public function handleAuthenticationFailure(AuthenticationException $authenticationException, Request $request, GuardAuthenticatorInterface $guardAuthenticator, $providerKey)
     {
         $token = $this->tokenStorage->getToken();
         if ($token instanceof PostAuthenticationGuardToken && $providerKey === $token->getProviderKey()) {

src/Symfony/Component/Security/Guard/GuardAuthenticatorInterface.php

@@ -18,6 +18,7 @@
 use Symfony\Component\Security\Core\User\UserInterface;
 use Symfony\Component\Security\Core\User\UserProviderInterface;
 use Symfony\Component\Security\Guard\Token\GuardTokenInterface;
+use Symfony\Component\Security\Http\EntryPoint\AuthenticationEntryPointInterface;
 
 /**
  * The interface for all "guard" authenticators.
@@ -28,9 +29,9 @@
  *
  * @author Ryan Weaver <[email protected]>
  *
- * @deprecated Symfony\Component\Security\Guard\AuthenticatorInterface must be used instead
+ * @deprecated since version 3.4, to be removed in 4.0. Use AuthenticatorInterface instead
  */
-interface GuardAuthenticatorInterface extends AuthenticatorInterface
+interface GuardAuthenticatorInterface extends AuthenticationEntryPointInterface
 {
     /**
      * Get the authentication credentials from the request and return them

src/Symfony/Component/Security/Guard/Provider/GuardAuthenticationProvider.php

@@ -56,7 +56,7 @@ public function __construct($guardAuthenticators, UserProviderInterface $userPro
     /**
      * Finds the correct authenticator for the token and calls it.
      *
-     * @param TokenInterface|GuardTokenInterface $token
+     * @param GuardTokenInterface $token
      *
      * @return TokenInterface
      */
@@ -101,7 +101,7 @@ public function authenticate(TokenInterface $token)
         // instances that will be checked if you have multiple firewalls.
     }
 
-    private function authenticateViaGuard(AuthenticatorInterface $guardAuthenticator, PreAuthenticationGuardToken $token)
+    private function authenticateViaGuard($guardAuthenticator, PreAuthenticationGuardToken $token)
     {
         // get the user from the GuardAuthenticator
         $user = $guardAuthenticator->getUser($token->getCredentials(), $this->userProvider);
@@ -142,6 +142,6 @@ private function authenticateViaGuard(AuthenticatorInterface $guardAuthenticator
 
     public function supports(TokenInterface $token)
     {
-        return $token instanceof TokenInterface;
+        return $token instanceof GuardTokenInterface;
     }
 }