vendor/symfony/security-http/Authentication/SimpleAuthenticationHandler.php line 21

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Security\Http\Authentication;
  14. use Psr\Log\LoggerInterface;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpFoundation\Response;
  17. use Symfony\Component\Security\Core\Authentication\SimpleAuthenticatorInterface;
  18. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  19. use Symfony\Component\Security\Core\Exception\AuthenticationException;
  21. @trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.2, use Guard instead.', SimpleAuthenticationHandler::class), E_USER_DEPRECATED);
  23. /**
  24.  * Class to proxy authentication success/failure handlers.
  25.  *
  26.  * Events are sent to the SimpleAuthenticatorInterface if it implements
  27.  * the right interface, otherwise (or if it fails to return a Response)
  28.  * the default handlers are triggered.
  29.  *
  30.  * @author Jordi Boggiano <j.boggiano@seld.be>
  31.  *
  32.  * @deprecated since Symfony 4.2, use Guard instead.
  33.  */
  34. class SimpleAuthenticationHandler implements AuthenticationFailureHandlerInterface, AuthenticationSuccessHandlerInterface
  35. {
  36.     protected $successHandler;
  37.     protected $failureHandler;
  38.     protected $simpleAuthenticator;
  39.     protected $logger;
  41.     /**
  42.      * @param SimpleAuthenticatorInterface          $authenticator  SimpleAuthenticatorInterface instance
  43.      * @param AuthenticationSuccessHandlerInterface $successHandler Default success handler
  44.      * @param AuthenticationFailureHandlerInterface $failureHandler Default failure handler
  45.      * @param LoggerInterface                       $logger         Optional logger
  46.      */
  47.     public function __construct(SimpleAuthenticatorInterface $authenticator, AuthenticationSuccessHandlerInterface $successHandler, AuthenticationFailureHandlerInterface $failureHandler, LoggerInterface $logger = null)
  48.     {
  49.         $this->simpleAuthenticator = $authenticator;
  50.         $this->successHandler = $successHandler;
  51.         $this->failureHandler = $failureHandler;
  52.         $this->logger = $logger;
  53.     }
  55.     /**
  56.      * {@inheritdoc}
  57.      */
  58.     public function onAuthenticationSuccess(Request $request, TokenInterface $token)
  59.     {
  60.         if ($this->simpleAuthenticator instanceof AuthenticationSuccessHandlerInterface) {
  61.             if ($this->logger) {
  62.                 $this->logger->debug('Selected an authentication success handler.', ['handler' => \get_class($this->simpleAuthenticator)]);
  63.             }
  65.             $response = $this->simpleAuthenticator->onAuthenticationSuccess($request, $token);
  66.             if ($response instanceof Response) {
  67.                 return $response;
  68.             }
  70.             if (null !== $response) {
  71.                 throw new \UnexpectedValueException(sprintf('The %s::onAuthenticationSuccess method must return null to use the default success handler, or a Response object', \get_class($this->simpleAuthenticator)));
  72.             }
  73.         }
  75.         if ($this->logger) {
  76.             $this->logger->debug('Fallback to the default authentication success handler.');
  77.         }
  79.         return $this->successHandler->onAuthenticationSuccess($request, $token);
  80.     }
  82.     /**
  83.      * {@inheritdoc}
  84.      */
  85.     public function onAuthenticationFailure(Request $request, AuthenticationException $exception)
  86.     {
  87.         if ($this->simpleAuthenticator instanceof AuthenticationFailureHandlerInterface) {
  88.             if ($this->logger) {
  89.                 $this->logger->debug('Selected an authentication failure handler.', ['handler' => \get_class($this->simpleAuthenticator)]);
  90.             }
  92.             $response = $this->simpleAuthenticator->onAuthenticationFailure($request, $exception);
  93.             if ($response instanceof Response) {
  94.                 return $response;
  95.             }
  97.             if (null !== $response) {
  98.                 throw new \UnexpectedValueException(sprintf('The %s::onAuthenticationFailure method must return null to use the default failure handler, or a Response object', \get_class($this->simpleAuthenticator)));
  99.             }
  100.         }
  102.         if ($this->logger) {
  103.             $this->logger->debug('Fallback to the default authentication failure handler.');
  104.         }
  106.         return $this->failureHandler->onAuthenticationFailure($request, $exception);
  107.     }
  108. }