Provides CSRF protection & validation.
This middleware adds a CSRF token to a cookie. The cookie value is compared to request data, or the X-CSRF-Token header on each PATCH, POST, PUT, or DELETE request.
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.
$_config
protected array
$_defaultConfig
protected array
$whitelistCallback
protected callable|null
__construct( array $config = [] )
Constructor
$config
optional [] __invoke( Cake\Http\ServerRequest $request , Cake\Http\Response $response , callable $next )
Checks and sets the CSRF token depending on the HTTP verb.
Cake\Http\ServerRequest
$request
Cake\Http\Response
$response
$next
Cake\Http\Response
_addTokenCookie( string $token , Cake\Http\ServerRequest $request , Cake\Http\Response $response )
Add a CSRF token to the response cookies.
$token
Cake\Http\ServerRequest
$request
Cake\Http\Response
$response
Cake\Http\Response
_addTokenToRequest( string $token , Cake\Http\ServerRequest $request )
Add a CSRF token to the request parameters.
$token
Cake\Http\ServerRequest
$request
Cake\Http\ServerRequest
_createToken( )
Create a new token to be used for CSRF protection
_validateAndUnsetTokenField( Cake\Http\ServerRequest $request )
Checks if the request is POST, PUT, DELETE or PATCH and validates the CSRF token
Cake\Http\ServerRequest
$request
Cake\Http\ServerRequest
_validateToken( Cake\Http\ServerRequest $request )
Validate the request data against the cookie token.
Cake\Http\ServerRequest
$request
Cake\Http\Exception\InvalidCsrfTokenException
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.
$callback
protected array
Default 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.field
The form field to check. Changing this will also require configuring FormHelper.[ 'cookieName' => 'csrfToken', 'expiry' => 0, 'secure' => false, 'httpOnly' => false, 'field' => '_csrfToken', ]
protected callable|null
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
.
© 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/3.8/class-Cake.Http.Middleware.CsrfProtectionMiddleware.html