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