Removed "services" prototype node from "custom_authenticator"

wouterj · wouterj · commit b17c440b811c · 2020-05-23T11:58:19.000+02:00
diff --git a/src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/CustomAuthenticatorFactory.php b/src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/CustomAuthenticatorFactory.php
@@ -35,7 +35,7 @@ public function getPosition(): string
 
     public function getKey(): string
     {
-        return 'custom_authenticator';
+        return 'custom_authenticators';
     }
 
     /**
@@ -44,19 +44,21 @@ public function getKey(): string
     public function addConfiguration(NodeDefinition $builder)
     {
         $builder
-            ->fixXmlConfig('service')
-            ->children()
-                ->arrayNode('services')
-                    ->info('An array of service ids for all of your "authenticators"')
-                    ->requiresAtLeastOneElement()
-                    ->prototype('scalar')->end()
-                ->end()
+            ->info('An array of service ids for all of your "authenticators"')
+            ->requiresAtLeastOneElement()
+            ->beforeNormalization()
+                ->ifString()
+                ->then(function ($v) { return [$v]; })
             ->end()
-        ;
+            ->prototype('scalar')->end();
+
+        // get the parent array node builder ("firewalls") from inside the children builder
+        $factoryRootNode = $builder->end()->end();
+        $factoryRootNode->fixXmlConfig('custom_authenticator');
     }
 
     public function createAuthenticator(ContainerBuilder $container, string $firewallName, array $config, string $userProviderId): array
     {
-        return $config['services'];
+        return $config;
     }
 }
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/DependencyInjection/SecurityExtensionTest.php b/src/Symfony/Bundle/SecurityBundle/Tests/DependencyInjection/SecurityExtensionTest.php
@@ -24,11 +24,15 @@
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\ExpressionLanguage\Expression;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 use Symfony\Component\Security\Core\Exception\AuthenticationException;
 use Symfony\Component\Security\Core\User\UserInterface;
 use Symfony\Component\Security\Core\User\UserProviderInterface;
-use Symfony\Component\Security\Guard\AuthenticatorInterface;
+use Symfony\Component\Security\Guard\AuthenticatorInterface as GuardAuthenticatorInterface;
+use Symfony\Component\Security\Http\Authenticator\AuthenticatorInterface;
+use Symfony\Component\Security\Http\Authenticator\HttpBasicAuthenticator;
+use Symfony\Component\Security\Http\Authenticator\Passport\PassportInterface;
 
 class SecurityExtensionTest extends TestCase
 {
@@ -520,6 +524,41 @@ public function testAlwaysAuthenticateBeforeGrantingCannotBeTrueWithAuthenticati
         $container->compile();
     }
 
+    /**
+     * @dataProvider provideConfigureCustomAuthenticatorData
+     */
+    public function testConfigureCustomAuthenticator(array $firewall, array $expectedAuthenticators)
+    {
+        $container = $this->getRawContainer();
+        $container->loadFromExtension('security', [
+            'enable_authenticator_manager' => true,
+            'providers' => [
+                'first' => ['id' => 'users'],
+            ],
+
+            'firewalls' => [
+                'main' => $firewall,
+            ],
+        ]);
+
+        $container->compile();
+
+        $this->assertEquals($expectedAuthenticators, array_map('strval', $container->getDefinition('security.authenticator.manager.main')->getArgument(0)));
+    }
+
+    public function provideConfigureCustomAuthenticatorData()
+    {
+        yield [
+            ['custom_authenticator' => TestAuthenticator::class],
+            [TestAuthenticator::class],
+        ];
+
+        yield [
+            ['custom_authenticators' => [TestAuthenticator::class, HttpBasicAuthenticator::class]],
+            [TestAuthenticator::class, HttpBasicAuthenticator::class],
+        ];
+    }
+
     protected function getRawContainer()
     {
         $container = new ContainerBuilder();
@@ -547,7 +586,30 @@ protected function getContainer()
     }
 }
 
-class NullAuthenticator implements AuthenticatorInterface
+class TestAuthenticator implements AuthenticatorInterface
+{
+    public function supports(Request $request): ?bool
+    {
+    }
+
+    public function authenticate(Request $request): PassportInterface
+    {
+    }
+
+    public function createAuthenticatedToken(PassportInterface $passport, string $firewallName): TokenInterface
+    {
+    }
+
+    public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName): ?Response
+    {
+    }
+
+    public function onAuthenticationFailure(Request $request, AuthenticationException $exception): ?Response
+    {
+    }
+}
+
+class NullAuthenticator implements GuardAuthenticatorInterface
 {
     public function start(Request $request, AuthenticationException $authException = null)
     {

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public function getPosition(): string`
`35`	`35`
`36`	`36`	`public function getKey(): string`
`37`	`37`	`{`
`38`		`- return 'custom_authenticator';`
	`38`	`+ return 'custom_authenticators';`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`/**`
`@@ -44,19 +44,21 @@ public function getKey(): string`
`44`	`44`	`public function addConfiguration(NodeDefinition $builder)`
`45`	`45`	`{`
`46`	`46`	`$builder`
`47`		`- ->fixXmlConfig('service')`
`48`		`- ->children()`
`49`		`- ->arrayNode('services')`
`50`		`- ->info('An array of service ids for all of your "authenticators"')`
`51`		`- ->requiresAtLeastOneElement()`
`52`		`- ->prototype('scalar')->end()`
`53`		`- ->end()`
	`47`	`+ ->info('An array of service ids for all of your "authenticators"')`
	`48`	`+ ->requiresAtLeastOneElement()`
	`49`	`+ ->beforeNormalization()`
	`50`	`+ ->ifString()`
	`51`	`+ ->then(function ($v) { return [$v]; })`
`54`	`52`	`->end()`
`55`		`- ;`
	`53`	`+ ->prototype('scalar')->end();`
	`54`	`+`
	`55`	`+ // get the parent array node builder ("firewalls") from inside the children builder`
	`56`	`+ $factoryRootNode = $builder->end()->end();`
	`57`	`+ $factoryRootNode->fixXmlConfig('custom_authenticator');`
`56`	`58`	`}`
`57`	`59`
`58`	`60`	`public function createAuthenticator(ContainerBuilder $container, string $firewallName, array $config, string $userProviderId): array`
`59`	`61`	`{`
`60`		`- return $config['services'];`
	`62`	`+ return $config;`
`61`	`63`	`}`
`62`	`64`	`}`