Spec-Zone.ru › CakePHP 3.8

Класс SecurityHeadersMiddleware

Обрабатывает общие заголовки безопасности удобным способом

Пространство имён: Cake\Http\Middleware
Ссылка: https://book.cakephp.org/3.0/ru/controllers/middleware.html#security-header-middleware
Расположение: Http/Middleware/SecurityHeadersMiddleware.php

Краткое описание констант

  • string

    ALL
    'all'
  • string

    ALLOW_FROM
    'allow-from'
  • string

    BY_CONTENT_TYPE
    'by-content-type'
  • string

    BY_FTP_FILENAME
    'by-ftp-filename'
  • string

    DENY
    'deny'
  • string

    MASTER_ONLY
    'master-only'
  • string

    NONE
    'none'
  • string

    NOOPEN
    'noopen'
  • string

    NOSNIFF
    'nosniff'
  • string

    NO_REFERRER
    'no-referrer'
  • string

    NO_REFERRER_WHEN_DOWNGRADE
    'no-referrer-when-downgrade'
  • string

    ORIGIN
    'origin'
  • string

    ORIGIN_WHEN_CROSS_ORIGIN
    'origin-when-cross-origin'
  • string

    SAMEORIGIN
    'sameorigin'
  • string

    SAME_ORIGIN
    'same-origin'
  • string

    STRICT_ORIGIN
    'strict-origin'
  • string

    STRICT_ORIGIN_WHEN_CROSS_ORIGIN
    'strict-origin-when-cross-origin'
  • string

    UNSAFE_URL
    'unsafe-url'
  • string

    XSS_BLOCK
    'block'
  • string

    XSS_DISABLED
    '0'
  • string

    XSS_ENABLED
    '1'
  • string

    XSS_ENABLED_BLOCK
    '1; mode=block'

Краткое описание свойств

  • $headers protected
    array
    Заголовки, связанные с безопасностью, которые нужно установить

Краткое описание методов

  • __invoke() public
    Обработать активы, если путь соответствует одному из них.
  • checkValues() protected
    Удобный метод для проверки, находится ли значение в списке разрешённых аргументов
  • noOpen() public
    X-Download-Options
  • noSniff() public
    X-Content-Type-Options
  • setCrossDomainPolicy() public
    X-Permitted-Cross-Domain-Policies
  • setReferrerPolicy() public
    Referrer-Policy
  • setXFrameOptions() public
    X-Frame-Options
  • setXssProtection() public
    X-XSS-Protection

Подробное описание методов

__invoke()source public

__invoke( Psr\Http\Message\ServerRequestInterface $request , Psr\Http\Message\ResponseInterface $response , callable $next )

Обработать активы, если путь соответствует одному из них.

Параметры

Psr\Http\Message\ServerRequestInterface $request
Запрос.
Psr\Http\Message\ResponseInterface $response
Ответ.
callable $next
Обработчик для вызова следующего middleware.

Возвращает

Psr\Http\Message\ResponseInterface
Ответ

checkValues()source protected

checkValues( string $value , array $allowed )

Удобный метод для проверки, находится ли значение в списке разрешённых аргументов

Параметры

string $value
Значение для проверки
array $allowed
Список разрешённых значений

Выбрасывает

InvalidArgumentException
Выбрасывается, если значение неверно.

noOpen()source public

noOpen( )

X-Download-Options

Устанавливает значение заголовка для него в 'noopen'

Возвращает


$this

Ссылка

https://msdn.microsoft.com/ru-ru/library/jj542450(v=vs.85).aspx

noSniff()source public

noSniff( )

X-Content-Type-Options

Устанавливает значение заголовка для него в 'nosniff'

Возвращает


$this

Ссылка

https://developer.mozilla.org/ru/docs/Web/HTTP/Headers/X-Content-Type-Options

setCrossDomainPolicy()source public

setCrossDomainPolicy( string $policy = self::ALL )

X-Permitted-Cross-Domain-Policies

Параметры

string $policy необязательно self::ALL

Значение политики. Доступные значения: 'all', 'none', 'master-only', 'by-content-type', 'by-ftp-filename'

Возвращает


$this

Ссылка

https://www.adobe.com/devnet/adobe-media-server/articles/cross-domain-xml-for-streaming.html
END_OF_DOCUMENT_MARKER

setReferrerPolicy()source public

setReferrerPolicy( string $policy = self::SAME_ORIGIN )

Политика Referrer-Policy

Параметры

string $policy необязательно self::SAME_ORIGIN

Значение политики. Доступные значения: 'no-referrer', 'no-referrer-when-downgrade', 'origin', 'origin-when-cross-origin', 'same-origin', 'strict-origin', 'strict-origin-when-cross-origin', 'unsafe-url'

Возвращаемое значение


$this

Ссылка

https://w3c.github.io/webappsec-referrer-policy

setXFrameOptions()source public

setXFrameOptions( string $option = self::SAMEORIGIN , string $url = null )

X-Frame-Options

Параметры

string $option необязательно self::SAMEORIGIN
Значение опции. Доступные значения: 'deny', 'sameorigin', 'allow-from '
string $url необязательно null
URL, если режим allow-from

Возвращаемое значение


$this

Ссылка

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options

setXssProtection()source public

setXssProtection( string $mode = self::XSS_BLOCK )

X-XSS-Protection

Параметры

string $mode необязательно self::XSS_BLOCK
Значение режима. Доступные значения: '1', '0', 'block'

Возвращаемое значение


$this

Ссылка

https://blogs.msdn.microsoft.com/ieinternals/2011/01/31/controlling-the-xss-filter

Подробности свойств

$headerssource

protected массив

Заголовки, относящиеся к безопасности

[]

© 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.SecurityHeadersMiddleware.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API