blob: 689db22ff25a5b53ad40b5cc9e2ba3e43fc31836 [file] [log] [blame]
Damien Miller4f752cf2013-12-18 17:45:35 +11001.\" $OpenBSD: ssh-keygen.1,v 1.117 2013/12/07 08:08:26 djm Exp $
Damien Miller32aa1441999-10-29 09:15:49 +10002.\"
Damien Miller32aa1441999-10-29 09:15:49 +10003.\" Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller32aa1441999-10-29 09:15:49 +10004.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5.\" All rights reserved
6.\"
Damien Millere4340be2000-09-16 13:29:08 +11007.\" 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".
Damien Miller32aa1441999-10-29 09:15:49 +100012.\"
Damien Millere4340be2000-09-16 13:29:08 +110013.\"
Ben Lindstrom92a2e382001-03-05 06:59:27 +000014.\" 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.
Damien Millere4340be2000-09-16 13:29:08 +110017.\"
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.
26.\"
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.
Damien Miller32aa1441999-10-29 09:15:49 +100037.\"
Damien Miller4f752cf2013-12-18 17:45:35 +110038.Dd $Mdocdate: December 7 2013 $
Damien Miller32aa1441999-10-29 09:15:49 +100039.Dt SSH-KEYGEN 1
40.Os
41.Sh NAME
42.Nm ssh-keygen
Ben Lindstrom5a707822001-04-22 17:15:46 +000043.Nd authentication key generation, management and conversion
Damien Miller32aa1441999-10-29 09:15:49 +100044.Sh SYNOPSIS
Damien Miller495dca32003-04-01 21:42:14 +100045.Bk -words
Damien Millerbad5e032010-07-16 13:59:59 +100046.Nm ssh-keygen
Damien Miller0bc1bd82000-11-13 22:57:25 +110047.Op Fl q
Damien Miller32aa1441999-10-29 09:15:49 +100048.Op Fl b Ar bits
Damien Miller55fafa02002-02-19 15:22:07 +110049.Fl t Ar type
Damien Miller32aa1441999-10-29 09:15:49 +100050.Op Fl N Ar new_passphrase
51.Op Fl C Ar comment
Damien Miller1a425f32000-09-02 10:08:09 +110052.Op Fl f Ar output_keyfile
Damien Miller32aa1441999-10-29 09:15:49 +100053.Nm ssh-keygen
54.Fl p
55.Op Fl P Ar old_passphrase
56.Op Fl N Ar new_passphrase
Damien Miller10f6f6b1999-11-17 17:29:08 +110057.Op Fl f Ar keyfile
Damien Miller32aa1441999-10-29 09:15:49 +100058.Nm ssh-keygen
Ben Lindstrom5a707822001-04-22 17:15:46 +000059.Fl i
Damien Miller44b25042010-07-02 13:35:01 +100060.Op Fl m Ar key_format
Damien Miller1a425f32000-09-02 10:08:09 +110061.Op Fl f Ar input_keyfile
Damien Millere247cc42000-05-07 12:03:14 +100062.Nm ssh-keygen
Ben Lindstrom5a707822001-04-22 17:15:46 +000063.Fl e
Damien Miller44b25042010-07-02 13:35:01 +100064.Op Fl m Ar key_format
Damien Miller1a425f32000-09-02 10:08:09 +110065.Op Fl f Ar input_keyfile
Damien Millere247cc42000-05-07 12:03:14 +100066.Nm ssh-keygen
67.Fl y
Damien Miller1a425f32000-09-02 10:08:09 +110068.Op Fl f Ar input_keyfile
Damien Millere247cc42000-05-07 12:03:14 +100069.Nm ssh-keygen
Damien Miller32aa1441999-10-29 09:15:49 +100070.Fl c
71.Op Fl P Ar passphrase
72.Op Fl C Ar comment
Damien Miller10f6f6b1999-11-17 17:29:08 +110073.Op Fl f Ar keyfile
74.Nm ssh-keygen
75.Fl l
Ben Lindstrom8fd372b2001-03-12 03:02:17 +000076.Op Fl f Ar input_keyfile
77.Nm ssh-keygen
78.Fl B
Damien Miller1a425f32000-09-02 10:08:09 +110079.Op Fl f Ar input_keyfile
Ben Lindstroma1ec4a92001-08-06 21:51:34 +000080.Nm ssh-keygen
Damien Miller048dc932010-02-12 09:22:04 +110081.Fl D Ar pkcs11
Ben Lindstroma1ec4a92001-08-06 21:51:34 +000082.Nm ssh-keygen
Damien Miller4b42d7f2005-03-01 21:48:35 +110083.Fl F Ar hostname
84.Op Fl f Ar known_hosts_file
Damien Miller718ed502008-11-03 19:15:20 +110085.Op Fl l
Damien Miller4b42d7f2005-03-01 21:48:35 +110086.Nm ssh-keygen
87.Fl H
88.Op Fl f Ar known_hosts_file
89.Nm ssh-keygen
90.Fl R Ar hostname
91.Op Fl f Ar known_hosts_file
92.Nm ssh-keygen
Damien Miller37876e92003-05-15 10:19:46 +100093.Fl r Ar hostname
94.Op Fl f Ar input_keyfile
95.Op Fl g
Darren Tucker019cefe2003-08-02 22:40:07 +100096.Nm ssh-keygen
97.Fl G Ar output_file
Darren Tucker06930c72003-12-31 11:34:51 +110098.Op Fl v
Darren Tucker019cefe2003-08-02 22:40:07 +100099.Op Fl b Ar bits
100.Op Fl M Ar memory
101.Op Fl S Ar start_point
102.Nm ssh-keygen
103.Fl T Ar output_file
104.Fl f Ar input_file
Darren Tucker06930c72003-12-31 11:34:51 +1100105.Op Fl v
Damien Miller4f752cf2013-12-18 17:45:35 +1100106.Op Fl a Ar rounds
Damien Millerdfceafe2012-07-06 13:44:19 +1000107.Op Fl J Ar num_lines
108.Op Fl j Ar start_line
Damien Miller390d0562011-10-18 16:05:19 +1100109.Op Fl K Ar checkpt
Darren Tucker019cefe2003-08-02 22:40:07 +1000110.Op Fl W Ar generator
Damien Miller0a80ca12010-02-27 07:55:05 +1100111.Nm ssh-keygen
112.Fl s Ar ca_key
113.Fl I Ar certificate_identity
114.Op Fl h
115.Op Fl n Ar principals
Damien Miller4e270b02010-04-16 15:56:21 +1000116.Op Fl O Ar option
Damien Miller0a80ca12010-02-27 07:55:05 +1100117.Op Fl V Ar validity_interval
Damien Miller4e270b02010-04-16 15:56:21 +1000118.Op Fl z Ar serial_number
Damien Miller0a80ca12010-02-27 07:55:05 +1100119.Ar
Damien Millerf2b70ca2010-03-05 07:39:35 +1100120.Nm ssh-keygen
Damien Millerf2b70ca2010-03-05 07:39:35 +1100121.Fl L
122.Op Fl f Ar input_keyfile
Damien Miller58f1baf2011-05-05 14:06:15 +1000123.Nm ssh-keygen
124.Fl A
Damien Millerf3747bf2013-01-18 11:44:04 +1100125.Nm ssh-keygen
126.Fl k
127.Fl f Ar krl_file
128.Op Fl u
Damien Millerac5542b2013-01-20 22:33:02 +1100129.Op Fl s Ar ca_public
130.Op Fl z Ar version_number
Damien Millerf3747bf2013-01-18 11:44:04 +1100131.Ar
132.Nm ssh-keygen
133.Fl Q
134.Fl f Ar krl_file
135.Ar
Damien Miller15f5b562010-03-03 10:25:21 +1100136.Ek
Damien Miller22c77262000-04-13 12:26:34 +1000137.Sh DESCRIPTION
Damien Miller32aa1441999-10-29 09:15:49 +1000138.Nm
Ben Lindstrom5a707822001-04-22 17:15:46 +0000139generates, manages and converts authentication keys for
Damien Miller32aa1441999-10-29 09:15:49 +1000140.Xr ssh 1 .
Damien Millere247cc42000-05-07 12:03:14 +1000141.Nm
Damien Miller6186bbc2010-09-24 22:00:54 +1000142can create RSA keys for use by SSH protocol version 1 and DSA, ECDSA or RSA
Damien Millerfbf486b2003-05-23 18:44:23 +1000143keys for use by SSH protocol version 2.
144The type of key to be generated is specified with the
Damien Miller0bc1bd82000-11-13 22:57:25 +1100145.Fl t
Damien Millera41c8b12002-01-22 23:05:08 +1100146option.
Damien Millerf14be5c2005-11-05 15:15:49 +1100147If invoked without any arguments,
148.Nm
Damien Miller83d0d392005-11-05 15:16:27 +1100149will generate an RSA key for use in SSH protocol 2 connections.
Damien Millere247cc42000-05-07 12:03:14 +1000150.Pp
Darren Tucker019cefe2003-08-02 22:40:07 +1000151.Nm
152is also used to generate groups for use in Diffie-Hellman group
153exchange (DH-GEX).
154See the
155.Sx MODULI GENERATION
156section for details.
157.Pp
Damien Millerf3747bf2013-01-18 11:44:04 +1100158Finally,
159.Nm
160can be used to generate and update Key Revocation Lists, and to test whether
Damien Millerac5542b2013-01-20 22:33:02 +1100161given keys have been revoked by one.
162See the
Damien Millerf3747bf2013-01-18 11:44:04 +1100163.Sx KEY REVOCATION LISTS
164section for details.
165.Pp
Damien Miller32aa1441999-10-29 09:15:49 +1000166Normally each user wishing to use SSH
Damien Millereb8b60e2010-08-31 22:41:14 +1000167with public key authentication runs this once to create the authentication
Damien Miller32aa1441999-10-29 09:15:49 +1000168key in
Damien Miller167ea5d2005-05-26 12:04:02 +1000169.Pa ~/.ssh/identity ,
Damien Millereb8b60e2010-08-31 22:41:14 +1000170.Pa ~/.ssh/id_ecdsa ,
Damien Miller167ea5d2005-05-26 12:04:02 +1000171.Pa ~/.ssh/id_dsa
Damien Millere247cc42000-05-07 12:03:14 +1000172or
Damien Miller167ea5d2005-05-26 12:04:02 +1000173.Pa ~/.ssh/id_rsa .
Damien Millere247cc42000-05-07 12:03:14 +1000174Additionally, the system administrator may use this to generate host keys,
175as seen in
176.Pa /etc/rc .
Damien Miller32aa1441999-10-29 09:15:49 +1000177.Pp
178Normally this program generates the key and asks for a file in which
Damien Miller450a7a12000-03-26 13:04:51 +1000179to store the private key.
180The public key is stored in a file with the same name but
Damien Miller32aa1441999-10-29 09:15:49 +1000181.Dq .pub
Damien Miller450a7a12000-03-26 13:04:51 +1000182appended.
183The program also asks for a passphrase.
184The passphrase may be empty to indicate no passphrase
Ben Lindstrombf555ba2001-01-18 02:04:35 +0000185(host keys must have an empty passphrase), or it may be a string of
Damien Miller450a7a12000-03-26 13:04:51 +1000186arbitrary length.
Ben Lindstrom4e366d52001-12-06 16:43:21 +0000187A passphrase is similar to a password, except it can be a phrase with a
188series of words, punctuation, numbers, whitespace, or any string of
189characters you want.
190Good passphrases are 10-30 characters long, are
Damien Miller32aa1441999-10-29 09:15:49 +1000191not simple sentences or otherwise easily guessable (English
Ben Lindstrom2a097a42001-06-09 01:13:40 +0000192prose has only 1-2 bits of entropy per character, and provides very bad
Ben Lindstrom4e366d52001-12-06 16:43:21 +0000193passphrases), and contain a mix of upper and lowercase letters,
194numbers, and non-alphanumeric characters.
Damien Miller450a7a12000-03-26 13:04:51 +1000195The passphrase can be changed later by using the
Damien Miller32aa1441999-10-29 09:15:49 +1000196.Fl p
197option.
198.Pp
Damien Miller450a7a12000-03-26 13:04:51 +1000199There is no way to recover a lost passphrase.
Damien Miller085c90f2011-05-05 14:15:33 +1000200If the passphrase is lost or forgotten, a new key must be generated
201and the corresponding public key copied to other machines.
Damien Miller32aa1441999-10-29 09:15:49 +1000202.Pp
Ben Lindstrom5a707822001-04-22 17:15:46 +0000203For RSA1 keys,
204there is also a comment field in the key file that is only for
Damien Miller450a7a12000-03-26 13:04:51 +1000205convenience to the user to help identify the key.
206The comment can tell what the key is for, or whatever is useful.
207The comment is initialized to
Damien Miller32aa1441999-10-29 09:15:49 +1000208.Dq user@host
209when the key is created, but can be changed using the
210.Fl c
211option.
212.Pp
Damien Millere247cc42000-05-07 12:03:14 +1000213After a key is generated, instructions below detail where the keys
214should be placed to be activated.
215.Pp
Damien Miller32aa1441999-10-29 09:15:49 +1000216The options are as follows:
217.Bl -tag -width Ds
Damien Miller58f1baf2011-05-05 14:06:15 +1000218.It Fl A
219For each of the key types (rsa1, rsa, dsa and ecdsa) for which host keys
220do not exist, generate the host keys with the default key file path,
221an empty passphrase, default bits for the key type, and default comment.
Damien Miller3ca1eb32011-05-05 14:13:50 +1000222This is used by
Damien Miller58f1baf2011-05-05 14:06:15 +1000223.Pa /etc/rc
224to generate new host keys.
Damien Miller4f752cf2013-12-18 17:45:35 +1100225.It Fl a Ar rounds
226When saving a new-format private key (i.e. an ed25519 key or any SSH protocol
2272 key when the
228.Fl o
229flag is set), this option specifies the number of KDF (key derivation function)
230rounds used.
231Higher numbers result in slower passphrase verification and increased
232resistance to brute-force password cracking (should the keys be stolen).
233.Pp
234When screening DH-GEX candidates (
235using the
Darren Tucker019cefe2003-08-02 22:40:07 +1000236.Fl T
Damien Miller4f752cf2013-12-18 17:45:35 +1100237command).
238This option specifies the number of primality tests to perform.
Damien Miller265d3092005-03-02 12:05:06 +1100239.It Fl B
240Show the bubblebabble digest of specified private or public key file.
Damien Miller32aa1441999-10-29 09:15:49 +1000241.It Fl b Ar bits
Damien Miller450a7a12000-03-26 13:04:51 +1000242Specifies the number of bits in the key to create.
Darren Tucker9f647332005-11-28 16:41:46 +1100243For RSA keys, the minimum size is 768 bits and the default is 2048 bits.
Damien Millerac7ef6a2005-06-16 13:19:06 +1000244Generally, 2048 bits is considered sufficient.
Darren Tucker9f647332005-11-28 16:41:46 +1100245DSA keys must be exactly 1024 bits as specified by FIPS 186-2.
Damien Millerad210322011-05-05 14:15:54 +1000246For ECDSA keys, the
247.Fl b
Damien Miller6232a162011-09-22 21:36:00 +1000248flag determines the key length by selecting from one of three elliptic
Damien Millerad210322011-05-05 14:15:54 +1000249curve sizes: 256, 384 or 521 bits.
250Attempting to use bit lengths other than these three values for ECDSA keys
251will fail.
Damien Miller265d3092005-03-02 12:05:06 +1100252.It Fl C Ar comment
253Provides a new comment.
Damien Miller32aa1441999-10-29 09:15:49 +1000254.It Fl c
255Requests changing the comment in the private and public key files.
Damien Millereb5fec62001-11-12 10:52:44 +1100256This operation is only supported for RSA1 keys.
Damien Miller32aa1441999-10-29 09:15:49 +1000257The program will prompt for the file containing the private keys, for
Ben Lindstromaafff9c2001-05-06 03:01:02 +0000258the passphrase if the key has one, and for the new comment.
Damien Miller7ea845e2010-02-12 09:21:02 +1100259.It Fl D Ar pkcs11
Damien Millera7618442010-02-12 09:26:02 +1100260Download the RSA public keys provided by the PKCS#11 shared library
261.Ar pkcs11 .
Damien Miller757f34e2010-08-05 13:05:31 +1000262When used in combination with
263.Fl s ,
264this option indicates that a CA key resides in a PKCS#11 token (see the
265.Sx CERTIFICATES
266section for details).
Ben Lindstrom5a707822001-04-22 17:15:46 +0000267.It Fl e
Ben Lindstrom46c264f2001-04-24 16:56:58 +0000268This option will read a private or public OpenSSH key file and
Damien Miller44b25042010-07-02 13:35:01 +1000269print to stdout the key in one of the formats specified by the
270.Fl m
271option.
272The default export format is
273.Dq RFC4716 .
Damien Millerea727282010-07-02 13:35:34 +1000274This option allows exporting OpenSSH keys for use by other programs, including
Damien Miller44b25042010-07-02 13:35:01 +1000275several commercial SSH implementations.
Damien Miller265d3092005-03-02 12:05:06 +1100276.It Fl F Ar hostname
277Search for the specified
278.Ar hostname
279in a
280.Pa known_hosts
281file, listing any occurrences found.
282This option is useful to find hashed host names or addresses and may also be
283used in conjunction with the
284.Fl H
285option to print found keys in a hashed format.
286.It Fl f Ar filename
287Specifies the filename of the key file.
288.It Fl G Ar output_file
289Generate candidate primes for DH-GEX.
290These primes must be screened for
291safety (using the
292.Fl T
293option) before use.
Damien Miller37876e92003-05-15 10:19:46 +1000294.It Fl g
Darren Tucker0b42e6d2004-08-13 21:22:40 +1000295Use generic DNS format when printing fingerprint resource records using the
Darren Tucker6e370372004-08-13 21:23:25 +1000296.Fl r
Darren Tucker0b42e6d2004-08-13 21:22:40 +1000297command.
Damien Miller265d3092005-03-02 12:05:06 +1100298.It Fl H
299Hash a
300.Pa known_hosts
Darren Tuckerda1adbc2005-03-14 23:15:58 +1100301file.
302This replaces all hostnames and addresses with hashed representations
303within the specified file; the original content is moved to a file with
304a .old suffix.
Damien Miller265d3092005-03-02 12:05:06 +1100305These hashes may be used normally by
306.Nm ssh
307and
308.Nm sshd ,
309but they do not reveal identifying information should the file's contents
310be disclosed.
311This option will not modify existing hashed hostnames and is therefore safe
312to use on files that mix hashed and non-hashed names.
Damien Miller0a80ca12010-02-27 07:55:05 +1100313.It Fl h
314When signing a key, create a host certificate instead of a user
315certificate.
316Please see the
317.Sx CERTIFICATES
318section for details.
Damien Miller15f5b562010-03-03 10:25:21 +1100319.It Fl I Ar certificate_identity
Damien Miller0a80ca12010-02-27 07:55:05 +1100320Specify the key identity when signing a public key.
321Please see the
322.Sx CERTIFICATES
323section for details.
Ben Lindstrom5a707822001-04-22 17:15:46 +0000324.It Fl i
325This option will read an unencrypted private (or public) key file
Damien Miller44b25042010-07-02 13:35:01 +1000326in the format specified by the
327.Fl m
328option and print an OpenSSH compatible private
Ben Lindstrom5a707822001-04-22 17:15:46 +0000329(or public) key to stdout.
Damien Millerdfceafe2012-07-06 13:44:19 +1000330.It Fl J Ar num_lines
331Exit after screening the specified number of lines
332while performing DH candidate screening using the
333.Fl T
334option.
335.It Fl j Ar start_line
336Start screening at the specified line number
337while performing DH candidate screening using the
338.Fl T
339option.
Damien Miller390d0562011-10-18 16:05:19 +1100340.It Fl K Ar checkpt
341Write the last line processed to the file
342.Ar checkpt
343while performing DH candidate screening using the
344.Fl T
345option.
346This will be used to skip lines in the input file that have already been
347processed if the job is restarted.
Damien Miller44b25042010-07-02 13:35:01 +1000348This option allows importing keys from other software, including several
349commercial SSH implementations.
350The default import format is
351.Dq RFC4716 .
Damien Millerf3747bf2013-01-18 11:44:04 +1100352.It Fl k
353Generate a KRL file.
354In this mode,
355.Nm
356will generate a KRL file at the location specified via the
357.Fl f
Damien Miller881a7a22013-01-20 22:34:46 +1100358flag that revokes every key or certificate presented on the command line.
Damien Millerf3747bf2013-01-18 11:44:04 +1100359Keys/certificates to be revoked may be specified by public key file or
360using the format described in the
361.Sx KEY REVOCATION LISTS
362section.
Damien Millerf2b70ca2010-03-05 07:39:35 +1100363.It Fl L
364Prints the contents of a certificate.
Damien Miller10f6f6b1999-11-17 17:29:08 +1100365.It Fl l
Darren Tucker35c45532008-06-13 04:43:15 +1000366Show fingerprint of specified public key file.
Damien Millereb5fec62001-11-12 10:52:44 +1100367Private RSA1 keys are also supported.
368For RSA and DSA keys
369.Nm
Darren Tuckerf09e8252008-06-13 05:18:03 +1000370tries to find the matching public key file and prints its fingerprint.
371If combined with
372.Fl v ,
373an ASCII art representation of the key is supplied with the fingerprint.
Damien Millerea727282010-07-02 13:35:34 +1000374.It Fl M Ar memory
375Specify the amount of memory to use (in megabytes) when generating
376candidate moduli for DH-GEX.
Damien Miller44b25042010-07-02 13:35:01 +1000377.It Fl m Ar key_format
378Specify a key format for the
379.Fl i
380(import) or
381.Fl e
Damien Millerea727282010-07-02 13:35:34 +1000382(export) conversion options.
Damien Miller44b25042010-07-02 13:35:01 +1000383The supported key formats are:
384.Dq RFC4716
Damien Millerea727282010-07-02 13:35:34 +1000385(RFC 4716/SSH2 public or private key),
Damien Miller44b25042010-07-02 13:35:01 +1000386.Dq PKCS8
387(PEM PKCS8 public key)
388or
389.Dq PEM
390(PEM public key).
391The default conversion format is
392.Dq RFC4716 .
Damien Miller265d3092005-03-02 12:05:06 +1100393.It Fl N Ar new_passphrase
394Provides the new passphrase.
Damien Miller0a80ca12010-02-27 07:55:05 +1100395.It Fl n Ar principals
396Specify one or more principals (user or host names) to be included in
397a certificate when signing a key.
398Multiple principals may be specified, separated by commas.
399Please see the
400.Sx CERTIFICATES
401section for details.
Damien Miller4e270b02010-04-16 15:56:21 +1000402.It Fl O Ar option
403Specify a certificate option when signing a key.
Damien Miller0a80ca12010-02-27 07:55:05 +1100404This option may be specified multiple times.
405Please see the
406.Sx CERTIFICATES
407section for details.
Damien Miller4e270b02010-04-16 15:56:21 +1000408The options that are valid for user certificates are:
Damien Miller0a80ca12010-02-27 07:55:05 +1100409.Bl -tag -width Ds
Damien Millerc59e2442010-03-22 05:50:31 +1100410.It Ic clear
411Clear all enabled permissions.
412This is useful for clearing the default set of permissions so permissions may
413be added individually.
414.It Ic force-command Ns = Ns Ar command
415Forces the execution of
416.Ar command
417instead of any shell or command specified by the user when
418the certificate is used for authentication.
Damien Miller0a80ca12010-02-27 07:55:05 +1100419.It Ic no-agent-forwarding
420Disable
421.Xr ssh-agent 1
Damien Miller15f5b562010-03-03 10:25:21 +1100422forwarding (permitted by default).
Damien Miller0a80ca12010-02-27 07:55:05 +1100423.It Ic no-port-forwarding
Damien Miller15f5b562010-03-03 10:25:21 +1100424Disable port forwarding (permitted by default).
Damien Miller0a80ca12010-02-27 07:55:05 +1100425.It Ic no-pty
Damien Miller15f5b562010-03-03 10:25:21 +1100426Disable PTY allocation (permitted by default).
Damien Miller0a80ca12010-02-27 07:55:05 +1100427.It Ic no-user-rc
428Disable execution of
429.Pa ~/.ssh/rc
430by
Damien Miller15f5b562010-03-03 10:25:21 +1100431.Xr sshd 8
432(permitted by default).
Damien Millerc59e2442010-03-22 05:50:31 +1100433.It Ic no-x11-forwarding
434Disable X11 forwarding (permitted by default).
Damien Miller081c9762010-03-08 11:30:00 +1100435.It Ic permit-agent-forwarding
436Allows
437.Xr ssh-agent 1
438forwarding.
Damien Miller0a80ca12010-02-27 07:55:05 +1100439.It Ic permit-port-forwarding
440Allows port forwarding.
441.It Ic permit-pty
442Allows PTY allocation.
443.It Ic permit-user-rc
444Allows execution of
445.Pa ~/.ssh/rc
446by
447.Xr sshd 8 .
Damien Millerc59e2442010-03-22 05:50:31 +1100448.It Ic permit-x11-forwarding
449Allows X11 forwarding.
450.It Ic source-address Ns = Ns Ar address_list
Damien Miller77497e12010-03-22 05:50:51 +1100451Restrict the source addresses from which the certificate is considered valid.
Damien Miller0a80ca12010-02-27 07:55:05 +1100452The
453.Ar address_list
454is a comma-separated list of one or more address/netmask pairs in CIDR
455format.
456.El
457.Pp
Damien Miller4e270b02010-04-16 15:56:21 +1000458At present, no options are valid for host keys.
Damien Miller4f752cf2013-12-18 17:45:35 +1100459.It Fl o
460Causes
461.Nm
462to save SSH protocol 2 private keys using the new OpenSSH format rather than
463the more compatible PEM format.
464The new format has increased resistance to brute-force password cracking
465but is not supported by versions of OpenSSH prior to 6.5.
466Ed25519 keys always use the new private key format.
Damien Miller265d3092005-03-02 12:05:06 +1100467.It Fl P Ar passphrase
468Provides the (old) passphrase.
Damien Miller32aa1441999-10-29 09:15:49 +1000469.It Fl p
470Requests changing the passphrase of a private key file instead of
Damien Miller450a7a12000-03-26 13:04:51 +1000471creating a new private key.
472The program will prompt for the file
Damien Miller32aa1441999-10-29 09:15:49 +1000473containing the private key, for the old passphrase, and twice for the
474new passphrase.
Damien Miller072fdcd2013-01-20 22:34:04 +1100475.It Fl Q
476Test whether keys have been revoked in a KRL.
Damien Miller32aa1441999-10-29 09:15:49 +1000477.It Fl q
478Silence
479.Nm ssh-keygen .
Damien Miller4b42d7f2005-03-01 21:48:35 +1100480.It Fl R Ar hostname
481Removes all keys belonging to
482.Ar hostname
Damien Miller4c9c6fd2005-03-02 12:03:43 +1100483from a
Damien Miller4b42d7f2005-03-01 21:48:35 +1100484.Pa known_hosts
485file.
Damien Miller4c9c6fd2005-03-02 12:03:43 +1100486This option is useful to delete hashed hosts (see the
Damien Miller4b42d7f2005-03-01 21:48:35 +1100487.Fl H
488option above).
Damien Miller265d3092005-03-02 12:05:06 +1100489.It Fl r Ar hostname
490Print the SSHFP fingerprint resource record named
491.Ar hostname
492for the specified public key file.
Darren Tucker019cefe2003-08-02 22:40:07 +1000493.It Fl S Ar start
494Specify start point (in hex) when generating candidate moduli for DH-GEX.
Damien Miller0a80ca12010-02-27 07:55:05 +1100495.It Fl s Ar ca_key
496Certify (sign) a public key using the specified CA key.
497Please see the
498.Sx CERTIFICATES
499section for details.
Damien Millerf3747bf2013-01-18 11:44:04 +1100500.Pp
501When generating a KRL,
502.Fl s
Damien Millerac5542b2013-01-20 22:33:02 +1100503specifies a path to a CA public key file used to revoke certificates directly
Damien Millerf3747bf2013-01-18 11:44:04 +1100504by key ID or serial number.
505See the
506.Sx KEY REVOCATION LISTS
507section for details.
Darren Tucker019cefe2003-08-02 22:40:07 +1000508.It Fl T Ar output_file
509Test DH group exchange candidate primes (generated using the
510.Fl G
511option) for safety.
Damien Miller265d3092005-03-02 12:05:06 +1100512.It Fl t Ar type
513Specifies the type of key to create.
514The possible values are
515.Dq rsa1
516for protocol version 1 and
Damien Miller6186bbc2010-09-24 22:00:54 +1000517.Dq dsa ,
518.Dq ecdsa
Damien Miller265d3092005-03-02 12:05:06 +1100519or
Damien Miller6186bbc2010-09-24 22:00:54 +1000520.Dq rsa
Damien Miller265d3092005-03-02 12:05:06 +1100521for protocol version 2.
Damien Millerac5542b2013-01-20 22:33:02 +1100522.It Fl u
523Update a KRL.
524When specified with
525.Fl k ,
Damien Miller881a7a22013-01-20 22:34:46 +1100526keys listed via the command line are added to the existing KRL rather than
Damien Millerac5542b2013-01-20 22:33:02 +1100527a new KRL being created.
Damien Miller0a80ca12010-02-27 07:55:05 +1100528.It Fl V Ar validity_interval
529Specify a validity interval when signing a certificate.
530A validity interval may consist of a single time, indicating that the
531certificate is valid beginning now and expiring at that time, or may consist
532of two times separated by a colon to indicate an explicit time interval.
533The start time may be specified as a date in YYYYMMDD format, a time
534in YYYYMMDDHHMMSS format or a relative time (to the current time) consisting
535of a minus sign followed by a relative time in the format described in the
Damien Millerfecfd112013-07-18 16:11:50 +1000536TIME FORMATS section of
Damien Miller77497e12010-03-22 05:50:51 +1100537.Xr sshd_config 5 .
Damien Miller0a80ca12010-02-27 07:55:05 +1100538The end time may be specified as a YYYYMMDD date, a YYYYMMDDHHMMSS time or
539a relative time starting with a plus character.
540.Pp
541For example:
542.Dq +52w1d
543(valid from now to 52 weeks and one day from now),
544.Dq -4w:+4w
545(valid from four weeks ago to four weeks from now),
546.Dq 20100101123000:20110101123000
547(valid from 12:30 PM, January 1st, 2010 to 12:30 PM, January 1st, 2011),
548.Dq -1d:20110101
549(valid from yesterday to midnight, January 1st, 2011).
Darren Tucker06930c72003-12-31 11:34:51 +1100550.It Fl v
551Verbose mode.
552Causes
553.Nm
554to print debugging messages about its progress.
555This is helpful for debugging moduli generation.
556Multiple
557.Fl v
558options increase the verbosity.
559The maximum is 3.
Damien Miller265d3092005-03-02 12:05:06 +1100560.It Fl W Ar generator
561Specify desired generator when testing candidate moduli for DH-GEX.
562.It Fl y
563This option will read a private
564OpenSSH format file and print an OpenSSH public key to stdout.
Damien Miller4e270b02010-04-16 15:56:21 +1000565.It Fl z Ar serial_number
566Specifies a serial number to be embedded in the certificate to distinguish
567this certificate from others from the same CA.
568The default serial number is zero.
Damien Millerf3747bf2013-01-18 11:44:04 +1100569.Pp
570When generating a KRL, the
571.Fl z
572flag is used to specify a KRL version number.
Damien Miller32aa1441999-10-29 09:15:49 +1000573.El
Darren Tucker019cefe2003-08-02 22:40:07 +1000574.Sh MODULI GENERATION
575.Nm
576may be used to generate groups for the Diffie-Hellman Group Exchange
577(DH-GEX) protocol.
578Generating these groups is a two-step process: first, candidate
579primes are generated using a fast, but memory intensive process.
580These candidate primes are then tested for suitability (a CPU-intensive
581process).
582.Pp
583Generation of primes is performed using the
584.Fl G
585option.
586The desired length of the primes may be specified by the
587.Fl b
588option.
589For example:
590.Pp
Damien Miller265d3092005-03-02 12:05:06 +1100591.Dl # ssh-keygen -G moduli-2048.candidates -b 2048
Darren Tucker019cefe2003-08-02 22:40:07 +1000592.Pp
593By default, the search for primes begins at a random point in the
594desired length range.
595This may be overridden using the
596.Fl S
597option, which specifies a different start point (in hex).
598.Pp
Damien Millerdfceafe2012-07-06 13:44:19 +1000599Once a set of candidates have been generated, they must be screened for
Darren Tucker019cefe2003-08-02 22:40:07 +1000600suitability.
601This may be performed using the
602.Fl T
603option.
604In this mode
605.Nm
606will read candidates from standard input (or a file specified using the
607.Fl f
608option).
609For example:
610.Pp
Damien Miller265d3092005-03-02 12:05:06 +1100611.Dl # ssh-keygen -T moduli-2048 -f moduli-2048.candidates
Darren Tucker019cefe2003-08-02 22:40:07 +1000612.Pp
613By default, each candidate will be subjected to 100 primality tests.
614This may be overridden using the
615.Fl a
616option.
617The DH generator value will be chosen automatically for the
618prime under consideration.
619If a specific generator is desired, it may be requested using the
620.Fl W
621option.
Damien Miller265d3092005-03-02 12:05:06 +1100622Valid generator values are 2, 3, and 5.
Darren Tucker019cefe2003-08-02 22:40:07 +1000623.Pp
624Screened DH groups may be installed in
625.Pa /etc/moduli .
626It is important that this file contains moduli of a range of bit lengths and
627that both ends of a connection share common moduli.
Damien Miller0a80ca12010-02-27 07:55:05 +1100628.Sh CERTIFICATES
629.Nm
630supports signing of keys to produce certificates that may be used for
631user or host authentication.
632Certificates consist of a public key, some identity information, zero or
Damien Miller1f181422010-04-18 08:08:03 +1000633more principal (user or host) names and a set of options that
Damien Miller0a80ca12010-02-27 07:55:05 +1100634are signed by a Certification Authority (CA) key.
635Clients or servers may then trust only the CA key and verify its signature
636on a certificate rather than trusting many user/host keys.
637Note that OpenSSH certificates are a different, and much simpler, format to
638the X.509 certificates used in
639.Xr ssl 8 .
640.Pp
641.Nm
642supports two types of certificates: user and host.
643User certificates authenticate users to servers, whereas host certificates
Damien Miller15f5b562010-03-03 10:25:21 +1100644authenticate server hosts to users.
645To generate a user certificate:
Damien Miller0a80ca12010-02-27 07:55:05 +1100646.Pp
647.Dl $ ssh-keygen -s /path/to/ca_key -I key_id /path/to/user_key.pub
648.Pp
649The resultant certificate will be placed in
Damien Miller1b61a282010-03-22 05:55:06 +1100650.Pa /path/to/user_key-cert.pub .
Damien Miller0a80ca12010-02-27 07:55:05 +1100651A host certificate requires the
652.Fl h
653option:
654.Pp
655.Dl $ ssh-keygen -s /path/to/ca_key -I key_id -h /path/to/host_key.pub
656.Pp
657The host certificate will be output to
Damien Miller1b61a282010-03-22 05:55:06 +1100658.Pa /path/to/host_key-cert.pub .
Damien Miller757f34e2010-08-05 13:05:31 +1000659.Pp
660It is possible to sign using a CA key stored in a PKCS#11 token by
661providing the token library using
662.Fl D
663and identifying the CA key by providing its public half as an argument
664to
665.Fl s :
666.Pp
667.Dl $ ssh-keygen -s ca_key.pub -D libpkcs11.so -I key_id host_key.pub
668.Pp
669In all cases,
Damien Miller0a80ca12010-02-27 07:55:05 +1100670.Ar key_id
671is a "key identifier" that is logged by the server when the certificate
672is used for authentication.
673.Pp
674Certificates may be limited to be valid for a set of principal (user/host)
675names.
676By default, generated certificates are valid for all users or hosts.
677To generate a certificate for a specified set of principals:
678.Pp
679.Dl $ ssh-keygen -s ca_key -I key_id -n user1,user2 user_key.pub
Damien Miller5a5d94b2010-03-22 05:57:49 +1100680.Dl "$ ssh-keygen -s ca_key -I key_id -h -n host.domain user_key.pub"
Damien Miller0a80ca12010-02-27 07:55:05 +1100681.Pp
682Additional limitations on the validity and use of user certificates may
Damien Miller1f181422010-04-18 08:08:03 +1000683be specified through certificate options.
Damien Miller4e270b02010-04-16 15:56:21 +1000684A certificate option may disable features of the SSH session, may be
Damien Miller0a80ca12010-02-27 07:55:05 +1100685valid only when presented from particular source addresses or may
686force the use of a specific command.
Damien Miller4e270b02010-04-16 15:56:21 +1000687For a list of valid certificate options, see the documentation for the
Damien Miller0a80ca12010-02-27 07:55:05 +1100688.Fl O
689option above.
690.Pp
691Finally, certificates may be defined with a validity lifetime.
692The
693.Fl V
694option allows specification of certificate start and end times.
695A certificate that is presented at a time outside this range will not be
696considered valid.
Darren Tucker3ee50c52012-09-06 21:18:11 +1000697By default, certificates are valid from
698.Ux
699Epoch to the distant future.
Damien Miller0a80ca12010-02-27 07:55:05 +1100700.Pp
701For certificates to be used for user or host authentication, the CA
702public key must be trusted by
703.Xr sshd 8
704or
705.Xr ssh 1 .
706Please refer to those manual pages for details.
Damien Millerf3747bf2013-01-18 11:44:04 +1100707.Sh KEY REVOCATION LISTS
708.Nm
709is able to manage OpenSSH format Key Revocation Lists (KRLs).
710These binary files specify keys or certificates to be revoked using a
Damien Millerac5542b2013-01-20 22:33:02 +1100711compact format, taking as little a one bit per certificate if they are being
Damien Millerf3747bf2013-01-18 11:44:04 +1100712revoked by serial number.
713.Pp
714KRLs may be generated using the
715.Fl k
716flag.
Damien Miller881a7a22013-01-20 22:34:46 +1100717This option reads one or more files from the command line and generates a new
Damien Millerf3747bf2013-01-18 11:44:04 +1100718KRL.
719The files may either contain a KRL specification (see below) or public keys,
720listed one per line.
721Plain public keys are revoked by listing their hash or contents in the KRL and
722certificates revoked by serial number or key ID (if the serial is zero or
723not available).
724.Pp
725Revoking keys using a KRL specification offers explicit control over the
726types of record used to revoke keys and may be used to directly revoke
727certificates by serial number or key ID without having the complete original
728certificate on hand.
729A KRL specification consists of lines containing one of the following directives
730followed by a colon and some directive-specific information.
731.Bl -tag -width Ds
Damien Millera0a7ee82013-01-20 22:35:06 +1100732.It Cm serial : Ar serial_number Ns Op - Ns Ar serial_number
Damien Millerf3747bf2013-01-18 11:44:04 +1100733Revokes a certificate with the specified serial number.
Damien Millerac5542b2013-01-20 22:33:02 +1100734Serial numbers are 64-bit values, not including zero and may be expressed
Damien Millerf3747bf2013-01-18 11:44:04 +1100735in decimal, hex or octal.
736If two serial numbers are specified separated by a hyphen, then the range
737of serial numbers including and between each is revoked.
738The CA key must have been specified on the
739.Nm
Damien Miller881a7a22013-01-20 22:34:46 +1100740command line using the
Damien Millerf3747bf2013-01-18 11:44:04 +1100741.Fl s
742option.
743.It Cm id : Ar key_id
744Revokes a certificate with the specified key ID string.
745The CA key must have been specified on the
746.Nm
Damien Miller881a7a22013-01-20 22:34:46 +1100747command line using the
Damien Millerf3747bf2013-01-18 11:44:04 +1100748.Fl s
749option.
750.It Cm key : Ar public_key
751Revokes the specified key.
Damien Millerac5542b2013-01-20 22:33:02 +1100752If a certificate is listed, then it is revoked as a plain public key.
Damien Millerf3747bf2013-01-18 11:44:04 +1100753.It Cm sha1 : Ar public_key
754Revokes the specified key by its SHA1 hash.
755.El
756.Pp
757KRLs may be updated using the
758.Fl u
759flag in addition to
760.Fl k .
Damien Miller881a7a22013-01-20 22:34:46 +1100761When this option is specified, keys listed via the command line are merged into
Damien Millerf3747bf2013-01-18 11:44:04 +1100762the KRL, adding to those already there.
763.Pp
764It is also possible, given a KRL, to test whether it revokes a particular key
765(or keys).
766The
767.Fl Q
768flag will query an existing KRL, testing each key specified on the commandline.
Damien Miller881a7a22013-01-20 22:34:46 +1100769If any key listed on the command line has been revoked (or an error encountered)
Damien Millerf3747bf2013-01-18 11:44:04 +1100770then
771.Nm
772will exit with a non-zero exit status.
773A zero exit status will only be returned if no key was revoked.
Damien Miller32aa1441999-10-29 09:15:49 +1000774.Sh FILES
Damien Miller6186bbc2010-09-24 22:00:54 +1000775.Bl -tag -width Ds -compact
Damien Miller167ea5d2005-05-26 12:04:02 +1000776.It Pa ~/.ssh/identity
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000777Contains the protocol version 1 RSA authentication identity of the user.
Damien Miller450a7a12000-03-26 13:04:51 +1000778This file should not be readable by anyone but the user.
779It is possible to
Damien Miller32aa1441999-10-29 09:15:49 +1000780specify a passphrase when generating the key; that passphrase will be
Damien Miller6186bbc2010-09-24 22:00:54 +1000781used to encrypt the private part of this file using 3DES.
Damien Miller450a7a12000-03-26 13:04:51 +1000782This file is not automatically accessed by
Damien Miller32aa1441999-10-29 09:15:49 +1000783.Nm
784but it is offered as the default file for the private key.
Ben Lindstrombda98b02001-07-04 03:35:24 +0000785.Xr ssh 1
Damien Millere247cc42000-05-07 12:03:14 +1000786will read this file when a login attempt is made.
Damien Miller6186bbc2010-09-24 22:00:54 +1000787.Pp
Damien Miller167ea5d2005-05-26 12:04:02 +1000788.It Pa ~/.ssh/identity.pub
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000789Contains the protocol version 1 RSA public key for authentication.
Damien Miller450a7a12000-03-26 13:04:51 +1000790The contents of this file should be added to
Damien Miller167ea5d2005-05-26 12:04:02 +1000791.Pa ~/.ssh/authorized_keys
Damien Miller32aa1441999-10-29 09:15:49 +1000792on all machines
Ben Lindstrom594e2032001-09-12 18:35:30 +0000793where the user wishes to log in using RSA authentication.
Damien Miller450a7a12000-03-26 13:04:51 +1000794There is no need to keep the contents of this file secret.
Damien Miller6186bbc2010-09-24 22:00:54 +1000795.Pp
Damien Miller167ea5d2005-05-26 12:04:02 +1000796.It Pa ~/.ssh/id_dsa
Damien Miller6186bbc2010-09-24 22:00:54 +1000797.It Pa ~/.ssh/id_ecdsa
Damien Miller167ea5d2005-05-26 12:04:02 +1000798.It Pa ~/.ssh/id_rsa
Damien Miller6186bbc2010-09-24 22:00:54 +1000799Contains the protocol version 2 DSA, ECDSA or RSA authentication identity of the user.
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000800This file should not be readable by anyone but the user.
801It is possible to
802specify a passphrase when generating the key; that passphrase will be
Darren Tucker199ee6f2009-10-24 11:50:17 +1100803used to encrypt the private part of this file using 128-bit AES.
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000804This file is not automatically accessed by
805.Nm
806but it is offered as the default file for the private key.
Ben Lindstrombda98b02001-07-04 03:35:24 +0000807.Xr ssh 1
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000808will read this file when a login attempt is made.
Damien Miller6186bbc2010-09-24 22:00:54 +1000809.Pp
810.It Pa ~/.ssh/id_dsa.pub
811.It Pa ~/.ssh/id_ecdsa.pub
Damien Miller167ea5d2005-05-26 12:04:02 +1000812.It Pa ~/.ssh/id_rsa.pub
Damien Miller6186bbc2010-09-24 22:00:54 +1000813Contains the protocol version 2 DSA, ECDSA or RSA public key for authentication.
Damien Millere247cc42000-05-07 12:03:14 +1000814The contents of this file should be added to
Damien Miller167ea5d2005-05-26 12:04:02 +1000815.Pa ~/.ssh/authorized_keys
Damien Millere247cc42000-05-07 12:03:14 +1000816on all machines
Ben Lindstrom594e2032001-09-12 18:35:30 +0000817where the user wishes to log in using public key authentication.
Damien Millere247cc42000-05-07 12:03:14 +1000818There is no need to keep the contents of this file secret.
Damien Miller6186bbc2010-09-24 22:00:54 +1000819.Pp
Darren Tucker019cefe2003-08-02 22:40:07 +1000820.It Pa /etc/moduli
821Contains Diffie-Hellman groups used for DH-GEX.
822The file format is described in
823.Xr moduli 5 .
Damien Miller37023962000-07-11 17:31:38 +1000824.El
Damien Miller32aa1441999-10-29 09:15:49 +1000825.Sh SEE ALSO
826.Xr ssh 1 ,
827.Xr ssh-add 1 ,
Damien Miller2e8b1c81999-11-15 23:33:56 +1100828.Xr ssh-agent 1 ,
Darren Tucker019cefe2003-08-02 22:40:07 +1000829.Xr moduli 5 ,
Ben Lindstrom77788dc2001-02-10 23:10:33 +0000830.Xr sshd 8
Ben Lindstrom5a707822001-04-22 17:15:46 +0000831.Rs
Damien Millerc0367fb2007-01-05 16:25:46 +1100832.%R RFC 4716
833.%T "The Secure Shell (SSH) Public Key File Format"
834.%D 2006
Ben Lindstrom5a707822001-04-22 17:15:46 +0000835.Re
Damien Millerf1ce5052003-06-11 22:04:39 +1000836.Sh AUTHORS
837OpenSSH is a derivative of the original and free
838ssh 1.2.12 release by Tatu Ylonen.
839Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
840Theo de Raadt and Dug Song
841removed many bugs, re-added newer features and
842created OpenSSH.
843Markus Friedl contributed the support for SSH
844protocol versions 1.5 and 2.0.