Spec-Zone.ru › CakePHP 4.3

Класс SecurityHeadersMiddleware

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

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

Константы

  • 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

    Заголовки, связанные с безопасностью, для установки

END_OF_DOCUMENT_MARKER

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

  • checkValues() protected

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

  • noOpen() public

    X-Download-Options

  • noSniff() public

    X-Content-Type-Options

  • process() public

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

  • setCrossDomainPolicy() public

    X-Permitted-Cross-Domain-Policies

  • setReferrerPolicy() public

    Referrer-Policy

  • setXFrameOptions() public

    X-Frame-Options

  • setXssProtection() public

    X-XSS-Protection

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

checkValues() protected

checkValues(string $value, array<string> $allowed): void

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

Параметры

string $value

Значение для проверки

array<string> $allowed

Список разрешенных значений

Возвращает

void

Исключения

InvalidArgumentException
Бросается, когда значение недопустимо.

noOpen() public

noOpen(): $this

X-Download-Options

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

Возвращает

$this

Ссылки

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

noSniff() public

noSniff(): $this

X-Content-Type-Options

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

Возвращает

$this

Ссылки

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

process() public

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

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

Обрабатывает входящий запрос сервера для создания ответа. Если не может создать ответ сам, делегирует обработку запросу.

Параметры

ServerRequestInterface $request

Запрос.

RequestHandlerInterface $handler

Обработчик запроса.

Возвращает

Psr\Http\Message\ResponseInterface

setCrossDomainPolicy() public

setCrossDomainPolicy(string $policy = self::ALL): $this

X-Permitted-Cross-Domain-Policies

Параметры

string $policy optional

Значение политики. Доступные значения: '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

setReferrerPolicy() public

setReferrerPolicy(string $policy = self::SAME_ORIGIN): $this

Referrer-Policy

Параметры

string $policy optional

Значение политики. Доступное значение: '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() public

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

X-Frame-Options

Параметры

string $option optional

Значение опции. Доступные значения: 'deny', 'sameorigin', 'allow-from '

string|null $url optional

URL, если режим allow-from

Возвращает

$this

Ссылки

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

setXssProtection() public

setXssProtection(string $mode = self::XSS_BLOCK): $this

X-XSS-Protection

Параметры

string $mode optional

Значение режима. Доступные значения: '1', '0', 'block'

Возвращает

$this

Ссылки

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

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

$headers protected

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

Тип

array

© 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.3/class-Cake.Http.Middleware.SecurityHeadersMiddleware.html

Spec-Zone.ru

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