Class CsrfProtectionMiddleware

Provides CSRF protection & validation.

This middleware adds a CSRF token to a cookie. The cookie value is compared to token in request data, or the X-CSRF-Token header on each PATCH, POST, PUT, or DELETE request. This is known as "double submit cookie" technique.

If the request data is missing or does not match the cookie data, an InvalidCsrfTokenException will be raised.

This middleware integrates with the FormHelper automatically and when used together your forms will have CSRF tokens automatically added when $this->Form->create(...) is used in a view.

Namespace: Cake\Http\Middleware

Constants summary

  • int
    TOKEN_VALUE_LENGTH
    16

Properties summary

  • $_config protected
    array

    Config for the CSRF handling.

  • $skipCheckCallback protected
    callable|null

    Callback for deciding whether or not to skip the token check for particular request.

Method Summary

Method Detail

__construct() public 

__construct(array $config)

Constructor

Parameters

array $config optional

Config options. See $_config for valid keys.

_addTokenCookie() protected 

_addTokenCookie(string $token, \Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response)

Add a CSRF token to the response cookies.

Parameters

string $token

The token to add.

\Psr\Http\Message\ServerRequestInterface $request

The request to validate against.

\Psr\Http\Message\ResponseInterface $response

The response.

Returns

\Psr\Http\Message\ResponseInterface

$response Modified response.

_createCookie() protected 

_createCookie(string $value, \Psr\Http\Message\ServerRequestInterface $request)

Create response cookie

Parameters

string $value

Cookie value

\Psr\Http\Message\ServerRequestInterface $request

The request object.

Returns

\Cake\Http\Cookie\CookieInterface

_createToken() protected 

_createToken()

Create a new token to be used for CSRF protection

Returns

string

_unsetTokenField() protected 

_unsetTokenField(\Psr\Http\Message\ServerRequestInterface $request)

Remove CSRF protection token from request data.

Parameters

\Psr\Http\Message\ServerRequestInterface $request

The request object.

Returns

\Psr\Http\Message\ServerRequestInterface

_validateToken() protected 

_validateToken(\Psr\Http\Message\ServerRequestInterface $request)

Validate the request data against the cookie token.

Parameters

\Psr\Http\Message\ServerRequestInterface $request

The request to validate against.

Throws

Cake\Http\Exception\InvalidCsrfTokenException
When the CSRF token is invalid or missing.

_verifyToken() protected 

_verifyToken(string $token)

Verify that CSRF token was originally generated by the receiving application.

Parameters

string $token

The CSRF token.

Returns

bool

createToken() public 

createToken()

Create a new token to be used for CSRF protection

Returns

string

process() public 

process(\Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Server\RequestHandlerInterface $handler)

Checks and sets the CSRF token depending on the HTTP verb.

Parameters

\Psr\Http\Message\ServerRequestInterface $request

The request.

\Psr\Http\Server\RequestHandlerInterface $handler

The request handler.

Returns

\Psr\Http\Message\ResponseInterface

A response.

skipCheckCallback() public 

skipCheckCallback(callable $callback)

Set callback for allowing to skip token check for particular request.

The callback will receive request instance as argument and must return true if you want to skip token check for the current request.

Parameters

callable $callback

A callable.

Returns

$this

whitelistCallback() public 

whitelistCallback(callable $callback)

Set callback for allowing to skip token check for particular request.

The callback will receive request instance as argument and must return true if you want to skip token check for the current request.

Parameters

callable $callback

A callable.

Returns

$this

Property Detail

$_config protected

Config for the CSRF handling.

  • cookieName The name of the cookie to send.
  • expiry A strotime compatible value of how long the CSRF token should last. Defaults to browser session.
  • secure Whether or not the cookie will be set with the Secure flag. Defaults to false.
  • httponly Whether or not the cookie will be set with the HttpOnly flag. Defaults to false.
  • samesite "SameSite" attribute for cookies. Defaults to null. Valid values: CookieInterface::SAMESITE_LAX, CookieInterface::SAMESITE_STRICT, CookieInterface::SAMESITE_NONE or null.
  • field The form field to check. Changing this will also require configuring FormHelper.

Type

array

$skipCheckCallback protected

Callback for deciding whether or not to skip the token check for particular request.

CSRF protection token check will be skipped if the callback returns true.

Type

callable|null

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.Http.Middleware.CsrfProtectionMiddleware.html