Version 1
[yaffs-website] / web / core / modules / system / tests / src / Functional / CsrfRequestHeaderTest.php
diff --git a/web/core/modules/system/tests/src/Functional/CsrfRequestHeaderTest.php b/web/core/modules/system/tests/src/Functional/CsrfRequestHeaderTest.php
new file mode 100644 (file)
index 0000000..c6d7b35
--- /dev/null
@@ -0,0 +1,83 @@
+<?php
+
+namespace Drupal\Tests\system\Functional;
+
+use Drupal\Core\Url;
+use Drupal\Tests\BrowserTestBase;
+use GuzzleHttp\Cookie\CookieJar;
+
+/**
+ * Tests protecting routes by requiring CSRF token in the request header.
+ *
+ * @group system
+ */
+class CsrfRequestHeaderTest extends BrowserTestBase {
+
+  /**
+   * Modules to enable.
+   *
+   * @var array
+   */
+  public static $modules = ['system', 'csrf_test'];
+
+  /**
+   * Tests access to routes protected by CSRF request header requirements.
+   *
+   * This checks one route that uses _csrf_request_header_token and one that
+   * uses the deprecated _access_rest_csrf.
+   */
+  public function testRouteAccess() {
+    $client = \Drupal::httpClient();
+    $csrf_token_paths = ['deprecated/session/token', 'session/token'];
+    // Test using the both the current path and a test path that returns
+    // a token using the deprecated 'rest' value.
+    // Checking /deprecated/session/token can be removed in 8.3.
+    // @see \Drupal\Core\Access\CsrfRequestHeaderAccessCheck::access()
+    foreach ($csrf_token_paths as $csrf_token_path) {
+      // Check both test routes.
+      $route_names = ['csrf_test.protected', 'csrf_test.deprecated.protected'];
+      foreach ($route_names as $route_name) {
+        $user = $this->drupalCreateUser();
+        $this->drupalLogin($user);
+
+        $csrf_token = $this->drupalGet($csrf_token_path);
+        $url = Url::fromRoute($route_name)
+          ->setAbsolute(TRUE)
+          ->toString();
+        $domain = parse_url($url, PHP_URL_HOST);
+
+        $session_id = $this->getSession()->getCookie($this->getSessionName());
+        /** @var \GuzzleHttp\Cookie\CookieJar $cookies */
+        $cookies = CookieJar::fromArray([$this->getSessionName() => $session_id], $domain);
+        $post_options = [
+          'headers' => ['Accept' => 'text/plain'],
+          'http_errors' => FALSE,
+        ];
+
+        // Test that access is allowed for anonymous user with no token in header.
+        $result = $client->post($url, $post_options);
+        $this->assertEquals(200, $result->getStatusCode());
+
+        // Add cookies to POST options so that all other requests are for the
+        // authenticated user.
+        $post_options['cookies'] = $cookies;
+
+        // Test that access is denied with no token in header.
+        $result = $client->post($url, $post_options);
+        $this->assertEquals(403, $result->getStatusCode());
+
+        // Test that access is allowed with correct token in header.
+        $post_options['headers']['X-CSRF-Token'] = $csrf_token;
+        $result = $client->post($url, $post_options);
+        $this->assertEquals(200, $result->getStatusCode());
+
+        // Test that access is denied with incorrect token in header.
+        $post_options['headers']['X-CSRF-Token'] = 'this-is-not-the-token-you-are-looking-for';
+        $result = $client->post($url, $post_options);
+        $this->assertEquals(403, $result->getStatusCode());
+      }
+    }
+
+  }
+
+}