vendor/symfony/security-http/Authentication/DefaultAuthenticationFailureHandler.php line 99

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\HttpKernel\HttpKernelInterface;
  17. use Symfony\Component\Security\Core\Exception\AuthenticationException;
  18. use Symfony\Component\Security\Core\Security;
  19. use Symfony\Component\Security\Http\HttpUtils;
  20. use Symfony\Component\Security\Http\ParameterBagUtils;
  22. /**
  23.  * Class with the default authentication failure handling logic.
  24.  *
  25.  * Can be optionally be extended from by the developer to alter the behavior
  26.  * while keeping the default behavior.
  27.  *
  28.  * @author Fabien Potencier <fabien@symfony.com>
  29.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  30.  * @author Alexander <iam.asm89@gmail.com>
  31.  */
  32. class DefaultAuthenticationFailureHandler implements AuthenticationFailureHandlerInterface
  33. {
  34.     protected $httpKernel;
  35.     protected $httpUtils;
  36.     protected $logger;
  37.     protected $options;
  38.     protected $defaultOptions = [
  39.         'failure_path' => null,
  40.         'failure_forward' => false,
  41.         'login_path' => '/login',
  42.         'failure_path_parameter' => '_failure_path',
  43.     ];
  45.     public function __construct(HttpKernelInterface $httpKernel, HttpUtils $httpUtils, array $options = [], LoggerInterface $logger = null)
  46.     {
  47.         $this->httpKernel = $httpKernel;
  48.         $this->httpUtils = $httpUtils;
  49.         $this->logger = $logger;
  50.         $this->setOptions($options);
  51.     }
  53.     /**
  54.      * Gets the options.
  55.      *
  56.      * @return array
  57.      */
  58.     public function getOptions()
  59.     {
  60.         return $this->options;
  61.     }
  63.     public function setOptions(array $options)
  64.     {
  65.         $this->options = array_merge($this->defaultOptions, $options);
  66.     }
  68.     /**
  69.      * {@inheritdoc}
  70.      */
  71.     public function onAuthenticationFailure(Request $request, AuthenticationException $exception)
  72.     {
  73.         $options = $this->options;
  74.         $failureUrl = ParameterBagUtils::getRequestParameterValue($request, $options['failure_path_parameter']);
  76.         if (\is_string($failureUrl) && (str_starts_with($failureUrl, '/') || str_starts_with($failureUrl, 'http'))) {
  77.             $options['failure_path'] = $failureUrl;
  78.         } elseif ($this->logger && $failureUrl) {
  79.             $this->logger->debug(sprintf('Ignoring query parameter "%s": not a valid URL.', $options['failure_path_parameter']));
  80.         }
  82.         $options['failure_path'] ?? $options['failure_path'] = $options['login_path'];
  84.         if ($options['failure_forward']) {
  85.             if (null !== $this->logger) {
  86.                 $this->logger->debug('Authentication failure, forward triggered.', ['failure_path' => $options['failure_path']]);
  87.             }
  89.             $subRequest = $this->httpUtils->createRequest($request, $options['failure_path']);
  90.             $subRequest->attributes->set(Security::AUTHENTICATION_ERROR, $exception);
  92.             return $this->httpKernel->handle($subRequest, HttpKernelInterface::SUB_REQUEST);
  93.         }
  95.         if (null !== $this->logger) {
  96.             $this->logger->debug('Authentication failure, redirect triggered.', ['failure_path' => $options['failure_path']]);
  97.         }
  99.         $request->getSession()->set(Security::AUTHENTICATION_ERROR, $exception);
  101.         return $this->httpUtils->createRedirectResponse($request, $options['failure_path']);
  102.     }
  103. }