[1.x] Symfony Mailer Office365

Thank you for applying!

Before giving links helpful to understand how the review process works, what to expect from a review, and what to do to avoid a review takes more time than needed, I would like to thank all the reviewers for the work they do.
These applications are volunters-driven, which also means it is not possible to predict when an application will be marked fixed and the applicant will get the permission to opt projects into security advisory policy. While we aim to make an application as quick as possible, it is also important for us that more people review the project used for an application. In this way, we make sure applications do not miss some important points that should be instead reported.
Applications are not meant to be complete debugging sessions that eliminate every existing bug, though. I apologize if sometimes applications seem to go into too-detailed reviews.

Please read Review process for security advisory coverage: What to expect for more details and Security advisory coverage application checklist to understand what reviewers look for. Tips for ensuring a smooth review gives some hints for a smoother review.

The important notes are the following.

• If you have not done it yet, you should enable GitLab CI for the project and fix the PHP_CodeSniffer errors/warnings it reports.
• For the time this application is open, only your commits are allowed.
• The purpose of this application is giving you a new drupal.org role that allows you to opt projects into security advisory coverage, either projects you already created, or projects you will create. The project status will not be changed by this application; once this application is closed, you will be able to change the project status from Not covered to Opt into security advisory coverage. This is possible only 14 days after the project is created.
  
  Keep in mind that once the project is opted into security advisory coverage, only Security Team members may change coverage.
• Only the person who created the application will get the permission to opt projects into security advisory coverage. No other person will get the same permission from the same application; that applies also to co-maintainers/maintainers of the project used for the application.
• We only accept an application per user. If you change your mind about the project to use for this application, or it is necessary to use a different project for the application, please update the issue summary with the link to the correct project and the issue title with the project name and the branch to review.

To the reviewers

Please read How to review security advisory coverage applications, Application workflow, What to cover in an application review, and Tools to use for reviews.

The important notes are the following.

• It is preferable to wait for a project moderator before posting the first comment on newly created applications. Project moderators will do some preliminary checks that are necessary before any change on the project files is suggested.
• Reviewers should show the output of a CLI tool only once per application.
• It may be best to have the applicant fix things before further review.

For new reviewers, I would also suggest to first read In which way the issue queue for coverage applications is different from other project queues.

1. FILE: README.md

The README file is missing the required sections - Requirements, Installation and Configuration.

2. FILE: symfony_mailer_office365.info.yml

package: Custom

Custom is not a package value used for projects hosted on drupal.org. That is not a mandatory value, and it can be omitted.

3. FILE: symfony_mailer_office365.module

For a new module that aims to be compatible with Drupal 10 and Drupal 11, I would rather implement hooks as class methods as described in Support for object oriented hook implementations using autowired services.
It would require increasing the minimum Drupal 10 version supported, but Drupal 10.1 is no longer supported.

4. FILE: src/Office365EsmtpTransportFactory.php

  /**
   * The XOAUTH2 authenticator instance.
   *
   * @var \Drupal\symfony_mailer_office365\Transport\Smtp\Auth\XOAuth2Authenticator
   */
  protected $authenticator;

  /**
   * Constructs the OAuthEsmtpTransportFactory object.
   *
   * @param \Drupal\symfony_mailer_office365\Transport\Smtp\Auth\XOAuth2Authenticator $authenticator
   *   The XOAUTH2 authenticator used for creating transport.
   * @param \Psr\EventDispatcher\EventDispatcherInterface|null $dispatcher
   *   Optional event dispatcher.
   * @param \Sentry\HttpClient\HttpClientInterface|null $client
   *   Optional HTTP client.
   * @param \Psr\Log\LoggerInterface|null $logger
   *   Optional logger interface.
   */
  public function __construct(
    XOAuth2Authenticator $authenticator,
    ?EventDispatcherInterface $dispatcher = NULL,
    ?HttpClientInterface $client = NULL,
    ?LoggerInterface $logger = NULL,
  ) {
    parent::__construct($dispatcher, $client, $logger);
    $this->authenticator = $authenticator;
  }

Modules which are compatible with Drupal 10 and higher versions are expected to use constructor property promotion.

5. FILE: src/Form/Office365ConfigForm.php

ConfigFormBase::__construct() parameters changed in Drupal 10.2. See the change record.

