RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.
Bug 1812062 - [Documentation] Requesting documentation update for list of prohibited characters in with firewall-cmd's --new-service parameter
Summary: [Documentation] Requesting documentation update for list of prohibited charac...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Linux 8
Classification: Red Hat
Component: firewalld
Version: 8.1
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: rc
: 8.0
Assignee: Eric Garver
QA Contact: Tomas Dolezal
URL:
Whiteboard:
Depends On:
Blocks: 1812995
TreeView+ depends on / blocked
 
Reported: 2020-03-10 13:13 UTC by Vipul Vaidya
Modified: 2023-12-15 17:28 UTC (History)
3 users (show)

Fixed In Version: firewalld-0.8.2-1.el8
Doc Type: No Doc Update
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-11-04 01:39:57 UTC
Type: Bug
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHBA-2020:4461 0 None None None 2020-11-04 01:40:21 UTC

Description Vipul Vaidya 2020-03-10 13:13:55 UTC
Description of problem:
- Customer is requesting to update the documentation of firewalld which contains the characters prohibited for use while creating a new service.
- I tried checking the documentation of RHEL7 and RHEL8 and do not see any information on the use of special characters
- Requesting an update of documentation as per concern raised by the customer. 


RHEL8:
+++++
  5.8.4. Adding new services
  https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/securing_networks/index

  31.8.4. Adding new services
  https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/configuring_and_managing_networking/index#adding-new-services_controlling-network-traffic-using-firewalld  
+++++

RHEL7:
+++++
  5.6.5. Adding New Services
  https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html-single/security_guide/index#sec-Adding_New_Services
+++++


Steps to Reproduce:
- Customer is executing below command every time with a new special character
~# firewall-cmd --permanent --new-service=<service-name>

Actual results:
- Various set of result obtained with each special character:
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'

Comment 1 Eric Garver 2020-03-10 13:24:58 UTC
Is this a request to update the firewall-cmd man page? The RHEL guide? Or both?

Comment 2 Khushal Chandak 2020-03-12 12:54:45 UTC
Hi Eric,

This request is for both i.e man page and the RHEL guide doc.

Comment 4 Eric Garver 2020-03-20 17:39:00 UTC
Upstream:

4edba793ff3c ("doc: specify accepted characters for object names")

-->8--

$ man doc/man/man1/firewall-cmd.1
[..]
       --permanent --new-service=service
           Add a new permanent and empty service.

           Service names must be alphanumeric and may additionally include
           characters: '_' and '-'.
[..]

Comment 10 errata-xmlrpc 2020-11-04 01:39:57 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (firewalld bug fix and enhancement update), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHBA-2020:4461


Note You need to log in before you can comment on or make changes to this bug.