abstract class MTimeProtectedFileStorageBase in Drupal 10

Base test class for MTime protected storage.

Hierarchy

• class \Drupal\Tests\Component\PhpStorage\PhpStorageTestBase extends \PHPUnit\Framework\TestCase
  • class \Drupal\Tests\Component\PhpStorage\MTimeProtectedFileStorageBase

File

core/tests/Drupal/Tests/Component/PhpStorage/MTimeProtectedFileStorageBase.php, line 12

Namespace

Drupal\Tests\Component\PhpStorage

abstract class MTimeProtectedFileStorageBase extends PhpStorageTestBase {

  /**
   * The PHP storage class to test.
   *
   * This should be overridden by extending classes.
   *
   * @var string
   */
  protected $storageClass;

  /**
   * The secret string to use for file creation.
   *
   * @var string
   */
  protected $secret;

  /**
   * Test settings to pass to storage instances.
   *
   * @var array
   */
  protected $settings;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();

    // Random generator.
    $random = new Random();
    $this->secret = $random
      ->name(8, TRUE);
    $this->settings = [
      'directory' => $this->directory,
      'bin' => 'test',
      'secret' => $this->secret,
    ];
  }

  /**
   * Tests basic load/save/delete operations.
   *
   * @covers ::load
   * @covers ::save
   * @covers ::delete
   * @covers ::exists
   */
  public function testCRUD() {
    $php = new $this->storageClass($this->settings);
    $this
      ->assertCRUD($php);
  }

  /**
   * Tests the security of the MTimeProtectedFileStorage implementation.
   *
   * We test two attacks: first changes the file mtime, then the directory
   * mtime too.
   *
   * We need to delay over 1 second for mtime test.
   * @medium
   */
  public function testSecurity() {
    $php = new $this->storageClass($this->settings);
    $name = 'test.php';
    $php
      ->save($name, '<?php');
    $expected_root_directory = $this->directory . '/test';
    if (substr($name, -4) === '.php') {
      $expected_directory = $expected_root_directory . '/' . substr($name, 0, -4);
    }
    else {
      $expected_directory = $expected_root_directory . '/' . $name;
    }
    $directory_mtime = filemtime($expected_directory);
    $expected_filename = $expected_directory . '/' . Crypt::hmacBase64($name, $this->secret . $directory_mtime) . '.php';

    // Ensure the file exists and that it and the containing directory have
    // minimal permissions. fileperms() can return high bits unrelated to
    // permissions, so mask with 0777.
    $this
      ->assertFileExists($expected_filename);
    $this
      ->assertSame(0444, fileperms($expected_filename) & 0777);
    $this
      ->assertSame(0777, fileperms($expected_directory) & 0777);

    // Ensure the root directory for the bin has a .htaccess file denying web
    // access.
    $this
      ->assertSame(file_get_contents($expected_root_directory . '/.htaccess'), FileSecurity::htaccessLines());

    // Ensure that if the file is replaced with an untrusted one (due to another
    // script's file upload vulnerability), it does not get loaded. Since mtime
    // granularity is 1 second, we cannot prevent an attack that happens within
    // a second of the initial save().
    sleep(1);
    for ($i = 0; $i < 2; $i++) {
      $php = new $this->storageClass($this->settings);
      $GLOBALS['hacked'] = FALSE;
      $untrusted_code = "<?php\n" . '$GLOBALS["hacked"] = TRUE;';
      chmod($expected_directory, 0700);
      chmod($expected_filename, 0700);
      if ($i) {

        // Now try to write the file in such a way that the directory mtime
        // changes and invalidates the hash.
        file_put_contents($expected_filename . '.tmp', $untrusted_code);
        rename($expected_filename . '.tmp', $expected_filename);
      }
      else {

        // On the first try do not change the directory mtime but the filemtime
        // is now larger than the directory mtime.
        file_put_contents($expected_filename, $untrusted_code);
      }
      chmod($expected_filename, 0400);
      chmod($expected_directory, 0100);
      $this
        ->assertSame(file_get_contents($expected_filename), $untrusted_code);
      $this
        ->assertSame($this->expected[$i], $php
        ->exists($name));
      $this
        ->assertSame($this->expected[$i], $php
        ->load($name));
      $this
        ->assertSame($this->expected[$i], $GLOBALS['hacked']);
    }
    unset($GLOBALS['hacked']);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MTimeProtectedFileStorageBase::$secret	protected	property	The secret string to use for file creation.
MTimeProtectedFileStorageBase::$settings	protected	property	Test settings to pass to storage instances.
MTimeProtectedFileStorageBase::$storageClass	protected	property	The PHP storage class to test.	2
MTimeProtectedFileStorageBase::setUp	protected	function	Overrides PhpStorageTestBase::setUp
MTimeProtectedFileStorageBase::testCRUD	public	function	Tests basic load/save/delete operations.
MTimeProtectedFileStorageBase::testSecurity	public	function	Tests the security of the MTimeProtectedFileStorage implementation.
PhpStorageTestBase::$directory	protected	property	A unique per test class directory path to test php storage.
PhpStorageTestBase::additionalAssertCRUD	protected	function	Additional asserts to be run.
PhpStorageTestBase::assertCRUD	public	function	Assert that a PHP storage's load/save/delete operations work.