symfony · dbu · Nov 14, 2023 · Nov 20, 2023 · nicolas-grekas · Nov 30, 2023
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -2091,6 +2091,15 @@ private function addMailerSection(ArrayNodeDefinition $rootNode, callable $enabl
                                 ->end()
                             ->end()
                         ->end()
+                        ->arrayNode('smtp')
+                            ->fixXmlConfig('authenticator')
+                            ->children()
+                                ->arrayNode('authenticators')
+                                    ->info('Services implementing AuthenticatorInterface to use with the EsmtpTransport')
+                                    ->prototype('scalar')->end()
+                                ->end()
+                            ->end()
+                        ->end()
                     ->end()
                 ->end()
             ->end()

diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -2556,6 +2556,11 @@ private function registerMailerConfiguration(array $config, ContainerBuilder $co
         } else {
             $mailer->replaceArgument(1, $messageBus ? new Reference($messageBus) : new Reference('messenger.default_bus', ContainerInterface::NULL_ON_INVALID_REFERENCE));
         }
+        $authenticators = [];
+        foreach ($config['smtp']['authenticators'] ?? [] as $authenticator) {
+            $authenticators[] = new Reference($authenticator);
+        }
+        $container->getDefinition('mailer.transport_factory.smtp')->setArgument(3, $authenticators);
 
         $classToServices = [
             MailerBridge\Brevo\Transport\BrevoTransportFactory::class => 'mailer.transport_factory.brevo',

diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd b/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd
@@ -737,6 +737,7 @@
             <xsd:element name="transport" type="mailer_transport" minOccurs="0" maxOccurs="unbounded" />
             <xsd:element name="envelope" type="mailer_envelope" minOccurs="0" maxOccurs="1" />
             <xsd:element name="header" type="header" minOccurs="0" maxOccurs="unbounded" />
+            <xsd:element name="smtp" type="mailer_smtp" minOccurs="0" maxOccurs="1" />
         </xsd:sequence>
         <xsd:attribute name="enabled" type="xsd:boolean" />
         <xsd:attribute name="dsn" type="xsd:string" />
@@ -758,6 +759,12 @@
         </xsd:sequence>
     </xsd:complexType>
 
+    <xsd:complexType name="mailer_smtp">
+        <xsd:sequence>
+            <xsd:element name="authenticator" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
+        </xsd:sequence>
+    </xsd:complexType>
+
     <xsd:complexType name="http_cache">
         <xsd:sequence>
             <xsd:element name="private-header" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />

diff --git a/...dle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/mailer_with_authenticators.php b/...dle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/mailer_with_authenticators.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection\Loader\Configurator;
+
+return static function (ContainerConfigurator $container) {
+    $container->extension('framework', [
+        'annotations' => false,
+        'http_method_override' => false,
+    'handle_all_throwables' => true,
+    'php_errors' => ['log' => true],
+        'mailer' => [
+            'smtp' => [
+                'authenticators' => [
+                    'my_authenticator_service1',
+                    'my_authenticator_service2',
+                ],
+            ],
+        ],
+    ]);
+};
diff --git a/...dle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/mailer_with_authenticators.xml b/...dle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/mailer_with_authenticators.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xmlns:framework="http://symfony.com/schema/dic/symfony"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
+                        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
+
+    <framework:config http-method-override="false" handle-all-throwables="true">
+        <framework:annotations enabled="false" />
+        <framework:php-errors log="true" />
+        <framework:mailer dsn="smtp://example.com">
+            <framework:smtp>
+                <framework:authenticator>my_authenticator_service1</framework:authenticator>
+                <framework:authenticator>my_authenticator_service2</framework:authenticator>
+            </framework:smtp>
+        </framework:mailer>
+    </framework:config>
+</container>
diff --git a/...dle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/mailer_with_authenticators.yml b/...dle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/mailer_with_authenticators.yml
@@ -0,0 +1,11 @@
+framework:
+    annotations: false
+    http_method_override: false
+    handle_all_throwables: true
+    php_errors:
+        log: true
+    mailer:
+        smtp:
+            authenticators:
+                - my_authenticator_service1
+                - my_authenticator_service2
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTestCase.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTestCase.php
@@ -2031,6 +2031,13 @@ public function testMailerWithSpecificMessageBus()
         $this->assertEquals(new Reference('app.another_bus'), $container->getDefinition('mailer.mailer')->getArgument(1));
     }
 
+    public function testMailerWithAuthenticators()
+    {
+        $container = $this->createContainerFromFile('mailer_with_authenticators');
+
+        $this->assertCount(2, $container->getDefinition('mailer.mailer')->getArgument(3));
+    }
+
     public function testHttpClientMockResponseFactory()
     {
         $container = $this->createContainerFromFile('http_client_mock_response_factory');

diff --git a/src/Symfony/Component/Mailer/Transport/Smtp/Auth/AuthTokenProviderInterface.php b/src/Symfony/Component/Mailer/Transport/Smtp/Auth/AuthTokenProviderInterface.php
@@ -0,0 +1,26 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Mailer\Transport\Smtp\Auth;
+
+/**
+ * The auth token provider knows how to create a valid token for the XOAuth2Authenticator.
+ *
+ * Usually with OAuth, you will need to do some web request to fetch the token.
+ * You also want to cache the token for as long as it is valid.
+ */
+interface AuthTokenProviderInterface
+{
+    /**
+     * Acquire the authentication token.
+     */
+    public function getToken(): string;
+}
diff --git a/src/Symfony/Component/Mailer/Transport/Smtp/Auth/XOAuth2Authenticator.php b/src/Symfony/Component/Mailer/Transport/Smtp/Auth/XOAuth2Authenticator.php
@@ -22,6 +22,13 @@
  */
 class XOAuth2Authenticator implements AuthenticatorInterface
 {
+    private ?AuthTokenProviderInterface $tokenProvider;
+
+    public function __construct(AuthTokenProviderInterface $tokenProvider = null)
+    {
+        $this->tokenProvider = $tokenProvider;
+    }
+
     public function getAuthKeyword(): string
     {
         return 'XOAUTH2';
@@ -32,6 +39,7 @@ public function getAuthKeyword(): string
      */
     public function authenticate(EsmtpTransport $client): void
     {
-        $client->executeCommand('AUTH XOAUTH2 '.base64_encode('user='.$client->getUsername()."\1auth=Bearer ".$client->getPassword()."\1\1")."\r\n", [235]);
+        $token = $this->tokenProvider?->getToken() : $client->getPassword();
+        $client->executeCommand('AUTH XOAUTH2 '.base64_encode('user='.$client->getUsername()."\1auth=Bearer ".$token."\1\1")."\r\n", [235]);
     }
 }
diff --git a/src/Symfony/Component/Mailer/Transport/Smtp/EsmtpTransport.php b/src/Symfony/Component/Mailer/Transport/Smtp/EsmtpTransport.php
@@ -27,11 +27,17 @@
  */
 class EsmtpTransport extends SmtpTransport
 {
+    /**
+     * @var AuthenticatorInterface[]
+     */
     private array $authenticators = [];
     private string $username = '';
     private string $password = '';
     private array $capabilities;
 
+    /**
+     * @param AuthenticatorInterface[]|null $authenticators
+     */
     public function __construct(string $host = 'localhost', int $port = 0, bool $tls = null, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null, AbstractStream $stream = null, array $authenticators = null)
     {
         parent::__construct($stream, $dispatcher, $logger);

diff --git a/src/Symfony/Component/Mailer/Transport/Smtp/EsmtpTransportFactory.php b/src/Symfony/Component/Mailer/Transport/Smtp/EsmtpTransportFactory.php
@@ -11,23 +11,41 @@
 
 namespace Symfony\Component\Mailer\Transport\Smtp;
 
+use Psr\EventDispatcher\EventDispatcherInterface;
+use Psr\Log\LoggerInterface;
 use Symfony\Component\Mailer\Transport\AbstractTransportFactory;
 use Symfony\Component\Mailer\Transport\Dsn;
+use Symfony\Component\Mailer\Transport\Smtp\Auth\AuthenticatorInterface;
 use Symfony\Component\Mailer\Transport\Smtp\Stream\SocketStream;
 use Symfony\Component\Mailer\Transport\TransportInterface;
+use Symfony\Contracts\HttpClient\HttpClientInterface;
 
 /**
  * @author Konstantin Myakshin <[email protected]>
  */
 final class EsmtpTransportFactory extends AbstractTransportFactory
 {
+    /**
+     * @var AuthenticatorInterface[]
+     */
+    private ?array $authenticators;
+
+    /**
+     * @param AuthenticatorInterface[]|null $authenticators
+     */
+    public function __construct(EventDispatcherInterface $dispatcher = null, HttpClientInterface $client = null, LoggerInterface $logger = null, array $authenticators = null)
+    {
+        parent::__construct($dispatcher, $client, $logger);
+        $this->authenticators = $authenticators;
+    }
+
     public function create(Dsn $dsn): TransportInterface
     {
         $tls = 'smtps' === $dsn->getScheme() ? true : null;
         $port = $dsn->getPort(0);
         $host = $dsn->getHost();
 
-        $transport = new EsmtpTransport($host, $port, $tls, $this->dispatcher, $this->logger);
+        $transport = new EsmtpTransport($host, $port, $tls, $this->dispatcher, $this->logger, null, $this->authenticators);
 
         /** @var SocketStream $stream */
         $stream = $transport->getStream();