Puppet Function: simplib::validate_net_list

Defined in:
lib/puppet/functions/simplib/validate_net_list.rb
Function type:
Ruby 4.x API

Overview

Validate that a passed list (‘Array` or single `String`) of networks is filled with valid IP addresses, network addresses (CIDR notation), or hostnames.

  • Hostnames are checked per RFC 1123.

  • Ports appended with # a colon ‘:` are allowed for hostnames and individual IP addresses.

  • Terminates catalog compilation if validation fails.

Signatures:

  • simplib::validate_net_list(String $net, Optional[String] $str_match) ⇒ Nil

    Examples:

    Passing

    
$trusted_nets = '10.10.10.0/24'
simplib::validate_net_list($trusted_nets)

$trusted_nets = '1.2.3.5:400'
simplib::validate_net_list($trusted_nets)

$trusted_nets = 'ALL'
simplib::validate_net_list($trusted_nets,'^(%any|ALL)$')

    Failing

    
$trusted_nets = '10.10.10.0/24,1.2.3.4'
simplib::validate_net_list($trusted_nets)

$trusted_nets = 'bad stuff'
simplib::validate_net_list($trusted_nets)

    Parameters:

    • net (String) —

      Single network to be validated.

    • str_match (Optional[String]) —

      Stringified regular expression (regex without the ‘//` delimiters)

    Returns:

    • (Nil)

    Raises:

    • (RuntimeError) —

      if validation fails

  • simplib::validate_net_list(Array[String] $net_list, Optional[String] $str_match) ⇒ Nil

    Examples:

    Passing

    
$trusted_nets = ['10.10.10.0/24','1.2.3.4','1.3.4.5:400']
simplib::validate_net_list($trusted_nets)

$trusted_nets = '10.10.10.0/24'
simplib::validate_net_list($trusted_nets)

$trusted_nets = ['10.10.10.0/24','1.2.3.4','%any','ALL']
simplib::validate_net_list($trusted_nets,'^(%any|ALL)$')

    Failing

    
$trusted_nets = ['10.10.10.0/24 1.2.3.4']
simplib::validate_net_list($trusted_nets)

$trusted_nets = 'bad stuff'
simplib::validate_net_list($trusted_nets)

    Parameters:

    • net_list (Array[String]) —

      ‘Array` of networks to be validated.

    • str_match (Optional[String]) —

      Stringified regular expression (regex without the ‘//` delimiters)

    Returns:

    • (Nil)

    Raises:

    • (RuntimeError) —

      if validation fails



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/puppet/functions/simplib/validate_net_list.rb', line 10

Puppet::Functions.create_function(:'simplib::validate_net_list') do

  # @param net Single network to be validated.
  # @param str_match Stringified regular expression (regex without
  #   the `//` delimiters)
  # @return [Nil]
  # @raise [RuntimeError] if validation fails
  #
  # @example Passing
  #
  #   $trusted_nets = '10.10.10.0/24'
  #   simplib::validate_net_list($trusted_nets)
  #
  #   $trusted_nets = '1.2.3.5:400'
  #   simplib::validate_net_list($trusted_nets)
  #
  #   $trusted_nets = 'ALL'
  #   simplib::validate_net_list($trusted_nets,'^(%any|ALL)$')
  #
  # @example Failing
  #
  #   $trusted_nets = '10.10.10.0/24,1.2.3.4'
  #   simplib::validate_net_list($trusted_nets)
  #
  #   $trusted_nets = 'bad stuff'
  #   simplib::validate_net_list($trusted_nets)
  #
  dispatch :validate_net do
    required_param 'String', :net
    optional_param 'String', :str_match
  end

  # @param net_list `Array` of networks to be validated.
  # @param str_match Stringified regular expression (regex without
  #   the `//` delimiters)
  # @return [Nil]
  # @raise [RuntimeError] if validation fails
  #
  # @example Passing
  #
  #   $trusted_nets = ['10.10.10.0/24','1.2.3.4','1.3.4.5:400']
  #   simplib::validate_net_list($trusted_nets)
  #
  #   $trusted_nets = '10.10.10.0/24'
  #   simplib::validate_net_list($trusted_nets)
  #
  #   $trusted_nets = ['10.10.10.0/24','1.2.3.4','%any','ALL']
  #   simplib::validate_net_list($trusted_nets,'^(%any|ALL)$')
  #
  # @example Failing
  #
  #   $trusted_nets = ['10.10.10.0/24 1.2.3.4']
  #   simplib::validate_net_list($trusted_nets)
  #
  #   $trusted_nets = 'bad stuff'
  #   simplib::validate_net_list($trusted_nets)
  dispatch :validate_net_list do
    required_param 'Array[String]', :net_list
    optional_param 'String', :str_match
  end

  def validate_net(net, str_match=nil)
    validate_net_list(Array(net), str_match)
  end

  def validate_net_list(net_list, str_match=nil)
    local_net_list = Array(net_list.dup)  # not allowed to modify arguments

    if str_match
      # hack to be backward compatible
      local_str_match = str_match.dup
      local_str_match = '\*' if local_str_match == '*'

      local_str_match = Regexp.new(local_str_match)
      local_net_list.delete_if{|x| local_str_match.match(x)}
    end

    require File.expand_path(File.dirname(__FILE__) + '/../../../puppetx/simp/simplib.rb')
    require 'ipaddr'

    # Needed to use other functions inside of this one
#    Puppet::Parser::Functions.autoloader.loadall

    local_net_list.each do |net|
      # Do we have a port?
      host,port = PuppetX::SIMP::Simplib.split_port(net)
      call_function('simplib::validate_port', port) if (port && !port.empty?)

      # Valid quad-dotted IPv4 addresses will validate as hostnames.
      # So check for IP addresses first
      begin
        IPAddr.new(host)
      # For some reason, can't see derived error class (IPAddr::Error)
      # when run by Puppet
      rescue ArgumentError
        # if looks like quad-dotted set of decimal numbers, most likely
        # it is not an oddly-named host, but a bad IPv4 address in which
        # one or more of the octets is out of range (configuration
        # fat-finger....)
        if host.match(/^([0-9]+)(\.[0-9]+){3}$/)
          fail("simplib::validate_net_list(): '#{net}' is not a valid network.")
        end

        # assume OK if this looks like hostname
        unless PuppetX::SIMP::Simplib.hostname_only?(host)
          fail("simplib::validate_net_list(): '#{net}' is not a valid network.")
        end
      end
    end
  end
end