With Drupal 10 and Drupal 11, there is no longer need to use #default_value for each form element, when the parent class is ConfigFormBase: It is sufficient to use #config_target, as in the following code.

    $form['image_toolkit'] = [
      '#type' => 'radios',
      '#title' => $this->t('Select an image processing toolkit'),
      '#config_target' => 'system.image:toolkit',
      '#options' => [],
    ];

Using that code, it is no longer needed to save the configuration values in the form submission handler: The parent class will take care of that.
For this change, it is necessary to require at least Drupal 10.3, but that is not an issue, since Drupal 10.2.x is no longer supported.

Reviewed 1.x at e6b137e.

src/Office365EsmtpTransportFactory.php

  public function supports(Dsn $dsn): bool {
    return TRUE;
  }

This factory is tagged mailer.transport_factory, so with this override it claims every DSN of every transport on the site (smtp://, sendmail://, the ones of other modules), and which factory wins depends on the collection order. AbstractTransportFactory::supports() already checks the scheme against getSupportedSchemes(); the override should be removed.

symfony_mailer_office365.routing.yml

symfony_mailer_office365.callback:
  path: '/office365/oauth/callback'
  ...
  requirements:
    _permission: 'access content'

The callback stores a site-wide token. The only person who lands on it is the administrator who started the login from the configuration form, so it should require administer mailer like the form does, not a permission anonymous users have.

src/TokenStateManager.php

  public function getLoginUrl(): string {
    $url = $this->provider->getAuthorizationUrl() . "&login_hint=" . $this->getMail();
    // Store the provider-generated state so the callback can validate it.
    $this->state->set('office365_oauth_state', $this->provider->getState());
    return $url;
  }

This runs from buildForm(), so every GET of the configuration form writes a new OAuth state, and the state is global rather than tied to the session that started the login: two administrators with the form open overwrite each other. Generate the state when the login link is followed (a route that redirects) and keep it in the private temp store of that user. The mail address is also concatenated into the URL without encoding; the League provider accepts getAuthorizationUrl(['login_hint' => $mail]) and encodes it.

src/Plugin/MailerTransport/Office365OAuthTransport.php

  public function defaultConfiguration() {
    $config = $this->configFactory->get('symfony_mailer_office365.config');
    return [
      ...
      'client_id' => $config->get('client_id'),
      'client_secret' => $config->get('client_secret'),
      'tenant_id' => $config->get('tenant_id'),
    ];
  }

The credentials are copied into the transport plugin configuration, which Symfony Mailer saves in its transport config entity. The client secret then lives in a second configuration object, is exported with the site configuration, and getDsn() prefers that stale copy over the module configuration when the credentials change. The DSN should read the module configuration at build time only, and the secret should not be part of the transport configuration at all.

src/Transport/Smtp/Auth/XOAuth2Authenticator.php

    if (!$token) {
      $this->messenger->addError($this->t('Could not connect to Office 365'));
      return;
    }
    ...
    catch (\Exception $e) {
      $this->tokenStateManager->handleException($e, "send mail");
    }

Authentication failures are swallowed: without a token the method returns and the SMTP session continues unauthenticated, and an exception from the AUTH command is logged and ignored, so Symfony believes the client is authenticated and the real error surfaces later in an unrelated place. An authenticator should throw a TransportException. The messenger has no place in a transport that also runs from cron and Drush.

src/Hook/Office365Hooks.php

  public function cron(): void {
    $this->tokenStateManager->refresh(TRUE);
  }

Cron forces a refresh on every run, which requests a new token from Microsoft each time. The README says the refresh happens "if necessary"; refresh() without the argument does exactly that.

src/Form/Office365ConfigForm.php

      '#prefix' => '<p><label><strong>Redirect URL</strong></label><br/>',
      ...
        '#markup' => 'Before logging in, make sure to add the Redirect URL in your Microsoft OAuth Configuration.',
      ...
      '#prefix' => '<p><strong>Expiry date: </strong>',

User-facing strings that are not passed to t().

symfony_mailer_office365.links.task.yml

symfony_mailer.override.status:

The local task key belongs to the Symfony Mailer namespace and collides with any task of the same name defined there. Keys of a module's own tasks are prefixed with the module name.

src/Drush/Commands/Office365DrushCommands.php

create() returns new static from a final class; PHPStan reports it. Drush 12 commands can use AutowireTrait and drop create().

AI-Generated: Yes (AI tools helped with this review; I checked each point myself.)