Club Drupal

<?php

/**

 * @file

 * Provides SimpleTests for core session handling functionality.

 */

class SessionTestCase extends DrupalWebTestCase {

  public static function getInfo() {

    return array(

      'name' => 'Session tests',

      'description' => 'Drupal session handling tests.',

      'group' => 'Session'

    );

  }

  function setUp() {

    parent::setUp('session_test');

  }

  /**

   * Tests for drupal_save_session() and drupal_session_regenerate().

   */

  function testSessionSaveRegenerate() {

    $this->assertFalse(drupal_save_session(), 'drupal_save_session() correctly returns FALSE (inside of testing framework) when initially called with no arguments.', 'Session');

    $this->assertFalse(drupal_save_session(FALSE), 'drupal_save_session() correctly returns FALSE when called with FALSE.', 'Session');

    $this->assertFalse(drupal_save_session(), 'drupal_save_session() correctly returns FALSE when saving has been disabled.', 'Session');

    $this->assertTrue(drupal_save_session(TRUE), 'drupal_save_session() correctly returns TRUE when called with TRUE.', 'Session');

    $this->assertTrue(drupal_save_session(), 'drupal_save_session() correctly returns TRUE when saving has been enabled.', 'Session');

    // Test session hardening code from SA-2008-044.

    $user = $this->drupalCreateUser(array('access content'));

    // Enable sessions.

    $this->sessionReset($user->uid);

    // Make sure the session cookie is set as HttpOnly.

    $this->drupalLogin($user);

    $this->assertTrue(preg_match('/HttpOnly/i', $this->drupalGetHeader('Set-Cookie', TRUE)), 'Session cookie is set as HttpOnly.');

    $this->drupalLogout();

    // Verify that the session is regenerated if a module calls exit

    // in hook_user_login().

    user_save($user, array('name' => 'session_test_user'));

    $user->name = 'session_test_user';

    $this->drupalGet('session-test/id');

    $matches = array();

    preg_match('/\s*session_id:(.*)\n/', $this->drupalGetContent(), $matches);

    $this->assertTrue(!empty($matches[1]) , 'Found session ID before logging in.');

    $original_session = $matches[1];

    // We cannot use $this->drupalLogin($user); because we exit in

    // session_test_user_login() which breaks a normal assertion.

    $edit = array(

      'name' => $user->name,

      'pass' => $user->pass_raw

    );

    $this->drupalPost('user', $edit, t('Log in'));

    $this->drupalGet('user');

    $pass = $this->assertText($user->name, format_string('Found name: %name', array('%name' => $user->name)), 'User login');

    $this->_logged_in = $pass;

    $this->drupalGet('session-test/id');

    $matches = array();

    preg_match('/\s*session_id:(.*)\n/', $this->drupalGetContent(), $matches);

    $this->assertTrue(!empty($matches[1]) , 'Found session ID after logging in.');

    $this->assertTrue($matches[1] != $original_session, 'Session ID changed after login.');

  }

  /**

   * Test data persistence via the session_test module callbacks.

   */

  function testDataPersistence() {

    $user = $this->drupalCreateUser(array('access content'));

    // Enable sessions.

    $this->sessionReset($user->uid);

    $this->drupalLogin($user);

    $value_1 = $this->randomName();

    $this->drupalGet('session-test/set/' . $value_1);

    $this->assertText($value_1, 'The session value was stored.', 'Session');

    $this->drupalGet('session-test/get');

    $this->assertText($value_1, 'Session correctly returned the stored data for an authenticated user.', 'Session');

    // Attempt to write over val_1. If drupal_save_session(FALSE) is working.

    // properly, val_1 will still be set.

    $value_2 = $this->randomName();

    $this->drupalGet('session-test/no-set/' . $value_2);

    $this->assertText($value_2, 'The session value was correctly passed to session-test/no-set.', 'Session');

    $this->drupalGet('session-test/get');

    $this->assertText($value_1, 'Session data is not saved for drupal_save_session(FALSE).', 'Session');

    // Switch browser cookie to anonymous user, then back to user 1.

    $this->sessionReset();

    $this->sessionReset($user->uid);

    $this->assertText($value_1, 'Session data persists through browser close.', 'Session');

    // Logout the user and make sure the stored value no longer persists.

    $this->drupalLogout();

    $this->sessionReset();

    $this->drupalGet('session-test/get');

    $this->assertNoText($value_1, "After logout, previous user's session data is not available.", 'Session');

    // Now try to store some data as an anonymous user.

    $value_3 = $this->randomName();

    $this->drupalGet('session-test/set/' . $value_3);

    $this->assertText($value_3, 'Session data stored for anonymous user.', 'Session');

    $this->drupalGet('session-test/get');

    $this->assertText($value_3, 'Session correctly returned the stored data for an anonymous user.', 'Session');

    // Try to store data when drupal_save_session(FALSE).

    $value_4 = $this->randomName();

    $this->drupalGet('session-test/no-set/' . $value_4);

    $this->assertText($value_4, 'The session value was correctly passed to session-test/no-set.', 'Session');

    $this->drupalGet('session-test/get');

    $this->assertText($value_3, 'Session data is not saved for drupal_save_session(FALSE).', 'Session');

    // Login, the data should persist.

    $this->drupalLogin($user);

    $this->sessionReset($user->uid);

    $this->drupalGet('session-test/get');

    $this->assertNoText($value_1, 'Session has persisted for an authenticated user after logging out and then back in.', 'Session');

    // Change session and create another user.

    $user2 = $this->drupalCreateUser(array('access content'));

    $this->sessionReset($user2->uid);

    $this->drupalLogin($user2);

  }

  /**

   * Test that empty anonymous sessions are destroyed.

   */

  function testEmptyAnonymousSession() {

    // Verify that no session is automatically created for anonymous user.

    $this->drupalGet('');

    $this->assertSessionCookie(FALSE);

    $this->assertSessionEmpty(TRUE);

    // The same behavior is expected when caching is enabled.

    variable_set('cache', 1);

    $this->drupalGet('');

    $this->assertSessionCookie(FALSE);

    $this->assertSessionEmpty(TRUE);

    $this->assertEqual($this->drupalGetHeader('X-Drupal-Cache'), 'MISS', 'Page was not cached.');

    // Start a new session by setting a message.

    $this->drupalGet('session-test/set-message');

    $this->assertSessionCookie(TRUE);

    $this->assertTrue($this->drupalGetHeader('Set-Cookie'), 'New session was started.');

    // Display the message, during the same request the session is destroyed

    // and the session cookie is unset.

    $this->drupalGet('');

    $this->assertSessionCookie(FALSE);

    $this->assertSessionEmpty(FALSE);

    $this->assertFalse($this->drupalGetHeader('X-Drupal-Cache'), 'Caching was bypassed.');

    $this->assertText(t('This is a dummy message.'), 'Message was displayed.');

    $this->assertTrue(preg_match('/SESS\w+=deleted/', $this->drupalGetHeader('Set-Cookie')), 'Session cookie was deleted.');

    // Verify that session was destroyed.

    $this->drupalGet('');

    $this->assertSessionCookie(FALSE);

    $this->assertSessionEmpty(TRUE);

    $this->assertNoText(t('This is a dummy message.'), 'Message was not cached.');

    $this->assertEqual($this->drupalGetHeader('X-Drupal-Cache'), 'HIT', 'Page was cached.');

    $this->assertFalse($this->drupalGetHeader('Set-Cookie'), 'New session was not started.');

    // Verify that no session is created if drupal_save_session(FALSE) is called.

    $this->drupalGet('session-test/set-message-but-dont-save');

    $this->assertSessionCookie(FALSE);

    $this->assertSessionEmpty(TRUE);

    // Verify that no message is displayed.

    $this->drupalGet('');

    $this->assertSessionCookie(FALSE);

    $this->assertSessionEmpty(TRUE);

    $this->assertNoText(t('This is a dummy message.'), 'The message was not saved.');

  }

  /**

   * Test that sessions are only saved when necessary.

   */

