Bug 1782838

Summary:	certmonger man pages and help do not include long options
Product:	Red Hat Enterprise Linux 8	Reporter:	Rob Crittenden <rcritten>
Component:	certmonger	Assignee:	Rob Crittenden <rcritten>
Status:	CLOSED ERRATA	QA Contact:	ipa-qe <ipa-qe>
Severity:	medium	Docs Contact:
Priority:	unspecified
Version:	8.1	CC:	ksiddiqu, nalin, pcech, sumenon
Target Milestone:	rc	Keywords:	TestCaseNotNeeded, Triaged
Target Release:	8.0
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:	certmonger-0.79.7-12.el8	Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2020-11-04 02:51:52 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 Rob Crittenden 2019-12-12 13:29:53 UTC

Description of problem:

The certmonger man pages generally don't include the long options when they are available and only include the short ones. The long should be added.

For example, getcert-start-tracking(1) provides -r and -R but not --renew and --no-renew.

This also affects the command-line help.

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

certmonger-0.79.7-3.el8.x86_64

How reproducible:


Steps to Reproduce:
1. man getcert-start-tracking or getcert start-tracking --help

Additional info:

The long options are configured in popt but only the short ones are displayed in command help.

Comment 1 Rob Crittenden 2020-05-07 20:31:08 UTC

The commands to verify will include the subcommands from getcert:

request         request a new certificate from a CA
start-tracking  begin monitoring an already-issued certificate
stop-tracking   stop monitoring a certificate
resubmit        resubmit an in-progress enrollment request, or start a new one
rekey           generate a new private key and replace a certificate
refresh         check on the status of an in-progress enrollment request
list            list certificates being monitored and requested
status          check the status of a certificate being monitored or requested
add-ca          add a CA configuration
add-scep-ca     add an SCEP CA configuration
list-cas        list known CA configurations
modify-ca       modify a CA configuration
refresh-ca      refresh cache of all information obtained from a CA
remove-ca       remove a CA configuration

Using: getcert <command> --help

In /usr/libexec/certmonger/, run with --help:

certmaster-submit
certmonger-session
dogtag-ipa-renew-agent-submit
dogtag-submit
ipa-submit
local-submit
scep-submit

The man pages to verify are:
certmaster-getcert.1
getcert-add-ca.1
getcert-add-scep-ca.1
getcert-list-cas.1
getcert-list.1
getcert-modify-ca.1
getcert-refresh-ca.1
getcert-refresh.1
getcert-rekey.1
getcert-remove-ca.1
getcert-request.1
getcert-resubmit.1
getcert-start-tracking.1
getcert-status.1
getcert-stop-tracking.1
getcert.1
ipa-getcert.1
local-getcert.1
selfsign-getcert.1
certmonger.conf.5
certmonger-certmaster-submit.8
certmonger-dogtag-ipa-renew-agent-submit.8
certmonger-dogtag-submit.8
certmonger-ipa-submit.8
certmonger-local-submit.8
certmonger-scep-submit.8
certmonger.8

Comment 2 Rob Crittenden 2020-05-14 17:54:42 UTC

fixed upstream

master:
6bf7aef2b5b5840cad6cff038e3d13998da6eb01
525a9b4fcc2401cae044526626c6d15b83c07731

This involved changes to both the man pages and some of the cli to include the long options.

Comment 8 errata-xmlrpc 2020-11-04 02:51:52 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 (certmonger 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:4671