クラス 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::class,
'allowedHosts' => [
'example.com',
'*.example.com',
],
],
];
}
// ...
}
注: 許可されるホスト名を制限する最良の方法は、Webサーバーの「仮想ホスト」設定を使用することです。このフィルタは、この設定が利用できないか、または侵害されている場合にのみ使用する必要があります。
公開プロパティ
プロパティ | 型 | 説明 | 定義元 |
---|---|---|---|
$allowedHosts | array|Closure|null | 許可されるホスト名のリスト。 | yii\filters\HostControl |
$denyCallback | callable|null | 現在のホストが$allowedHostsと一致しない場合に呼び出されるコールバック。 | yii\filters\HostControl |
$except | array | このフィルタを適用しないアクションIDのリスト。 | yii\base\ActionFilter |
$fallbackHostInfo | string|null | Request::$hostInfoが無効な場合に使用されるフォールバックホスト情報(例:https://yii.dokyumento.jp )。 |
yii\filters\HostControl |
$only | array | このフィルタを適用するアクションIDのリスト。 | yii\base\ActionFilter |
$owner | yii\base\Component|null | このビヘイビアのオーナー | yii\base\Behavior |
公開メソッド
保護されたメソッド
メソッド | 説明 | 定義元 |
---|---|---|
denyAccess() | アクセスを拒否します。 | yii\filters\HostControl |
getActionId() | yii\base\Action::$uniqueIdをモジュールに相対的なIDに変換することによって、アクションIDを返します。 | yii\base\ActionFilter |
isActive() | 指定されたアクションに対してフィルタがアクティブかどうかを示す値を返します。 | yii\base\ActionFilter |
プロパティの詳細
許可されるホスト名のリスト。各ホストはワイルドカードパターンとして指定できます。例えば
[
'example.com',
'*.example.com',
]
このフィールドは、次のシグネチャのPHPコールバックとして指定できます。
function (\yii\base\Action $action) {
//return array of strings
}
ここで、$action
は現在のactionオブジェクトです。
このフィールドが設定されていない場合、ホスト名チェックは実行されません。
現在のホストが$allowedHostsと一致しない場合に呼び出されるコールバック。設定されていない場合、denyAccess()が呼び出されます。
コールバックのシグネチャは次のようになります。
function (\yii\base\Action $action)
ここで、$action
は現在のactionオブジェクトです。
注:独自のホスト拒否処理を実装する際には、現在の要求されたホスト名、絶対URLリンクの作成、ページ部分のキャッシュなどを使用しないようにしてください。
Request::$hostInfoが無効な場合に使用されるフォールバックホスト情報(例:https://yii.dokyumento.jp
)。$denyCallbackが呼び出される前にRequest::$hostInfoを置き換えて、無効なホストがそれ以降の処理に使用されないようにします。 `null` を設定して Request::$hostInfo を変更しないようにすることもできます。デフォルト値は空文字列です(これにより、絶対URLではなく相対URLが作成されます)。
yii\web\Request::getHostInfo()も参照してください。
メソッドの詳細
定義位置: yii\base\BaseObject::__call()
クラスメソッドではない名前付きメソッドを呼び出します。
これはPHPのマジックメソッドであり、未知のメソッドが呼び出された際に暗黙的に呼び出されるため、直接このメソッドを呼び出さないでください。
public mixed __call ( $name, $params ) | ||
$name | string |
メソッド名 |
$params | array |
メソッドパラメータ |
戻り値 | mixed |
メソッドの戻り値 |
---|---|---|
例外 | yii\base\UnknownMethodException |
未知のメソッド呼び出し時 |
public function __call($name, $params)
{
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
定義位置: yii\base\BaseObject::__construct()
コンストラクタ。
デフォルトの実装では、以下の2つの処理を行います。
- 与えられた設定
$config
を使用してオブジェクトを初期化します。 - init()を呼び出します。
このメソッドを子クラスでオーバーライドする場合は、
- コンストラクタの最後の引数を、ここにある
$config
のような設定配列にすることをお勧めします。 - コンストラクタの最後に親の実装を呼び出してください。
public void __construct ( $config = [] ) | ||
$config | array |
オブジェクトのプロパティを初期化するために使用される名前と値のペア |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
定義位置: yii\base\BaseObject::__get()
オブジェクトプロパティの値を返します。
これはPHPのマジックメソッドであり、`$value = $object->property;`を実行した際に暗黙的に呼び出されるため、直接このメソッドを呼び出さないでください。
詳しくは__set()を参照してください。
public mixed __get ( $name ) | ||
$name | string |
プロパティ名 |
戻り値 | mixed |
プロパティ値 |
---|---|---|
例外 | yii\base\UnknownPropertyException |
プロパティが定義されていない場合 |
例外 | yii\base\InvalidCallException |
プロパティが書き込み専用の場合 |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter();
} elseif (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
定義位置: yii\base\BaseObject::__isset()
プロパティが設定されているか、つまり定義されていてnullでないかどうかを確認します。
これはPHPのマジックメソッドであり、`isset($object->property)`を実行した際に暗黙的に呼び出されるため、直接このメソッドを呼び出さないでください。
プロパティが定義されていない場合、falseが返されることに注意してください。
詳しくはhttps://www.php.net/manual/en/function.isset.phpを参照してください。
public boolean __isset ( $name ) | ||
$name | string |
プロパティ名またはイベント名 |
戻り値 | boolean |
指定されたプロパティが設定されているかどうか(nullでないか)。 |
---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
return false;
}
定義位置: yii\base\BaseObject::__set()
オブジェクトプロパティの値を設定します。
これはPHPのマジックメソッドであり、`$object->property = $value;`を実行した際に暗黙的に呼び出されるため、直接このメソッドを呼び出さないでください。
詳しくは__get()を参照してください。
public void __set ( $name, $value ) | ||
$name | string |
プロパティ名またはイベント名 |
$value | mixed |
プロパティ値 |
例外 | yii\base\UnknownPropertyException |
プロパティが定義されていない場合 |
---|---|---|
例外 | yii\base\InvalidCallException |
プロパティが読み取り専用の場合 |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter($value);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
} else {
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
}
定義位置: yii\base\BaseObject::__unset()
オブジェクトプロパティをnullに設定します。
これはPHPのマジックメソッドであり、`unset($object->property)`を実行した際に暗黙的に呼び出されるため、直接このメソッドを呼び出さないでください。
プロパティが定義されていない場合、このメソッドは何もしません。プロパティが読み取り専用の場合、例外をスローします。
詳しくはhttps://www.php.net/manual/en/function.unset.phpを参照してください。
public void __unset ( $name ) | ||
$name | string |
プロパティ名 |
例外 | yii\base\InvalidCallException |
プロパティが読み取り専用の場合。 |
---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
}
}
定義位置: yii\base\ActionFilter::afterAction()
このメソッドは、アクションが実行された直後に呼び出されます。
アクションのポスト処理を行うために、このメソッドをオーバーライドできます。
public mixed afterAction ( $action, $result ) | ||
$action | yii\base\Action |
実行されたばかりのアクション。 |
$result | mixed |
アクションの実行結果 |
戻り値 | mixed |
処理されたアクションの結果。 |
---|
public function afterAction($action, $result)
{
return $result;
}
public void afterFilter ( $event ) | ||
$event | yii\base\ActionEvent |
public function afterFilter($event)
{
$event->result = $this->afterAction($event->action, $event->result);
$this->owner->off(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter']);
}
定義位置: yii\base\ActionFilter::attach()
ビヘイビアオブジェクトをコンポーネントにアタッチします。
デフォルトの実装では、$ownerプロパティを設定し、events()で宣言されているイベントハンドラをアタッチします。このメソッドをオーバーライドする場合は、親の実装を必ず呼び出してください。
public void attach ( $owner ) | ||
$owner | yii\base\Component |
このビヘイビアがアタッチされるコンポーネント。 |
public function attach($owner)
{
$this->owner = $owner;
$owner->on(Controller::EVENT_BEFORE_ACTION, [$this, 'beforeFilter']);
}
このメソッドは、アクションが実行される直前に(可能なすべてのフィルタの後)呼び出されます。アクションの最終準備を行うために、このメソッドをオーバーライドすることができます。
public boolean beforeAction ( $action ) | ||
$action | yii\base\Action |
実行されるアクション。 |
戻り値 | boolean |
アクションの実行を継続するかどうか。 |
---|
public function beforeAction($action)
{
$allowedHosts = $this->allowedHosts;
if ($allowedHosts instanceof \Closure) {
$allowedHosts = call_user_func($allowedHosts, $action);
}
if ($allowedHosts === null) {
return true;
}
if (!is_array($allowedHosts) && !$allowedHosts instanceof \Traversable) {
$allowedHosts = (array) $allowedHosts;
}
$currentHost = Yii::$app->getRequest()->getHostName();
foreach ($allowedHosts as $allowedHost) {
if (StringHelper::matchWildcard($allowedHost, $currentHost)) {
return true;
}
}
// replace invalid host info to prevent using it in further processing
if ($this->fallbackHostInfo !== null) {
Yii::$app->getRequest()->setHostInfo($this->fallbackHostInfo);
}
if ($this->denyCallback !== null) {
call_user_func($this->denyCallback, $action);
} else {
$this->denyAccess($action);
}
return false;
}
public void beforeFilter ( $event ) | ||
$event | yii\base\ActionEvent |
public function beforeFilter($event)
{
if (!$this->isActive($event->action)) {
return;
}
$event->isValid = $this->beforeAction($event->action);
if ($event->isValid) {
// call afterFilter only if beforeFilter succeeds
// beforeFilter and afterFilter should be properly nested
$this->owner->on(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter'], null, false);
} else {
$event->handled = true;
}
}
定義位置: yii\base\BaseObject::canGetProperty()
プロパティを読み取ることができるかどうかを示す値を返します。
プロパティは、以下の場合に読み取り可能です。
- 指定された名前に関連付けられたゲッターメソッドがクラスに存在する場合(この場合、プロパティ名は大小文字を区別しません)。
- 指定された名前のメンバ変数がクラスに存在する場合(
$checkVars
が true の場合)。
参照: canSetProperty().
public boolean canGetProperty ( $name, $checkVars = true ) | ||
$name | string |
プロパティ名 |
$checkVars | boolean |
メンバ変数をプロパティとして扱うかどうか |
戻り値 | boolean |
プロパティを読み取ることができるかどうか |
---|
public function canGetProperty($name, $checkVars = true)
{
return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
定義位置: yii\base\BaseObject::canSetProperty()
プロパティを設定できるかどうかを示す値を返します。
プロパティは、以下の場合に書き込み可能です。
- 指定された名前に関連付けられたセッターメソッドがクラスに存在する場合(この場合、プロパティ名は大小文字を区別しません)。
- 指定された名前のメンバ変数がクラスに存在する場合(
$checkVars
が true の場合)。
参照: canGetProperty().
public boolean canSetProperty ( $name, $checkVars = true ) | ||
$name | string |
プロパティ名 |
$checkVars | boolean |
メンバ変数をプロパティとして扱うかどうか |
戻り値 | boolean |
プロパティを書き込むことができるかどうか |
---|
public function canSetProperty($name, $checkVars = true)
{
return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
::class
を使用してください。
定義位置: yii\base\BaseObject::className()
このクラスの完全修飾名を返します。
public static string className ( ) | ||
戻り値 | string |
このクラスの完全修飾名。 |
---|
public static function className()
{
return get_called_class();
}
アクセスを拒否します。
デフォルトの実装では、プログラムの実行を終了してすぐに404ページが表示されます。このメソッドをオーバーライドして、独自のアクセス拒否ハンドラを作成できます。ただし、その際、現在の要求されたホスト名、絶対URLリンクの作成、ページ部分のキャッシュなどを避けてください。
protected void denyAccess ( $action ) | ||
$action | yii\base\Action |
実行されるアクション。 |
例外 | yii\web\NotFoundHttpException |
---|
protected function denyAccess($action)
{
$exception = new NotFoundHttpException(Yii::t('yii', 'Page not found.'));
// use regular error handling if $this->fallbackHostInfo was set
if (!empty(Yii::$app->getRequest()->hostName)) {
throw $exception;
}
$response = Yii::$app->getResponse();
$errorHandler = Yii::$app->getErrorHandler();
$response->setStatusCode($exception->statusCode, $exception->getMessage());
$response->data = $errorHandler->renderFile($errorHandler->errorView, ['exception' => $exception]);
$response->send();
Yii::$app->end();
}
定義位置: yii\base\ActionFilter::detach()
ビヘイビアオブジェクトをコンポーネントからデタッチします。
デフォルトの実装では、$ownerプロパティをアンセットし、events()で宣言されたイベントハンドラをデタッチします。このメソッドをオーバーライドする場合は、親の実装を必ず呼び出してください。
public void detach ( ) |
public function detach()
{
if ($this->owner) {
$this->owner->off(Controller::EVENT_BEFORE_ACTION, [$this, 'beforeFilter']);
$this->owner->off(Controller::EVENT_AFTER_ACTION, [$this, 'afterFilter']);
$this->owner = null;
}
}
定義位置: yii\base\Behavior::events()
$ownerのイベントのイベントハンドラを宣言します。
子クラスは、このメソッドをオーバーライドして、$ownerコンポーネントのイベントにアタッチするべきPHPコールバックを宣言できます。
コールバックは、ビヘイビアがオーナーにアタッチされると$ownerのイベントにアタッチされ、ビヘイビアがコンポーネントからデタッチされるとイベントからデタッチされます。
コールバックは、以下のいずれかになります。
- このビヘイビアのメソッド:
'handleClick'
、[$this, 'handleClick']
と同等 - オブジェクトメソッド:
[$object, 'handleClick']
- 静的メソッド:
['Page', 'handleClick']
- 無名関数:
function ($event) { ... }
例を以下に示します。
[
Model::EVENT_BEFORE_VALIDATE => 'myBeforeValidate',
Model::EVENT_AFTER_VALIDATE => 'myAfterValidate',
]
public array events ( ) | ||
戻り値 | array |
イベント(配列キー)と対応するイベントハンドラメソッド(配列値)。 |
---|
public function events()
{
return [];
}
定義位置: yii\base\ActionFilter::getActionId()
yii\base\Action::$uniqueIdをモジュールに相対的なIDに変換することによって、アクションIDを返します。
protected string getActionId ( $action ) | ||
$action | yii\base\Action |
protected function getActionId($action)
{
if ($this->owner instanceof Module) {
$mid = $this->owner->getUniqueId();
$id = $action->getUniqueId();
if ($mid !== '' && strpos($id, $mid) === 0) {
$id = substr($id, strlen($mid) + 1);
}
} else {
$id = $action->id;
}
return $id;
}
定義位置: yii\base\BaseObject::hasMethod()
メソッドが定義されているかどうかを示す値を返します。
デフォルトの実装は、PHP関数method_exists()
の呼び出しです。PHPマジックメソッド__call()
を実装した場合は、このメソッドをオーバーライドできます。
public boolean hasMethod ( $name ) | ||
$name | string |
メソッド名 |
戻り値 | boolean |
メソッドが定義されているかどうか |
---|
public function hasMethod($name)
{
return method_exists($this, $name);
}
定義位置: yii\base\BaseObject::hasProperty()
プロパティが定義されているかどうかを示す値を返します。
プロパティは、以下の場合に定義されています。
- 指定された名前に関連付けられたゲッターまたはセッターメソッドがクラスに存在する場合(この場合、プロパティ名は大小文字を区別しません)。
- 指定された名前のメンバ変数がクラスに存在する場合(
$checkVars
が true の場合)。
参照:
public boolean hasProperty ( $name, $checkVars = true ) | ||
$name | string |
プロパティ名 |
$checkVars | boolean |
メンバ変数をプロパティとして扱うかどうか |
戻り値 | boolean |
プロパティが定義されているかどうか |
---|
public function hasProperty($name, $checkVars = true)
{
return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
public void init ( ) |
public function init()
{
}
定義場所: yii\base\ActionFilter::isActive()
指定されたアクションに対してフィルタがアクティブかどうかを示す値を返します。
protected boolean isActive ( $action ) | ||
$action | yii\base\Action |
フィルタリングされるアクション |
戻り値 | boolean |
指定されたアクションに対してフィルタが有効かどうか。 |
---|
protected function isActive($action)
{
$id = $this->getActionId($action);
if (empty($this->only)) {
$onlyMatch = true;
} else {
$onlyMatch = false;
foreach ($this->only as $pattern) {
if (StringHelper::matchWildcard($pattern, $id)) {
$onlyMatch = true;
break;
}
}
}
$exceptMatch = false;
foreach ($this->except as $pattern) {
if (StringHelper::matchWildcard($pattern, $id)) {
$exceptMatch = true;
break;
}
}
return !$exceptMatch && $onlyMatch;
}
コメントするにはサインアップ または ログインしてください。