Annotation of src/usr.bin/ssh/ssh-keygen.1, Revision 1.155
1.155 ! djm 1: .\" $OpenBSD: ssh-keygen.1,v 1.154 2019/01/22 11:19:42 djm Exp $
1.1 deraadt 2: .\"
3: .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
4: .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5: .\" All rights reserved
6: .\"
1.22 deraadt 7: .\" As far as I am concerned, the code I have written for this software
8: .\" can be used freely for any purpose. Any derived versions of this
9: .\" software must be clearly marked as such, and if the derived work is
10: .\" incompatible with the protocol description in the RFC file, it must be
11: .\" called by a name other than "ssh" or "Secure Shell".
12: .\"
13: .\"
1.33 deraadt 14: .\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved.
15: .\" Copyright (c) 1999 Aaron Campbell. All rights reserved.
16: .\" Copyright (c) 1999 Theo de Raadt. All rights reserved.
1.22 deraadt 17: .\"
18: .\" Redistribution and use in source and binary forms, with or without
19: .\" modification, are permitted provided that the following conditions
20: .\" are met:
21: .\" 1. Redistributions of source code must retain the above copyright
22: .\" notice, this list of conditions and the following disclaimer.
23: .\" 2. Redistributions in binary form must reproduce the above copyright
24: .\" notice, this list of conditions and the following disclaimer in the
25: .\" documentation and/or other materials provided with the distribution.
1.1 deraadt 26: .\"
1.22 deraadt 27: .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
28: .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
29: .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
30: .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
31: .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
32: .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33: .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34: .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35: .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
36: .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1.1 deraadt 37: .\"
1.154 djm 38: .Dd $Mdocdate: January 22 2019 $
1.2 deraadt 39: .Dt SSH-KEYGEN 1
40: .Os
41: .Sh NAME
42: .Nm ssh-keygen
1.37 markus 43: .Nd authentication key generation, management and conversion
1.2 deraadt 44: .Sh SYNOPSIS
1.97 schwarze 45: .Bk -words
1.2 deraadt 46: .Nm ssh-keygen
1.25 markus 47: .Op Fl q
1.2 deraadt 48: .Op Fl b Ar bits
1.139 jmc 49: .Op Fl t Cm dsa | ecdsa | ed25519 | rsa
1.2 deraadt 50: .Op Fl N Ar new_passphrase
51: .Op Fl C Ar comment
1.20 markus 52: .Op Fl f Ar output_keyfile
1.155 ! djm 53: .Op Fl m Ar format
1.2 deraadt 54: .Nm ssh-keygen
55: .Fl p
56: .Op Fl P Ar old_passphrase
57: .Op Fl N Ar new_passphrase
1.9 markus 58: .Op Fl f Ar keyfile
1.155 ! djm 59: .Op Fl m Ar format
1.2 deraadt 60: .Nm ssh-keygen
1.37 markus 61: .Fl i
1.95 djm 62: .Op Fl m Ar key_format
1.20 markus 63: .Op Fl f Ar input_keyfile
1.16 deraadt 64: .Nm ssh-keygen
1.37 markus 65: .Fl e
1.95 djm 66: .Op Fl m Ar key_format
1.20 markus 67: .Op Fl f Ar input_keyfile
1.16 deraadt 68: .Nm ssh-keygen
1.17 markus 69: .Fl y
1.20 markus 70: .Op Fl f Ar input_keyfile
1.17 markus 71: .Nm ssh-keygen
1.2 deraadt 72: .Fl c
73: .Op Fl P Ar passphrase
74: .Op Fl C Ar comment
1.9 markus 75: .Op Fl f Ar keyfile
76: .Nm ssh-keygen
77: .Fl l
1.125 naddy 78: .Op Fl v
1.124 djm 79: .Op Fl E Ar fingerprint_hash
1.35 markus 80: .Op Fl f Ar input_keyfile
81: .Nm ssh-keygen
82: .Fl B
1.20 markus 83: .Op Fl f Ar input_keyfile
1.48 jakob 84: .Nm ssh-keygen
1.82 jmc 85: .Fl D Ar pkcs11
1.48 jakob 86: .Nm ssh-keygen
1.64 djm 87: .Fl F Ar hostname
88: .Op Fl f Ar known_hosts_file
1.79 sthen 89: .Op Fl l
1.64 djm 90: .Nm ssh-keygen
91: .Fl H
92: .Op Fl f Ar known_hosts_file
93: .Nm ssh-keygen
94: .Fl R Ar hostname
95: .Op Fl f Ar known_hosts_file
1.57 jakob 96: .Nm ssh-keygen
97: .Fl r Ar hostname
98: .Op Fl f Ar input_keyfile
99: .Op Fl g
1.60 djm 100: .Nm ssh-keygen
101: .Fl G Ar output_file
1.61 djm 102: .Op Fl v
1.60 djm 103: .Op Fl b Ar bits
104: .Op Fl M Ar memory
105: .Op Fl S Ar start_point
106: .Nm ssh-keygen
107: .Fl T Ar output_file
108: .Fl f Ar input_file
1.61 djm 109: .Op Fl v
1.117 djm 110: .Op Fl a Ar rounds
1.109 dtucker 111: .Op Fl J Ar num_lines
112: .Op Fl j Ar start_line
1.108 dtucker 113: .Op Fl K Ar checkpt
1.60 djm 114: .Op Fl W Ar generator
1.84 djm 115: .Nm ssh-keygen
116: .Fl s Ar ca_key
117: .Fl I Ar certificate_identity
118: .Op Fl h
1.142 djm 119: .Op Fl U
120: .Op Fl D Ar pkcs11_provider
1.84 djm 121: .Op Fl n Ar principals
1.93 djm 122: .Op Fl O Ar option
1.84 djm 123: .Op Fl V Ar validity_interval
1.93 djm 124: .Op Fl z Ar serial_number
1.84 djm 125: .Ar
1.86 djm 126: .Nm ssh-keygen
127: .Fl L
128: .Op Fl f Ar input_keyfile
1.102 stevesk 129: .Nm ssh-keygen
130: .Fl A
1.143 djm 131: .Op Fl f Ar prefix_path
1.111 djm 132: .Nm ssh-keygen
133: .Fl k
134: .Fl f Ar krl_file
135: .Op Fl u
1.112 jmc 136: .Op Fl s Ar ca_public
137: .Op Fl z Ar version_number
1.111 djm 138: .Ar
139: .Nm ssh-keygen
140: .Fl Q
141: .Fl f Ar krl_file
142: .Ar
1.85 jmc 143: .Ek
1.13 aaron 144: .Sh DESCRIPTION
1.2 deraadt 145: .Nm
1.37 markus 146: generates, manages and converts authentication keys for
1.2 deraadt 147: .Xr ssh 1 .
1.15 deraadt 148: .Nm
1.140 jmc 149: can create keys for use by SSH protocol version 2.
1.130 jmc 150: .Pp
1.58 jmc 151: The type of key to be generated is specified with the
1.25 markus 152: .Fl t
1.52 djm 153: option.
1.70 djm 154: If invoked without any arguments,
155: .Nm
1.141 naddy 156: will generate an RSA key.
1.15 deraadt 157: .Pp
1.60 djm 158: .Nm
159: is also used to generate groups for use in Diffie-Hellman group
160: exchange (DH-GEX).
161: See the
162: .Sx MODULI GENERATION
163: section for details.
164: .Pp
1.111 djm 165: Finally,
166: .Nm
167: can be used to generate and update Key Revocation Lists, and to test whether
1.112 jmc 168: given keys have been revoked by one.
169: See the
1.111 djm 170: .Sx KEY REVOCATION LISTS
171: section for details.
172: .Pp
1.2 deraadt 173: Normally each user wishing to use SSH
1.99 djm 174: with public key authentication runs this once to create the authentication
1.1 deraadt 175: key in
1.118 naddy 176: .Pa ~/.ssh/id_dsa ,
1.99 djm 177: .Pa ~/.ssh/id_ecdsa ,
1.118 naddy 178: .Pa ~/.ssh/id_ed25519
1.15 deraadt 179: or
1.68 djm 180: .Pa ~/.ssh/id_rsa .
1.15 deraadt 181: Additionally, the system administrator may use this to generate host keys,
182: as seen in
183: .Pa /etc/rc .
1.2 deraadt 184: .Pp
1.1 deraadt 185: Normally this program generates the key and asks for a file in which
1.12 aaron 186: to store the private key.
187: The public key is stored in a file with the same name but
1.2 deraadt 188: .Dq .pub
1.12 aaron 189: appended.
190: The program also asks for a passphrase.
191: The passphrase may be empty to indicate no passphrase
1.26 markus 192: (host keys must have an empty passphrase), or it may be a string of
1.12 aaron 193: arbitrary length.
1.51 stevesk 194: A passphrase is similar to a password, except it can be a phrase with a
195: series of words, punctuation, numbers, whitespace, or any string of
196: characters you want.
197: Good passphrases are 10-30 characters long, are
1.1 deraadt 198: not simple sentences or otherwise easily guessable (English
1.42 markus 199: prose has only 1-2 bits of entropy per character, and provides very bad
1.51 stevesk 200: passphrases), and contain a mix of upper and lowercase letters,
201: numbers, and non-alphanumeric characters.
1.12 aaron 202: The passphrase can be changed later by using the
1.2 deraadt 203: .Fl p
1.1 deraadt 204: option.
1.2 deraadt 205: .Pp
1.12 aaron 206: There is no way to recover a lost passphrase.
1.105 djm 207: If the passphrase is lost or forgotten, a new key must be generated
208: and the corresponding public key copied to other machines.
1.2 deraadt 209: .Pp
1.153 djm 210: .Nm
211: will by default write keys in an OpenSSH-specific format.
212: This format is preferred as it offers better protection for
213: keys at rest as well as allowing storage of key comments within
214: the private key file itself.
215: The key comment may be useful to help identify the key.
1.12 aaron 216: The comment is initialized to
1.2 deraadt 217: .Dq user@host
218: when the key is created, but can be changed using the
219: .Fl c
1.1 deraadt 220: option.
1.153 djm 221: .Pp
222: It is still possible for
223: .Nm
224: to write the previously-used PEM format private keys using the
225: .Fl m
226: flag.
227: This may be used when generating new keys, and existing new-format
228: keys may be converted using this option in conjunction with the
229: .Fl p
230: (change passphrase) flag.
1.2 deraadt 231: .Pp
1.15 deraadt 232: After a key is generated, instructions below detail where the keys
233: should be placed to be activated.
234: .Pp
1.2 deraadt 235: The options are as follows:
236: .Bl -tag -width Ds
1.102 stevesk 237: .It Fl A
1.139 jmc 238: For each of the key types (rsa, dsa, ecdsa and ed25519)
1.118 naddy 239: for which host keys
1.102 stevesk 240: do not exist, generate the host keys with the default key file path,
241: an empty passphrase, default bits for the key type, and default comment.
1.144 jmc 242: If
1.143 djm 243: .Fl f
1.144 jmc 244: has also been specified, its argument is used as a prefix to the
1.143 djm 245: default path for the resulting host key files.
1.104 jmc 246: This is used by
1.102 stevesk 247: .Pa /etc/rc
248: to generate new host keys.
1.117 djm 249: .It Fl a Ar rounds
1.148 djm 250: When saving a private key this option specifies the number of KDF
251: (key derivation function) rounds used.
1.117 djm 252: Higher numbers result in slower passphrase verification and increased
253: resistance to brute-force password cracking (should the keys be stolen).
254: .Pp
1.140 jmc 255: When screening DH-GEX candidates (using the
1.60 djm 256: .Fl T
1.117 djm 257: command).
258: This option specifies the number of primality tests to perform.
1.66 jmc 259: .It Fl B
260: Show the bubblebabble digest of specified private or public key file.
1.2 deraadt 261: .It Fl b Ar bits
1.12 aaron 262: Specifies the number of bits in the key to create.
1.126 djm 263: For RSA keys, the minimum size is 1024 bits and the default is 2048 bits.
1.69 djm 264: Generally, 2048 bits is considered sufficient.
1.72 dtucker 265: DSA keys must be exactly 1024 bits as specified by FIPS 186-2.
1.106 djm 266: For ECDSA keys, the
267: .Fl b
1.107 deraadt 268: flag determines the key length by selecting from one of three elliptic
1.106 djm 269: curve sizes: 256, 384 or 521 bits.
270: Attempting to use bit lengths other than these three values for ECDSA keys
271: will fail.
1.123 sobrado 272: Ed25519 keys have a fixed length and the
1.118 naddy 273: .Fl b
274: flag will be ignored.
1.66 jmc 275: .It Fl C Ar comment
276: Provides a new comment.
1.2 deraadt 277: .It Fl c
1.1 deraadt 278: Requests changing the comment in the private and public key files.
279: The program will prompt for the file containing the private keys, for
1.41 stevesk 280: the passphrase if the key has one, and for the new comment.
1.81 markus 281: .It Fl D Ar pkcs11
1.83 markus 282: Download the RSA public keys provided by the PKCS#11 shared library
283: .Ar pkcs11 .
1.98 djm 284: When used in combination with
285: .Fl s ,
286: this option indicates that a CA key resides in a PKCS#11 token (see the
287: .Sx CERTIFICATES
288: section for details).
1.124 djm 289: .It Fl E Ar fingerprint_hash
290: Specifies the hash algorithm used when displaying key fingerprints.
291: Valid options are:
292: .Dq md5
293: and
294: .Dq sha256 .
295: The default is
296: .Dq sha256 .
1.37 markus 297: .It Fl e
1.40 markus 298: This option will read a private or public OpenSSH key file and
1.154 djm 299: print to stdout a public key in one of the formats specified by the
1.95 djm 300: .Fl m
301: option.
302: The default export format is
303: .Dq RFC4716 .
1.96 jmc 304: This option allows exporting OpenSSH keys for use by other programs, including
1.95 djm 305: several commercial SSH implementations.
1.151 djm 306: .It Fl F Ar hostname | [hostname]:port
1.66 jmc 307: Search for the specified
308: .Ar hostname
1.151 djm 309: (with optional port number)
1.66 jmc 310: in a
311: .Pa known_hosts
312: file, listing any occurrences found.
313: This option is useful to find hashed host names or addresses and may also be
314: used in conjunction with the
315: .Fl H
316: option to print found keys in a hashed format.
317: .It Fl f Ar filename
318: Specifies the filename of the key file.
319: .It Fl G Ar output_file
320: Generate candidate primes for DH-GEX.
321: These primes must be screened for
322: safety (using the
323: .Fl T
324: option) before use.
1.57 jakob 325: .It Fl g
1.62 jakob 326: Use generic DNS format when printing fingerprint resource records using the
1.63 jmc 327: .Fl r
1.62 jakob 328: command.
1.66 jmc 329: .It Fl H
330: Hash a
331: .Pa known_hosts
1.67 dtucker 332: file.
333: This replaces all hostnames and addresses with hashed representations
334: within the specified file; the original content is moved to a file with
335: a .old suffix.
1.66 jmc 336: These hashes may be used normally by
337: .Nm ssh
338: and
339: .Nm sshd ,
340: but they do not reveal identifying information should the file's contents
341: be disclosed.
342: This option will not modify existing hashed hostnames and is therefore safe
343: to use on files that mix hashed and non-hashed names.
1.84 djm 344: .It Fl h
345: When signing a key, create a host certificate instead of a user
346: certificate.
347: Please see the
348: .Sx CERTIFICATES
349: section for details.
1.85 jmc 350: .It Fl I Ar certificate_identity
1.84 djm 351: Specify the key identity when signing a public key.
352: Please see the
353: .Sx CERTIFICATES
354: section for details.
1.37 markus 355: .It Fl i
356: This option will read an unencrypted private (or public) key file
1.95 djm 357: in the format specified by the
358: .Fl m
359: option and print an OpenSSH compatible private
1.37 markus 360: (or public) key to stdout.
1.122 jmc 361: This option allows importing keys from other software, including several
362: commercial SSH implementations.
363: The default import format is
364: .Dq RFC4716 .
1.109 dtucker 365: .It Fl J Ar num_lines
366: Exit after screening the specified number of lines
367: while performing DH candidate screening using the
368: .Fl T
369: option.
370: .It Fl j Ar start_line
371: Start screening at the specified line number
372: while performing DH candidate screening using the
373: .Fl T
374: option.
1.108 dtucker 375: .It Fl K Ar checkpt
376: Write the last line processed to the file
377: .Ar checkpt
378: while performing DH candidate screening using the
379: .Fl T
380: option.
381: This will be used to skip lines in the input file that have already been
382: processed if the job is restarted.
1.111 djm 383: .It Fl k
384: Generate a KRL file.
385: In this mode,
386: .Nm
387: will generate a KRL file at the location specified via the
388: .Fl f
1.114 jmc 389: flag that revokes every key or certificate presented on the command line.
1.111 djm 390: Keys/certificates to be revoked may be specified by public key file or
391: using the format described in the
392: .Sx KEY REVOCATION LISTS
393: section.
1.86 djm 394: .It Fl L
1.129 djm 395: Prints the contents of one or more certificates.
1.9 markus 396: .It Fl l
1.77 grunk 397: Show fingerprint of specified public key file.
1.50 markus 398: For RSA and DSA keys
399: .Nm
1.78 jmc 400: tries to find the matching public key file and prints its fingerprint.
401: If combined with
402: .Fl v ,
1.132 jmc 403: a visual ASCII art representation of the key is supplied with the
1.131 djm 404: fingerprint.
1.96 jmc 405: .It Fl M Ar memory
406: Specify the amount of memory to use (in megabytes) when generating
407: candidate moduli for DH-GEX.
1.95 djm 408: .It Fl m Ar key_format
1.155 ! djm 409: Specify a key format for key generation, the
1.95 djm 410: .Fl i
1.155 ! djm 411: (import),
1.95 djm 412: .Fl e
1.155 ! djm 413: (export) conversion options, and the
! 414: .Fl p
! 415: change passphrase operation.
! 416: The latter may be used to convert between OpenSSH private key and PEM
! 417: private key formats.
1.95 djm 418: The supported key formats are:
419: .Dq RFC4716
1.96 jmc 420: (RFC 4716/SSH2 public or private key),
1.95 djm 421: .Dq PKCS8
422: (PEM PKCS8 public key)
423: or
424: .Dq PEM
425: (PEM public key).
426: The default conversion format is
427: .Dq RFC4716 .
1.148 djm 428: Setting a format of
429: .Dq PEM
430: when generating or updating a supported private key type will cause the
431: key to be stored in the legacy PEM private key format.
1.66 jmc 432: .It Fl N Ar new_passphrase
433: Provides the new passphrase.
1.84 djm 434: .It Fl n Ar principals
435: Specify one or more principals (user or host names) to be included in
436: a certificate when signing a key.
437: Multiple principals may be specified, separated by commas.
438: Please see the
439: .Sx CERTIFICATES
440: section for details.
1.93 djm 441: .It Fl O Ar option
442: Specify a certificate option when signing a key.
1.84 djm 443: This option may be specified multiple times.
1.137 jmc 444: See also the
1.84 djm 445: .Sx CERTIFICATES
1.137 jmc 446: section for further details.
1.146 djm 447: .Pp
448: At present, no standard options are valid for host keys.
1.93 djm 449: The options that are valid for user certificates are:
1.137 jmc 450: .Pp
451: .Bl -tag -width Ds -compact
1.89 jmc 452: .It Ic clear
453: Clear all enabled permissions.
454: This is useful for clearing the default set of permissions so permissions may
455: be added individually.
1.137 jmc 456: .Pp
457: .It Ic critical : Ns Ar name Ns Op Ns = Ns Ar contents
458: .It Ic extension : Ns Ar name Ns Op Ns = Ns Ar contents
459: Includes an arbitrary certificate critical option or extension.
460: The specified
461: .Ar name
462: should include a domain suffix, e.g.\&
463: .Dq name@example.com .
464: If
465: .Ar contents
466: is specified then it is included as the contents of the extension/option
467: encoded as a string, otherwise the extension/option is created with no
468: contents (usually indicating a flag).
469: Extensions may be ignored by a client or server that does not recognise them,
470: whereas unknown critical options will cause the certificate to be refused.
1.138 jmc 471: .Pp
1.89 jmc 472: .It Ic force-command Ns = Ns Ar command
473: Forces the execution of
474: .Ar command
475: instead of any shell or command specified by the user when
476: the certificate is used for authentication.
1.137 jmc 477: .Pp
1.84 djm 478: .It Ic no-agent-forwarding
479: Disable
480: .Xr ssh-agent 1
1.85 jmc 481: forwarding (permitted by default).
1.137 jmc 482: .Pp
1.84 djm 483: .It Ic no-port-forwarding
1.85 jmc 484: Disable port forwarding (permitted by default).
1.137 jmc 485: .Pp
1.84 djm 486: .It Ic no-pty
1.85 jmc 487: Disable PTY allocation (permitted by default).
1.137 jmc 488: .Pp
1.84 djm 489: .It Ic no-user-rc
490: Disable execution of
491: .Pa ~/.ssh/rc
492: by
1.85 jmc 493: .Xr sshd 8
494: (permitted by default).
1.137 jmc 495: .Pp
1.89 jmc 496: .It Ic no-x11-forwarding
497: Disable X11 forwarding (permitted by default).
1.137 jmc 498: .Pp
1.88 djm 499: .It Ic permit-agent-forwarding
500: Allows
501: .Xr ssh-agent 1
502: forwarding.
1.137 jmc 503: .Pp
1.84 djm 504: .It Ic permit-port-forwarding
505: Allows port forwarding.
1.137 jmc 506: .Pp
1.84 djm 507: .It Ic permit-pty
508: Allows PTY allocation.
1.137 jmc 509: .Pp
1.84 djm 510: .It Ic permit-user-rc
511: Allows execution of
512: .Pa ~/.ssh/rc
513: by
514: .Xr sshd 8 .
1.137 jmc 515: .Pp
1.146 djm 516: .It Ic permit-X11-forwarding
1.89 jmc 517: Allows X11 forwarding.
1.137 jmc 518: .Pp
1.89 jmc 519: .It Ic source-address Ns = Ns Ar address_list
1.90 jmc 520: Restrict the source addresses from which the certificate is considered valid.
1.84 djm 521: The
522: .Ar address_list
523: is a comma-separated list of one or more address/netmask pairs in CIDR
524: format.
525: .El
1.66 jmc 526: .It Fl P Ar passphrase
527: Provides the (old) passphrase.
1.2 deraadt 528: .It Fl p
1.1 deraadt 529: Requests changing the passphrase of a private key file instead of
1.12 aaron 530: creating a new private key.
531: The program will prompt for the file
1.1 deraadt 532: containing the private key, for the old passphrase, and twice for the
533: new passphrase.
1.113 jmc 534: .It Fl Q
535: Test whether keys have been revoked in a KRL.
1.5 aaron 536: .It Fl q
537: Silence
538: .Nm ssh-keygen .
1.152 djm 539: .It Fl R Ar hostname | [hostname]:port
1.151 djm 540: Removes all keys belonging to the specified
1.64 djm 541: .Ar hostname
1.151 djm 542: (with optional port number)
1.65 jmc 543: from a
1.64 djm 544: .Pa known_hosts
545: file.
1.65 jmc 546: This option is useful to delete hashed hosts (see the
1.64 djm 547: .Fl H
548: option above).
1.66 jmc 549: .It Fl r Ar hostname
550: Print the SSHFP fingerprint resource record named
551: .Ar hostname
552: for the specified public key file.
1.60 djm 553: .It Fl S Ar start
554: Specify start point (in hex) when generating candidate moduli for DH-GEX.
1.84 djm 555: .It Fl s Ar ca_key
556: Certify (sign) a public key using the specified CA key.
557: Please see the
558: .Sx CERTIFICATES
559: section for details.
1.111 djm 560: .Pp
561: When generating a KRL,
562: .Fl s
1.112 jmc 563: specifies a path to a CA public key file used to revoke certificates directly
1.111 djm 564: by key ID or serial number.
565: See the
566: .Sx KEY REVOCATION LISTS
567: section for details.
1.60 djm 568: .It Fl T Ar output_file
569: Test DH group exchange candidate primes (generated using the
570: .Fl G
571: option) for safety.
1.139 jmc 572: .It Fl t Cm dsa | ecdsa | ed25519 | rsa
1.66 jmc 573: Specifies the type of key to create.
574: The possible values are
1.100 naddy 575: .Dq dsa ,
1.118 naddy 576: .Dq ecdsa ,
577: .Dq ed25519 ,
1.100 naddy 578: or
1.139 jmc 579: .Dq rsa .
1.142 djm 580: .It Fl U
581: When used in combination with
582: .Fl s ,
583: this option indicates that a CA key resides in a
584: .Xr ssh-agent 1 .
585: See the
586: .Sx CERTIFICATES
587: section for more information.
1.112 jmc 588: .It Fl u
589: Update a KRL.
590: When specified with
591: .Fl k ,
1.114 jmc 592: keys listed via the command line are added to the existing KRL rather than
1.112 jmc 593: a new KRL being created.
1.84 djm 594: .It Fl V Ar validity_interval
595: Specify a validity interval when signing a certificate.
596: A validity interval may consist of a single time, indicating that the
597: certificate is valid beginning now and expiring at that time, or may consist
598: of two times separated by a colon to indicate an explicit time interval.
1.145 djm 599: .Pp
600: The start time may be specified as the string
601: .Dq always
602: to indicate the certificate has no specified start time,
1.147 djm 603: a date in YYYYMMDD format, a time in YYYYMMDDHHMM[SS] format,
1.145 djm 604: a relative time (to the current time) consisting of a minus sign followed by
605: an interval in the format described in the
1.116 jmc 606: TIME FORMATS section of
1.90 jmc 607: .Xr sshd_config 5 .
1.145 djm 608: .Pp
1.147 djm 609: The end time may be specified as a YYYYMMDD date, a YYYYMMDDHHMM[SS] time,
1.145 djm 610: a relative time starting with a plus character or the string
611: .Dq forever
612: to indicate that the certificate has no expirty date.
1.84 djm 613: .Pp
614: For example:
615: .Dq +52w1d
616: (valid from now to 52 weeks and one day from now),
617: .Dq -4w:+4w
618: (valid from four weeks ago to four weeks from now),
619: .Dq 20100101123000:20110101123000
620: (valid from 12:30 PM, January 1st, 2010 to 12:30 PM, January 1st, 2011),
621: .Dq -1d:20110101
622: (valid from yesterday to midnight, January 1st, 2011).
1.145 djm 623: .Dq -1m:forever
624: (valid from one minute ago and never expiring).
1.61 djm 625: .It Fl v
626: Verbose mode.
627: Causes
628: .Nm
629: to print debugging messages about its progress.
630: This is helpful for debugging moduli generation.
631: Multiple
632: .Fl v
633: options increase the verbosity.
634: The maximum is 3.
1.66 jmc 635: .It Fl W Ar generator
636: Specify desired generator when testing candidate moduli for DH-GEX.
637: .It Fl y
638: This option will read a private
639: OpenSSH format file and print an OpenSSH public key to stdout.
1.93 djm 640: .It Fl z Ar serial_number
641: Specifies a serial number to be embedded in the certificate to distinguish
642: this certificate from others from the same CA.
643: The default serial number is zero.
1.111 djm 644: .Pp
645: When generating a KRL, the
646: .Fl z
647: flag is used to specify a KRL version number.
1.2 deraadt 648: .El
1.60 djm 649: .Sh MODULI GENERATION
650: .Nm
651: may be used to generate groups for the Diffie-Hellman Group Exchange
652: (DH-GEX) protocol.
653: Generating these groups is a two-step process: first, candidate
654: primes are generated using a fast, but memory intensive process.
655: These candidate primes are then tested for suitability (a CPU-intensive
656: process).
657: .Pp
658: Generation of primes is performed using the
659: .Fl G
660: option.
661: The desired length of the primes may be specified by the
662: .Fl b
663: option.
664: For example:
665: .Pp
1.66 jmc 666: .Dl # ssh-keygen -G moduli-2048.candidates -b 2048
1.60 djm 667: .Pp
668: By default, the search for primes begins at a random point in the
669: desired length range.
670: This may be overridden using the
671: .Fl S
672: option, which specifies a different start point (in hex).
673: .Pp
1.109 dtucker 674: Once a set of candidates have been generated, they must be screened for
1.60 djm 675: suitability.
676: This may be performed using the
677: .Fl T
678: option.
679: In this mode
680: .Nm
681: will read candidates from standard input (or a file specified using the
682: .Fl f
683: option).
684: For example:
685: .Pp
1.66 jmc 686: .Dl # ssh-keygen -T moduli-2048 -f moduli-2048.candidates
1.60 djm 687: .Pp
688: By default, each candidate will be subjected to 100 primality tests.
689: This may be overridden using the
690: .Fl a
691: option.
692: The DH generator value will be chosen automatically for the
693: prime under consideration.
694: If a specific generator is desired, it may be requested using the
695: .Fl W
696: option.
1.66 jmc 697: Valid generator values are 2, 3, and 5.
1.60 djm 698: .Pp
699: Screened DH groups may be installed in
700: .Pa /etc/moduli .
701: It is important that this file contains moduli of a range of bit lengths and
702: that both ends of a connection share common moduli.
1.84 djm 703: .Sh CERTIFICATES
704: .Nm
705: supports signing of keys to produce certificates that may be used for
706: user or host authentication.
707: Certificates consist of a public key, some identity information, zero or
1.94 jmc 708: more principal (user or host) names and a set of options that
1.84 djm 709: are signed by a Certification Authority (CA) key.
710: Clients or servers may then trust only the CA key and verify its signature
711: on a certificate rather than trusting many user/host keys.
712: Note that OpenSSH certificates are a different, and much simpler, format to
713: the X.509 certificates used in
714: .Xr ssl 8 .
715: .Pp
716: .Nm
717: supports two types of certificates: user and host.
718: User certificates authenticate users to servers, whereas host certificates
1.85 jmc 719: authenticate server hosts to users.
720: To generate a user certificate:
1.84 djm 721: .Pp
722: .Dl $ ssh-keygen -s /path/to/ca_key -I key_id /path/to/user_key.pub
723: .Pp
724: The resultant certificate will be placed in
1.91 djm 725: .Pa /path/to/user_key-cert.pub .
1.84 djm 726: A host certificate requires the
727: .Fl h
728: option:
729: .Pp
730: .Dl $ ssh-keygen -s /path/to/ca_key -I key_id -h /path/to/host_key.pub
731: .Pp
732: The host certificate will be output to
1.91 djm 733: .Pa /path/to/host_key-cert.pub .
1.98 djm 734: .Pp
735: It is possible to sign using a CA key stored in a PKCS#11 token by
736: providing the token library using
737: .Fl D
738: and identifying the CA key by providing its public half as an argument
739: to
740: .Fl s :
741: .Pp
1.127 naddy 742: .Dl $ ssh-keygen -s ca_key.pub -D libpkcs11.so -I key_id user_key.pub
1.142 djm 743: .Pp
744: Similarly, it is possible for the CA key to be hosted in a
745: .Xr ssh-agent 1 .
746: This is indicated by the
747: .Fl U
748: flag and, again, the CA key must be identified by its public half.
749: .Pp
750: .Dl $ ssh-keygen -Us ca_key.pub -I key_id user_key.pub
1.98 djm 751: .Pp
752: In all cases,
1.84 djm 753: .Ar key_id
754: is a "key identifier" that is logged by the server when the certificate
755: is used for authentication.
756: .Pp
757: Certificates may be limited to be valid for a set of principal (user/host)
758: names.
759: By default, generated certificates are valid for all users or hosts.
760: To generate a certificate for a specified set of principals:
761: .Pp
762: .Dl $ ssh-keygen -s ca_key -I key_id -n user1,user2 user_key.pub
1.127 naddy 763: .Dl "$ ssh-keygen -s ca_key -I key_id -h -n host.domain host_key.pub"
1.84 djm 764: .Pp
765: Additional limitations on the validity and use of user certificates may
1.94 jmc 766: be specified through certificate options.
1.93 djm 767: A certificate option may disable features of the SSH session, may be
1.84 djm 768: valid only when presented from particular source addresses or may
769: force the use of a specific command.
1.93 djm 770: For a list of valid certificate options, see the documentation for the
1.84 djm 771: .Fl O
772: option above.
773: .Pp
774: Finally, certificates may be defined with a validity lifetime.
775: The
776: .Fl V
777: option allows specification of certificate start and end times.
778: A certificate that is presented at a time outside this range will not be
779: considered valid.
1.110 jmc 780: By default, certificates are valid from
781: .Ux
782: Epoch to the distant future.
1.84 djm 783: .Pp
784: For certificates to be used for user or host authentication, the CA
785: public key must be trusted by
786: .Xr sshd 8
787: or
788: .Xr ssh 1 .
789: Please refer to those manual pages for details.
1.111 djm 790: .Sh KEY REVOCATION LISTS
791: .Nm
792: is able to manage OpenSSH format Key Revocation Lists (KRLs).
793: These binary files specify keys or certificates to be revoked using a
1.119 tedu 794: compact format, taking as little as one bit per certificate if they are being
1.111 djm 795: revoked by serial number.
796: .Pp
797: KRLs may be generated using the
798: .Fl k
799: flag.
1.114 jmc 800: This option reads one or more files from the command line and generates a new
1.111 djm 801: KRL.
802: The files may either contain a KRL specification (see below) or public keys,
803: listed one per line.
804: Plain public keys are revoked by listing their hash or contents in the KRL and
805: certificates revoked by serial number or key ID (if the serial is zero or
806: not available).
807: .Pp
808: Revoking keys using a KRL specification offers explicit control over the
809: types of record used to revoke keys and may be used to directly revoke
810: certificates by serial number or key ID without having the complete original
811: certificate on hand.
812: A KRL specification consists of lines containing one of the following directives
813: followed by a colon and some directive-specific information.
814: .Bl -tag -width Ds
1.115 jmc 815: .It Cm serial : Ar serial_number Ns Op - Ns Ar serial_number
1.111 djm 816: Revokes a certificate with the specified serial number.
1.112 jmc 817: Serial numbers are 64-bit values, not including zero and may be expressed
1.111 djm 818: in decimal, hex or octal.
819: If two serial numbers are specified separated by a hyphen, then the range
820: of serial numbers including and between each is revoked.
821: The CA key must have been specified on the
822: .Nm
1.114 jmc 823: command line using the
1.111 djm 824: .Fl s
825: option.
826: .It Cm id : Ar key_id
827: Revokes a certificate with the specified key ID string.
828: The CA key must have been specified on the
829: .Nm
1.114 jmc 830: command line using the
1.111 djm 831: .Fl s
832: option.
833: .It Cm key : Ar public_key
834: Revokes the specified key.
1.112 jmc 835: If a certificate is listed, then it is revoked as a plain public key.
1.111 djm 836: .It Cm sha1 : Ar public_key
1.149 djm 837: Revokes the specified key by including its SHA1 hash in the KRL.
838: .It Cm sha256 : Ar public_key
839: Revokes the specified key by including its SHA256 hash in the KRL.
840: KRLs that revoke keys by SHA256 hash are not supported by OpenSSH versions
841: prior to 7.9.
842: .It Cm hash : Ar fingerprint
1.150 djm 843: Revokes a key using a fingerprint hash, as obtained from a
1.149 djm 844: .Xr sshd 8
845: authentication log message or the
846: .Nm
847: .Fl l
848: flag.
849: Only SHA256 fingerprints are supported here and resultant KRLs are
850: not supported by OpenSSH versions prior to 7.9.
1.111 djm 851: .El
852: .Pp
853: KRLs may be updated using the
854: .Fl u
855: flag in addition to
856: .Fl k .
1.114 jmc 857: When this option is specified, keys listed via the command line are merged into
1.111 djm 858: the KRL, adding to those already there.
859: .Pp
860: It is also possible, given a KRL, to test whether it revokes a particular key
861: (or keys).
862: The
863: .Fl Q
1.128 jmc 864: flag will query an existing KRL, testing each key specified on the command line.
1.114 jmc 865: If any key listed on the command line has been revoked (or an error encountered)
1.111 djm 866: then
867: .Nm
868: will exit with a non-zero exit status.
869: A zero exit status will only be returned if no key was revoked.
1.2 deraadt 870: .Sh FILES
1.100 naddy 871: .Bl -tag -width Ds -compact
1.68 djm 872: .It Pa ~/.ssh/id_dsa
1.100 naddy 873: .It Pa ~/.ssh/id_ecdsa
1.118 naddy 874: .It Pa ~/.ssh/id_ed25519
1.100 naddy 875: .It Pa ~/.ssh/id_rsa
1.141 naddy 876: Contains the DSA, ECDSA, Ed25519 or RSA
1.118 naddy 877: authentication identity of the user.
1.15 deraadt 878: This file should not be readable by anyone but the user.
879: It is possible to
880: specify a passphrase when generating the key; that passphrase will be
1.80 dtucker 881: used to encrypt the private part of this file using 128-bit AES.
1.15 deraadt 882: This file is not automatically accessed by
883: .Nm
884: but it is offered as the default file for the private key.
1.46 markus 885: .Xr ssh 1
1.15 deraadt 886: will read this file when a login attempt is made.
1.100 naddy 887: .Pp
1.68 djm 888: .It Pa ~/.ssh/id_dsa.pub
1.100 naddy 889: .It Pa ~/.ssh/id_ecdsa.pub
1.118 naddy 890: .It Pa ~/.ssh/id_ed25519.pub
1.68 djm 891: .It Pa ~/.ssh/id_rsa.pub
1.141 naddy 892: Contains the DSA, ECDSA, Ed25519 or RSA
1.118 naddy 893: public key for authentication.
1.15 deraadt 894: The contents of this file should be added to
1.68 djm 895: .Pa ~/.ssh/authorized_keys
1.15 deraadt 896: on all machines
1.49 deraadt 897: where the user wishes to log in using public key authentication.
1.12 aaron 898: There is no need to keep the contents of this file secret.
1.100 naddy 899: .Pp
1.60 djm 900: .It Pa /etc/moduli
901: Contains Diffie-Hellman groups used for DH-GEX.
902: The file format is described in
903: .Xr moduli 5 .
1.19 aaron 904: .El
1.2 deraadt 905: .Sh SEE ALSO
906: .Xr ssh 1 ,
907: .Xr ssh-add 1 ,
1.8 ericj 908: .Xr ssh-agent 1 ,
1.60 djm 909: .Xr moduli 5 ,
1.30 itojun 910: .Xr sshd 8
1.37 markus 911: .Rs
1.73 markus 912: .%R RFC 4716
913: .%T "The Secure Shell (SSH) Public Key File Format"
914: .%D 2006
1.37 markus 915: .Re
1.59 jmc 916: .Sh AUTHORS
917: OpenSSH is a derivative of the original and free
918: ssh 1.2.12 release by Tatu Ylonen.
919: Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
920: Theo de Raadt and Dug Song
921: removed many bugs, re-added newer features and
922: created OpenSSH.
923: Markus Friedl contributed the support for SSH
924: protocol versions 1.5 and 2.0.