firewalld::custom_service creates files with invalid names

[trevor-vaughan]

Affected Puppet, Ruby, OS and module versions/distributions

• Puppet: All
• Ruby: All
• Distribution: All
• Module version: 4.2.2

How to reproduce (e.g Puppet code you use)

firewalld::custom_service { 'foo.bar.baz': }

What are you seeing

Firewalld error on restarting: Error: INVALID_NAME: '.' is not allowed in 'foo.bar.baz'

What behaviour did you expect instead

The module should scrub names for safety

Any additional information you'd like to impart

Working on a patch.

Determined the disallowed set of characters using the following code:

require 'shellwords'

chars = (0..9).to_a + ('A'..'z').to_a + ('!'..'?').to_a

chars.each do |char|
  name = Shellwords.escape(%(test#{char}thing))
  %x{firewall-cmd --permanent --new-service=#{name}}
end

Output:

Error: INVALID_NAME: '[' is not allowed in 'test[thing'
Error: INVALID_NAME: '' is not allowed in 'test\thing'
Error: INVALID_NAME: ']' is not allowed in 'test]thing'
Error: INVALID_NAME: '^' is not allowed in 'test^thing'
Error: INVALID_NAME: '' is not allowed in 'testthing'
Error: INVALID_NAME: '!' is not allowed in 'test!thing'
Error: INVALID_NAME: '"' is not allowed in 'test"thing'
Error: INVALID_NAME: '#' is not allowed in 'test#thing'
Error: INVALID_NAME: '$' is not allowed in 'test$thing'
Error: INVALID_NAME: '%' is not allowed in 'test%thing'
Error: INVALID_NAME: '&' is not allowed in 'test&thing'
Error: INVALID_NAME: ''' is not allowed in 'test'thing'
Error: INVALID_NAME: '(' is not allowed in 'test(thing'
Error: INVALID_NAME: ')' is not allowed in 'test)thing'
Error: INVALID_NAME: '' is not allowed in 'testthing'
Error: INVALID_NAME: '+' is not allowed in 'test+thing'
Error: INVALID_NAME: ',' is not allowed in 'test,thing'
Error: INVALID_NAME: '.' is not allowed in 'test.thing'
Error: INVALID_NAME: '/' is not allowed in 'test/thing'
Error: INVALID_NAME: ':' is not allowed in 'test:thing'
Error: INVALID_NAME: ';' is not allowed in 'test;thing'
Error: INVALID_NAME: '<' is not allowed in 'test<thing'
Error: INVALID_NAME: '=' is not allowed in 'test=thing'
Error: INVALID_NAME: '>' is not allowed in 'test>thing'
Error: INVALID_NAME: '?' is not allowed in 'test?thing'

This basically means that you can have the following characters in the name: ('A'..'z').to_a + ('0'..'9').to_a + ['_','-']