Класс yii\validators\IpValidator

Валидатор проверяет, является ли значение атрибута корректным адресом IPv4/IPv6 или подсетью.

Он также может изменить значение атрибута, если включена нормализация расширения IPv6.

Ниже приведены примеры правил валидации, использующих этот валидатор:

['ip_address', 'ip'], // IPv4 or IPv6 address
['ip_address', 'ip', 'ipv6' => false], // IPv4 address (IPv6 is disabled)
['ip_address', 'ip', 'subnet' => true], // requires a CIDR prefix (like 10.0.0.1/24) for the IP address
['ip_address', 'ip', 'subnet' => null], // CIDR prefix is optional
['ip_address', 'ip', 'subnet' => null, 'normalize' => true], // CIDR prefix is optional and will be added when missing
['ip_address', 'ip', 'ranges' => ['192.168.0.0/24']], // only IP addresses from the specified subnet are allowed
['ip_address', 'ip', 'ranges' => ['!192.168.0.0/24', 'any']], // any IP is allowed except IP in the specified subnet
['ip_address', 'ip', 'expandIPv6' => true], // expands IPv6 address to a full notation format

Публичные свойства

Публичные методы

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

Константы

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

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

Расширять ли адрес IPv6 до полного формата записи. По умолчанию false.

public boolean $expandIPv6 = false

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

Используется пользовательское сообщение об ошибке, когда проверка завершается неудачно из-за $subnet равно false, но префикс CIDR присутствует.

Вы можете использовать следующие плейсхолдеры в сообщении:

• {attribute}: метка атрибута, который проверяется
• {value}: значение атрибута, который проверяется

См. также $subnet.

public string $hasSubnet = null

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

Является ли проверяемое значение адресом IPv4. По умолчанию true.

public boolean $ipv4 = true

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

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

Вы можете использовать следующие плейсхолдеры в сообщении:

• {attribute}: метка атрибута, который проверяется
• {value}: значение атрибута, который проверяется

См. также $ipv4.

public string $ipv4NotAllowed = null

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

Шаблон регулярных выражений для проверки адреса IPv4

public string $ipv4Pattern = '/^(?:(?:2(?:[0-4][0-9]|5[0-5])|[0-1]?[0-9]?[0-9])\.){3}(?:(?:2([0-4][0-9]|5[0-5])|[0-1]?[0-9]?[0-9]))$/'

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

Является ли проверяемое значение адресом IPv6. По умолчанию true.

public boolean $ipv6 = true

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

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

Вы можете использовать следующие плейсхолдеры в сообщении:

• {attribute}: метка атрибута, который проверяется
• {value}: значение атрибута, который проверяется

См. также $ipv6.

public string $ipv6NotAllowed = null

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

Шаблон регулярных выражений для проверки адреса IPv6

public string $ipv6Pattern = '/^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$/'

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

Пользовательское сообщение об ошибке используется при ошибке формата IP-адреса.

Вы можете использовать следующие плейсхолдеры в сообщении:

• {attribute}: метка атрибута, который проверяется
• {value}: значение атрибута, который проверяется

public string $message = null

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

Разрешает ли адрес символ NEGATION_CHAR в начале. По умолчанию false.

public boolean $negation = false

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

Псевдонимы сетей, которые могут использоваться в $ranges.

• ключ - имя псевдонима
• значение - массив строк. Строка может быть диапазоном IP-адресов, IP-адресом или другим псевдонимом. Строка может быть отрицаемой с помощью NEGATION_CHAR (независимо от negation опции).

По умолчанию определены следующие псевдонимы:

• *: any
• any: 0.0.0.0/0, ::/0
• private: 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, fd00::/8
• multicast: 224.0.0.0/4, ff00::/8
• linklocal: 169.254.0.0/16, fe80::/10
• localhost: 127.0.0.0/8', ::1
• documentation: 192.0.2.0/24, 198.51.100.0/24, 203.0.113.0/24, 2001:db8::/32
• system: multicast, linklocal, localhost, documentation

public array $networks = ['*' => ['any'], 'any' => ['0.0.0.0/0', '::/0'], 'private' => ['10.0.0.0/8', '172.16.0.0/12', '192.168.0.0/16', 'fd00::/8'], 'multicast' => ['224.0.0.0/4', 'ff00::/8'], 'linklocal' => ['169.254.0.0/16', 'fe80::/10'], 'localhost' => ['127.0.0.0/8', '::1'], 'documentation' => ['192.0.2.0/24', '198.51.100.0/24', '203.0.113.0/24', '2001:db8::/32'], 'system' => ['multicast', 'linklocal', 'localhost', 'documentation']]

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

Пользовательское сообщение об ошибке используется, когда проверка не проходит из-за того, что параметр подсети $subnet установлен в 'только', но префикс CIDR не задан.

Вы можете использовать следующие плейсхолдеры в сообщении:

• {attribute}: метка атрибута, который проверяется
• {value}: значение атрибута, который проверяется

См. также $subnet.

public string $noSubnet = null

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

Добавлять ли префикс CIDR с минимальной длиной (32 для IPv4 и 128 для IPv6) к адресу без него. Работает только если subnet не false. Например:

• 10.0.1.5 будет нормализован до 10.0.1.5/32
• 2008:db0::1 будет нормализован до 2008:db0::1/128 По умолчанию false.

См. также $subnet.

public boolean $normalize = false

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

Пользовательское сообщение об ошибке используется, когда проверка не проходит из-за того, что IP-адрес не разрешён настройкой $ranges.

Вы можете использовать следующие плейсхолдеры в сообщении:

• {attribute}: метка атрибута, который проверяется
• {value}: значение атрибута, который проверяется

См. также $ranges.

public string $notInRange = null

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

Диапазоны IPv4 или IPv6, которые разрешены или запрещены.

Когда массив пуст или опция не задана, все IP-адреса разрешены.

В противном случае правила проверяются последовательно до первого совпадения. IP-адрес запрещён, если он не совпал ни с одним из правил.

Пример:

[
     'ranges' => [
         '192.168.10.128'
         '!192.168.10.0/24',
         'any' // allows any other IP addresses
     ]
]

В данном примере доступ разрешен для всех IPv4 и IPv6 адресов, кроме подсети 192.168.10.0/24. IPv4 адрес 192.168.10.128 также разрешен, так как он указан раньше ограничения.

public array getRanges ( )
public void setRanges ( $ranges )

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

Можно ли использовать адрес с подсетью CIDR, например, 192.168.10.0/24. Возможные значения:

• false - адрес не должен иметь подсети (по умолчанию).
• true - указать подсеть обязательно.
• null - указать подсеть необязательно.

public boolean $subnet = false

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

Пользовательское сообщение об ошибке используется при ошибке CIDR.

Вы можете использовать следующие плейсхолдеры в сообщении:

• {attribute}: метка атрибута, который проверяется
• {value}: значение атрибута, который проверяется

См. также $subnet.

public string $wrongCidr = null

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

[
     'ranges' => [
         '192.168.10.128'
         '!192.168.10.0/24',
         'any' // allows any other IP addresses
     ]
]