. */ declare(strict_types=1); namespace App\EventSubscriber\UserSystem; use Symfony\Bundle\SecurityBundle\Security; use App\Entity\UserSystem\Group; use App\Entity\UserSystem\User; use Symfony\Component\EventDispatcher\EventSubscriberInterface; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Session\Session; use Symfony\Component\HttpKernel\Event\RequestEvent; use Symfony\Component\HttpKernel\KernelEvents; use Symfony\Component\Security\Http\HttpUtils; /** * This event subscriber redirects a user to its settings page, when it needs to change its password or is enforced * to setup a 2FA method (enforcement can be set per group). * In this cases the user is unable to access sites other than the whitelisted (see ALLOWED_ROUTES). */ final class PasswordChangeNeededSubscriber implements EventSubscriberInterface { /** * @var string[] The routes the user is allowed to access without being redirected. * This should be only routes related to login/logout and user settings */ public const ALLOWED_ROUTES = [ '2fa_login', '2fa_login_check', 'user_settings', 'club_base_register_u2f', 'logout', ]; /** * @var string The route the user will redirected to, if he needs to change this password */ public const REDIRECT_TARGET = 'user_settings'; public function __construct(private readonly Security $security, private readonly HttpUtils $httpUtils) { } /** * This function is called when the kernel encounters a request. * It checks if the user must change its password or add an 2FA mehtod and redirect it to the user settings page, * if needed. */ public function redirectToSettingsIfNeeded(RequestEvent $event): void { $user = $this->security->getUser(); $request = $event->getRequest(); if (!$event->isMainRequest()) { return; } if (!$user instanceof User) { return; } //If the user is impersonated, we don't need to redirect him if ($this->security->isGranted('IS_IMPERSONATOR')) { return; } //Abort if we dont need to redirect the user. if (!$user->isNeedPwChange() && !self::TFARedirectNeeded($user, $request)) { return; } //Check for a whitelisted URL foreach (static::ALLOWED_ROUTES as $route) { //Dont do anything if we encounter an allowed route if ($this->httpUtils->checkRequestPath($request, $route)) { return; } } /* Dont redirect tree endpoints, as this would cause trouble and creates multiple flash warnigs for one page reload */ if (str_contains($request->getUri(), '/tree/')) { return; } /** @var Session $session */ $session = $request->getSession(); $flashBag = $session->getFlashBag(); //Show appropriate message to user about the reason he was redirected if ($user->isNeedPwChange()) { $flashBag->add('warning', 'user.pw_change_needed.flash'); } if (self::TFARedirectNeeded($user, $request)) { $flashBag->add('warning', 'user.2fa_needed.flash'); } $event->setResponse($this->httpUtils->createRedirectResponse($request, static::REDIRECT_TARGET)); } /** * Check if a redirect because of a missing 2FA method is needed. * That is the case if the group of the user enforces 2FA, but the user has neither Google Authenticator nor an * U2F key setup. * The result is cached for some minutes in the session to prevent unnecessary database queries. * * @param User $user the user for which should be checked if it needs to be redirected * * @return bool true if the user needs to be redirected */ public static function TFARedirectNeeded(User $user, Request $request): bool { //Check if when we have checked the user the last time $session = $request->getSession(); $last_check = $session->get('tfa_redirect_check', 0); //If we have checked the user already in the last 10 minutes, we don't need to check it again if ($last_check > time() - 600) { return false; } //Otherwise we check the user again $tfa_enabled = $user->isWebAuthnAuthenticatorEnabled() || $user->isGoogleAuthenticatorEnabled(); $result = $user->getGroup() instanceof Group && $user->getGroup()->isEnforce2FA() && !$tfa_enabled; //If no redirect is needed, we set the last check time to now if (!$result) { $session->set('tfa_redirect_check', time()); } return $result; } public static function getSubscribedEvents(): array { return [ KernelEvents::REQUEST => 'redirectToSettingsIfNeeded', ]; } }