Bug 1746876

Summary:	Confusing Description of rsyslog-gnutls rpm
Product:	Red Hat Enterprise Linux 8	Reporter:	Jan Pazdziora (Red Hat) <jpazdziora>
Component:	rsyslog	Assignee:	Jiří Vymazal <jvymazal>
Status:	CLOSED ERRATA	QA Contact:	Dalibor Pospíšil <dapospis>
Severity:	low	Docs Contact:
Priority:	medium
Version:	8.0	CC:	dapospis, jvymazal, rmeggins
Target Milestone:	rc	Keywords:	Documentation, EasyFix, Triaged
Target Release:	8.2
Hardware:	All
OS:	All
Whiteboard:
Fixed In Version:	rsyslog-8.1911.0-1.el8	Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2020-04-28 16:01:03 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Jan Pazdziora (Red Hat) 2019-08-29 12:20:38 UTC

Description of problem:

The rsyslog-gnutls rpm only ships

$ rpm -ql rsyslog-gnutls
/usr/lib/.build-id
/usr/lib/.build-id/08
/usr/lib/.build-id/08/ad68b613261f69d178676e834ee1941b5059c5
/usr/lib64/rsyslog/lmnsd_gtls.so

so there seem to be no documentation or man page about its purpose or behaviour. Checking the rpm -qi rsyslog-gnutls output, it says

Summary     : TLS protocol support for rsyslog
Description :
The rsyslog-gnutls package contains the rsyslog plugins that provide the
ability to receive syslog messages via upcoming syslog-transport-tls
IETF standard protocol.

However, the same Description has been there since RHEL 6. Is there some new upcoming syslog-transport-tls IETF standard protocol coming? Or is this about RFC 5425 from 2009?

Version-Release number of selected component (if applicable):

rsyslog-gnutls-8.37.0-12.el8.x86_64

How reproducible:

Deterministic.

Steps to Reproduce:
1. Try to figure out what rsyslog-gnutls is about.

Actual results:

No documentation in the package, no man page, and rpm header Description talking about some upcoming standard.

Expected results:

Documentation, man page, or rpm header Description being more accurate about the plugin, its relation to standard, and ideally its usage.

Additional info:

Comment 1 Jan Pazdziora (Red Hat) 2019-08-29 12:28:07 UTC

Another confusing part of the Description is the part about

   ability to receive syslog messages via upcoming syslog-transport-tls

which somehow suggests that it is only needed on the machine active as a receiver for remote syslog reception. While it seems that it is needed on the rsyslog client which send to the remote server via TLS as well.

Comment 8 errata-xmlrpc 2020-04-28 16:01:03 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, 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/RHSA-2020:1702