  function testSessionWrite() {

    $user = $this->drupalCreateUser(array('access content'));

    $this->drupalLogin($user);

    $sql = 'SELECT u.access, s.timestamp FROM {users} u INNER JOIN {sessions} s ON u.uid = s.uid WHERE u.uid = :uid';

    $times1 = db_query($sql, array(':uid' => $user->uid))->fetchObject();

    // Before every request we sleep one second to make sure that if the session

    // is saved, its timestamp will change.

    // Modify the session.

    sleep(1);

    $this->drupalGet('session-test/set/foo');

    $times2 = db_query($sql, array(':uid' => $user->uid))->fetchObject();

    $this->assertEqual($times2->access, $times1->access, 'Users table was not updated.');

    $this->assertNotEqual($times2->timestamp, $times1->timestamp, 'Sessions table was updated.');

    // Write the same value again, i.e. do not modify the session.

    sleep(1);

    $this->drupalGet('session-test/set/foo');

    $times3 = db_query($sql, array(':uid' => $user->uid))->fetchObject();

    $this->assertEqual($times3->access, $times1->access, 'Users table was not updated.');

    $this->assertEqual($times3->timestamp, $times2->timestamp, 'Sessions table was not updated.');

    // Do not change the session.

    sleep(1);

    $this->drupalGet('');

    $times4 = db_query($sql, array(':uid' => $user->uid))->fetchObject();

    $this->assertEqual($times4->access, $times3->access, 'Users table was not updated.');

    $this->assertEqual($times4->timestamp, $times3->timestamp, 'Sessions table was not updated.');

    // Force updating of users and sessions table once per second.

    variable_set('session_write_interval', 0);

    $this->drupalGet('');

    $times5 = db_query($sql, array(':uid' => $user->uid))->fetchObject();

    $this->assertNotEqual($times5->access, $times4->access, 'Users table was updated.');

    $this->assertNotEqual($times5->timestamp, $times4->timestamp, 'Sessions table was updated.');

  }

  /**

   * Test that empty session IDs are not allowed.

   */

  function testEmptySessionID() {

    $user = $this->drupalCreateUser(array('access content'));

    $this->drupalLogin($user);

    $this->drupalGet('session-test/is-logged-in');

    $this->assertResponse(200, 'User is logged in.');

    // Reset the sid in {sessions} to a blank string. This may exist in the

    // wild in some cases, although we normally prevent it from happening.

    db_query("UPDATE {sessions} SET sid = '' WHERE uid = :uid", array(':uid' => $user->uid));

    // Send a blank sid in the session cookie, and the session should no longer

    // be valid. Closing the curl handler will stop the previous session ID

    // from persisting.

    $this->curlClose();

    $this->additionalCurlOptions[CURLOPT_COOKIE] = rawurlencode($this->session_name) . '=;';

    $this->drupalGet('session-test/id-from-cookie');

    $this->assertRaw("session_id:\n", 'Session ID is blank as sent from cookie header.');

    // Assert that we have an anonymous session now.

    $this->drupalGet('session-test/is-logged-in');

    $this->assertResponse(403, 'An empty session ID is not allowed.');

  }

  /**

   * Reset the cookie file so that it refers to the specified user.

   *

   * @param $uid User id to set as the active session.

   */

  function sessionReset($uid = 0) {

    // Close the internal browser.

    $this->curlClose();

    $this->loggedInUser = FALSE;

    // Change cookie file for user.

    $this->cookieFile = file_stream_wrapper_get_instance_by_scheme('temporary')->getDirectoryPath() . '/cookie.' . $uid . '.txt';

    $this->additionalCurlOptions[CURLOPT_COOKIEFILE] = $this->cookieFile;

    $this->additionalCurlOptions[CURLOPT_COOKIESESSION] = TRUE;

    $this->drupalGet('session-test/get');

    $this->assertResponse(200, 'Session test module is correctly enabled.', 'Session');

  }

  /**

   * Assert whether the SimpleTest browser sent a session cookie.

   */

  function assertSessionCookie($sent) {

    if ($sent) {

      $this->assertNotNull($this->session_id, 'Session cookie was sent.');

    }

    else {

      $this->assertNull($this->session_id, 'Session cookie was not sent.');

    }

  }

  /**

   * Assert whether $_SESSION is empty at the beginning of the request.

   */

  function assertSessionEmpty($empty) {

    if ($empty) {

      $this->assertIdentical($this->drupalGetHeader('X-Session-Empty'), '1', 'Session was empty.');

    }

    else {

      $this->assertIdentical($this->drupalGetHeader('X-Session-Empty'), '0', 'Session was not empty.');

    }

  }

}

/**

 * Ensure that when running under HTTPS two session cookies are generated.

 */

class SessionHttpsTestCase extends DrupalWebTestCase {

  public static function getInfo() {

    return array(

      'name' => 'Session HTTPS handling',

      'description' => 'Ensure that when running under HTTPS two session cookies are generated.',

      'group' => 'Session'

    );

  }

