class CSRFAccessCheck

Access protection against CSRF attacks.

Hierarchy

Expanded class hierarchy of CSRFAccessCheck

1 string reference to 'CSRFAccessCheck'
rest.services.yml in drupal/core/modules/rest/rest.services.yml
drupal/core/modules/rest/rest.services.yml
1 service uses CSRFAccessCheck

File

drupal/core/modules/rest/lib/Drupal/rest/Access/CSRFAccessCheck.php, line 17
Contains Drupal\rest\Access\CSRFAccessCheck.

Namespace

Drupal\rest\Access
View source
class CSRFAccessCheck implements AccessCheckInterface {

  /**
   * Implements AccessCheckInterface::applies().
   */
  public function applies(Route $route) {
    $requirements = $route
      ->getRequirements();
    if (array_key_exists('_access_rest_csrf', $requirements)) {
      if (isset($requirements['_method'])) {

        // There could be more than one method requirement separated with '|'.
        $methods = explode('|', $requirements['_method']);

        // CSRF protection only applies to write operations, so we can filter
        // out any routes that require reading methods only.
        $write_methods = array_diff($methods, array(
          'GET',
          'HEAD',
          'OPTIONS',
          'TRACE',
        ));
        if (empty($write_methods)) {
          return FALSE;
        }
      }

      // No method requirement given, so we run this access check to be on the
      // safe side.
      return TRUE;
    }
    return FALSE;
  }

  /**
   * Implements AccessCheckInterface::access().
   */
  public function access(Route $route, Request $request) {
    $method = $request
      ->getMethod();
    $cookie = $request->cookies
      ->get(session_name(), FALSE);

    // This check only applies if
    // 1. this is a write operation
    // 2. the user was successfully authenticated and
    // 3. the request comes with a session cookie.
    if (!in_array($method, array(
      'GET',
      'HEAD',
      'OPTIONS',
      'TRACE',
    )) && user_is_logged_in() && $cookie) {
      $csrf_token = $request->headers
        ->get('X-CSRF-Token');
      if (!drupal_valid_token($csrf_token, 'rest')) {
        return FALSE;
      }
    }

    // As we do not perform any authorization here we always return NULL to
    // indicate that other access checkers should decide if the request is
    // legit.
    return NULL;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AccessCheckInterface::ALLOW constant Grant access.
AccessCheckInterface::DENY constant Deny access.
AccessCheckInterface::KILL constant Block access.
CSRFAccessCheck::access public function Implements AccessCheckInterface::access(). Overrides AccessCheckInterface::access
CSRFAccessCheck::applies public function Implements AccessCheckInterface::applies(). Overrides AccessCheckInterface::applies