update security system according to symfony 5.3

Author: vincent-peugnet

config/packages/security.yaml

@@ -1,5 +1,8 @@
 security:
-    encoders:
+    # https://symfony.com/doc/current/security/authenticator_manager.html
+    enable_authenticator_manager: true
+    password_hashers:
+        Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface: 'auto'
         App\Entity\User:
             algorithm: auto
 
@@ -15,12 +18,9 @@ security:
             pattern: ^/(_(profiler|wdt)|css|images|js)/
             security: false
         main:
-            anonymous: true
             lazy: true
             provider: app_user_provider
-            guard:
-                authenticators:
-                    - App\Security\LoginFormAuthenticator
+            custom_authenticator: App\Security\LoginFormAuthenticator
             logout:
                 path: app_logout
                 # where to redirect after logout

src/Controller/ResetPasswordController.php

@@ -37,8 +37,8 @@
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Mailer\MailerInterface;
 use Symfony\Component\Mime\Address;
+use Symfony\Component\PasswordHasher\Hasher\UserPasswordHasherInterface;
 use Symfony\Component\Routing\Annotation\Route;
-use Symfony\Component\Security\Core\Encoder\UserPasswordEncoderInterface;
 use SymfonyCasts\Bundle\ResetPassword\Controller\ResetPasswordControllerTrait;
 use SymfonyCasts\Bundle\ResetPassword\Exception\ResetPasswordExceptionInterface;
 use SymfonyCasts\Bundle\ResetPassword\ResetPasswordHelperInterface;
