Initial Drupal 11 with DDEV setup

web/core/modules/basic_auth/tests/modules/basic_auth_test/basic_auth_test.info.yml

@@ -0,0 +1,5 @@
+name: 'HTTP Basic Authentication test'
+type: module
+description: 'Support module for HTTP Basic Authentication testing.'
+package: Testing
+version: VERSION

web/core/modules/basic_auth/tests/modules/basic_auth_test/basic_auth_test.routing.yml

@@ -0,0 +1,16 @@
+basic_auth_test.state.modify:
+  path: '/basic_auth_test/state/modify'
+  defaults:
+    _controller: '\Drupal\basic_auth_test\BasicAuthTestController::modifyState'
+  options:
+    _auth:
+      - basic_auth
+  requirements:
+    _user_is_logged_in: 'TRUE'
+
+basic_auth_test.state.read:
+  path: '/basic_auth_test/state/read'
+  defaults:
+    _controller: '\Drupal\basic_auth_test\BasicAuthTestController::readState'
+  requirements:
+    _access: 'TRUE'

web/core/modules/basic_auth/tests/modules/basic_auth_test/src/BasicAuthTestController.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\basic_auth_test;
+
+/**
+ * Provides routes for HTTP Basic Authentication testing.
+ */
+class BasicAuthTestController {
+
+  /**
+   * @see \Drupal\basic_auth\Tests\Authentication\BasicAuthTest::testControllerNotCalledBeforeAuth()
+   */
+  public function modifyState() {
+    \Drupal::state()->set('basic_auth_test.state.controller_executed', TRUE);
+    return ['#markup' => 'Done'];
+  }
+
+  /**
+   * @see \Drupal\basic_auth\Tests\Authentication\BasicAuthTest::testControllerNotCalledBeforeAuth()
+   */
+  public function readState() {
+    // Mark this page as being uncacheable.
+    \Drupal::service('page_cache_kill_switch')->trigger();
+
+    return [
+      '#markup' => \Drupal::state()->get('basic_auth_test.state.controller_executed') ? 'yep' : 'nope',
+      '#cache' => [
+        'max-age' => 0,
+      ],
+    ];
+  }
+
+}

web/core/modules/basic_auth/tests/src/Functional/BasicAuthTest.php

