Class: PuppetX::Firewall::Utility

Inherits:
Object
  • Object
show all
Defined in:
lib/puppet_x/puppetlabs/firewall/utility.rb

Overview

A utility class meant to contain re-usable code

Class Method Summary collapse

Class Method Details

.create_absent(namevar, title) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



63
64
65
66
67
68
69
70
71
 
# File 'lib/puppet_x/puppetlabs/firewall/utility.rb', line 63

def self.create_absent(namevar, title)
  result = if title.is_a? Hash
             title.dup
           else
             { namevar => title }
           end
  result[:ensure] = 'absent'
  result
end

.dscp_number_to_class(value) ⇒ Object

Converts a given number to its dscp class name www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/puppet_x/puppetlabs/firewall/utility.rb', line 267

def self.dscp_number_to_class(value)
  case value
  when '0x0a' then 'af11'
  when '0x0c' then 'af12'
  when '0x0e' then 'af13'
  when '0x12' then 'af21'
  when '0x14' then 'af22'
  when '0x16' then 'af23'
  when '0x1a' then 'af31'
  when '0x1c' then 'af32'
  when '0x1e' then 'af33'
  when '0x22' then 'af41'
  when '0x24' then 'af42'
  when '0x26' then 'af43'
  when '0x08' then 'cs1'
  when '0x10' then 'cs2'
  when '0x18' then 'cs3'
  when '0x20' then 'cs4'
  when '0x28' then 'cs5'
  when '0x30' then 'cs6'
  when '0x38' then 'cs7'
  when '0x2e' then 'ef'
  else nil
  end
end

.host_to_ip(value, proto = nil) ⇒ Object

Takes an address and protocol and returns the address in CIDR notation.

The protocol is only used when the address is a hostname.

If the address is:

- A hostname:
  It will be resolved
- An IPv4 address:
  It will be qualified with a /32 CIDR notation
- An IPv6 address:
  It will be qualified with a /128 CIDR notation
- An IP address with a CIDR notation:
  It will be normalised
- An IP address with a dotted-quad netmask:
  It will be converted to CIDR notation
- Any address with a resulting prefix length of zero:
  It will return nil which is equivilent to not specifying an address



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
121
122
123
124
 
# File 'lib/puppet_x/puppetlabs/firewall/utility.rb', line 92

def self.host_to_ip(value, proto = nil)
  begin
    value = PuppetX::Firewall::IPCidr.new(value)
  rescue StandardError
    family = case proto
             when 'IPv4', 'iptables'
               Socket::AF_INET
             when 'IPv6', 'ip6tables'
               Socket::AF_INET6
             when nil
               raise ArgumentError, 'Proto must be specified for a hostname'
             else
               raise ArgumentError, "Unsupported address family: #{proto}"
             end

    new_value = nil
    Resolv.each_address(value) do |addr|
      begin # rubocop:disable Style/RedundantBegin
        new_value = PuppetX::Firewall::IPCidr.new(addr, family)
        break
      rescue StandardError # looking for the one that works # rubocop:disable Lint/SuppressedException
      end
    end

    raise "Failed to resolve hostname #{value}" if new_value.nil?

    value = new_value
  end

  return nil if value.prefixlen.zero?

  value.cidr
end

.host_to_mask(value, proto) ⇒ Object

Takes an address mask and protocol and converts the host portion to CIDR notation.

This takes into account you can negate a mask but follows all rules defined in host_to_ip for the host/address part.



132
133
134
135
136
137
138
139
140
 
# File 'lib/puppet_x/puppetlabs/firewall/utility.rb', line 132

def self.host_to_mask(value, proto)
  match = value.match %r{(!)\s?(.*)$}
  return PuppetX::Firewall::Utility.host_to_ip(value, proto) unless match

  cidr = PuppetX::Firewall::Utility.host_to_ip(match[2], proto)
  return nil if cidr.nil?

  "#{match[1]} #{cidr}"
end

.icmp_name_to_number(value_icmp, protocol) ⇒ Object

Translate the symbolic names for icmp packet types to integers



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/puppet_x/puppetlabs/firewall/utility.rb', line 143

def self.icmp_name_to_number(value_icmp, protocol)
  if value_icmp.to_s.match?(%r{^\d+$})
    value_icmp.to_s
  elsif ['IPv4', 'iptables'].include?(protocol)
    # https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml
    case value_icmp
    when 'echo-reply' then '0'
    when 'destination-unreachable' then '3'
    when 'source-quench' then '4'
    when 'redirect' then '6'
    when 'echo-request' then '8'
    when 'router-advertisement' then '9'
    when 'router-solicitation' then '10'
    when 'time-exceeded' then '11'
    when 'parameter-problem' then '12'
    when 'timestamp-request' then '13'
    when 'timestamp-reply' then '14'
    when 'address-mask-request' then '17'
    when 'address-mask-reply' then '18'
    else nil
    end
  elsif ['IPv6', 'ip6tables'].include?(protocol)
    # https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml
    case value_icmp
    when 'destination-unreachable' then '1'
    when 'too-big' then '2'
    when 'time-exceeded' then '3'
    when 'parameter-problem' then '4'
    when 'echo-request' then '128'
    when 'echo-reply' then '129'
    when 'router-solicitation' then '133'
    when 'router-advertisement' then '134'
    when 'neighbour-solicitation' then '135'
    when 'neighbour-advertisement' then '136'
    when 'redirect' then '137'
    else nil
    end
  else
    raise ArgumentError, "unsupported protocol family '#{protocol}'"
  end
