[1.0.x] Social Auth Entra ID

Thank you for applying!

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 run phpcs --standard=Drupal,DrupalPractice on the project, which alone fixes most of what reviewers would report.
• 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 won't be changed by this application and no other user will be able to opt projects into security advisory policy.
• 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 Code Review Administrator before commenting on newly created applications. Code Review Administrators 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. Fix phpcs issues.

phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml social_auth_entra_id/

FILE: social_auth_entra_id/social_auth_entra_id.routing.yml
----------------------------------------------------------------------
FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES
----------------------------------------------------------------------
 15 | WARNING | Open page callback found, please add a comment before the line why there is no access restriction
 24 | WARNING | Open page callback found, please add a comment before the line why there is no access restriction
----------------------------------------------------------------------

FILE: social_auth_entra_id/social_auth_entra_id.permissions.yml
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 3 | ERROR | [x] Expected 1 newline at end of file; 2 found
----------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------

FILE: social_auth_entra_id/src/Plugin/Block/EntraIdLoginBlockBlock.php
----------------------------------------------------------------------
FOUND 0 ERRORS AND 3 WARNINGS AFFECTING 3 LINES
----------------------------------------------------------------------
 29 | WARNING | \Drupal calls should be avoided in classes, use dependency injection instead
 44 | WARNING | Unused variable $link.
 52 | WARNING | Unused variable $link.
----------------------------------------------------------------------

FILE: social_auth_entra_id/tests/src/Unit/Controller/SocialAuthEntraIdControllerTest.php
----------------------------------------------------------------------
FOUND 6 ERRORS AFFECTING 6 LINES
----------------------------------------------------------------------
  33 | ERROR | Missing @var tag in member variable comment
  35 | ERROR | Missing member variable doc comment
  36 | ERROR | Missing member variable doc comment
  37 | ERROR | Missing member variable doc comment
  38 | ERROR | Missing member variable doc comment
 123 | ERROR | The array declaration extends to column 81 (the limit is 80). The array content should be split up over multiple lines
----------------------------------------------------------------------

2. FILE: README.txt

Replace README.txt with README.md, that should follow the content and formatting described in README.md template.

3. FILE: social_auth_entra_id.module

/**
 * @file
 * Primary module hooks for social_auth_entra_id module.
 */

Drupal does not have primary and secondary hooks. Instead of that, it is preferable to use the usual description: Hook implementations for the [module name] module. where [module name] is the name of the module given in its .info.yml file.

Rest seems fine to me.

Let’s wait for other reviewers to take a look. If everything goes fine, you will get the role.

Thanks for submitting!

The block configuration form is vulnerable to XSS exploits. Any editor user that has the permission "Administer blocks" can insert malicious scripts into the Login Text field like <script>alert('XSS');</script>.

The permission "Administer blocks" is not restricted for access and often given to content editors. They should not be able to take over the site with an XSS attack.

Solution: do you need to use the Markup class? If you just pass your assembled string to #markup then Drupal will sanitize bad scripts for you? Or does it then strip your i HTML tag? Then you could use Xss::filter() to only allow some tags you need.

And please don't remove the security tag, we keep that for statistics and to show examples of security problems.

Not strictly speaking security so I wouldn't suggest this blocking approval but a few concerns:
- Caching: unless there is some need, I'd strongly suggest caching based on user context, and not setting max-age to 0. That will disable full page cache on any page with that block. Caching based on user will let anonymous pages still be cached at least.
- *.module file is not required if it is empty.
- weak dependency on font-awesome (fa-* classes) with no mention of font-awesome requirements

I am changing priority as per Issue priorities.

When #allowed_tags is used, there is no need to pass the markup to XSS::filter(), because with #allowed_tags that is done by Drupal core.

I do not have the time to make a full review; that is why I did not change the issue status.

• The following points are just a start and don't necessarily encompass all of the changes that may be necessary
• A specific point may just be an example and may apply in other places
• A review is about code that does not follow the coding standards, contains possible security issue, or does not correctly use the Drupal API
• The single review points are not ordered, not even by importance

src/Controller/SocialAuthEntraIdController.php

Since that class does not use methods from the parent class, it does not need to use ControllerBase as parent class. Controllers do not need to have a parent class; as long as they implement \Drupal\Core\DependencyInjection\ContainerInjectionInterface, they are fine.

      catch (\Exception $e) {
        $this->messenger->addError($this->t('An error occurred.'));
        $this->loggerFactory->get('social_auth_entra_id')->error($e->getMessage());
      }

The $message parameter passed to the LoggerInterface methods must be a literal string that uses placeholders. It is not a translatable string returned from t() nor $this->t(), a string concatenation, a value returned from a function/method, nor a variable containing an exception object.

src/Plugin/Block/EntraIdLoginBlockBlock.php

   $safe_login_text = Xss::filter($login_text, ['i', 'strong', 'em', 'b', 'u', 'span']);

    return [
      'content' => [
        '#type' => 'link',
        '#title' => [
          '#markup' => $safe_login_text,
          '#allowed_tags' => ['i', 'strong', 'em', 'b', 'u', 'span'],
        ],
        '#url' => Url::fromRoute('social_auth_entra_id.redirect'),
        '#attributes' => ['class' => [$custom_class]],
        '#attached' => [
          'library' => [
            'social_auth_entra_id/font-awesome',
          ],
        ],
        '#cache' => [
          'contexts' => ['user'],
        ],
      ],
    ];

When #allowed_tags is used, there is no need to pass the markup to XSS::filter(), because with #allowed_tags that is done by Drupal core.

Thank you for your contribution and for your patience with the review process!

I am going to update your account so you can opt into security advisory coverage any project you create, including the projects you already created.

These are some recommended readings to help you with maintainership:

• Dries' post on Responsible maintainers
• Maintainership
• Git version control system
• Issue procedures and etiquette
• Maintaining and responding to issues for a project
• Release naming conventions.

You can find more contributors chatting on Slack or IRC in #drupal-contribute. So, come hang out and stay involved!
Anyone is welcome to participate in the review process. Please consider reviewing other projects that are pending review. I encourage you to learn more about that process and join the group of reviewers.

I thank also all the reviewers for helping with these applications.