BlockXssTest.php in Drupal 9

Namespace

Drupal\Tests\block\Functional

File

core/modules/block/tests/src/Functional/BlockXssTest.php

<?php

namespace Drupal\Tests\block\Functional;

use Drupal\block_content\Entity\BlockContent;
use Drupal\block_content\Entity\BlockContentType;
use Drupal\Core\Url;
use Drupal\system\Entity\Menu;
use Drupal\Tests\BrowserTestBase;
use Drupal\views\Entity\View;

/**
 * Tests that the block module properly escapes block descriptions.
 *
 * @group block
 */
class BlockXssTest extends BrowserTestBase {

  /**
   * Modules to install.
   *
   * @var array
   */
  protected static $modules = [
    'block',
    'block_content',
    'menu_ui',
    'views',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'classy';

  /**
   * Tests that nothing is escaped other than the blocks explicitly tested.
   */
  public function testNoUnexpectedEscaping() {
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'administer blocks',
      'access administration pages',
    ]));
    $this
      ->drupalGet(Url::fromRoute('block.admin_display'));
    $this
      ->clickLink('Place block');
    $this
      ->assertSession()
      ->assertNoEscaped('<');
  }

  /**
   * Tests XSS in title.
   */
  public function testXssInTitle() {
    $this->container
      ->get('module_installer')
      ->install([
      'block_test',
    ]);
    $this
      ->drupalPlaceBlock('test_xss_title', [
      'label' => '<script>alert("XSS label");</script>',
    ]);
    \Drupal::state()
      ->set('block_test.content', $this
      ->randomMachineName());
    $this
      ->drupalGet('');

    // Check that the block title was properly sanitized when rendered.
    $this
      ->assertSession()
      ->responseNotContains('<script>alert("XSS label");</script>');
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'administer blocks',
      'access administration pages',
    ]));
    $default_theme = $this
      ->config('system.theme')
      ->get('default');
    $this
      ->drupalGet('admin/structure/block/list/' . $default_theme);

    // Check that the block title was properly sanitized in Block Plugin UI
    // Admin page.
    $this
      ->assertSession()
      ->responseNotContains("<script>alert('XSS subject');</script>");
  }

  /**
   * Tests XSS in category.
   */
  public function testXssInCategory() {
    $this->container
      ->get('module_installer')
      ->install([
      'block_test',
    ]);
    $this
      ->drupalPlaceBlock('test_xss_title');
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'administer blocks',
      'access administration pages',
    ]));
    $this
      ->drupalGet(Url::fromRoute('block.admin_display'));
    $this
      ->clickLink('Place block');
    $this
      ->assertSession()
      ->responseNotContains("<script>alert('XSS category');</script>");
  }

  /**
   * Tests various modules that provide blocks for XSS.
   */
  public function testBlockXss() {
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->doViewTest();
    $this
      ->doMenuTest();
    $this
      ->doBlockContentTest();
    $this
      ->drupalGet(Url::fromRoute('block.admin_display'));
    $this
      ->clickLink('Place block');

    // Check that the page does not have double escaped HTML tags.
    $this
      ->assertSession()
      ->responseNotContains('&amp;lt;');
  }

  /**
   * Tests XSS coming from View block labels.
   */
  protected function doViewTest() {

    // Create a View without a custom label for its block Display. The
    // admin_label of the block then becomes just the View's label.
    $view = View::create([
      'id' => $this
        ->randomMachineName(),
      'label' => '<script>alert("view1");</script>',
    ]);
    $view
      ->addDisplay('block');
    $view
      ->save();

    // Create a View with a custom label for its block Display. The
    // admin_label of the block then becomes the View's label combined with
    // the Display's label.
    $view = View::create([
      'id' => $this
        ->randomMachineName(),
      'label' => '<script>alert("view2");</script>',
    ]);
    $view
      ->addDisplay('block', 'Fish & chips');
    $view
      ->save();
    $this
      ->drupalGet(Url::fromRoute('block.admin_display'));
    $this
      ->clickLink('Place block');

    // \Drupal\views\Plugin\Derivative\ViewsBlock::getDerivativeDefinitions()
    // has a different code path for an admin label based only on the View
    // label versus one based on both the View label and the Display label.
    // Ensure that this test is covering both code paths by asserting the
    // absence of a ":" for the first View and the presence of a ":" for the
    // second one. Note that the second assertion is redundant with the one
    // further down which also checks for the Display label, but is included
    // here for clarity.
    $this
      ->assertSession()
      ->assertNoEscaped('<script>alert("view1");</script>:');
    $this
      ->assertSession()
      ->assertEscaped('<script>alert("view2");</script>:');

    // Assert that the blocks have their admin labels escaped and
    // don't appear anywhere unescaped.
    $this
      ->assertSession()
      ->assertEscaped('<script>alert("view1");</script>');
    $this
      ->assertSession()
      ->responseNotContains('<script>alert("view1");</script>');
    $this
      ->assertSession()
      ->assertEscaped('<script>alert("view2");</script>: Fish & chips');
    $this
      ->assertSession()
      ->responseNotContains('<script>alert("view2");</script>');
    $this
      ->assertSession()
      ->responseNotContains('Fish & chips');

    // Assert the Display label doesn't appear anywhere double escaped.
    $this
      ->assertSession()
      ->responseNotContains('Fish & chips');
    $this
      ->assertSession()
      ->responseNotContains('Fish &amp;amp; chips');
  }

  /**
   * Tests XSS coming from Menu block labels.
   */
  protected function doMenuTest() {
    Menu::create([
      'id' => $this
        ->randomMachineName(),
      'label' => '<script>alert("menu");</script>',
    ])
      ->save();
    $this
      ->drupalGet(Url::fromRoute('block.admin_display'));
    $this
      ->clickLink('Place block');
    $this
      ->assertSession()
      ->assertEscaped('<script>alert("menu");</script>');
    $this
      ->assertSession()
      ->responseNotContains('<script>alert("menu");</script>');
  }

  /**
   * Tests XSS coming from Block Content block info.
   */
  protected function doBlockContentTest() {
    BlockContentType::create([
      'id' => 'basic',
      'label' => 'basic',
      'revision' => TRUE,
    ])
      ->save();
    BlockContent::create([
      'type' => 'basic',
      'info' => '<script>alert("block_content");</script>',
    ])
      ->save();
    $this
      ->drupalGet(Url::fromRoute('block.admin_display'));
    $this
      ->clickLink('Place block');
    $this
      ->assertSession()
      ->assertEscaped('<script>alert("block_content");</script>');
    $this
      ->assertSession()
      ->responseNotContains('<script>alert("block_content");</script>');
  }

}

Classes

Name	Description
BlockXssTest	Tests that the block module properly escapes block descriptions.