end

.log_level_name_to_number(value) ⇒ Object

Convert log_level names to their respective numbers www.iana.org/assignments/syslog-parameters/syslog-parameters.xhtml



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/puppet_x/puppetlabs/firewall/utility.rb', line 187

def self.log_level_name_to_number(value)
  if value.to_s.match?(%r{^[0-7]$})
    value.to_s
  else
    case value
    when 'panic' then '0'
    when 'alert' then '1'
    when 'crit' then '2'
    when 'err', 'error' then '3'
    when 'warn', 'warning' then '4'
    when 'not', 'notice' then '5'
    when 'info' then '6'
    when 'debug' then '7'
    else nil
    end
  end
end

.mark_mask_to_hex(value) ⇒ Object

Accepts a valid mark or mark/mask and returns them in the valid hexidecimal format. USed for set_mark



220
221
222
223
224
225
226
227
 
# File 'lib/puppet_x/puppetlabs/firewall/utility.rb', line 220

def self.mark_mask_to_hex(value)
  match = value.to_s.match(%r{([a-fA-F0-9x]+)/?([a-fA-F0-9x]+)?})
  mark = PuppetX::Firewall::Utility.to_hex32(match[1])
  return "#{mark}/0xffffffff" if match[2].nil?

  mask = PuppetX::Firewall::Utility.to_hex32(match[2])
  "#{mark}/#{mask}"
end

.mark_to_hex(value) ⇒ Object

Accepts a valid mark and returns them in the valid hexidecimal format. Accounts for negation. Used for match_mark / connmark



232
233
234
235
236
237
238
 
# File 'lib/puppet_x/puppetlabs/firewall/utility.rb', line 232

def self.mark_to_hex(value)
  match = value.to_s.match(%r{^(!\s)?([a-fA-F0-9x]+)})
  mask = PuppetX::Firewall::Utility.to_hex32(match[2])
  return mask if match[1].nil?

  "! #{mask}"
end

.persist_iptables(context, name, protocol) ⇒ Object

Save any current iptables changes so they are retained upon restart



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
 
# File 'lib/puppet_x/puppetlabs/firewall/utility.rb', line 12

def self.persist_iptables(context, name, protocol)
  os_key = Facter.value('os')['family']
  cmd = case os_key
        when 'RedHat'
          case protocol
          when 'IPv4', 'iptables'
            ['/usr/libexec/iptables/iptables.init', 'save']
          when 'IPv6', 'ip6tables'
            ['/usr/libexec/iptables/ip6tables.init', 'save']
          end
        when 'Debian'
          fact = Facter.fact(:iptables_persistent_version)
          fact.flush if fact.respond_to?(:flush)
          persist_ver = fact.value

          case protocol
          when 'IPv4', 'IPv6', 'iptables', 'ip6tables'
            if persist_ver && Puppet::Util::Package.versioncmp(persist_ver, '1.0').positive?
              ['/usr/sbin/service', 'netfilter-persistent', 'save']
            else
              ['/usr/sbin/service', 'iptables-persistent', 'save']
            end
          end
        when 'Archlinux'
          case protocol
          when 'IPv4', 'iptables'
            ['/bin/sh', '-c', '/usr/sbin/iptables-save > /etc/iptables/iptables.rules']
          when 'IPv6', 'ip6tables'
            ['/bin/sh', '-c', '/usr/sbin/ip6tables-save > /etc/iptables/ip6tables.rules']
          end
        when 'Suse'
          case protocol
          when 'IPv4', 'iptables'
            ['/bin/sh', '-c', '/usr/sbin/iptables-save > /etc/sysconfig/iptables']
          end
        else
          # Catch unsupported OSs
          debug('firewall: Rule persistence is not supported for this type/OS')
          return
        end

  # Run the persist command within a rescue block
  begin
    context.notice("Ensuring changes to '#{name}' persist")
    Puppet::Provider.execute(cmd)
  rescue Puppet::ExecutionFailure => e
    warn "Unable to persist firewall rules: #{e}"
  end
end

.proto_number_to_name(value) ⇒ Object

Converts a given number to its protocol keyword www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/puppet_x/puppetlabs/firewall/utility.rb', line 242

def self.proto_number_to_name(value)
  return value if %r{^(?:!\s)?([a-z])}.match?(value)

  match = value.to_s.match(%r{^(!\s)?(.*)})
  keyword = case match[2]
            when '1' then 'icmp'
            when '2' then 'igmp'
            when '4' then 'ipencap'
            when '6' then 'tcp'
            when '7' then 'cbt'
            when '17' then 'udp'
            when '47' then 'gre'
            when '50' then 'esp'
            when '51' then 'ah'
            when '89' then 'ospf'
            when '103' then 'pim'
            when '112' then 'vrrp'
            when '132' then 'sctp'
            else raise ArgumentError, "Unsupported proto number: #{value}"
            end
  "#{match[1]}#{keyword}"
end

.to_hex32(value) ⇒ Object

Validates the argument is int or hex, and returns valid hex conversion of the value or nil otherwise.



207
208
209
210
211
212
213
214
215
 
# File 'lib/puppet_x/puppetlabs/firewall/utility.rb', line 207

def self.to_hex32(value)
  begin
    value = Integer(value)
    return "0x#{value.to_s(16)}" if value.between?(0, 0xffffffff)
  rescue ArgumentError
    # pass
  end
  nil
end