Класс yii\filters\HostControl

HostControl обеспечивает простой контроль над запрошенным именем хоста.

Этот фильтр обеспечивает защиту от 'атак на заголовок хоста', разрешая выполнение действия только для указанных имен хостов.

Пример конфигурации приложения:

return [
    'as hostControl' => [
        'class' => 'yii\filters\HostControl',
        'allowedHosts' => [
            'example.com',
            '*.example.com',
        ],
    ],
    // ...
];

Пример конфигурации контроллера:

use yii\web\Controller;
use yii\filters\HostControl;

class SiteController extends Controller
{
    public function behaviors()
    {
        return [
            'hostControl' => [
                'class' => HostControl::className(),
                'allowedHosts' => [
                    'example.com',
                    '*.example.com',
                ],
            ],
        ];
    }

    // ...
}

Примечание: лучший способ ограничить разрешенные имена хостов — использование конфигурации виртуальных хостов веб-сервера. Этот фильтр следует использовать только в том случае, если эта конфигурация недоступна или скомпрометирована.

Общедоступные свойства

Общедоступные методы

Защищённые методы

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

$allowedHosts общедоступное свойство

Список имен хостов, которые разрешены. Каждый хост может быть указан в виде шаблона с подстановкой. Например:

[
    'example.com',
    '*.example.com',
]

Это поле может быть указано как PHP обратный вызов с следующим сигнатурой:

function (\yii\base\Action $action) {
    //return array of strings
}

где $action — текущий объект действия.

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

public array|Closure|null $allowedHosts = null

$denyCallback общедоступное свойство

Обратный вызов, который будет вызван, если текущий хост не соответствует $allowedHosts. Если не установлено, будет вызван denyAccess().

Сигнатура обратного вызова должна быть следующей:

function (\yii\base\Action $action)

где $action — текущий объект действия.

Примечание: при реализации собственной обработки отказа доступа к хосту убедитесь, что вы избегаете использования текущего имени запрошенного хоста, создания абсолютных ссылок URL, кэширования частей страницы и т. д.

public callable $denyCallback = null

$fallbackHostInfo общедоступное свойство

Дополнительная информация о хосте (например, http://www.yiiframework.com) используемая, когда Request::$hostInfo недопустима. Это значение заменит Request::$hostInfo перед вызовом $denyCallback, чтобы убедиться, что недопустимый хост не будет использоваться для дальнейшей обработки. Вы можете установить его в null чтобы оставить Request::$hostInfo без изменений. Значение по умолчанию — пустая строка (это приведет к созданию относительных ссылок вместо абсолютных).

См. также yii\web\Request::getHostInfo().

public string|null $fallbackHostInfo = ''

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