SessionAuthenticationTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\system\Functional\Session;

use Drupal\Core\Url;
use Drupal\Tests\basic_auth\Traits\BasicAuthTestTrait;
use Drupal\Tests\BrowserTestBase;

/**
 * Tests if sessions are correctly handled when a user authenticates.
 *
 * @group Session
 */
class SessionAuthenticationTest extends BrowserTestBase {
  use BasicAuthTestTrait;
  
  /**
   * A test user.
   *
   * @var \Drupal\user\Entity\User
   */
  protected $user;
  
  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'basic_auth',
    'session_test',
  ];
  
  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';
  
  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    // Create a test administrator user.
    $this->user = $this->drupalCreateUser([
      'administer site configuration',
    ]);
  }
  
  /**
   * Check that a basic authentication session does not leak.
   *
   * Regression test for a bug that caused a session initiated by basic
   * authentication to persist over subsequent unauthorized requests.
   */
  public function testSessionFromBasicAuthenticationDoesNotLeak() : void {
    // This route is authorized through basic_auth only, not cookie.
    $protected_url = Url::fromRoute('session_test.get_session_basic_auth');
    // This route is not protected.
    $unprotected_url = Url::fromRoute('session_test.get_session_no_auth');
    // Test that the route is not accessible as an anonymous user.
    $this->drupalGet($protected_url);
    $session = $this->getSession();
    $this->assertSession()
      ->statusCodeEquals(401);
    // We should be able to access the route with basic authentication.
    $this->basicAuthGet($protected_url, $this->user
      ->getAccountName(), $this->user->passRaw);
    $this->assertSession()
      ->statusCodeEquals(200);
    // Check that the correct user is logged in.
    $this->assertEquals($this->user
      ->id(), json_decode($session->getPage()
      ->getContent())->user, 'The correct user is authenticated on a route with basic authentication.');
    $session->restart();
    // If we now try to access a page without basic authentication then we
    // should no longer be logged in.
    $this->drupalGet($unprotected_url);
    $this->assertSession()
      ->statusCodeEquals(200);
    $this->assertEquals(0, json_decode($session->getPage()
      ->getContent())->user, 'The user is no longer authenticated after visiting a page without basic authentication.');
    // If we access the protected page again without basic authentication we
    // should get 401 Unauthorized.
    $this->drupalGet($protected_url);
    $this->assertSession()
      ->statusCodeEquals(401);
  }
  
  /**
   * Tests if a session can be initiated through basic authentication.
   */
  public function testBasicAuthSession() : void {
    // Set a session value on a request through basic auth.
    $test_value = 'alpaca';
    $response = $this->basicAuthGet('session-test/set-session/' . $test_value, $this->user
      ->getAccountName(), $this->user->pass_raw);
    $this->assertSessionData($response, $test_value);
    $this->assertSession()
      ->statusCodeEquals(200);
    // Test that on a subsequent request the session value is still present.
    $response = $this->basicAuthGet('session-test/get-session', $this->user
      ->getAccountName(), $this->user->pass_raw);
    $this->assertSessionData($response, $test_value);
    $this->assertSession()
      ->statusCodeEquals(200);
  }
  
  /**
   * Checks the session data returned by the session test routes.
   *
   * @param string $response
   *   A response object containing the session values and the user ID.
   * @param string $expected
   *   The expected session value.
   *
   * @internal
   */
  protected function assertSessionData(string $response, string $expected) : void {
    $response = json_decode($response, TRUE);
    $this->assertEquals([
      'test_value' => $expected,
    ], $response['session'], 'The session data matches the expected value.');
    // Check that we are logged in as the correct user.
    $this->assertEquals($this->user
      ->id(), $response['user'], 'The correct user is logged in.');
  }
  
  /**
   * Tests that a session is not started automatically by basic authentication.
   */
  public function testBasicAuthNoSession() : void {
    // A route that is authorized through basic_auth only, not cookie.
    $no_cookie_url = Url::fromRoute('session_test.get_session_basic_auth');
    // A route that is authorized with standard cookie authentication.
    $cookie_url = 'user/login';
    // If we authenticate with a third party authentication system then no
    // session cookie should be set, the third party system is responsible for
    // sustaining the session.
    $this->basicAuthGet($no_cookie_url, $this->user
      ->getAccountName(), $this->user->passRaw);
    $this->assertSession()
      ->statusCodeEquals(200);
    $this->assertEmpty($this->getSessionCookies());
    // Mink stores some information in the session that breaks the next check if
    // not reset.
    $this->getSession()
      ->restart();
    // On the other hand, authenticating using Cookie sets a cookie.
    $this->drupalGet($cookie_url);
    $this->assertEmpty($this->getSessionCookies());
    $edit = [
      'name' => $this->user
        ->getAccountName(),
      'pass' => $this->user->passRaw,
    ];
    $this->drupalGet($cookie_url);
    $this->submitForm($edit, 'Log in');
    $this->assertNotEmpty($this->getSessionCookies());
  }

}