@@ -107,7 +107,7 @@ public function checkEmail(): Response
      */
     public function reset(
         Request $request,
-        UserPasswordEncoderInterface $passwordEncoder,
+        UserPasswordHasherInterface $passwordHasher,
         string $token = null
     ): Response {
         if ($token) {
@@ -143,7 +143,7 @@ public function reset(
             $this->resetPasswordHelper->removeResetRequest($token);
 
             // Encode the plain password, and set it.
-            $encodedPassword = $passwordEncoder->encodePassword(
+            $encodedPassword = $passwordHasher->hashPassword(
                 $user,
                 $form->get('plainPassword')->getData()
             );

src/Controller/SecurityController.php

@@ -53,7 +53,7 @@ public function login(AuthenticationUtils $authenticationUtils): Response
     /**
      * @Route("/logout", name="app_logout")
      */
-    public function logout()
+    public function logout(): void
     {
         throw new \LogicException();
     }

src/Controller/SignUpController.php

@@ -28,37 +28,39 @@
 
 use App\Entity\User;
 use App\Event\InvitationEvent;
+use App\Form\RegistrationFormType;
 use App\Form\SignUpType;
 use App\Repository\InvitationRepository;
 use App\Repository\UserClassRepository;
 use App\Repository\UserRepository;
 use App\Security\EmailVerifier;
-use App\Security\LoginFormAuthenticator;
+use Symfony\Bridge\Twig\Mime\TemplatedEmail;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
-use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface as EventDispatcherEventDispatcherInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Mime\Address;
+use Symfony\Component\PasswordHasher\Hasher\UserPasswordHasherInterface;
 use Symfony\Component\Routing\Annotation\Route;
-use Symfony\Component\Security\Core\Encoder\UserPasswordEncoderInterface;
-use Symfony\Component\Security\Guard\GuardAuthenticatorHandler;
+use SymfonyCasts\Bundle\VerifyEmail\Exception\VerifyEmailExceptionInterface;
 
 class SignUpController extends AbstractController
 {
-    private $userLimitReached = false;
+    private bool $userLimitReached = false;
+    private bool $needCode = false;
+
 
     /**
      * @Route("/signup", name="sign_up")
      */
-    public function index(
+    public function register(
         Request $request,
-        UserClassRepository $userClassRepository,
+        EmailVerifier $emailVerifier,
+        UserPasswordHasherInterface $userPasswordHasherInterface,
         UserRepository $userRepository,
-        GuardAuthenticatorHandler $guardHandler,
-        LoginFormAuthenticator $authenticator,
-        UserPasswordEncoderInterface $passwordEncoder,
+        UserClassRepository $userClassRepository,
         InvitationRepository $invitationRepository,
-        EventDispatcherInterface $dispatcher,
-        EmailVerifier $emailVerifier
+        EventDispatcherEventDispatcherInterface $dispatcher
     ): Response {
 
         // Check user limit
@@ -69,24 +71,22 @@ public function index(
                 $this->userLimitReached = true;
             }
         }
+        // Check if app is registrations are open
+        $this->needCode = !$this->getParameter('app.open_registration');
 
 
         $user = new User();
-
-        $needCode = !$this->getParameter('app.open_registration');
         $form = $this->createForm(
             SignUpType::class,
             $user,
-            ['needCode' => $needCode, 'userLimitReached' => $this->userLimitReached]
+            ['needCode' => $this->needCode, 'userLimitReached' => $this->userLimitReached]
         );
-
         $form->handleRequest($request);
+
         if ($form->isSubmitted() && $form->isValid()) {
-            /** @var User $user */
             $user = $form->getData();
-
             $user->setPassword(
-                $passwordEncoder->encodePassword(
+                $userPasswordHasherInterface->hashPassword(
                     $user,
                     $form->get('plainPassword')->getData()
                 )
@@ -103,7 +103,7 @@ public function index(
             $entityManager = $this->getDoctrine()->getManager();
             $entityManager->persist($user);
 
-            if ($needCode) {
+            if ($this->needCode) {
                 $code = $form->get('code')->getData();
                 $invitation = $invitationRepository->findOneBy(['code' => $code]);
                 $invitation->setChild($user);
@@ -114,6 +114,7 @@ public function index(
                 $entityManager->flush();
             }
 
+
             // Send validation email
             $emailVerifier->sendEmailConfirmation(
                 'email_verify',
@@ -122,15 +123,9 @@ public function index(
             $email = $user->getEmail();
             $this->addFlash('primary', "An email have been send to $email for validation");
 
-            return $guardHandler->authenticateUserAndHandleSuccess(
-                $user,
-                $request,
-                $authenticator,
-                'main' // firewall name in security.yaml
-            );
+            return $this->redirectToRoute('app_login');
         }
 
-
         return $this->render('sign_up/index.html.twig', [
             'form' => $form->createView(),
             'userLimitReached' => $this->userLimitReached,

src/DataFixtures/UserFixture.php

@@ -32,15 +32,15 @@
 use Doctrine\Bundle\FixturesBundle\Fixture;
 use Doctrine\Common\DataFixtures\DependentFixtureInterface;
 use Doctrine\Persistence\ObjectManager;
-use Symfony\Component\Security\Core\Encoder\UserPasswordEncoderInterface;
+use Symfony\Component\PasswordHasher\Hasher\UserPasswordHasherInterface;
 
 class UserFixture extends Fixture implements DependentFixtureInterface
 {
-    private $passwordEncoder;
+    private $passwordHasher;
 
-    public function __construct(UserPasswordEncoderInterface $passwordEncoder)
+    public function __construct(UserPasswordHasherInterface $passwordHasher)
     {
-        $this->passwordEncoder = $passwordEncoder;
+        $this->passwordHasher = $passwordHasher;
     }
 
 
@@ -63,7 +63,7 @@ public function load(ObjectManager $manager)
         $userBolos
             ->setUsername('bolos')
             ->setEmail('[email protected]')
-            ->setPassword($this->passwordEncoder->encodePassword($userBolos, 'bolos'))
+            ->setPassword($this->passwordHasher->hashPassword($userBolos, 'bolos'))
             ->setUserClass($basicUser)
             ->setCreatedAt(new DateTime('2020-02-02'))
             ->setParanoia(0)
@@ -74,7 +74,7 @@ public function load(ObjectManager $manager)
         $userVincent
             ->setUsername('vincent')
             ->setEmail('[email protected]')
-            ->setPassword($this->passwordEncoder->encodePassword($userVincent, 'vincent'))
+            ->setPassword($this->passwordHasher->hashPassword($userVincent, 'vincent'))
             ->setUserClass($member)
             ->setCreatedAt(new DateTime('2020-06-02'))
             ->setParanoia(0)
@@ -87,7 +87,7 @@ public function load(ObjectManager $manager)
         $userGuillaume
             ->setUsername('guillaume')
             ->setEmail('[email protected]')
-            ->setPassword($this->passwordEncoder->encodePassword($userGuillaume, 'gp231299'))
+            ->setPassword($this->passwordHasher->hashPassword($userGuillaume, 'gp231299'))
             ->setUserClass($basicUser)
             ->setCreatedAt(new DateTime('2020-04-04'))
             ->setParanoia(0)
@@ -99,7 +99,7 @@ public function load(ObjectManager $manager)
         $userLea
             ->setUsername('leatine')
             ->setEmail('[email protected]')
-            ->setPassword($this->passwordEncoder->encodePassword($userLea, 'leatine'))
+            ->setPassword($this->passwordHasher->hashPassword($userLea, 'leatine'))
             ->setUserClass($member)
             ->setCreatedAt(new DateTime('2019-06-06'))
             ->setParanoia(0)
@@ -111,7 +111,7 @@ public function load(ObjectManager $manager)
         $userNicolas
             ->setUsername('nicolas')
             ->setEmail('[email protected]')
-            ->setPassword($this->passwordEncoder->encodePassword($userNicolas, 'espace'))
+            ->setPassword($this->passwordHasher->hashPassword($userNicolas, 'espace'))
             ->setUserClass($member)
             ->setCreatedAt(new DateTime('2018-01-01'))
             ->setParanoia(1)
@@ -123,7 +123,7 @@ public function load(ObjectManager $manager)
         $userAudrey
             ->setUsername('audrey')
             ->setEmail('[email protected]')
-            ->setPassword($this->passwordEncoder->encodePassword($userAudrey, 'missmogwai'))
+            ->setPassword($this->passwordHasher->hashPassword($userAudrey, 'missmogwai'))
             ->setRole(User::ROLE_MODERATOR)
             ->setUserClass($powerUser)
             ->setCreatedAt(new DateTime('2018-03-03'))
@@ -136,7 +136,7 @@ public function load(ObjectManager $manager)
         $userGuilhem
             ->setUsername('guilhem')
             ->setEmail('[email protected]')
-            ->setPassword($this->passwordEncoder->encodePassword($userGuilhem, 'guilhem'))
+            ->setPassword($this->passwordHasher->hashPassword($userGuilhem, 'guilhem'))
             ->setUserClass($elite)
             ->setCreatedAt(new DateTime('2017-09-09'))
             ->setParanoia(2)
@@ -148,7 +148,7 @@ public function load(ObjectManager $manager)
         $userRelou
             ->setUsername('relou')
             ->setEmail('[email protected]')
-            ->setPassword($this->passwordEncoder->encodePassword($userRelou, 'relou'))
+            ->setPassword($this->passwordHasher->hashPassword($userRelou, 'relou'))
             ->setUserClass($member)
             ->setCreatedAt(new DateTime('2019-09-09'))
             ->setParanoia(0)
@@ -161,7 +161,7 @@ public function load(ObjectManager $manager)
         $userEscargot
             ->setUsername('escargot')
             ->setEmail('[email protected]')
-            ->setPassword($this->passwordEncoder->encodePassword($userEscargot, 'escargot'))
+            ->setPassword($this->passwordHasher->hashPassword($userEscargot, 'escargot'))
             ->setUserClass($basicUser)
             ->setCreatedAt(new DateTime('2013-03-03'))
             ->setLastActivity(new DateTime('2013-04-04'))

src/Entity/User.php

@@ -35,14 +35,15 @@
 use Symfony\Component\Validator\Constraints as Assert;
 use Doctrine\ORM\Mapping as ORM;
 use InvalidArgumentException;
+use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
 use Symfony\Component\Security\Core\User\UserInterface;
 
 /**
  * @ORM\Entity(repositoryClass=UserRepository::class)
  * @UniqueEntity(fields={"username"}, message="There is already an account with this username")
  * @UniqueEntity(fields={"email"}, message="There is already an account with this email adress")
  */
-class User implements UserInterface
+class User implements UserInterface, PasswordAuthenticatedUserInterface
 {
     public const ROLE_USER      =   0;
     public const ROLE_MODERATOR =  50;
@@ -240,6 +241,11 @@ public function setUsername(string $username): self
         return $this;
     }
 
+    public function getUserIdentifier(): string
+    {
+        return (string) $this->username;
+    }
+
     public function getRole(): int
     {
         return $this->role;

src/EventSubscriber/ActivitySubscriber.php

@@ -72,7 +72,7 @@ public static function getSubscribedEvents()
 
     public function onKernelTerminate(TerminateEvent $event): void
     {
-        if ($event->isMasterRequest()) {
+        if ($event->isMainRequest()) {
             $user = $this->security->getUser();
             $delay = $this->parameterBag->get('app.last_activity_delay');
             if (($user instanceof User) && $user->getLastActivity() < new DateTime("$delay minute ago")) {

src/Form/SignUpType.php

@@ -46,14 +46,6 @@
 
 class SignUpType extends AbstractType
 {
-    /** @var UserpasswordEncoderInterface */
-    private $passwordEncoder;
-
-    public function __construct(UserPasswordEncoderInterface $passwordEncoder)
-    {
-        $this->passwordEncoder = $passwordEncoder;
-    }
-
     public function buildForm(FormBuilderInterface $builder, array $options): void
     {
         /** @var bool */