Bug 1020432

Summary: Fix man page for ssh-keygen because of certificate support
Product: Red Hat Enterprise Linux 6 Reporter: Miroslav Vadkerti <mvadkert>
Component: man-pages-overridesAssignee: Peter Schiffer <pschiffe>
Status: CLOSED ERRATA QA Contact: Iveta Wiedermann <isenfeld>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 6.5CC: isenfeld, ovasik, pschiffe, pvrabec, tlavigne
Target Milestone: rcKeywords: ManPageChange, Patch
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Cause: "-n" option in ssh-keygen(1) program was renamed to "-Z" option, but ssh-keygen(1) manual page was not updated Consequence: incorrect documentation Fix: update ssh-keygen(1) manual page Result: correct documentation
 Story Points: ---
Clone Of: Environment:
Last Closed: 2013-11-21 22:59:33 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:
Bug Depends On:    
Bug Blocks: 1023044    
Attachments:
Description Flags
fixed ssh-keygen.1 none

Description Miroslav Vadkerti 2013-10-17 16:12:26 UTC 
Description of problem:
Bug 906872 - certificate support in OpenSSH introduced a feature but the ssh-keygen man page was not adjusted correctly. The upstream provided -n option has been changed to -Z as the original is already used by our downstream patch. This needs to be properly documented in our version of man page. Without this our patch bring in an undocumented option and the usability of the feature becomes limited.

Version-Release number of selected component (if applicable):
openssh-5.3p1-94.el6

How reproducible:
100%

Steps to Reproduce:
1. man ssh-keygen, check -n and -Z documentation

Actual results:
no -Z documentation

Expected results:
Properly documented -Z option for passing principal list
Comment 1 Petr Lautrbach 2013-10-18 09:05:41 UTC 
Created attachment 813656 [details]
fixed ssh-keygen.1

diff --git a/ssh-keygen.1 b/ssh-keygen.1
index fa520d4..8dfa302 100644
--- a/ssh-keygen.1
+++ b/ssh-keygen.1
@@ -113,7 +113,7 @@
 .Fl s Ar ca_key
 .Fl I Ar certificate_identity
 .Op Fl h
-.Op Fl n Ar principals
+.Op Fl Z Ar principals
 .Op Fl O Ar option
 .Op Fl V Ar validity_interval
 .Op Fl z Ar serial_number
@@ -300,7 +300,7 @@ candidate moduli for DH-GEX.
 Extract the public key from smartcard.
 .It Fl N Ar new_passphrase
 Provides the new passphrase.
-.It Fl n Ar principals
+.It Fl Z Ar principals
 Specify one or more principals (user or host names) to be included in
 a certificate when signing a key.
 Multiple principals may be specified, separated by commas.
@@ -549,8 +549,8 @@ names.
 By default, generated certificates are valid for all users or hosts.
 To generate a certificate for a specified set of principals:
 .Pp
-.Dl $ ssh-keygen -s ca_key -I key_id -n user1,user2 user_key.pub
-.Dl "$ ssh-keygen -s ca_key -I key_id -h -n host.domain user_key.pub"
+.Dl $ ssh-keygen -s ca_key -I key_id -Z user1,user2 user_key.pub
+.Dl "$ ssh-keygen -s ca_key -I key_id -h -Z host.domain user_key.pub"
 .Pp
 Additional limitations on the validity and use of user certificates may
 be specified through certificate options.
Comment 2 RHEL Program Management 2013-10-24 08:08:05 UTC 
This request was not resolved in time for the current release.
Red Hat invites you to ask your support representative to
propose this request, if still desired, for consideration in
the next release of Red Hat Enterprise Linux.
Comment 10 errata-xmlrpc 2013-11-21 22:59:33 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.

http://rhn.redhat.com/errata/RHBA-2013-1695.html