blob: 52f4b6ea6265ec9103a79724b6a1bbef90080cb4 [file] [log] [blame]
Damien Millerf3747bf2013-01-18 11:44:04 +11001.\" $OpenBSD: ssh-keygen.1,v 1.111 2013/01/17 23:00:01 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 Millerf3747bf2013-01-18 11:44:04 +110038.Dd $Mdocdate: January 17 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
Darren Tucker019cefe2003-08-02 22:40:07 +1000106.Op Fl a Ar num_trials
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
129.Op Fl s ca_public
130.Op Fl z version_number
131.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
161given keys have been revoked by one. See the
162.Sx KEY REVOCATION LISTS
163section for details.
164.Pp
Damien Miller32aa1441999-10-29 09:15:49 +1000165Normally each user wishing to use SSH
Damien Millereb8b60e2010-08-31 22:41:14 +1000166with public key authentication runs this once to create the authentication
Damien Miller32aa1441999-10-29 09:15:49 +1000167key in
Damien Miller167ea5d2005-05-26 12:04:02 +1000168.Pa ~/.ssh/identity ,
Damien Millereb8b60e2010-08-31 22:41:14 +1000169.Pa ~/.ssh/id_ecdsa ,
Damien Miller167ea5d2005-05-26 12:04:02 +1000170.Pa ~/.ssh/id_dsa
Damien Millere247cc42000-05-07 12:03:14 +1000171or
Damien Miller167ea5d2005-05-26 12:04:02 +1000172.Pa ~/.ssh/id_rsa .
Damien Millere247cc42000-05-07 12:03:14 +1000173Additionally, the system administrator may use this to generate host keys,
174as seen in
175.Pa /etc/rc .
Damien Miller32aa1441999-10-29 09:15:49 +1000176.Pp
177Normally this program generates the key and asks for a file in which
Damien Miller450a7a12000-03-26 13:04:51 +1000178to store the private key.
179The public key is stored in a file with the same name but
Damien Miller32aa1441999-10-29 09:15:49 +1000180.Dq .pub
Damien Miller450a7a12000-03-26 13:04:51 +1000181appended.
182The program also asks for a passphrase.
183The passphrase may be empty to indicate no passphrase
Ben Lindstrombf555ba2001-01-18 02:04:35 +0000184(host keys must have an empty passphrase), or it may be a string of
Damien Miller450a7a12000-03-26 13:04:51 +1000185arbitrary length.
Ben Lindstrom4e366d52001-12-06 16:43:21 +0000186A passphrase is similar to a password, except it can be a phrase with a
187series of words, punctuation, numbers, whitespace, or any string of
188characters you want.
189Good passphrases are 10-30 characters long, are
Damien Miller32aa1441999-10-29 09:15:49 +1000190not simple sentences or otherwise easily guessable (English
Ben Lindstrom2a097a42001-06-09 01:13:40 +0000191prose has only 1-2 bits of entropy per character, and provides very bad
Ben Lindstrom4e366d52001-12-06 16:43:21 +0000192passphrases), and contain a mix of upper and lowercase letters,
193numbers, and non-alphanumeric characters.
Damien Miller450a7a12000-03-26 13:04:51 +1000194The passphrase can be changed later by using the
Damien Miller32aa1441999-10-29 09:15:49 +1000195.Fl p
196option.
197.Pp
Damien Miller450a7a12000-03-26 13:04:51 +1000198There is no way to recover a lost passphrase.
Damien Miller085c90f2011-05-05 14:15:33 +1000199If the passphrase is lost or forgotten, a new key must be generated
200and the corresponding public key copied to other machines.
Damien Miller32aa1441999-10-29 09:15:49 +1000201.Pp
Ben Lindstrom5a707822001-04-22 17:15:46 +0000202For RSA1 keys,
203there is also a comment field in the key file that is only for
Damien Miller450a7a12000-03-26 13:04:51 +1000204convenience to the user to help identify the key.
205The comment can tell what the key is for, or whatever is useful.
206The comment is initialized to
Damien Miller32aa1441999-10-29 09:15:49 +1000207.Dq user@host
208when the key is created, but can be changed using the
209.Fl c
210option.
211.Pp
Damien Millere247cc42000-05-07 12:03:14 +1000212After a key is generated, instructions below detail where the keys
213should be placed to be activated.
214.Pp
Damien Miller32aa1441999-10-29 09:15:49 +1000215The options are as follows:
216.Bl -tag -width Ds
Damien Miller58f1baf2011-05-05 14:06:15 +1000217.It Fl A
218For each of the key types (rsa1, rsa, dsa and ecdsa) for which host keys
219do not exist, generate the host keys with the default key file path,
220an empty passphrase, default bits for the key type, and default comment.
Damien Miller3ca1eb32011-05-05 14:13:50 +1000221This is used by
Damien Miller58f1baf2011-05-05 14:06:15 +1000222.Pa /etc/rc
223to generate new host keys.
Darren Tucker019cefe2003-08-02 22:40:07 +1000224.It Fl a Ar trials
225Specifies the number of primality tests to perform when screening DH-GEX
226candidates using the
227.Fl T
228command.
Damien Miller265d3092005-03-02 12:05:06 +1100229.It Fl B
230Show the bubblebabble digest of specified private or public key file.
Damien Miller32aa1441999-10-29 09:15:49 +1000231.It Fl b Ar bits
Damien Miller450a7a12000-03-26 13:04:51 +1000232Specifies the number of bits in the key to create.
Darren Tucker9f647332005-11-28 16:41:46 +1100233For RSA keys, the minimum size is 768 bits and the default is 2048 bits.
Damien Millerac7ef6a2005-06-16 13:19:06 +1000234Generally, 2048 bits is considered sufficient.
Darren Tucker9f647332005-11-28 16:41:46 +1100235DSA keys must be exactly 1024 bits as specified by FIPS 186-2.
Damien Millerad210322011-05-05 14:15:54 +1000236For ECDSA keys, the
237.Fl b
Damien Miller6232a162011-09-22 21:36:00 +1000238flag determines the key length by selecting from one of three elliptic
Damien Millerad210322011-05-05 14:15:54 +1000239curve sizes: 256, 384 or 521 bits.
240Attempting to use bit lengths other than these three values for ECDSA keys
241will fail.
Damien Miller265d3092005-03-02 12:05:06 +1100242.It Fl C Ar comment
243Provides a new comment.
Damien Miller32aa1441999-10-29 09:15:49 +1000244.It Fl c
245Requests changing the comment in the private and public key files.
Damien Millereb5fec62001-11-12 10:52:44 +1100246This operation is only supported for RSA1 keys.
Damien Miller32aa1441999-10-29 09:15:49 +1000247The program will prompt for the file containing the private keys, for
Ben Lindstromaafff9c2001-05-06 03:01:02 +0000248the passphrase if the key has one, and for the new comment.
Damien Miller7ea845e2010-02-12 09:21:02 +1100249.It Fl D Ar pkcs11
Damien Millera7618442010-02-12 09:26:02 +1100250Download the RSA public keys provided by the PKCS#11 shared library
251.Ar pkcs11 .
Damien Miller757f34e2010-08-05 13:05:31 +1000252When used in combination with
253.Fl s ,
254this option indicates that a CA key resides in a PKCS#11 token (see the
255.Sx CERTIFICATES
256section for details).
Ben Lindstrom5a707822001-04-22 17:15:46 +0000257.It Fl e
Ben Lindstrom46c264f2001-04-24 16:56:58 +0000258This option will read a private or public OpenSSH key file and
Damien Miller44b25042010-07-02 13:35:01 +1000259print to stdout the key in one of the formats specified by the
260.Fl m
261option.
262The default export format is
263.Dq RFC4716 .
Damien Millerea727282010-07-02 13:35:34 +1000264This option allows exporting OpenSSH keys for use by other programs, including
Damien Miller44b25042010-07-02 13:35:01 +1000265several commercial SSH implementations.
Damien Miller265d3092005-03-02 12:05:06 +1100266.It Fl F Ar hostname
267Search for the specified
268.Ar hostname
269in a
270.Pa known_hosts
271file, listing any occurrences found.
272This option is useful to find hashed host names or addresses and may also be
273used in conjunction with the
274.Fl H
275option to print found keys in a hashed format.
276.It Fl f Ar filename
277Specifies the filename of the key file.
278.It Fl G Ar output_file
279Generate candidate primes for DH-GEX.
280These primes must be screened for
281safety (using the
282.Fl T
283option) before use.
Damien Miller37876e92003-05-15 10:19:46 +1000284.It Fl g
Darren Tucker0b42e6d2004-08-13 21:22:40 +1000285Use generic DNS format when printing fingerprint resource records using the
Darren Tucker6e370372004-08-13 21:23:25 +1000286.Fl r
Darren Tucker0b42e6d2004-08-13 21:22:40 +1000287command.
Damien Miller265d3092005-03-02 12:05:06 +1100288.It Fl H
289Hash a
290.Pa known_hosts
Darren Tuckerda1adbc2005-03-14 23:15:58 +1100291file.
292This replaces all hostnames and addresses with hashed representations
293within the specified file; the original content is moved to a file with
294a .old suffix.
Damien Miller265d3092005-03-02 12:05:06 +1100295These hashes may be used normally by
296.Nm ssh
297and
298.Nm sshd ,
299but they do not reveal identifying information should the file's contents
300be disclosed.
301This option will not modify existing hashed hostnames and is therefore safe
302to use on files that mix hashed and non-hashed names.
Damien Miller0a80ca12010-02-27 07:55:05 +1100303.It Fl h
304When signing a key, create a host certificate instead of a user
305certificate.
306Please see the
307.Sx CERTIFICATES
308section for details.
Damien Miller15f5b562010-03-03 10:25:21 +1100309.It Fl I Ar certificate_identity
Damien Miller0a80ca12010-02-27 07:55:05 +1100310Specify the key identity when signing a public key.
311Please see the
312.Sx CERTIFICATES
313section for details.
Ben Lindstrom5a707822001-04-22 17:15:46 +0000314.It Fl i
315This option will read an unencrypted private (or public) key file
Damien Miller44b25042010-07-02 13:35:01 +1000316in the format specified by the
317.Fl m
318option and print an OpenSSH compatible private
Ben Lindstrom5a707822001-04-22 17:15:46 +0000319(or public) key to stdout.
Damien Millerdfceafe2012-07-06 13:44:19 +1000320.It Fl J Ar num_lines
321Exit after screening the specified number of lines
322while performing DH candidate screening using the
323.Fl T
324option.
325.It Fl j Ar start_line
326Start screening at the specified line number
327while performing DH candidate screening using the
328.Fl T
329option.
Damien Miller390d0562011-10-18 16:05:19 +1100330.It Fl K Ar checkpt
331Write the last line processed to the file
332.Ar checkpt
333while performing DH candidate screening using the
334.Fl T
335option.
336This will be used to skip lines in the input file that have already been
337processed if the job is restarted.
Damien Miller44b25042010-07-02 13:35:01 +1000338This option allows importing keys from other software, including several
339commercial SSH implementations.
340The default import format is
341.Dq RFC4716 .
Damien Millerf3747bf2013-01-18 11:44:04 +1100342.It Fl k
343Generate a KRL file.
344In this mode,
345.Nm
346will generate a KRL file at the location specified via the
347.Fl f
348flag that revokes every key or certificate presented on the command-line.
349Keys/certificates to be revoked may be specified by public key file or
350using the format described in the
351.Sx KEY REVOCATION LISTS
352section.
Damien Millerf2b70ca2010-03-05 07:39:35 +1100353.It Fl L
354Prints the contents of a certificate.
Damien Miller10f6f6b1999-11-17 17:29:08 +1100355.It Fl l
Darren Tucker35c45532008-06-13 04:43:15 +1000356Show fingerprint of specified public key file.
Damien Millereb5fec62001-11-12 10:52:44 +1100357Private RSA1 keys are also supported.
358For RSA and DSA keys
359.Nm
Darren Tuckerf09e8252008-06-13 05:18:03 +1000360tries to find the matching public key file and prints its fingerprint.
361If combined with
362.Fl v ,
363an ASCII art representation of the key is supplied with the fingerprint.
Damien Millerea727282010-07-02 13:35:34 +1000364.It Fl M Ar memory
365Specify the amount of memory to use (in megabytes) when generating
366candidate moduli for DH-GEX.
Damien Miller44b25042010-07-02 13:35:01 +1000367.It Fl m Ar key_format
368Specify a key format for the
369.Fl i
370(import) or
371.Fl e
Damien Millerea727282010-07-02 13:35:34 +1000372(export) conversion options.
Damien Miller44b25042010-07-02 13:35:01 +1000373The supported key formats are:
374.Dq RFC4716
Damien Millerea727282010-07-02 13:35:34 +1000375(RFC 4716/SSH2 public or private key),
Damien Miller44b25042010-07-02 13:35:01 +1000376.Dq PKCS8
377(PEM PKCS8 public key)
378or
379.Dq PEM
380(PEM public key).
381The default conversion format is
382.Dq RFC4716 .
Damien Miller265d3092005-03-02 12:05:06 +1100383.It Fl N Ar new_passphrase
384Provides the new passphrase.
Damien Miller0a80ca12010-02-27 07:55:05 +1100385.It Fl n Ar principals
386Specify one or more principals (user or host names) to be included in
387a certificate when signing a key.
388Multiple principals may be specified, separated by commas.
389Please see the
390.Sx CERTIFICATES
391section for details.
Damien Miller4e270b02010-04-16 15:56:21 +1000392.It Fl O Ar option
393Specify a certificate option when signing a key.
Damien Miller0a80ca12010-02-27 07:55:05 +1100394This option may be specified multiple times.
395Please see the
396.Sx CERTIFICATES
397section for details.
Damien Miller4e270b02010-04-16 15:56:21 +1000398The options that are valid for user certificates are:
Damien Miller0a80ca12010-02-27 07:55:05 +1100399.Bl -tag -width Ds
Damien Millerc59e2442010-03-22 05:50:31 +1100400.It Ic clear
401Clear all enabled permissions.
402This is useful for clearing the default set of permissions so permissions may
403be added individually.
404.It Ic force-command Ns = Ns Ar command
405Forces the execution of
406.Ar command
407instead of any shell or command specified by the user when
408the certificate is used for authentication.
Damien Miller0a80ca12010-02-27 07:55:05 +1100409.It Ic no-agent-forwarding
410Disable
411.Xr ssh-agent 1
Damien Miller15f5b562010-03-03 10:25:21 +1100412forwarding (permitted by default).
Damien Miller0a80ca12010-02-27 07:55:05 +1100413.It Ic no-port-forwarding
Damien Miller15f5b562010-03-03 10:25:21 +1100414Disable port forwarding (permitted by default).
Damien Miller0a80ca12010-02-27 07:55:05 +1100415.It Ic no-pty
Damien Miller15f5b562010-03-03 10:25:21 +1100416Disable PTY allocation (permitted by default).
Damien Miller0a80ca12010-02-27 07:55:05 +1100417.It Ic no-user-rc
418Disable execution of
419.Pa ~/.ssh/rc
420by
Damien Miller15f5b562010-03-03 10:25:21 +1100421.Xr sshd 8
422(permitted by default).
Damien Millerc59e2442010-03-22 05:50:31 +1100423.It Ic no-x11-forwarding
424Disable X11 forwarding (permitted by default).
Damien Miller081c9762010-03-08 11:30:00 +1100425.It Ic permit-agent-forwarding
426Allows
427.Xr ssh-agent 1
428forwarding.
Damien Miller0a80ca12010-02-27 07:55:05 +1100429.It Ic permit-port-forwarding
430Allows port forwarding.
431.It Ic permit-pty
432Allows PTY allocation.
433.It Ic permit-user-rc
434Allows execution of
435.Pa ~/.ssh/rc
436by
437.Xr sshd 8 .
Damien Millerc59e2442010-03-22 05:50:31 +1100438.It Ic permit-x11-forwarding
439Allows X11 forwarding.
440.It Ic source-address Ns = Ns Ar address_list
Damien Miller77497e12010-03-22 05:50:51 +1100441Restrict the source addresses from which the certificate is considered valid.
Damien Miller0a80ca12010-02-27 07:55:05 +1100442The
443.Ar address_list
444is a comma-separated list of one or more address/netmask pairs in CIDR
445format.
446.El
447.Pp
Damien Miller4e270b02010-04-16 15:56:21 +1000448At present, no options are valid for host keys.
Damien Miller265d3092005-03-02 12:05:06 +1100449.It Fl P Ar passphrase
450Provides the (old) passphrase.
Damien Miller32aa1441999-10-29 09:15:49 +1000451.It Fl p
452Requests changing the passphrase of a private key file instead of
Damien Miller450a7a12000-03-26 13:04:51 +1000453creating a new private key.
454The program will prompt for the file
Damien Miller32aa1441999-10-29 09:15:49 +1000455containing the private key, for the old passphrase, and twice for the
456new passphrase.
457.It Fl q
458Silence
459.Nm ssh-keygen .
Damien Miller4b42d7f2005-03-01 21:48:35 +1100460.It Fl R Ar hostname
461Removes all keys belonging to
462.Ar hostname
Damien Miller4c9c6fd2005-03-02 12:03:43 +1100463from a
Damien Miller4b42d7f2005-03-01 21:48:35 +1100464.Pa known_hosts
465file.
Damien Miller4c9c6fd2005-03-02 12:03:43 +1100466This option is useful to delete hashed hosts (see the
Damien Miller4b42d7f2005-03-01 21:48:35 +1100467.Fl H
468option above).
Damien Miller265d3092005-03-02 12:05:06 +1100469.It Fl r Ar hostname
470Print the SSHFP fingerprint resource record named
471.Ar hostname
472for the specified public key file.
Darren Tucker019cefe2003-08-02 22:40:07 +1000473.It Fl S Ar start
474Specify start point (in hex) when generating candidate moduli for DH-GEX.
Damien Miller0a80ca12010-02-27 07:55:05 +1100475.It Fl s Ar ca_key
476Certify (sign) a public key using the specified CA key.
477Please see the
478.Sx CERTIFICATES
479section for details.
Damien Millerf3747bf2013-01-18 11:44:04 +1100480.Pp
481When generating a KRL,
482.Fl s
483specifies a path to a CA public key file used to revoke certificated directly
484by key ID or serial number.
485See the
486.Sx KEY REVOCATION LISTS
487section for details.
Darren Tucker019cefe2003-08-02 22:40:07 +1000488.It Fl T Ar output_file
489Test DH group exchange candidate primes (generated using the
490.Fl G
491option) for safety.
Damien Miller265d3092005-03-02 12:05:06 +1100492.It Fl t Ar type
493Specifies the type of key to create.
494The possible values are
495.Dq rsa1
496for protocol version 1 and
Damien Miller6186bbc2010-09-24 22:00:54 +1000497.Dq dsa ,
498.Dq ecdsa
Damien Miller265d3092005-03-02 12:05:06 +1100499or
Damien Miller6186bbc2010-09-24 22:00:54 +1000500.Dq rsa
Damien Miller265d3092005-03-02 12:05:06 +1100501for protocol version 2.
Damien Miller0a80ca12010-02-27 07:55:05 +1100502.It Fl V Ar validity_interval
503Specify a validity interval when signing a certificate.
504A validity interval may consist of a single time, indicating that the
505certificate is valid beginning now and expiring at that time, or may consist
506of two times separated by a colon to indicate an explicit time interval.
507The start time may be specified as a date in YYYYMMDD format, a time
508in YYYYMMDDHHMMSS format or a relative time (to the current time) consisting
509of a minus sign followed by a relative time in the format described in the
510.Sx TIME FORMATS
511section of
Damien Miller77497e12010-03-22 05:50:51 +1100512.Xr sshd_config 5 .
Damien Miller0a80ca12010-02-27 07:55:05 +1100513The end time may be specified as a YYYYMMDD date, a YYYYMMDDHHMMSS time or
514a relative time starting with a plus character.
515.Pp
516For example:
517.Dq +52w1d
518(valid from now to 52 weeks and one day from now),
519.Dq -4w:+4w
520(valid from four weeks ago to four weeks from now),
521.Dq 20100101123000:20110101123000
522(valid from 12:30 PM, January 1st, 2010 to 12:30 PM, January 1st, 2011),
523.Dq -1d:20110101
524(valid from yesterday to midnight, January 1st, 2011).
Damien Millerf3747bf2013-01-18 11:44:04 +1100525.It Fl u
526Update a KRL.
527When specified with
528.Fl k ,
529keys listed via the command-line are added to the existing KRL rather than
530a new KRL being created.
Darren Tucker06930c72003-12-31 11:34:51 +1100531.It Fl v
532Verbose mode.
533Causes
534.Nm
535to print debugging messages about its progress.
536This is helpful for debugging moduli generation.
537Multiple
538.Fl v
539options increase the verbosity.
540The maximum is 3.
Damien Miller265d3092005-03-02 12:05:06 +1100541.It Fl W Ar generator
542Specify desired generator when testing candidate moduli for DH-GEX.
543.It Fl y
544This option will read a private
545OpenSSH format file and print an OpenSSH public key to stdout.
Damien Miller4e270b02010-04-16 15:56:21 +1000546.It Fl z Ar serial_number
547Specifies a serial number to be embedded in the certificate to distinguish
548this certificate from others from the same CA.
549The default serial number is zero.
Damien Millerf3747bf2013-01-18 11:44:04 +1100550.Pp
551When generating a KRL, the
552.Fl z
553flag is used to specify a KRL version number.
Damien Miller32aa1441999-10-29 09:15:49 +1000554.El
Darren Tucker019cefe2003-08-02 22:40:07 +1000555.Sh MODULI GENERATION
556.Nm
557may be used to generate groups for the Diffie-Hellman Group Exchange
558(DH-GEX) protocol.
559Generating these groups is a two-step process: first, candidate
560primes are generated using a fast, but memory intensive process.
561These candidate primes are then tested for suitability (a CPU-intensive
562process).
563.Pp
564Generation of primes is performed using the
565.Fl G
566option.
567The desired length of the primes may be specified by the
568.Fl b
569option.
570For example:
571.Pp
Damien Miller265d3092005-03-02 12:05:06 +1100572.Dl # ssh-keygen -G moduli-2048.candidates -b 2048
Darren Tucker019cefe2003-08-02 22:40:07 +1000573.Pp
574By default, the search for primes begins at a random point in the
575desired length range.
576This may be overridden using the
577.Fl S
578option, which specifies a different start point (in hex).
579.Pp
Damien Millerdfceafe2012-07-06 13:44:19 +1000580Once a set of candidates have been generated, they must be screened for
Darren Tucker019cefe2003-08-02 22:40:07 +1000581suitability.
582This may be performed using the
583.Fl T
584option.
585In this mode
586.Nm
587will read candidates from standard input (or a file specified using the
588.Fl f
589option).
590For example:
591.Pp
Damien Miller265d3092005-03-02 12:05:06 +1100592.Dl # ssh-keygen -T moduli-2048 -f moduli-2048.candidates
Darren Tucker019cefe2003-08-02 22:40:07 +1000593.Pp
594By default, each candidate will be subjected to 100 primality tests.
595This may be overridden using the
596.Fl a
597option.
598The DH generator value will be chosen automatically for the
599prime under consideration.
600If a specific generator is desired, it may be requested using the
601.Fl W
602option.
Damien Miller265d3092005-03-02 12:05:06 +1100603Valid generator values are 2, 3, and 5.
Darren Tucker019cefe2003-08-02 22:40:07 +1000604.Pp
605Screened DH groups may be installed in
606.Pa /etc/moduli .
607It is important that this file contains moduli of a range of bit lengths and
608that both ends of a connection share common moduli.
Damien Miller0a80ca12010-02-27 07:55:05 +1100609.Sh CERTIFICATES
610.Nm
611supports signing of keys to produce certificates that may be used for
612user or host authentication.
613Certificates consist of a public key, some identity information, zero or
Damien Miller1f181422010-04-18 08:08:03 +1000614more principal (user or host) names and a set of options that
Damien Miller0a80ca12010-02-27 07:55:05 +1100615are signed by a Certification Authority (CA) key.
616Clients or servers may then trust only the CA key and verify its signature
617on a certificate rather than trusting many user/host keys.
618Note that OpenSSH certificates are a different, and much simpler, format to
619the X.509 certificates used in
620.Xr ssl 8 .
621.Pp
622.Nm
623supports two types of certificates: user and host.
624User certificates authenticate users to servers, whereas host certificates
Damien Miller15f5b562010-03-03 10:25:21 +1100625authenticate server hosts to users.
626To generate a user certificate:
Damien Miller0a80ca12010-02-27 07:55:05 +1100627.Pp
628.Dl $ ssh-keygen -s /path/to/ca_key -I key_id /path/to/user_key.pub
629.Pp
630The resultant certificate will be placed in
Damien Miller1b61a282010-03-22 05:55:06 +1100631.Pa /path/to/user_key-cert.pub .
Damien Miller0a80ca12010-02-27 07:55:05 +1100632A host certificate requires the
633.Fl h
634option:
635.Pp
636.Dl $ ssh-keygen -s /path/to/ca_key -I key_id -h /path/to/host_key.pub
637.Pp
638The host certificate will be output to
Damien Miller1b61a282010-03-22 05:55:06 +1100639.Pa /path/to/host_key-cert.pub .
Damien Miller757f34e2010-08-05 13:05:31 +1000640.Pp
641It is possible to sign using a CA key stored in a PKCS#11 token by
642providing the token library using
643.Fl D
644and identifying the CA key by providing its public half as an argument
645to
646.Fl s :
647.Pp
648.Dl $ ssh-keygen -s ca_key.pub -D libpkcs11.so -I key_id host_key.pub
649.Pp
650In all cases,
Damien Miller0a80ca12010-02-27 07:55:05 +1100651.Ar key_id
652is a "key identifier" that is logged by the server when the certificate
653is used for authentication.
654.Pp
655Certificates may be limited to be valid for a set of principal (user/host)
656names.
657By default, generated certificates are valid for all users or hosts.
658To generate a certificate for a specified set of principals:
659.Pp
660.Dl $ ssh-keygen -s ca_key -I key_id -n user1,user2 user_key.pub
Damien Miller5a5d94b2010-03-22 05:57:49 +1100661.Dl "$ ssh-keygen -s ca_key -I key_id -h -n host.domain user_key.pub"
Damien Miller0a80ca12010-02-27 07:55:05 +1100662.Pp
663Additional limitations on the validity and use of user certificates may
Damien Miller1f181422010-04-18 08:08:03 +1000664be specified through certificate options.
Damien Miller4e270b02010-04-16 15:56:21 +1000665A certificate option may disable features of the SSH session, may be
Damien Miller0a80ca12010-02-27 07:55:05 +1100666valid only when presented from particular source addresses or may
667force the use of a specific command.
Damien Miller4e270b02010-04-16 15:56:21 +1000668For a list of valid certificate options, see the documentation for the
Damien Miller0a80ca12010-02-27 07:55:05 +1100669.Fl O
670option above.
671.Pp
672Finally, certificates may be defined with a validity lifetime.
673The
674.Fl V
675option allows specification of certificate start and end times.
676A certificate that is presented at a time outside this range will not be
677considered valid.
Darren Tucker3ee50c52012-09-06 21:18:11 +1000678By default, certificates are valid from
679.Ux
680Epoch to the distant future.
Damien Miller0a80ca12010-02-27 07:55:05 +1100681.Pp
682For certificates to be used for user or host authentication, the CA
683public key must be trusted by
684.Xr sshd 8
685or
686.Xr ssh 1 .
687Please refer to those manual pages for details.
Damien Millerf3747bf2013-01-18 11:44:04 +1100688.Sh KEY REVOCATION LISTS
689.Nm
690is able to manage OpenSSH format Key Revocation Lists (KRLs).
691These binary files specify keys or certificates to be revoked using a
692compact format; taking as little a one bit per certificate if they are being
693revoked by serial number.
694.Pp
695KRLs may be generated using the
696.Fl k
697flag.
698This option reads one or more files from the command-line and generates a new
699KRL.
700The files may either contain a KRL specification (see below) or public keys,
701listed one per line.
702Plain public keys are revoked by listing their hash or contents in the KRL and
703certificates revoked by serial number or key ID (if the serial is zero or
704not available).
705.Pp
706Revoking keys using a KRL specification offers explicit control over the
707types of record used to revoke keys and may be used to directly revoke
708certificates by serial number or key ID without having the complete original
709certificate on hand.
710A KRL specification consists of lines containing one of the following directives
711followed by a colon and some directive-specific information.
712.Bl -tag -width Ds
713.It Cm serial : Ar serial_number Op -serial_number
714Revokes a certificate with the specified serial number.
715Serial numbers are 64 bit values, not including zero and may be expressed
716in decimal, hex or octal.
717If two serial numbers are specified separated by a hyphen, then the range
718of serial numbers including and between each is revoked.
719The CA key must have been specified on the
720.Nm
721command-line using the
722.Fl s
723option.
724.It Cm id : Ar key_id
725Revokes a certificate with the specified key ID string.
726The CA key must have been specified on the
727.Nm
728command-line using the
729.Fl s
730option.
731.It Cm key : Ar public_key
732Revokes the specified key.
733In a certificate is listed, then it is revoked as a plain public key.
734.It Cm sha1 : Ar public_key
735Revokes the specified key by its SHA1 hash.
736.El
737.Pp
738KRLs may be updated using the
739.Fl u
740flag in addition to
741.Fl k .
742When this option is specified, keys listed via the command-line are merged into
743the KRL, adding to those already there.
744.Pp
745It is also possible, given a KRL, to test whether it revokes a particular key
746(or keys).
747The
748.Fl Q
749flag will query an existing KRL, testing each key specified on the commandline.
750If any key listed on the command-line has been revoked (or an error encountered)
751then
752.Nm
753will exit with a non-zero exit status.
754A zero exit status will only be returned if no key was revoked.
Damien Miller32aa1441999-10-29 09:15:49 +1000755.Sh FILES
Damien Miller6186bbc2010-09-24 22:00:54 +1000756.Bl -tag -width Ds -compact
Damien Miller167ea5d2005-05-26 12:04:02 +1000757.It Pa ~/.ssh/identity
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000758Contains the protocol version 1 RSA authentication identity of the user.
Damien Miller450a7a12000-03-26 13:04:51 +1000759This file should not be readable by anyone but the user.
760It is possible to
Damien Miller32aa1441999-10-29 09:15:49 +1000761specify a passphrase when generating the key; that passphrase will be
Damien Miller6186bbc2010-09-24 22:00:54 +1000762used to encrypt the private part of this file using 3DES.
Damien Miller450a7a12000-03-26 13:04:51 +1000763This file is not automatically accessed by
Damien Miller32aa1441999-10-29 09:15:49 +1000764.Nm
765but it is offered as the default file for the private key.
Ben Lindstrombda98b02001-07-04 03:35:24 +0000766.Xr ssh 1
Damien Millere247cc42000-05-07 12:03:14 +1000767will read this file when a login attempt is made.
Damien Miller6186bbc2010-09-24 22:00:54 +1000768.Pp
Damien Miller167ea5d2005-05-26 12:04:02 +1000769.It Pa ~/.ssh/identity.pub
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000770Contains the protocol version 1 RSA public key for authentication.
Damien Miller450a7a12000-03-26 13:04:51 +1000771The contents of this file should be added to
Damien Miller167ea5d2005-05-26 12:04:02 +1000772.Pa ~/.ssh/authorized_keys
Damien Miller32aa1441999-10-29 09:15:49 +1000773on all machines
Ben Lindstrom594e2032001-09-12 18:35:30 +0000774where the user wishes to log in using RSA authentication.
Damien Miller450a7a12000-03-26 13:04:51 +1000775There is no need to keep the contents of this file secret.
Damien Miller6186bbc2010-09-24 22:00:54 +1000776.Pp
Damien Miller167ea5d2005-05-26 12:04:02 +1000777.It Pa ~/.ssh/id_dsa
Damien Miller6186bbc2010-09-24 22:00:54 +1000778.It Pa ~/.ssh/id_ecdsa
Damien Miller167ea5d2005-05-26 12:04:02 +1000779.It Pa ~/.ssh/id_rsa
Damien Miller6186bbc2010-09-24 22:00:54 +1000780Contains the protocol version 2 DSA, ECDSA or RSA authentication identity of the user.
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000781This file should not be readable by anyone but the user.
782It is possible to
783specify a passphrase when generating the key; that passphrase will be
Darren Tucker199ee6f2009-10-24 11:50:17 +1100784used to encrypt the private part of this file using 128-bit AES.
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000785This file is not automatically accessed by
786.Nm
787but it is offered as the default file for the private key.
Ben Lindstrombda98b02001-07-04 03:35:24 +0000788.Xr ssh 1
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000789will read this file when a login attempt is made.
Damien Miller6186bbc2010-09-24 22:00:54 +1000790.Pp
791.It Pa ~/.ssh/id_dsa.pub
792.It Pa ~/.ssh/id_ecdsa.pub
Damien Miller167ea5d2005-05-26 12:04:02 +1000793.It Pa ~/.ssh/id_rsa.pub
Damien Miller6186bbc2010-09-24 22:00:54 +1000794Contains the protocol version 2 DSA, ECDSA or RSA public key for authentication.
Damien Millere247cc42000-05-07 12:03:14 +1000795The contents of this file should be added to
Damien Miller167ea5d2005-05-26 12:04:02 +1000796.Pa ~/.ssh/authorized_keys
Damien Millere247cc42000-05-07 12:03:14 +1000797on all machines
Ben Lindstrom594e2032001-09-12 18:35:30 +0000798where the user wishes to log in using public key authentication.
Damien Millere247cc42000-05-07 12:03:14 +1000799There is no need to keep the contents of this file secret.
Damien Miller6186bbc2010-09-24 22:00:54 +1000800.Pp
Darren Tucker019cefe2003-08-02 22:40:07 +1000801.It Pa /etc/moduli
802Contains Diffie-Hellman groups used for DH-GEX.
803The file format is described in
804.Xr moduli 5 .
Damien Miller37023962000-07-11 17:31:38 +1000805.El
Damien Miller32aa1441999-10-29 09:15:49 +1000806.Sh SEE ALSO
807.Xr ssh 1 ,
808.Xr ssh-add 1 ,
Damien Miller2e8b1c81999-11-15 23:33:56 +1100809.Xr ssh-agent 1 ,
Darren Tucker019cefe2003-08-02 22:40:07 +1000810.Xr moduli 5 ,
Ben Lindstrom77788dc2001-02-10 23:10:33 +0000811.Xr sshd 8
Ben Lindstrom5a707822001-04-22 17:15:46 +0000812.Rs
Damien Millerc0367fb2007-01-05 16:25:46 +1100813.%R RFC 4716
814.%T "The Secure Shell (SSH) Public Key File Format"
815.%D 2006
Ben Lindstrom5a707822001-04-22 17:15:46 +0000816.Re
Damien Millerf1ce5052003-06-11 22:04:39 +1000817.Sh AUTHORS
818OpenSSH is a derivative of the original and free
819ssh 1.2.12 release by Tatu Ylonen.
820Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
821Theo de Raadt and Dug Song
822removed many bugs, re-added newer features and
823created OpenSSH.
824Markus Friedl contributed the support for SSH
825protocol versions 1.5 and 2.0.