@@ -0,0 +1,270 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\Tests\basic_auth\Functional;
+
+use Drupal\Core\Url;
+use Drupal\Tests\basic_auth\Traits\BasicAuthTestTrait;
+use Drupal\language\Entity\ConfigurableLanguage;
+use Drupal\Tests\BrowserTestBase;
+use Drupal\user\Entity\Role;
+
+/**
+ * Tests for BasicAuth authentication provider.
+ *
+ * @group basic_auth
+ */
+class BasicAuthTest extends BrowserTestBase {
+
+  use BasicAuthTestTrait;
+
+  /**
+   * Modules installed for all tests.
+   *
+   * @var array
+   */
+  protected static $modules = [
+    'basic_auth',
+    'router_test',
+    'locale',
+    'basic_auth_test',
+  ];
+
+  /**
+   * {@inheritdoc}
+   */
+  protected $defaultTheme = 'stark';
+
+  /**
+   * Tests http basic authentication.
+   */
+  public function testBasicAuth(): void {
+    // Enable page caching.
+    $config = $this->config('system.performance');
+    $config->set('cache.page.max_age', 300);
+    $config->save();
+
+    $account = $this->drupalCreateUser();
+    $url = Url::fromRoute('router_test.11');
+
+    // Ensure we can log in with valid authentication details.
+    $this->basicAuthGet($url, $account->getAccountName(), $account->pass_raw);
+    $this->assertSession()->pageTextContains($account->getAccountName());
+    $this->assertSession()->statusCodeEquals(200);
+    $this->mink->resetSessions();
+    $this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'UNCACHEABLE (request policy)');
+    // Check that Cache-Control is not set to public.
+    $this->assertSession()->responseHeaderNotContains('Cache-Control', 'public');
+
+    // Ensure that invalid authentication details give access denied.
+    $this->basicAuthGet($url, $account->getAccountName(), $this->randomMachineName());
+    $this->assertSession()->pageTextNotContains($account->getAccountName());
+    $this->assertSession()->statusCodeEquals(403);
+    $this->mink->resetSessions();
+
+    // Ensure that the user is prompted to authenticate if they are not yet
+    // authenticated and the route only allows basic auth.
+    $this->drupalGet($url);
+    $this->assertSession()->responseHeaderEquals('WWW-Authenticate', 'Basic realm="' . \Drupal::config('system.site')->get('name') . '"');
+    $this->assertSession()->statusCodeEquals(401);
+
+    // Ensure that a route without basic auth defined doesn't prompt for auth.
+    $this->drupalGet('admin');
+    $this->assertSession()->statusCodeEquals(403);
+
+    $account = $this->drupalCreateUser(['access administration pages']);
+
+    // Ensure that a route without basic auth defined doesn't allow login.
+    $this->basicAuthGet(Url::fromRoute('system.admin'), $account->getAccountName(), $account->pass_raw);
+    $this->assertSession()->linkNotExists('Log out', 'User is not logged in');
+    $this->assertSession()->statusCodeEquals(403);
+    $this->mink->resetSessions();
+
+    // Ensure that pages already in the page cache aren't returned from page
+    // cache if basic auth credentials are provided.
+    $url = Url::fromRoute('router_test.10');
+    $this->drupalGet($url);
+    $this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'MISS');
+    $this->basicAuthGet($url, $account->getAccountName(), $account->pass_raw);
+    $this->assertSession()->responseHeaderEquals('X-Drupal-Cache', 'UNCACHEABLE (request policy)');
+    // Check that Cache-Control is not set to public.
+    $this->assertSession()->responseHeaderNotContains('Cache-Control', 'public');
+  }
+
+  /**
+   * Tests the global login flood control.
+   */
+  public function testGlobalLoginFloodControl(): void {
+    $this->config('user.flood')
+      ->set('ip_limit', 2)
+      // Set a high per-user limit out so that it is not relevant in the test.
+      ->set('user_limit', 4000)
+      ->save();
+
+    $user = $this->drupalCreateUser([]);
+    $incorrect_user = clone $user;
+    $incorrect_user->pass_raw .= 'incorrect';
+    $url = Url::fromRoute('router_test.11');
+
+    // Try 2 failed logins.
+    for ($i = 0; $i < 2; $i++) {
+      $this->basicAuthGet($url, $incorrect_user->getAccountName(), $incorrect_user->pass_raw);
+    }
+
+    // IP limit has reached to its limit. Even valid user credentials will fail.
+    $this->basicAuthGet($url, $user->getAccountName(), $user->pass_raw);
+    $this->assertSession()->statusCodeEquals(403);
+  }
+
+  /**
+   * Tests the per-user login flood control.
+   */
+  public function testPerUserLoginFloodControl(): void {
+    $this->config('user.flood')
+      // Set a high global limit out so that it is not relevant in the test.
+      ->set('ip_limit', 4000)
+      ->set('user_limit', 2)
+      ->save();
+
+    $user = $this->drupalCreateUser([]);
+    $incorrect_user = clone $user;
+    $incorrect_user->pass_raw .= 'incorrect';
+    $user2 = $this->drupalCreateUser([]);
+    $url = Url::fromRoute('router_test.11');
+
+    // Try a failed login.
+    $this->basicAuthGet($url, $incorrect_user->getAccountName(), $incorrect_user->pass_raw);
+
+    // A successful login will reset the per-user flood control count.
+    $this->basicAuthGet($url, $user->getAccountName(), $user->pass_raw);
+    $this->assertSession()->statusCodeEquals(200);
+
+    // Try 2 failed logins for a user. They will trigger flood control.
+    for ($i = 0; $i < 2; $i++) {
+      $this->basicAuthGet($url, $incorrect_user->getAccountName(), $incorrect_user->pass_raw);
+    }
+
+    // Now the user account is blocked.
+    $this->basicAuthGet($url, $user->getAccountName(), $user->pass_raw);
+    $this->assertSession()->statusCodeEquals(403);
+
+    // Try one successful attempt for a different user, it should not trigger
+    // any flood control.
+    $this->basicAuthGet($url, $user2->getAccountName(), $user2->pass_raw);
+    $this->assertSession()->statusCodeEquals(200);
+  }
+
+  /**
+   * Tests compatibility with locale/UI translation.
+   */
+  public function testLocale(): void {
+    ConfigurableLanguage::createFromLangcode('de')->save();
+    $this->config('system.site')->set('default_langcode', 'de')->save();
+
+    $account = $this->drupalCreateUser();
+    $url = Url::fromRoute('router_test.11');
+
+    $this->basicAuthGet($url, $account->getAccountName(), $account->pass_raw);
+    $this->assertSession()->pageTextContains($account->getAccountName());
+    $this->assertSession()->statusCodeEquals(200);
+  }
+
+  /**
+   * Tests if a comprehensive message is displayed when the route is denied.
+   */
+  public function testUnauthorizedErrorMessage(): void {
+    $account = $this->drupalCreateUser();
+    $url = Url::fromRoute('router_test.11');
+
+    // Case when no credentials are passed, a user friendly access
+    // unauthorized message is displayed.
+    $this->drupalGet($url);
+    $this->assertSession()->statusCodeEquals(401);
+    $this->assertSession()->pageTextNotContains('Exception');
+    $this->assertSession()->pageTextContains('Log in to access this page.');
+
+    // Case when empty credentials are passed, a user friendly access denied
+    // message is displayed.
+    $this->basicAuthGet($url, NULL, NULL);
+    $this->assertSession()->statusCodeEquals(403);
+    $this->assertSession()->pageTextContains('Access denied');
+
+    // Case when wrong credentials are passed, a user friendly access denied
+    // message is displayed.
+    $this->basicAuthGet($url, $account->getAccountName(), $this->randomMachineName());
+    $this->assertSession()->statusCodeEquals(403);
+    $this->assertSession()->pageTextContains('Access denied');
+
+    // Case when correct credentials but hasn't access to the route, an user
+    // friendly access denied message is displayed.
+    $url = Url::fromRoute('router_test.15');
+    $this->basicAuthGet($url, $account->getAccountName(), $account->pass_raw);
+    $this->assertSession()->statusCodeEquals(403);
+    $this->assertSession()->pageTextContains('Access denied');
+  }
+
+  /**
+   * Tests the cacheability of the Basic Auth 401 response.
+   *
+   * @see \Drupal\basic_auth\Authentication\Provider\BasicAuth::challengeException()
+   */
+  public function testCacheabilityOf401Response(): void {
+    $url = Url::fromRoute('router_test.11');
+
+    $assert_response_cacheability = function ($expected_page_cache_header_value, $expected_dynamic_page_cache_header_value) use ($url) {
+      $this->drupalGet($url);
+      $this->assertSession()->statusCodeEquals(401);
+      $this->assertSession()->responseHeaderEquals('X-Drupal-Cache', $expected_page_cache_header_value);
+      $this->assertSession()->responseHeaderEquals('X-Drupal-Dynamic-Cache', $expected_dynamic_page_cache_header_value);
+    };
+
+    // 1. First request: cold caches, both Page Cache and Dynamic Page Cache are
+    // now primed.
+    $assert_response_cacheability('MISS', 'MISS');
+    // 2. Second request: Page Cache HIT, we don't even hit Dynamic Page Cache.
+    // This is going to keep happening.
+    $assert_response_cacheability('HIT', 'MISS');
+    // 3. Third request: after clearing Page Cache, we now see that Dynamic Page
+    // Cache is a HIT too.
+    $this->container->get('cache.page')->deleteAll();
+    $assert_response_cacheability('MISS', 'HIT');
+    // 4. Fourth request: warm caches.
+    $assert_response_cacheability('HIT', 'HIT');
+
+    // If the permissions of the 'anonymous' role change, it may no longer be
+    // necessary to be authenticated to access this route. Therefore the cached
+    // 401 responses should be invalidated.
+    $this->grantPermissions(Role::load(Role::ANONYMOUS_ID), ['access content']);
+    $assert_response_cacheability('MISS', 'MISS');
+    $assert_response_cacheability('HIT', 'MISS');
+    // Idem for when the 'system.site' config changes.
+    $this->config('system.site')->save();
+    $assert_response_cacheability('MISS', 'MISS');
+    $assert_response_cacheability('HIT', 'MISS');
+  }
+
+  /**
+   * Tests if the controller is called before authentication.
+   *
+   * @see https://www.drupal.org/node/2817727
+   */
+  public function testControllerNotCalledBeforeAuth(): void {
+    $this->drupalGet('/basic_auth_test/state/modify');
+    $this->assertSession()->statusCodeEquals(401);
+    $this->drupalGet('/basic_auth_test/state/read');
+    $this->assertSession()->statusCodeEquals(200);
+    $this->assertSession()->pageTextContains('nope');
+
+    $account = $this->drupalCreateUser();
+    $this->basicAuthGet('/basic_auth_test/state/modify', $account->getAccountName(), $account->pass_raw);
+    $this->assertSession()->statusCodeEquals(200);
+    $this->assertSession()->pageTextContains('Done');
+
+    $this->mink->resetSessions();
+    $this->drupalGet('/basic_auth_test/state/read');
+    $this->assertSession()->statusCodeEquals(200);
+    $this->assertSession()->pageTextContains('yep');
+  }
+
+}

