Skip to content

Commit 53bf879

Browse files
ghoneycuttghoneycutt
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.
1 parent e08cfa9 commit 53bf879

25 files changed

+547
-0
lines changed

‎README.md

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -413,6 +413,130 @@ Unacceptable input example:
413413
/usr2/username/bin:/usr/local/bin:/usr/bin:.
414414
```
415415

416+
#### `Stdlib::IP::Address`
417+
418+
Matches any IP address, including both IPv4 and IPv6 addresses. It will
419+
match them either with or without an address prefix as used in CIDR
420+
format IPv4 addresses.
421+
422+
Examples:
423+
424+
```
425+
'127.0.0.1' =~ Stdlib::IP::Address # true
426+
'8.8.4.4' =~ Stdlib::IP::Address # true
427+
'10.1.240.4/24' =~ Stdlib::IP::Address # true
428+
'52.10.10.141' =~ Stdlib::IP::Address # true
429+
'192.168.1' =~ Stdlib::IP::Address # false
430+
'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address # true
431+
'FF01:0:0:0:0:0:0:101' =~ Stdlib::IP::Address # true
432+
'FF01::101' =~ Stdlib::IP::Address # true
433+
'FF01:0:0:0:0:0:0:101/32' =~ Stdlib::IP::Address # true
434+
'FF01::101/60' =~ Stdlib::IP::Address # true
435+
'::' =~ Stdlib::IP::Address # true
436+
'12AB::CD30:192.168.0.1' =~ Stdlib::IP::Address # true
437+
```
438+
439+
#### `Stdlib::IP::Address::V4`
440+
441+
Match any string consisting of an IPv4 address in the quad-dotted
442+
decimal format, with or without a CIDR prefix. It will not match any
443+
abbreviated form (e.g., 192.168.1) because these are poorly documented
444+
and inconsistently supported.
445+
446+
Examples:
447+
448+
```
449+
'127.0.0.1' =~ Stdlib::IP::Address::V4 # true
450+
'8.8.4.4' =~ Stdlib::IP::Address::V4 # true
451+
'10.1.240.4/24' =~ Stdlib::IP::Address::V4 # true
452+
'52.10.10.141' =~ Stdlib::IP::Address::V4 # true
453+
'192.168.1' =~ Stdlib::IP::Address::V4 # false
454+
'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address::V4 # false
455+
'12AB::CD30:192.168.0.1' =~ Stdlib::IP::Address::V4 # false
456+
```
457+
458+
#### `Stdlib::IP::Address::V6`
459+
460+
Match any string consistenting of an IPv6 address in any of the
461+
documented formats in RFC 2373, with or without an address prefix.
462+
463+
Examples:
464+
465+
```
466+
'127.0.0.1' =~ Stdlib::IP::Address::V6 # false
467+
'10.1.240.4/24' =~ Stdlib::IP::Address::V6 # true
468+
'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address::V6 # true
469+
'FF01:0:0:0:0:0:0:101' =~ Stdlib::IP::Address::V6 # true
470+
'FF01::101' =~ Stdlib::IP::Address::V6 # true
471+
'FF01:0:0:0:0:0:0:101/32' =~ Stdlib::IP::Address::V6 # true
472+
'FF01::101/60' =~ Stdlib::IP::Address::V6 # true
473+
'::' =~ Stdlib::IP::Address::V6 # true
474+
'12AB::CD30:192.168.0.1' =~ Stdlib::IP::Address::V6 # true
475+
```
476+
477+
#### `Stdlib::IP::Address::Nosubnet`
478+
479+
Match the same things as the `Stdlib::IP::Address` alias, except it will not
480+
match an address that includes an address prefix (e.g., it will match
481+
`192.168.0.6` but not `192.168.0.6/24`).
482+
483+
#### `Stdlib::IP::Address::V4::CIDR`
484+
485+
Match an IPv4 address in the CIDR format. It will only match if the
486+
address contains an address prefix (e.g., it will match `192.168.0.6/24`
487+
but not `192.168.0.6`).
488+
489+
#### `Stdlib::IP::Address::V4::Nosubnet`
490+
491+
Match an IPv4 address only if the address does not contain an address
492+
prefix (e.g., it will match `192.168.0.6` but not `192.168.0.6/24`).
493+
494+
#### `Stdlib::IP::Address::V6::Full`
495+
496+
Match an IPv6 address formatted in the "preferred form" as documented in
497+
section 2.2.1 of RFC 2373, with or without an address prefix as
498+
documented in section 2.3 of RFC 2373.
499+
500+
#### `Stdlib::IP::Address::V6::Alternate`
501+
502+
Match an IPv6 address formatted in the "alternative form" allowing for
503+
representing the last two 16-bit pieces of the address with a
504+
quad-dotted decimal, as documented in section 2.2.1 of RFC 2373. It will
505+
match addresses with or without an address prefix as documented in
506+
section 2.3 of RFC 2373.
507+
508+
#### `Stdlib::IP::Address::V6::Compressed`
509+
510+
Match an IPv6 address which may contain `::` used to compress zeros as
511+
documented in section 2.2.2 of RFC 2373. It will match addresses with
512+
or without an address prefix as documented in section 2.3 of RFC 2373.
513+
514+
#### `Stdlib::IP::Address::V6::Nosubnet`
515+
516+
Alias to allow `Stdlib::IP::Address::V6::Nosubnet::Full`,
517+
`Stdlib::IP::Address::V6::Nosubnet::Alternate` and
518+
`Stdlib::IP::Address::V6::Nosubnet::Compressed`.
519+
520+
#### `Stdlib::IP::Address::V6::Nosubnet::Full`
521+
522+
Match an IPv6 address formatted in the "preferred form" as documented in
523+
section 2.2.1 of RFC 2373. It will not match addresses with address
524+
prefix as documented in section 2.3 of RFC 2373.
525+
526+
#### `Stdlib::IP::Address::V6::Nosubnet::Alternate`
527+
528+
Match an IPv6 address formatted in the "alternative form" allowing for
529+
representing the last two 16-bit pieces of the address with a
530+
quad-dotted decimal, as documented in section 2.2.1 of RFC 2373. It will
531+
only match addresses without an address prefix as documented in section
532+
2.3 of RFC 2373.
533+
534+
#### `Stdlib::IP::Address::V6::Nosubnet::Compressed`
535+
536+
Match an IPv6 address which may contain `::` used to compress zeros as
537+
documented in section 2.2.2 of RFC 2373. It will only match addresses
538+
without an address prefix as documented in section 2.3 of RFC 2373.
539+
416540
### Facts
417541
418542
#### `package_provider`

‎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: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
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+
'::13.1.68.3',
8+
'::FFFF:129.144.52.38',
9+
'1080::8:800:200C:417A',
10+
'1080::8:800:200C:417A/60',
11+
'FF01::101',
12+
'::1',
13+
'::',
14+
].each do |value|
15+
describe value.inspect do
16+
it { is_expected.to allow_value(value) }
17+
end
18+
end
19+
end
20+
21+
describe 'rejects other values' do
22+
[
23+
'nope',
24+
'127.0.0.1',
25+
'FEDC::BA98:7654:3210::3210',
26+
].each do |value|
27+
describe value.inspect do
28+
it { is_expected.not_to allow_value(value) }
29+
end
30+
end
31+
end
32+
end
33+
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)