https://github.com/miken32/networkrules
Laravel validation rules for checking IP addresses and networks
https://github.com/miken32/networkrules
ip-address ip-networking laravel networking subnets validation
Last synced: 7 months ago
JSON representation
Laravel validation rules for checking IP addresses and networks
- Host: GitHub
- URL: https://github.com/miken32/networkrules
- Owner: miken32
- License: agpl-3.0
- Created: 2023-10-04T19:10:08.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-08T18:04:40.000Z (over 1 year ago)
- Last Synced: 2025-10-20T01:53:02.948Z (8 months ago)
- Topics: ip-address, ip-networking, laravel, networking, subnets, validation
- Language: PHP
- Homepage:
- Size: 83 KB
- Stars: 11
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A Collection of Rules
for the Reliable Validation
of
Internet Protocol Addreſſes,
Networks, and Subnets
which the author hopes will be found uſeful to
Laravel Programmers &c.
## Installation
```sh
composer require miken32/network-rules
```
## Available Validation Rules
Here is a list of the available rules and their usage.
[In Network](#in_networkcidr)
[IP Or Net](#ip_or_net)
[Netv4](#netv4lowhigh)
[Netv6](#netv6lowhigh)
[Private IP](#private_ip)
[Private IPv4](#private_ipv4)
[Private IPv6](#private_ipv6)
[Private Net](#private_net)
[Routable IP or Net](#routable_ip_or_net)
[Routable IP](#routable_ip)
[Routable IPv4](#routable_ipv4)
[Routable IPv6](#routable_ipv6)
[Routable Net](#routable_netlowhigh)
[Routable Netv4](#routable_netv4lowhigh)
[Routable Netv6](#routable_netv6lowhigh)
### in_network:cidr,...
The field under validation must be an IP address within one of the given networks.
The networks must be given in CIDR notation, and may be either IPv4 or IPv6 networks.
```none
'ip4_address' => 'in_network:192.168.0.1/24',
'some_address' => 'in_network:192.168.0.0/24,192.168.1.0/24,192.168.2.0/24',
'ip6_address' => 'in_network:fd03:224f:a5c3:99ae::0/64'
```
### ip_or_net
The field under validation must be an IP address or network in CIDR notation.
The address or network may be either IPv4 or IPv6.
### netv4:_low_,_high_
The field under validation must be an IPv4 network in CIDR notation.
If provided, the number of bits in the mask must be between `low` and `high`.
```none
'bounded_network' => 'netv4:20,24',
'unbounded_network' => 'netv4'
```
### netv6:_low_,_high_
The field under validation must be an IPv6 network in CIDR notation.
If provided, the number of bits in the mask must be between `low` and `high`.
```none
'bounded_network' => 'netv6:56,64'
'unbounded_network' => 'netv6'
```
### private_ip
The field under validation must be a private IPv4 or IPv6 address.
Private addresses are defined as being within one of the following networks:
* 10.0.0.0/8
* 172.16.0.0/12
* 192.168.0.0/16
* fc00::/7
The following networks are considered _reserved_, not _private_.
They are **not** considered valid by this rule:
* 0.0.0.0/8
* 127.0.0.0/8
* 169.254.0.0/16
* 240.0.0.0/4
* ::/128
* ::1/128
* 2001:10::/28
* 2001:db8::/32
* 3ffe::/16
* 5f00::/8
* fe80::/10
### private_ipv4
The field under validation must be a private IPv4 addresses.
The networks considered private are described in the `private_ip` rule.
### private_ipv6
The field under validation must be a private IPv6 addresses.
The networks considered private are described in the `private_ip` rule.
### private_net
The field under validation must be a private IP network in CIDR notation.
The networks considered private are described in the `private_ip` rule.
### routable_ip_or_net
The field under validation must be a globally routable IP address or network in CIDR notation.
This excludes all private and reserved ranges, as detailed the the `private_ip` rule.
### routable_ip
The field under validation must be a globally routable IPv4 or IPv6 address.
This excludes all private and reserved ranges, as detailed the the `private_ip` rule.
### routable_ipv4
The field under validation must be a globally routable IPv4 address.
This excludes all private and reserved ranges, as detailed the the `private_ip` rule.
### routable_ipv6
The field under validation must be a globally routable IPv6 address.
This excludes all private and reserved ranges, as detailed the the `private_ip` rule.
### routable_net:_low_,_high_
The field under validation must be a globally routable IP network in CIDR notation.
The network must not overlap any private or reserved ranges, as detailed the the `private_ip` rule.
If provided, the number of bits in the mask must be between `low` and `high`.
### routable_netv4:_low_,_high_
The field under validation must be a globally routable IPv4 network in CIDR notation.
The network must not overlap any private or reserved ranges, as detailed the the `private_ip` rule.
If provided, the number of bits in the mask must be between `low` and `high`.
### routable_netv6:_low_,_high_
The field under validation must be a globally routable IPv6 network in CIDR notation.
The network must not overlap any private or reserved ranges, as detailed the the `private_ip` rule.
If provided, the number of bits in the mask must be between `low` and `high`.
## Usage
The included validation rules can be used either as traditional string-based validation rules
or as instantiated classes. The following code blocks perform identical validations.
```php
['in_network:192.168.10.0/24'], // must be an IPv4 address in the specified network
'subnet' => ['netv4'], // must be an IPv4 CIDR network
'ipv6_subnet' => ['netv6:48,56'], // must be an IPv6 CIDR network between 48 and 56 bits
];
}
}
```
```php
[new Rules\InNetwork('192.168.10.0/24')], // must be an IPv4 address in the specified network
'subnet' => [new Rules\Netv4()], // must be an IPv4 CIDR network
'ipv6_subnet' => [new Rules\Netv6(48, 56)], // must be an IPv6 CIDR network between 48 and 56 bits
];
}
}
```