  public function setUp() {

    parent::setUp('session_test');

  }

  protected function testHttpsSession() {

    global $is_https;

    if ($is_https) {

      $secure_session_name = session_name();

      $insecure_session_name = substr(session_name(), 1);

    }

    else {

      $secure_session_name = 'S' . session_name();

      $insecure_session_name = session_name();

    }

    $user = $this->drupalCreateUser(array('access administration pages'));

    // Test HTTPS session handling by altering the form action to submit the

    // login form through https.php, which creates a mock HTTPS request.

    $this->drupalGet('user');

    $form = $this->xpath('//form[@id="user-login"]');

    $form[0]['action'] = $this->httpsUrl('user');

    $edit = array('name' => $user->name, 'pass' => $user->pass_raw);

    $this->drupalPost(NULL, $edit, t('Log in'));

    // Test a second concurrent session.

    $this->curlClose();

    $this->drupalGet('user');

    $form = $this->xpath('//form[@id="user-login"]');

    $form[0]['action'] = $this->httpsUrl('user');

    $this->drupalPost(NULL, $edit, t('Log in'));

    // Check secure cookie on secure page.

    $this->assertTrue($this->cookies[$secure_session_name]['secure'], 'The secure cookie has the secure attribute');

    // Check insecure cookie is not set.

    $this->assertFalse(isset($this->cookies[$insecure_session_name]));

    $ssid = $this->cookies[$secure_session_name]['value'];

    $this->assertSessionIds($ssid, $ssid, 'Session has a non-empty SID and a correct secure SID.');

    $cookie = $secure_session_name . '=' . $ssid;

    // Verify that user is logged in on secure URL.

    $this->curlClose();

    $this->drupalGet($this->httpsUrl('admin/config'), array(), array('Cookie: ' . $cookie));

    $this->assertText(t('Configuration'));

    $this->assertResponse(200);

    // Verify that user is not logged in on non-secure URL.

    $this->curlClose();

    $this->drupalGet($this->httpUrl('admin/config'), array(), array('Cookie: ' . $cookie));

    $this->assertNoText(t('Configuration'));

    $this->assertResponse(403);

    // Verify that empty SID cannot be used on the non-secure site.

    $this->curlClose();

    $cookie = $insecure_session_name . '=';

    $this->drupalGet($this->httpUrl('admin/config'), array(), array('Cookie: ' . $cookie));

    $this->assertResponse(403);

    // Test HTTP session handling by altering the form action to submit the

    // login form through http.php, which creates a mock HTTP request on HTTPS

    // test environments.

    $this->curlClose();

    $this->drupalGet('user');

    $form = $this->xpath('//form[@id="user-login"]');

    $form[0]['action'] = $this->httpUrl('user');

    $edit = array('name' => $user->name, 'pass' => $user->pass_raw);

    $this->drupalPost(NULL, $edit, t('Log in'));

    $this->drupalGet($this->httpUrl('admin/config'));

    $this->assertResponse(200);

    $sid = $this->cookies[$insecure_session_name]['value'];

    $this->assertSessionIds($sid, '', 'Session has the correct SID and an empty secure SID.');

    // Verify that empty secure SID cannot be used on the secure site.

    $this->curlClose();

    $cookie = $secure_session_name . '=';

    $this->drupalGet($this->httpsUrl('admin/config'), array(), array('Cookie: ' . $cookie));

    $this->assertResponse(403);

    // Clear browser cookie jar.

    $this->cookies = array();

    if ($is_https) {

      // The functionality does not make sense when running on HTTPS.

      return;

    }

    // Enable secure pages.

    variable_set('https', TRUE);

    $this->curlClose();

    // Start an anonymous session on the insecure site.

    $session_data = $this->randomName();

    $this->drupalGet('session-test/set/' . $session_data);

    // Check secure cookie on insecure page.

    $this->assertFalse(isset($this->cookies[$secure_session_name]), 'The secure cookie is not sent on insecure pages.');

    // Check insecure cookie on insecure page.

    $this->assertFalse($this->cookies[$insecure_session_name]['secure'], 'The insecure cookie does not have the secure attribute');

    // Store the anonymous cookie so we can validate that its session is killed

    // after login.

    $anonymous_cookie = $insecure_session_name . '=' . $this->cookies[$insecure_session_name]['value'];

    // Check that password request form action is not secure.

    $this->drupalGet('user/password');

    $form = $this->xpath('//form[@id="user-pass"]');

    $this->assertNotEqual(substr($form[0]['action'], 0, 6), 'https:', 'Password request form action is not secure');

    $form[0]['action'] = $this->httpsUrl('user');

    // Check that user login form action is secure.

    $this->drupalGet('user');

    $form = $this->xpath('//form[@id="user-login"]');

    $this->assertEqual(substr($form[0]['action'], 0, 6), 'https:', 'Login form action is secure');

    $form[0]['action'] = $this->httpsUrl('user');

    $edit = array(

      'name' => $user->name,

      'pass' => $user->pass_raw,

    );

    $this->drupalPost(NULL, $edit, t('Log in'));

    // Check secure cookie on secure page.

    $this->assertTrue($this->cookies[$secure_session_name]['secure'], 'The secure cookie has the secure attribute');

    // Check insecure cookie on secure page.

    $this->assertFalse($this->cookies[$insecure_session_name]['secure'], 'The insecure cookie does not have the secure attribute');

    $sid = $this->cookies[$insecure_session_name]['value'];

    $ssid = $this->cookies[$secure_session_name]['value'];

    $this->assertSessionIds($sid, $ssid, 'Session has both secure and insecure SIDs');

    $cookies = array(

      $insecure_session_name . '=' . $sid,

      $secure_session_name . '=' . $ssid,

    );

    // Test that session data saved before login is still available on the

    // authenticated session.

    $this->drupalGet('session-test/get');

    $this->assertText($session_data, 'Session correctly returned the stored data set by the anonymous session.');

    foreach ($cookies as $cookie_key => $cookie) {

      foreach (array('admin/config', $this->httpsUrl('admin/config')) as $url_key => $url) {

        $this->curlClose();

        $this->drupalGet($url, array(), array('Cookie: ' . $cookie));

        if ($cookie_key == $url_key) {

          $this->assertText(t('Configuration'));

          $this->assertResponse(200);

        }

        else {

          $this->assertNoText(t('Configuration'));

          $this->assertResponse(403);

        }

      }

    }

    // Test that session data saved before login is not available using the

    // pre-login anonymous cookie.

    $this->cookies = array();

    $this->drupalGet('session-test/get', array('Cookie: ' . $anonymous_cookie));

    $this->assertNoText($session_data, 'Initial anonymous session is inactive after login.');

    // Clear browser cookie jar.

    $this->cookies = array();

    // Start an anonymous session on the secure site.

    $this->drupalGet($this->httpsUrl('session-test/set/1'));

    // Mock a login to the secure site using the secure session cookie.

    $this->drupalGet('user');

    $form = $this->xpath('//form[@id="user-login"]');

    $form[0]['action'] = $this->httpsUrl('user');

    $this->drupalPost(NULL, $edit, t('Log in'));

    // Test that the user is also authenticated on the insecure site.

    $this->drupalGet("user/{$user->uid}/edit");

    $this->assertResponse(200);

  }

