Skip to content

Commit 6dad21e

Browse files
ghoneycuttRyan Whitehurst
ghoneycutt
and
Ryan Whitehurst
committed
(MODULES-6366) Add data types for IP validation
The types are from https://github.com/thrnio/puppet-ip which was released under the Apache-2.0 license by Ryan Whitehurst. Spec tests added and code modified to work with puppetlabs/stdlib by Garrett Honeycutt. Co-authored-by: Ryan Whitehurst <ryan@ryanwhitehurst.com> Co-authored-by: Garrett Honeycutt <code@garretthoneycutt.com>
1 parent b9a40c8 commit 6dad21e

25 files changed

Lines changed: 542 additions & 0 deletions

‎README.md‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -705,6 +705,129 @@ Unacceptable input example:
705705
foobar2001:db8::1
706706
```
707707
708+
#### `Stdlib::IP::Address`
709+
710+
Matches any IP address, including both IPv4 and IPv6 addresses. It will
711+
match them either with or without an address prefix as used in CIDR
712+
format IPv4 addresses.
713+
714+
Examples:
715+
716+
```
717+
'127.0.0.1' =~ Stdlib::IP::Address # true
718+
'8.8.4.4' =~ Stdlib::IP::Address # true
719+
'10.1.240.4/24' =~ Stdlib::IP::Address # true
720+
'52.10.10.141' =~ Stdlib::IP::Address # true
721+
'192.168.1' =~ Stdlib::IP::Address # false
722+
'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address # true
723+
'FF01:0:0:0:0:0:0:101' =~ Stdlib::IP::Address # true
724+
'FF01::101' =~ Stdlib::IP::Address # true
725+
'FF01:0:0:0:0:0:0:101/32' =~ Stdlib::IP::Address # true
726+
'FF01::101/60' =~ Stdlib::IP::Address # true
727+
'::' =~ Stdlib::IP::Address # true
728+
'12AB::CD30:192.168.0.1' =~ Stdlib::IP::Address # true
729+
```
730+
731+
#### `Stdlib::IP::Address::V4`
732+
733+
Match any string consisting of an IPv4 address in the quad-dotted
734+
decimal format, with or without a CIDR prefix. It will not match any
735+
abbreviated form (e.g., 192.168.1) because these are poorly documented
736+
and inconsistently supported.
737+
738+
Examples:
739+
740+
```
741+
'127.0.0.1' =~ Stdlib::IP::Address::V4 # true
742+
'8.8.4.4' =~ Stdlib::IP::Address::V4 # true
743+
'10.1.240.4/24' =~ Stdlib::IP::Address::V4 # true
744+
'52.10.10.141' =~ Stdlib::IP::Address::V4 # true
745+
'192.168.1' =~ Stdlib::IP::Address::V4 # false
746+
'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address::V4 # false
747+
'12AB::CD30:192.168.0.1' =~ Stdlib::IP::Address::V4 # false
748+
```
749+
750+
#### `Stdlib::IP::Address::V6`
751+
752+
Match any string consistenting of an IPv6 address in any of the
753+
documented formats in RFC 2373, with or without an address prefix.
754+
755+
Examples:
756+
757+
```
758+
'127.0.0.1' =~ Stdlib::IP::Address::V6 # false
759+
'10.1.240.4/24' =~ Stdlib::IP::Address::V6 # false
760+
'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address::V6 # true
761+
'FF01:0:0:0:0:0:0:101' =~ Stdlib::IP::Address::V6 # true
762+
'FF01::101' =~ Stdlib::IP::Address::V6 # true
763+
'FF01:0:0:0:0:0:0:101/32' =~ Stdlib::IP::Address::V6 # true
764+
'FF01::101/60' =~ Stdlib::IP::Address::V6 # true
765+
'::' =~ Stdlib::IP::Address::V6 # true
766+
'12AB::CD30:192.168.0.1' =~ Stdlib::IP::Address::V6 # true
767+
```
768+
769+
#### `Stdlib::IP::Address::Nosubnet`
770+
771+
Match the same things as the `Stdlib::IP::Address` alias, except it will not
772+
match an address that includes an address prefix (e.g., it will match
773+
`192.168.0.6` but not `192.168.0.6/24`).
774+
775+
#### `Stdlib::IP::Address::V4::CIDR`
776+
777+
Match an IPv4 address in the CIDR format. It will only match if the
778+
address contains an address prefix (e.g., it will match `192.168.0.6/24`
779+
but not `192.168.0.6`).
780+
781+
#### `Stdlib::IP::Address::V4::Nosubnet`
782+
783+
Match an IPv4 address only if the address does not contain an address
784+
prefix (e.g., it will match `192.168.0.6` but not `192.168.0.6/24`).
785+
786+
#### `Stdlib::IP::Address::V6::Full`
787+
788+
Match an IPv6 address formatted in the "preferred form" as documented in
789+
section 2.2.1 of RFC 2373, with or without an address prefix as
790+
documented in section 2.3 of RFC 2373.
791+
792+
#### `Stdlib::IP::Address::V6::Alternate`
793+
794+
Match an IPv6 address formatted in the "alternative form" allowing for
795+
representing the last two 16-bit pieces of the address with a
796+
quad-dotted decimal, as documented in section 2.2.1 of RFC 2373. It will
797+
match addresses with or without an address prefix as documented in
798+
section 2.3 of RFC 2373.
799+
800+
#### `Stdlib::IP::Address::V6::Compressed`
801+
802+
Match an IPv6 address which may contain `::` used to compress zeros as
803+
documented in section 2.2.2 of RFC 2373. It will match addresses with
804+
or without an address prefix as documented in section 2.3 of RFC 2373.
805+
806+
#### `Stdlib::IP::Address::V6::Nosubnet`
807+
808+
Alias to allow `Stdlib::IP::Address::V6::Nosubnet::Full`,
809+
`Stdlib::IP::Address::V6::Nosubnet::Alternate` and
810+
`Stdlib::IP::Address::V6::Nosubnet::Compressed`.
811+
812+
#### `Stdlib::IP::Address::V6::Nosubnet::Full`
813+
814+
Match an IPv6 address formatted in the "preferred form" as documented in
815+
section 2.2.1 of RFC 2373. It will not match addresses with address
816+
prefix as documented in section 2.3 of RFC 2373.
817+
818+
#### `Stdlib::IP::Address::V6::Nosubnet::Alternate`
819+
820+
Match an IPv6 address formatted in the "alternative form" allowing for
821+
representing the last two 16-bit pieces of the address with a
822+
quad-dotted decimal, as documented in section 2.2.1 of RFC 2373. It will
823+
only match addresses without an address prefix as documented in section
824+
2.3 of RFC 2373.
825+
826+
#### `Stdlib::IP::Address::V6::Nosubnet::Compressed`
827+
828+
Match an IPv6 address which may contain `::` used to compress zeros as
829+
documented in section 2.2.2 of RFC 2373. It will only match addresses
830+
without an address prefix as documented in section 2.3 of RFC 2373.
708831
709832
### Facts
710833

‎spec/type_aliases/ip_address_nosubnet_spec.rb‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
require 'spec_helper'
2+
3+
if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0
4+
describe 'Stdlib::IP::Address::Nosubnet' do
5+
describe 'accepts ipv4 and ipv6 addresses without subnets' do
6+
[
7+
'224.0.0.0',
8+
'255.255.255.255',
9+
'0.0.0.0',
10+
'192.88.99.0',
11+
'2001:0db8:85a3:0000:0000:8a2e:0370:7334',
12+
'fa76:8765:34ac:0823:ab76:eee9:0987:1111',
13+
'127.0.0.1',
14+
'8.8.4.4',
15+
'52.10.10.141',
16+
'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210',
17+
'FF01:0:0:0:0:0:0:101',
18+
'FF01::101',
19+
'::',
20+
'12AB::CD30:192.168.0.1',
21+
].each do |value|
22+
describe value.inspect do
23+
it { is_expected.to allow_value(value) }
24+
end
25+
end
26+
end
27+
28+
describe 'rejects other values' do
29+
[
30+
'10.1.240.4/24',
31+
'FF01:0:0:0:0:0:0:101/32',
32+
'FF01::101/60',
33+
'nope',
34+
'77',
35+
'4.4.4',
36+
'2001:0db8:85a3:000000:0000:8a2e:0370:7334',
37+
].each do |value|
38+
describe value.inspect do
39+
it { is_expected.not_to allow_value(value) }
40+
end
41+
end
42+
end
43+
end
44+
end

‎spec/type_aliases/ip_address_spec.rb‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
require 'spec_helper'
2+
3+
if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0
4+
describe 'Stdlib::IP::Address' do
5+
describe 'accepts ipv4 and ipv6 addresses' do
6+
[
7+
'224.0.0.0',
8+
'255.255.255.255',
9+
'0.0.0.0',
10+
'192.88.99.0',
11+
'2001:0db8:85a3:0000:0000:8a2e:0370:7334',
12+
'fa76:8765:34ac:0823:ab76:eee9:0987:1111',
13+
'127.0.0.1',
14+
'8.8.4.4',
15+
'10.1.240.4/24',
16+
'52.10.10.141',
17+
'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210',
18+
'FF01:0:0:0:0:0:0:101',
19+
'FF01::101',
20+
'FF01:0:0:0:0:0:0:101/32',
21+
'FF01::101/60',
22+
'::',
23+
'12AB::CD30:192.168.0.1',
24+
].each do |value|
25+
describe value.inspect do
26+
it { is_expected.to allow_value(value) }
27+
end
28+
end
29+
end
30+
31+
describe 'rejects other values' do
32+
[
33+
'nope',
34+
'77',
35+
'4.4.4',
36+
'2001:0db8:85a3:000000:0000:8a2e:0370:7334',
37+
].each do |value|
38+
describe value.inspect do
39+
it { is_expected.not_to allow_value(value) }
40+
end
41+
end
42+
end
43+
end
44+
end

‎spec/type_aliases/ip_address_v4_nosubnet_spec.rb‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
require 'spec_helper'
2+
3+
if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0
4+
describe 'Stdlib::IP::Address::V4::Nosubnet' do
5+
describe 'accepts ipv4 addresses without subnets' do
6+
[
7+
'127.0.0.1',
8+
'8.8.4.4',
9+
'52.10.10.141',
10+
].each do |value|
11+
describe value.inspect do
12+
it { is_expected.to allow_value(value) }
13+
end
14+
end
15+
end
16+
17+
describe 'rejects other values' do
18+
[
19+
'10.1.240.4/24',
20+
'192.168.1',
21+
'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210',
22+
'12AB::CD30:192.168.0.1',
23+
].each do |value|
24+
describe value.inspect do
25+
it { is_expected.not_to allow_value(value) }
26+
end
27+
end
28+
end
29+
end
30+
end

‎spec/type_aliases/ip_address_v4_spec.rb‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
require 'spec_helper'
2+
3+
if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0
4+
describe 'Stdlib::IP::Address::V4' do
5+
describe 'accepts ipv4 addresses' do
6+
[
7+
'127.0.0.1',
8+
'8.8.4.4',
9+
'10.1.240.4/24',
10+
'52.10.10.141',
11+
].each do |value|
12+
describe value.inspect do
13+
it { is_expected.to allow_value(value) }
14+
end
15+
end
16+
end
17+
18+
describe 'rejects other values' do
19+
[
20+
'192.168.1',
21+
'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210',
22+
'12AB::CD30:192.168.0.1',
23+
].each do |value|
24+
describe value.inspect do
25+
it { is_expected.not_to allow_value(value) }
26+
end
27+
end
28+
end
29+
end
30+
end

‎spec/type_aliases/ip_address_v6_alternative_spec.rb‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
require 'spec_helper'
2+
3+
if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0
4+
describe 'Stdlib::IP::Address::V6::Alternative' do
5+
describe 'accepts ipv6 addresses in alternative format' do
6+
[
7+
'0:0:0:0:0:0:13.1.68.3',
8+
'0:0:0:0:0:FFFF:129.144.52.38',
9+
'0:0:0:0:0:FFFF:129.144.52.38/60',
10+
].each do |value|
11+
describe value.inspect do
12+
it { is_expected.to allow_value(value) }
13+
end
14+
end
15+
end
16+
17+
describe 'rejects other values' do
18+
[
19+
'nope',
20+
'127.0.0.1',
21+
].each do |value|
22+
describe value.inspect do
23+
it { is_expected.not_to allow_value(value) }
24+
end
25+
end
26+
end
27+
end
28+
end

‎spec/type_aliases/ip_address_v6_compressed_spec.rb‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
require 'spec_helper'
2+
3+
if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0
4+
describe 'Stdlib::IP::Address::V6::Compressed' do
5+
describe 'accepts ipv6 addresses in compressed format' do
6+
[
7+
'1080::8:800:200C:417A',
8+
'1080::8:800:200C:417A/60',
9+
'FF01::101',
10+
'::1',
11+
'::',
12+
].each do |value|
13+
describe value.inspect do
14+
it { is_expected.to allow_value(value) }
15+
end
16+
end
17+
end
18+
19+
describe 'rejects other values' do
20+
[
21+
'nope',
22+
'127.0.0.1',
23+
'FEDC::BA98:7654:3210::3210',
24+
].each do |value|
25+
describe value.inspect do
26+
it { is_expected.not_to allow_value(value) }
27+
end
28+
end
29+
end
30+
end
31+
end

‎spec/type_aliases/ip_address_v6_full_spec.rb‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
require 'spec_helper'
2+
3+
if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0
4+
describe 'Stdlib::IP::Address::V6::Full' do
5+
describe 'accepts ipv6 addresses in full format' do
6+
[
7+
'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210',
8+
'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210/60',
9+
'1080:0:0:0:8:800:200C:417A',
10+
].each do |value|
11+
describe value.inspect do
12+
it { is_expected.to allow_value(value) }
13+
end
14+
end
15+
end
16+
17+
describe 'rejects other values' do
18+
[
19+
'nope',
20+
'127.0.0.1',
21+
].each do |value|
22+
describe value.inspect do
23+
it { is_expected.not_to allow_value(value) }
24+
end
25+
end
26+
end
27+
end
28+
end

0 commit comments

Comments
 (0)
⚡