Class yii\validators\IpValidator

The validator checks if the attribute value is a valid IPv4/IPv6 address or subnet.

It also may change attribute's value if normalization of IPv6 expansion is enabled.

The following are examples of validation rules using this validator:

['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

Public Properties

Public Methods

Protected Methods

Constants

Property Details

$expandIPv6 public property

Whether to expand an IPv6 address to the full notation format. Defaults to false.

public boolean $expandIPv6 = false

$hasSubnet public property

User-defined error message is used when validation fails due to $subnet is false, but CIDR prefix is present.

You may use the following placeholders in the message:

• {attribute}: the label of the attribute being validated
• {value}: the value of the attribute being validated

See also $subnet.

public string $hasSubnet = null

$ipv4 public property

Whether the validating value can be an IPv4 address. Defaults to true.

public boolean $ipv4 = true

$ipv4NotAllowed public property

User-defined error message is used when validation fails due to the disabled IPv4 validation.

You may use the following placeholders in the message:

• {attribute}: the label of the attribute being validated
• {value}: the value of the attribute being validated

See also $ipv4.

public string $ipv4NotAllowed = null

$ipv4Pattern public property

Regexp-pattern to validate IPv4 address

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 public property

Whether the validating value can be an IPv6 address. Defaults to true.

public boolean $ipv6 = true

$ipv6NotAllowed public property

User-defined error message is used when validation fails due to the disabled IPv6 validation.

You may use the following placeholders in the message:

• {attribute}: the label of the attribute being validated
• {value}: the value of the attribute being validated

See also $ipv6.

public string $ipv6NotAllowed = null

$ipv6Pattern public property

Regexp-pattern to validate IPv6 address

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 public property

User-defined error message is used when validation fails due to the wrong IP address format.

You may use the following placeholders in the message:

• {attribute}: the label of the attribute being validated
• {value}: the value of the attribute being validated

public string $message = null

$negation public property

Whether address may have a NEGATION_CHAR character at the beginning. Defaults to false.

public boolean $negation = false

$networks public property

The network aliases, that can be used in $ranges.

• key - alias name
• value - array of strings. String can be an IP range, IP address or another alias. String can be negated with NEGATION_CHAR (independent of negation option).

The following aliases are defined by default:

• *: 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 public property

User-defined error message is used when validation fails due to subnet $subnet set to 'only', but the CIDR prefix is not set.

You may use the following placeholders in the message:

• {attribute}: the label of the attribute being validated
• {value}: the value of the attribute being validated

See also $subnet.

public string $noSubnet = null

$normalize public property

Whether to add the CIDR prefix with the smallest length (32 for IPv4 and 128 for IPv6) to an address without it. Works only when subnet is not false. For example:

• 10.0.1.5 will normalized to 10.0.1.5/32
• 2008:db0::1 will be normalized to 2008:db0::1/128 Defaults to false.

See also $subnet.

public boolean $normalize = false

$notInRange public property

User-defined error message is used when validation fails due to IP address is not not allowed by $ranges check.

You may use the following placeholders in the message:

• {attribute}: the label of the attribute being validated
• {value}: the value of the attribute being validated

See also $ranges.

public string $notInRange = null

$ranges public property

The IPv4 or IPv6 ranges that are allowed or forbidden.

When the array is empty, or the option not set, all IP addresses are allowed.

Otherwise, the rules are checked sequentially until the first match is found. An IP address is forbidden, when it has not matched any of the rules.

Example:

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

In this example, access is allowed for all the IPv4 and IPv6 addresses excluding the 192.168.10.0/24 subnet. IPv4 address 192.168.10.128 is also allowed, because it is listed before the restriction.

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

$subnet public property

Whether the address can be an IP with CIDR subnet, like 192.168.10.0/24. The following values are possible:

• false - the address must not have a subnet (default).
• true - specifying a subnet is required.
• null - specifying a subnet is optional.

public boolean $subnet = false

$wrongCidr public property

User-defined error message is used when validation fails due to the wrong CIDR.

You may use the following placeholders in the message:

• {attribute}: the label of the attribute being validated
• {value}: the value of the attribute being validated

See also $subnet.

public string $wrongCidr = null

Method Details

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