CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 4.1 Strawberry API

  • Project:
    • CakePHP
      • CakePHP
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 4.1
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Command
    • Console
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • Http
      • Client
      • Cookie
      • Exception
      • Middleware
      • Session
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

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
See: https://cheatsheetseries.owasp.org/cheatsheets/Cross-Site_Request_Forgery_Prevention_Cheat_Sheet.html#double-submit-cookie

Constants

  • int
    TOKEN_VALUE_LENGTH ¶
    16

Property 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

  • __construct() public

    Constructor

  • _addTokenCookie() protected

    Add a CSRF token to the response cookies.

  • _createCookie() protected

    Create response cookie

  • _createToken() protected deprecated

    Create a new token to be used for CSRF protection

  • _unsetTokenField() protected

    Remove CSRF protection token from request data.

  • _validateToken() protected

    Validate the request data against the cookie token.

  • _verifyToken() protected

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

  • createToken() public

    Create a new token to be used for CSRF protection

  • process() public

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

  • skipCheckCallback() public

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

  • whitelistCallback() public deprecated

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

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): Psr\Http\Message\ResponseInterface

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

_createCookie() ¶ protected

_createCookie(string $value, Psr\Http\Message\ServerRequestInterface $request): Cake\Http\Cookie\CookieInterface

Create response cookie

Parameters
string $value

Cookie value

Psr\Http\Message\ServerRequestInterface $request

The request object.

Returns
Cake\Http\Cookie\CookieInterface

_createToken() ¶ protected

_createToken(): string

Create a new token to be used for CSRF protection

Returns
string

_unsetTokenField() ¶ protected

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

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): void

Validate the request data against the cookie token.

Parameters
Psr\Http\Message\ServerRequestInterface $request

The request to validate against.

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

_verifyToken() ¶ protected

_verifyToken(string $token): bool

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

Parameters
string $token

The CSRF token.

Returns
bool

createToken() ¶ public

createToken(): string

Create a new token to be used for CSRF protection

Returns
string

process() ¶ public

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

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

Processes an incoming server request in order to produce a response. If unable to produce the response itself, it may delegate to the provided request handler to do so.

Parameters
ServerRequestInterface $request

The request.

RequestHandlerInterface $handler

The request handler.

Returns
Psr\Http\Message\ResponseInterface

skipCheckCallback() ¶ public

skipCheckCallback(callable $callback): $this

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): $this

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
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs