vendor/symfony/security-bundle/Security.php line 60

  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\Bundle\SecurityBundle;
  14. use Psr\Container\ContainerInterface;
  15. use Symfony\Bundle\SecurityBundle\Security\FirewallConfig;
  16. use Symfony\Component\HttpFoundation\Request;
  17. use Symfony\Component\HttpFoundation\Response;
  18. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  19. use Symfony\Component\Security\Core\Exception\LogicException;
  20. use Symfony\Component\Security\Core\Exception\LogoutException;
  21. use Symfony\Component\Security\Core\Security as LegacySecurity;
  22. use Symfony\Component\Security\Core\User\UserInterface;
  23. use Symfony\Component\Security\Csrf\CsrfToken;
  24. use Symfony\Component\Security\Http\Authenticator\AuthenticatorInterface;
  25. use Symfony\Component\Security\Http\Event\LogoutEvent;
  26. use Symfony\Component\Security\Http\ParameterBagUtils;
  27. use Symfony\Component\Security\Http\SecurityRequestAttributes;
  28. use Symfony\Contracts\Service\ServiceProviderInterface;
  30. /**
  31.  * Helper class for commonly-needed security tasks.
  32.  *
  33.  * @author Ryan Weaver <ryan@symfonycasts.com>
  34.  * @author Robin Chalas <robin.chalas@gmail.com>
  35.  * @author Arnaud Frézet <arnaud@larriereguichet.fr>
  36.  *
  37.  * @final
  38.  */
  39. class Security extends LegacySecurity
  40. {
  41.     public const ACCESS_DENIED_ERROR = SecurityRequestAttributes::ACCESS_DENIED_ERROR;
  42.     public const AUTHENTICATION_ERROR = SecurityRequestAttributes::AUTHENTICATION_ERROR;
  43.     public const LAST_USERNAME = SecurityRequestAttributes::LAST_USERNAME;
  45.     public function __construct(private readonly ContainerInterface $container, private readonly array $authenticators = [])
  46.     {
  47.         parent::__construct($container, false);
  48.     }
  50.     public function getFirewallConfig(Request $request): ?FirewallConfig
  51.     {
  52.         return $this->container->get('security.firewall.map')->getFirewallConfig($request);
  53.     }
  55.     /**
  56.      * @param UserInterface $user              The user to authenticate
  57.      * @param string|null   $authenticatorName The authenticator name (e.g. "form_login") or service id (e.g. SomeApiKeyAuthenticator::class) - required only if multiple authenticators are configured
  58.      * @param string|null   $firewallName      The firewall name - required only if multiple firewalls are configured
  59.      */
  60.     public function login(UserInterface $user, string $authenticatorName = null, string $firewallName = null): void
  61.     {
  62.         $request = $this->container->get('request_stack')->getCurrentRequest();
  63.         $firewallName ??= $this->getFirewallConfig($request)?->getName();
  65.         if (!$firewallName) {
  66.             throw new LogicException('Unable to login as the current route is not covered by any firewall.');
  67.         }
  69.         $authenticator = $this->getAuthenticator($authenticatorName, $firewallName);
  71.         $this->container->get('security.user_checker')->checkPreAuth($user);
  72.         $this->container->get('security.authenticator.managers_locator')->get($firewallName)->authenticateUser($user, $authenticator, $request);
  73.     }
  75.     /**
  76.      * Logout the current user by dispatching the LogoutEvent.
  77.      *
  78.      * @param bool $validateCsrfToken Whether to look for a valid CSRF token based on the `logout` listener configuration
  79.      *
  80.      * @return Response|null The LogoutEvent's Response if any
  81.      *
  82.      * @throws LogoutException When $validateCsrfToken is true and the CSRF token is not found or invalid
  83.      */
  84.     public function logout(bool $validateCsrfToken = true): ?Response
  85.     {
  86.         /** @var TokenStorageInterface $tokenStorage */
  87.         $tokenStorage = $this->container->get('security.token_storage');
  89.         if (!($token = $tokenStorage->getToken()) || !$token->getUser()) {
  90.             throw new LogicException('Unable to logout as there is no logged-in user.');
  91.         }
  93.         $request = $this->container->get('request_stack')->getMainRequest();
  95.         if (!$firewallConfig = $this->container->get('security.firewall.map')->getFirewallConfig($request)) {
  96.             throw new LogicException('Unable to logout as the request is not behind a firewall.');
  97.         }
  99.         if ($validateCsrfToken) {
  100.             if (!$this->container->has('security.csrf.token_manager') || !$logoutConfig = $firewallConfig->getLogout()) {
  101.                 throw new LogicException(sprintf('Unable to logout with CSRF token validation. Either make sure that CSRF protection is enabled and "logout" is configured on the "%s" firewall, or bypass CSRF token validation explicitly by passing false to the $validateCsrfToken argument of this method.', $firewallConfig->getName()));
  102.             }
  103.             $csrfToken = ParameterBagUtils::getRequestParameterValue($request, $logoutConfig['csrf_parameter']);
  104.             if (!\is_string($csrfToken) || !$this->container->get('security.csrf.token_manager')->isTokenValid(new CsrfToken($logoutConfig['csrf_token_id'], $csrfToken))) {
  105.                 throw new LogoutException('Invalid CSRF token.');
  106.             }
  107.         }
  109.         $logoutEvent = new LogoutEvent($request, $token);
  110.         $this->container->get('security.firewall.event_dispatcher_locator')->get($firewallConfig->getName())->dispatch($logoutEvent);
  112.         $tokenStorage->setToken(null);
  114.         return $logoutEvent->getResponse();
  115.     }
  117.     private function getAuthenticator(?string $authenticatorName, string $firewallName): AuthenticatorInterface
  118.     {
  119.         if (!isset($this->authenticators[$firewallName])) {
  120.             throw new LogicException(sprintf('No authenticators found for firewall "%s".', $firewallName));
  121.         }
  123.         /** @var ServiceProviderInterface $firewallAuthenticatorLocator */
  124.         $firewallAuthenticatorLocator = $this->authenticators[$firewallName];
  126.         if (!$authenticatorName) {
  127.             $authenticatorIds = array_keys($firewallAuthenticatorLocator->getProvidedServices());
  129.             if (!$authenticatorIds) {
  130.                 throw new LogicException(sprintf('No authenticator was found for the firewall "%s".', $firewallName));
  131.             }
  132.             if (1 < \count($authenticatorIds)) {
  133.                 throw new LogicException(sprintf('Too many authenticators were found for the current firewall "%s". You must provide an instance of "%s" to login programmatically. The available authenticators for the firewall "%s" are "%s".', $firewallName, AuthenticatorInterface::class, $firewallName, implode('" ,"', $authenticatorIds)));
  134.             }
  136.             return $firewallAuthenticatorLocator->get($authenticatorIds[0]);
  137.         }
  139.         if ($firewallAuthenticatorLocator->has($authenticatorName)) {
  140.             return $firewallAuthenticatorLocator->get($authenticatorName);
  141.         }
  143.         $authenticatorId = 'security.authenticator.'.$authenticatorName.'.'.$firewallName;
  145.         if (!$firewallAuthenticatorLocator->has($authenticatorId)) {
  146.             throw new LogicException(sprintf('Unable to find an authenticator named "%s" for the firewall "%s". Available authenticators: "%s".', $authenticatorName, $firewallName, implode('", "', array_keys($firewallAuthenticatorLocator->getProvidedServices()))));
  147.         }
  149.         return $firewallAuthenticatorLocator->get($authenticatorId);
  150.     }
  151. }