[Security][SecurityBundle] Allow passing attributes to passport via Security::login()

Author: alexandre-daubois

Diff for: CHANGELOG.md

@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Allow configuring the secret used to sign login links
+ * Allow passing optional passport attributes to `Security::login()`
 
 7.1
 ---

Diff for: Security.php

@@ -74,14 +74,15 @@ public function getFirewallConfig(Request $request): ?FirewallConfig
     }
 
     /**
-     * @param UserInterface    $user              The user to authenticate
-     * @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
-     * @param string|null      $firewallName      The firewall name - required only if multiple firewalls are configured
-     * @param BadgeInterface[] $badges            Badges to add to the user's passport
+     * @param UserInterface        $user              The user to authenticate
+     * @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
+     * @param string|null          $firewallName      The firewall name - required only if multiple firewalls are configured
+     * @param BadgeInterface[]     $badges            Badges to add to the user's passport
+     * @param array<string, mixed> $attributes        Attributes to add to the user's passport
      *
      * @return Response|null The authenticator success response if any
      */
-    public function login(UserInterface $user, ?string $authenticatorName = null, ?string $firewallName = null, array $badges = []): ?Response
+    public function login(UserInterface $user, ?string $authenticatorName = null, ?string $firewallName = null, array $badges = [], array $attributes = []): ?Response
     {
         $request = $this->container->get('request_stack')->getCurrentRequest();
         if (null === $request) {
@@ -99,7 +100,7 @@ public function login(UserInterface $user, ?string $authenticatorName = null, ?s
         $userCheckerLocator = $this->container->get('security.user_checker_locator');
         $userCheckerLocator->get($firewallName)->checkPreAuth($user);
 
-        return $this->container->get('security.authenticator.managers_locator')->get($firewallName)->authenticateUser($user, $authenticator, $request, $badges);
+        return $this->container->get('security.authenticator.managers_locator')->get($firewallName)->authenticateUser($user, $authenticator, $request, $badges, $attributes);
     }
 
     /**

Diff for: Security/UserAuthenticator.php

@@ -38,8 +38,8 @@ public function __construct(FirewallMap $firewallMap, ContainerInterface $userAu
         $this->requestStack = $requestStack;
     }
 
-    public function authenticateUser(UserInterface $user, AuthenticatorInterface $authenticator, Request $request, array $badges = []): ?Response
+    public function authenticateUser(UserInterface $user, AuthenticatorInterface $authenticator, Request $request, array $badges = [], array $attributes = []): ?Response
     {
-        return $this->getForFirewall()->authenticateUser($user, $authenticator, $request, $badges);
+        return $this->getForFirewall()->authenticateUser($user, $authenticator, $request, $badges, $attributes);
     }
 }

Diff for: Tests/SecurityTest.php

@@ -33,6 +33,7 @@
 use Symfony\Component\Security\Csrf\CsrfTokenManagerInterface;
 use Symfony\Component\Security\Http\Authentication\UserAuthenticatorInterface;
 use Symfony\Component\Security\Http\Authenticator\AuthenticatorInterface;
+use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;
 use Symfony\Component\Security\Http\Event\LogoutEvent;
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 use Symfony\Contracts\Service\ServiceProviderInterface;
@@ -135,6 +136,7 @@ public function testLogin()
         $userAuthenticator = $this->createMock(UserAuthenticatorInterface::class);
         $user = $this->createMock(UserInterface::class);
         $userChecker = $this->createMock(UserCheckerInterface::class);
+        $badge = new UserBadge('foo');
 
         $container = new Container();
         $container->set('request_stack', $requestStack);
@@ -143,7 +145,7 @@ public function testLogin()
         $container->set('security.user_checker_locator', $this->createContainer('main', $userChecker));
 
         $firewallMap->expects($this->once())->method('getFirewallConfig')->willReturn($firewall);
-        $userAuthenticator->expects($this->once())->method('authenticateUser')->with($user, $authenticator, $request);
+        $userAuthenticator->expects($this->once())->method('authenticateUser')->with($user, $authenticator, $request, [$badge], ['foo' => 'bar']);
         $userChecker->expects($this->once())->method('checkPreAuth')->with($user);
 
         $firewallAuthenticatorLocator = $this->createMock(ServiceProviderInterface::class);
@@ -161,7 +163,7 @@ public function testLogin()
 
         $security = new Security($container, ['main' => $firewallAuthenticatorLocator]);
 
-        $security->login($user);
+        $security->login($user, badges: [$badge], attributes: ['foo' => 'bar']);
     }
 
     public function testLoginReturnsAuthenticatorResponse()