  /**

   * Test that there exists a session with two specific session IDs.

   *

   * @param $sid

   *   The insecure session ID to search for.

   * @param $ssid

   *   The secure session ID to search for.

   * @param $assertion_text

   *   The text to display when we perform the assertion.

   *

   * @return

   *   The result of assertTrue() that there's a session in the system that

   *   has the given insecure and secure session IDs.

   */

  protected function assertSessionIds($sid, $ssid, $assertion_text) {

    $args = array(

      ':sid' => $sid,

      ':ssid' => $ssid,

    );

    return $this->assertTrue(db_query('SELECT timestamp FROM {sessions} WHERE sid = :sid AND ssid = :ssid', $args)->fetchField(), $assertion_text);

  }

  /**

   * Builds a URL for submitting a mock HTTPS request to HTTP test environments.

   *

   * @param $url

   *   A Drupal path such as 'user'.

   *

   * @return

   *   An absolute URL.

   */

  protected function httpsUrl($url) {

    global $base_url;

    return $base_url . '/modules/simpletest/tests/https.php?q=' . $url;

  }

  /**

   * Builds a URL for submitting a mock HTTP request to HTTPS test environments.

   *

   * @param $url

   *   A Drupal path such as 'user'.

   *

   * @return

   *   An absolute URL.

   */

  protected function httpUrl($url) {

    global $base_url;

    return $base_url . '/modules/simpletest/tests/http.php?q=' . $url;

  }

}