web/core/modules/basic_auth/tests/src/Functional/GenericTest.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\Tests\basic_auth\Functional;
+
+use Drupal\Tests\system\Functional\Module\GenericModuleTestBase;
+
+/**
+ * Generic module test for basic_auth.
+ *
+ * @group basic_auth
+ */
+class GenericTest extends GenericModuleTestBase {}

web/core/modules/basic_auth/tests/src/Traits/BasicAuthTestTrait.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\Tests\basic_auth\Traits;
+
+/**
+ * Provides common functionality for Basic Authentication test classes.
+ */
+trait BasicAuthTestTrait {
+
+  /**
+   * Retrieves a Drupal path or an absolute path using basic authentication.
+   *
+   * @param \Drupal\Core\Url|string $path
+   *   Drupal path or URL to load into the internal browser.
+   * @param string $username
+   *   The username to use for basic authentication.
+   * @param string $password
+   *   The password to use for basic authentication.
+   * @param array $options
+   *   (optional) Options to be forwarded to the URL generator.
+   *
+   * @return string
+   *   The retrieved HTML string, also available as $this->getRawContent().
+   */
+  protected function basicAuthGet($path, $username, $password, array $options = []) {
+    return $this->drupalGet($path, $options, $this->getBasicAuthHeaders($username, $password));
+  }
+
+  /**
+   * Returns HTTP headers that can be used for basic authentication in Curl.
+   *
+   * @param string $username
+   *   The username to use for basic authentication.
+   * @param string $password
+   *   The password to use for basic authentication.
+   *
+   * @return array
+   *   An array of raw request headers as used by curl_setopt().
+   */
+  protected function getBasicAuthHeaders($username, $password): array {
+    // Set up Curl to use basic authentication with the test user's credentials.
+    return ['Authorization' => 'Basic ' . base64_encode("$username:$password")];
+  }
+
+}