On this page
Class SecurityHeadersMiddleware
Handles common security headers in a convenient way
Link: https://book.cakephp.org/3.0/en/controllers/middleware.html#security-header-middleware
Location: Http/Middleware/SecurityHeadersMiddleware.php
Constants summary
stringALL'all'stringALLOW_FROM'allow-from'stringBY_CONTENT_TYPE'by-content-type'stringBY_FTP_FILENAME'by-ftp-filename'stringDENY'deny'stringMASTER_ONLY'master-only'stringNONE'none'stringNOOPEN'noopen'stringNOSNIFF'nosniff'stringNO_REFERRER'no-referrer'stringNO_REFERRER_WHEN_DOWNGRADE'no-referrer-when-downgrade'stringORIGIN'origin'stringORIGIN_WHEN_CROSS_ORIGIN'origin-when-cross-origin'stringSAMEORIGIN'sameorigin'stringSAME_ORIGIN'same-origin'stringSTRICT_ORIGIN'strict-origin'stringSTRICT_ORIGIN_WHEN_CROSS_ORIGIN'strict-origin-when-cross-origin'stringUNSAFE_URL'unsafe-url'stringXSS_BLOCK'block'stringXSS_DISABLED'0'stringXSS_ENABLED'1'stringXSS_ENABLED_BLOCK'1; mode=block'
Properties summary
-
$headersprotectedSecurity related headers to setarray
Method Summary
-
__invoke() publicServe assets if the path matches one.
-
checkValues() protectedConvenience method to check if a value is in the list of allowed args
-
noOpen() publicX-Download-Options
-
noSniff() publicX-Content-Type-Options
-
setCrossDomainPolicy() publicX-Permitted-Cross-Domain-Policies
-
setReferrerPolicy() publicReferrer-Policy
-
setXFrameOptions() publicX-Frame-Options
-
setXssProtection() publicX-XSS-Protection
Method Detail
__invoke()source public
__invoke( Psr\Http\Message\ServerRequestInterface $request , Psr\Http\Message\ResponseInterface $response , callable $next )
Serve assets if the path matches one.
Parameters
-
Psr\Http\Message\ServerRequestInterface
$request - The request.
-
Psr\Http\Message\ResponseInterface
$response - The response.
-
callable
$next - Callback to invoke the next middleware.
Returns
Psr\Http\Message\ResponseInterfaceA response
checkValues()source protected
checkValues( string $value , array $allowed )
Convenience method to check if a value is in the list of allowed args
Parameters
-
string
$value - Value to check
-
array
$allowed - List of allowed values
Throws
InvalidArgumentExceptionThrown when a value is invalid.
noOpen()source public
noOpen( )
X-Download-Options
Sets the header value for it to 'noopen'
Returns
$this
Link
https://msdn.microsoft.com/en-us/library/jj542450(v=vs.85).aspxnoSniff()source public
noSniff( )
X-Content-Type-Options
Sets the header value for it to 'nosniff'
Returns
$this
Link
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-OptionssetCrossDomainPolicy()source public
setCrossDomainPolicy( string $policy = self::ALL )
X-Permitted-Cross-Domain-Policies
Parameters
-
string
$policyoptional self::ALL -
Policy value. Available Values: 'all', 'none', 'master-only', 'by-content-type', 'by-ftp-filename'
Returns
$this
Link
https://www.adobe.com/devnet/adobe-media-server/articles/cross-domain-xml-for-streaming.htmlsetReferrerPolicy()source public
setReferrerPolicy( string $policy = self::SAME_ORIGIN )
Referrer-Policy
Parameters
-
string
$policyoptional self::SAME_ORIGIN -
Policy value. Available Value: 'no-referrer', 'no-referrer-when-downgrade', 'origin', 'origin-when-cross-origin', 'same-origin', 'strict-origin', 'strict-origin-when-cross-origin', 'unsafe-url'
Returns
$this
Link
https://w3c.github.io/webappsec-referrer-policysetXFrameOptions()source public
setXFrameOptions( string $option = self::SAMEORIGIN , string $url = null )
X-Frame-Options
Parameters
-
string
$optionoptional self::SAMEORIGIN -
Option value. Available Values: 'deny', 'sameorigin', 'allow-from
' -
string
$urloptional null -
URL if mode is
allow-from
Returns
$this
Link
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-OptionssetXssProtection()source public
setXssProtection( string $mode = self::XSS_BLOCK )
X-XSS-Protection
Parameters
-
string
$modeoptional self::XSS_BLOCK - Mode value. Available Values: '1', '0', 'block'
Returns
$this
Link
https://blogs.msdn.microsoft.com/ieinternals/2011/01/31/controlling-the-xss-filterProperties detail
© 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.7/class-Cake.Http.Middleware.SecurityHeadersMiddleware.html