blob: 5454d00ce883b2f2b8aeda6839025efe4b7cc092 [file] [log] [blame]
Damien Millerac7ef6a2005-06-16 13:19:06 +10001.\" $OpenBSD: ssh-keygen.1,v 1.69 2005/06/08 03:50:00 djm Exp $
Ben Lindstrom36579d32001-01-29 07:39:26 +00002.\"
Damien Miller32aa1441999-10-29 09:15:49 +10003.\" -*- nroff -*-
4.\"
Damien Miller32aa1441999-10-29 09:15:49 +10005.\" Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller32aa1441999-10-29 09:15:49 +10006.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
7.\" All rights reserved
8.\"
Damien Millere4340be2000-09-16 13:29:08 +11009.\" As far as I am concerned, the code I have written for this software
10.\" can be used freely for any purpose. Any derived versions of this
11.\" software must be clearly marked as such, and if the derived work is
12.\" incompatible with the protocol description in the RFC file, it must be
13.\" called by a name other than "ssh" or "Secure Shell".
Damien Miller32aa1441999-10-29 09:15:49 +100014.\"
Damien Millere4340be2000-09-16 13:29:08 +110015.\"
Ben Lindstrom92a2e382001-03-05 06:59:27 +000016.\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved.
17.\" Copyright (c) 1999 Aaron Campbell. All rights reserved.
18.\" Copyright (c) 1999 Theo de Raadt. All rights reserved.
Damien Millere4340be2000-09-16 13:29:08 +110019.\"
20.\" Redistribution and use in source and binary forms, with or without
21.\" modification, are permitted provided that the following conditions
22.\" are met:
23.\" 1. Redistributions of source code must retain the above copyright
24.\" notice, this list of conditions and the following disclaimer.
25.\" 2. Redistributions in binary form must reproduce the above copyright
26.\" notice, this list of conditions and the following disclaimer in the
27.\" documentation and/or other materials provided with the distribution.
28.\"
29.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
30.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
31.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
32.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
33.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
34.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
38.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Damien Miller32aa1441999-10-29 09:15:49 +100039.\"
40.Dd September 25, 1999
41.Dt SSH-KEYGEN 1
42.Os
43.Sh NAME
44.Nm ssh-keygen
Ben Lindstrom5a707822001-04-22 17:15:46 +000045.Nd authentication key generation, management and conversion
Damien Miller32aa1441999-10-29 09:15:49 +100046.Sh SYNOPSIS
47.Nm ssh-keygen
Damien Miller495dca32003-04-01 21:42:14 +100048.Bk -words
Damien Miller0bc1bd82000-11-13 22:57:25 +110049.Op Fl q
Damien Miller32aa1441999-10-29 09:15:49 +100050.Op Fl b Ar bits
Damien Miller55fafa02002-02-19 15:22:07 +110051.Fl t Ar type
Damien Miller32aa1441999-10-29 09:15:49 +100052.Op Fl N Ar new_passphrase
53.Op Fl C Ar comment
Damien Miller1a425f32000-09-02 10:08:09 +110054.Op Fl f Ar output_keyfile
Damien Miller495dca32003-04-01 21:42:14 +100055.Ek
Damien Miller32aa1441999-10-29 09:15:49 +100056.Nm ssh-keygen
57.Fl p
58.Op Fl P Ar old_passphrase
59.Op Fl N Ar new_passphrase
Damien Miller10f6f6b1999-11-17 17:29:08 +110060.Op Fl f Ar keyfile
Damien Miller32aa1441999-10-29 09:15:49 +100061.Nm ssh-keygen
Ben Lindstrom5a707822001-04-22 17:15:46 +000062.Fl i
Damien Miller1a425f32000-09-02 10:08:09 +110063.Op Fl f Ar input_keyfile
Damien Millere247cc42000-05-07 12:03:14 +100064.Nm ssh-keygen
Ben Lindstrom5a707822001-04-22 17:15:46 +000065.Fl e
Damien Miller1a425f32000-09-02 10:08:09 +110066.Op Fl f Ar input_keyfile
Damien Millere247cc42000-05-07 12:03:14 +100067.Nm ssh-keygen
68.Fl y
Damien Miller1a425f32000-09-02 10:08:09 +110069.Op Fl f Ar input_keyfile
Damien Millere247cc42000-05-07 12:03:14 +100070.Nm ssh-keygen
Damien Miller32aa1441999-10-29 09:15:49 +100071.Fl c
72.Op Fl P Ar passphrase
73.Op Fl C Ar comment
Damien Miller10f6f6b1999-11-17 17:29:08 +110074.Op Fl f Ar keyfile
75.Nm ssh-keygen
76.Fl l
Ben Lindstrom8fd372b2001-03-12 03:02:17 +000077.Op Fl f Ar input_keyfile
78.Nm ssh-keygen
79.Fl B
Damien Miller1a425f32000-09-02 10:08:09 +110080.Op Fl f Ar input_keyfile
Ben Lindstroma1ec4a92001-08-06 21:51:34 +000081.Nm ssh-keygen
82.Fl D Ar reader
83.Nm ssh-keygen
Damien Miller4b42d7f2005-03-01 21:48:35 +110084.Fl F Ar hostname
85.Op Fl f Ar known_hosts_file
86.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
Ben Lindstroma1ec4a92001-08-06 21:51:34 +000093.Fl U Ar reader
94.Op Fl f Ar input_keyfile
Damien Miller37876e92003-05-15 10:19:46 +100095.Nm ssh-keygen
96.Fl r Ar hostname
97.Op Fl f Ar input_keyfile
98.Op Fl g
Darren Tucker019cefe2003-08-02 22:40:07 +100099.Nm ssh-keygen
100.Fl G Ar output_file
Darren Tucker06930c72003-12-31 11:34:51 +1100101.Op Fl v
Darren Tucker019cefe2003-08-02 22:40:07 +1000102.Op Fl b Ar bits
103.Op Fl M Ar memory
104.Op Fl S Ar start_point
105.Nm ssh-keygen
106.Fl T Ar output_file
107.Fl f Ar input_file
Darren Tucker06930c72003-12-31 11:34:51 +1100108.Op Fl v
Darren Tucker019cefe2003-08-02 22:40:07 +1000109.Op Fl a Ar num_trials
110.Op Fl W Ar generator
Damien Miller22c77262000-04-13 12:26:34 +1000111.Sh DESCRIPTION
Damien Miller32aa1441999-10-29 09:15:49 +1000112.Nm
Ben Lindstrom5a707822001-04-22 17:15:46 +0000113generates, manages and converts authentication keys for
Damien Miller32aa1441999-10-29 09:15:49 +1000114.Xr ssh 1 .
Damien Millere247cc42000-05-07 12:03:14 +1000115.Nm
Ben Lindstromcb72e4f2002-06-21 00:41:51 +0000116can create RSA keys for use by SSH protocol version 1 and RSA or DSA
Damien Millerfbf486b2003-05-23 18:44:23 +1000117keys for use by SSH protocol version 2.
118The type of key to be generated is specified with the
Damien Miller0bc1bd82000-11-13 22:57:25 +1100119.Fl t
Damien Millera41c8b12002-01-22 23:05:08 +1100120option.
Damien Millere247cc42000-05-07 12:03:14 +1000121.Pp
Darren Tucker019cefe2003-08-02 22:40:07 +1000122.Nm
123is also used to generate groups for use in Diffie-Hellman group
124exchange (DH-GEX).
125See the
126.Sx MODULI GENERATION
127section for details.
128.Pp
Damien Miller32aa1441999-10-29 09:15:49 +1000129Normally each user wishing to use SSH
Damien Millere247cc42000-05-07 12:03:14 +1000130with RSA or DSA authentication runs this once to create the authentication
Damien Miller32aa1441999-10-29 09:15:49 +1000131key in
Damien Miller167ea5d2005-05-26 12:04:02 +1000132.Pa ~/.ssh/identity ,
133.Pa ~/.ssh/id_dsa
Damien Millere247cc42000-05-07 12:03:14 +1000134or
Damien Miller167ea5d2005-05-26 12:04:02 +1000135.Pa ~/.ssh/id_rsa .
Damien Millere247cc42000-05-07 12:03:14 +1000136Additionally, the system administrator may use this to generate host keys,
137as seen in
138.Pa /etc/rc .
Damien Miller32aa1441999-10-29 09:15:49 +1000139.Pp
140Normally this program generates the key and asks for a file in which
Damien Miller450a7a12000-03-26 13:04:51 +1000141to store the private key.
142The public key is stored in a file with the same name but
Damien Miller32aa1441999-10-29 09:15:49 +1000143.Dq .pub
Damien Miller450a7a12000-03-26 13:04:51 +1000144appended.
145The program also asks for a passphrase.
146The passphrase may be empty to indicate no passphrase
Ben Lindstrombf555ba2001-01-18 02:04:35 +0000147(host keys must have an empty passphrase), or it may be a string of
Damien Miller450a7a12000-03-26 13:04:51 +1000148arbitrary length.
Ben Lindstrom4e366d52001-12-06 16:43:21 +0000149A passphrase is similar to a password, except it can be a phrase with a
150series of words, punctuation, numbers, whitespace, or any string of
151characters you want.
152Good passphrases are 10-30 characters long, are
Damien Miller32aa1441999-10-29 09:15:49 +1000153not simple sentences or otherwise easily guessable (English
Ben Lindstrom2a097a42001-06-09 01:13:40 +0000154prose has only 1-2 bits of entropy per character, and provides very bad
Ben Lindstrom4e366d52001-12-06 16:43:21 +0000155passphrases), and contain a mix of upper and lowercase letters,
156numbers, and non-alphanumeric characters.
Damien Miller450a7a12000-03-26 13:04:51 +1000157The passphrase can be changed later by using the
Damien Miller32aa1441999-10-29 09:15:49 +1000158.Fl p
159option.
160.Pp
Damien Miller450a7a12000-03-26 13:04:51 +1000161There is no way to recover a lost passphrase.
162If the passphrase is
Ben Lindstrom594e2032001-09-12 18:35:30 +0000163lost or forgotten, a new key must be generated and copied to the
Damien Miller32aa1441999-10-29 09:15:49 +1000164corresponding public key to other machines.
165.Pp
Ben Lindstrom5a707822001-04-22 17:15:46 +0000166For RSA1 keys,
167there is also a comment field in the key file that is only for
Damien Miller450a7a12000-03-26 13:04:51 +1000168convenience to the user to help identify the key.
169The comment can tell what the key is for, or whatever is useful.
170The comment is initialized to
Damien Miller32aa1441999-10-29 09:15:49 +1000171.Dq user@host
172when the key is created, but can be changed using the
173.Fl c
174option.
175.Pp
Damien Millere247cc42000-05-07 12:03:14 +1000176After a key is generated, instructions below detail where the keys
177should be placed to be activated.
178.Pp
Damien Miller32aa1441999-10-29 09:15:49 +1000179The options are as follows:
180.Bl -tag -width Ds
Darren Tucker019cefe2003-08-02 22:40:07 +1000181.It Fl a Ar trials
182Specifies the number of primality tests to perform when screening DH-GEX
183candidates using the
184.Fl T
185command.
Damien Miller265d3092005-03-02 12:05:06 +1100186.It Fl B
187Show the bubblebabble digest of specified private or public key file.
Damien Miller32aa1441999-10-29 09:15:49 +1000188.It Fl b Ar bits
Damien Miller450a7a12000-03-26 13:04:51 +1000189Specifies the number of bits in the key to create.
190Minimum is 512 bits.
Damien Millerac7ef6a2005-06-16 13:19:06 +1000191Generally, 2048 bits is considered sufficient.
192The default is 2048 bits.
Damien Miller265d3092005-03-02 12:05:06 +1100193.It Fl C Ar comment
194Provides a new comment.
Damien Miller32aa1441999-10-29 09:15:49 +1000195.It Fl c
196Requests changing the comment in the private and public key files.
Damien Millereb5fec62001-11-12 10:52:44 +1100197This operation is only supported for RSA1 keys.
Damien Miller32aa1441999-10-29 09:15:49 +1000198The program will prompt for the file containing the private keys, for
Ben Lindstromaafff9c2001-05-06 03:01:02 +0000199the passphrase if the key has one, and for the new comment.
Damien Miller265d3092005-03-02 12:05:06 +1100200.It Fl D Ar reader
201Download the RSA public key stored in the smartcard in
202.Ar reader .
Ben Lindstrom5a707822001-04-22 17:15:46 +0000203.It Fl e
Ben Lindstrom46c264f2001-04-24 16:56:58 +0000204This option will read a private or public OpenSSH key file and
205print the key in a
Ben Lindstrom5a707822001-04-22 17:15:46 +0000206.Sq SECSH Public Key File Format
207to stdout.
208This option allows exporting keys for use by several commercial
209SSH implementations.
Damien Miller265d3092005-03-02 12:05:06 +1100210.It Fl F Ar hostname
211Search for the specified
212.Ar hostname
213in a
214.Pa known_hosts
215file, listing any occurrences found.
216This option is useful to find hashed host names or addresses and may also be
217used in conjunction with the
218.Fl H
219option to print found keys in a hashed format.
220.It Fl f Ar filename
221Specifies the filename of the key file.
222.It Fl G Ar output_file
223Generate candidate primes for DH-GEX.
224These primes must be screened for
225safety (using the
226.Fl T
227option) before use.
Damien Miller37876e92003-05-15 10:19:46 +1000228.It Fl g
Darren Tucker0b42e6d2004-08-13 21:22:40 +1000229Use generic DNS format when printing fingerprint resource records using the
Darren Tucker6e370372004-08-13 21:23:25 +1000230.Fl r
Darren Tucker0b42e6d2004-08-13 21:22:40 +1000231command.
Damien Miller265d3092005-03-02 12:05:06 +1100232.It Fl H
233Hash a
234.Pa known_hosts
Darren Tuckerda1adbc2005-03-14 23:15:58 +1100235file.
236This replaces all hostnames and addresses with hashed representations
237within the specified file; the original content is moved to a file with
238a .old suffix.
Damien Miller265d3092005-03-02 12:05:06 +1100239These hashes may be used normally by
240.Nm ssh
241and
242.Nm sshd ,
243but they do not reveal identifying information should the file's contents
244be disclosed.
245This option will not modify existing hashed hostnames and is therefore safe
246to use on files that mix hashed and non-hashed names.
Ben Lindstrom5a707822001-04-22 17:15:46 +0000247.It Fl i
248This option will read an unencrypted private (or public) key file
249in SSH2-compatible format and print an OpenSSH compatible private
250(or public) key to stdout.
251.Nm
Ben Lindstrom2857d9c2001-04-22 17:19:46 +0000252also reads the
Ben Lindstrom5a707822001-04-22 17:15:46 +0000253.Sq SECSH Public Key File Format .
254This option allows importing keys from several commercial
255SSH implementations.
Damien Miller10f6f6b1999-11-17 17:29:08 +1100256.It Fl l
Damien Millereb5fec62001-11-12 10:52:44 +1100257Show fingerprint of specified public key file.
258Private RSA1 keys are also supported.
259For RSA and DSA keys
260.Nm
261tries to find the matching public key file and prints its fingerprint.
Damien Miller265d3092005-03-02 12:05:06 +1100262.It Fl M Ar memory
263Specify the amount of memory to use (in megabytes) when generating
264candidate moduli for DH-GEX.
265.It Fl N Ar new_passphrase
266Provides the new passphrase.
267.It Fl P Ar passphrase
268Provides the (old) passphrase.
Damien Miller32aa1441999-10-29 09:15:49 +1000269.It Fl p
270Requests changing the passphrase of a private key file instead of
Damien Miller450a7a12000-03-26 13:04:51 +1000271creating a new private key.
272The program will prompt for the file
Damien Miller32aa1441999-10-29 09:15:49 +1000273containing the private key, for the old passphrase, and twice for the
274new passphrase.
275.It Fl q
276Silence
277.Nm ssh-keygen .
278Used by
279.Pa /etc/rc
280when creating a new key.
Damien Miller4b42d7f2005-03-01 21:48:35 +1100281.It Fl R Ar hostname
282Removes all keys belonging to
283.Ar hostname
Damien Miller4c9c6fd2005-03-02 12:03:43 +1100284from a
Damien Miller4b42d7f2005-03-01 21:48:35 +1100285.Pa known_hosts
286file.
Damien Miller4c9c6fd2005-03-02 12:03:43 +1100287This option is useful to delete hashed hosts (see the
Damien Miller4b42d7f2005-03-01 21:48:35 +1100288.Fl H
289option above).
Damien Miller265d3092005-03-02 12:05:06 +1100290.It Fl r Ar hostname
291Print the SSHFP fingerprint resource record named
292.Ar hostname
293for the specified public key file.
Darren Tucker019cefe2003-08-02 22:40:07 +1000294.It Fl S Ar start
295Specify start point (in hex) when generating candidate moduli for DH-GEX.
296.It Fl T Ar output_file
297Test DH group exchange candidate primes (generated using the
298.Fl G
299option) for safety.
Damien Miller265d3092005-03-02 12:05:06 +1100300.It Fl t Ar type
301Specifies the type of key to create.
302The possible values are
303.Dq rsa1
304for protocol version 1 and
305.Dq rsa
306or
307.Dq dsa
308for protocol version 2.
Ben Lindstroma1ec4a92001-08-06 21:51:34 +0000309.It Fl U Ar reader
310Upload an existing RSA private key into the smartcard in
311.Ar reader .
Darren Tucker06930c72003-12-31 11:34:51 +1100312.It Fl v
313Verbose mode.
314Causes
315.Nm
316to print debugging messages about its progress.
317This is helpful for debugging moduli generation.
318Multiple
319.Fl v
320options increase the verbosity.
321The maximum is 3.
Damien Miller265d3092005-03-02 12:05:06 +1100322.It Fl W Ar generator
323Specify desired generator when testing candidate moduli for DH-GEX.
324.It Fl y
325This option will read a private
326OpenSSH format file and print an OpenSSH public key to stdout.
Damien Miller32aa1441999-10-29 09:15:49 +1000327.El
Darren Tucker019cefe2003-08-02 22:40:07 +1000328.Sh MODULI GENERATION
329.Nm
330may be used to generate groups for the Diffie-Hellman Group Exchange
331(DH-GEX) protocol.
332Generating these groups is a two-step process: first, candidate
333primes are generated using a fast, but memory intensive process.
334These candidate primes are then tested for suitability (a CPU-intensive
335process).
336.Pp
337Generation of primes is performed using the
338.Fl G
339option.
340The desired length of the primes may be specified by the
341.Fl b
342option.
343For example:
344.Pp
Damien Miller265d3092005-03-02 12:05:06 +1100345.Dl # ssh-keygen -G moduli-2048.candidates -b 2048
Darren Tucker019cefe2003-08-02 22:40:07 +1000346.Pp
347By default, the search for primes begins at a random point in the
348desired length range.
349This may be overridden using the
350.Fl S
351option, which specifies a different start point (in hex).
352.Pp
353Once a set of candidates have been generated, they must be tested for
354suitability.
355This may be performed using the
356.Fl T
357option.
358In this mode
359.Nm
360will read candidates from standard input (or a file specified using the
361.Fl f
362option).
363For example:
364.Pp
Damien Miller265d3092005-03-02 12:05:06 +1100365.Dl # ssh-keygen -T moduli-2048 -f moduli-2048.candidates
Darren Tucker019cefe2003-08-02 22:40:07 +1000366.Pp
367By default, each candidate will be subjected to 100 primality tests.
368This may be overridden using the
369.Fl a
370option.
371The DH generator value will be chosen automatically for the
372prime under consideration.
373If a specific generator is desired, it may be requested using the
374.Fl W
375option.
Damien Miller265d3092005-03-02 12:05:06 +1100376Valid generator values are 2, 3, and 5.
Darren Tucker019cefe2003-08-02 22:40:07 +1000377.Pp
378Screened DH groups may be installed in
379.Pa /etc/moduli .
380It is important that this file contains moduli of a range of bit lengths and
381that both ends of a connection share common moduli.
Damien Miller32aa1441999-10-29 09:15:49 +1000382.Sh FILES
383.Bl -tag -width Ds
Damien Miller167ea5d2005-05-26 12:04:02 +1000384.It Pa ~/.ssh/identity
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000385Contains the protocol version 1 RSA authentication identity of the user.
Damien Miller450a7a12000-03-26 13:04:51 +1000386This file should not be readable by anyone but the user.
387It is possible to
Damien Miller32aa1441999-10-29 09:15:49 +1000388specify a passphrase when generating the key; that passphrase will be
Damien Miller450a7a12000-03-26 13:04:51 +1000389used to encrypt the private part of this file using 3DES.
390This file is not automatically accessed by
Damien Miller32aa1441999-10-29 09:15:49 +1000391.Nm
392but it is offered as the default file for the private key.
Ben Lindstrombda98b02001-07-04 03:35:24 +0000393.Xr ssh 1
Damien Millere247cc42000-05-07 12:03:14 +1000394will read this file when a login attempt is made.
Damien Miller167ea5d2005-05-26 12:04:02 +1000395.It Pa ~/.ssh/identity.pub
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000396Contains the protocol version 1 RSA public key for authentication.
Damien Miller450a7a12000-03-26 13:04:51 +1000397The contents of this file should be added to
Damien Miller167ea5d2005-05-26 12:04:02 +1000398.Pa ~/.ssh/authorized_keys
Damien Miller32aa1441999-10-29 09:15:49 +1000399on all machines
Ben Lindstrom594e2032001-09-12 18:35:30 +0000400where the user wishes to log in using RSA authentication.
Damien Miller450a7a12000-03-26 13:04:51 +1000401There is no need to keep the contents of this file secret.
Damien Miller167ea5d2005-05-26 12:04:02 +1000402.It Pa ~/.ssh/id_dsa
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000403Contains the protocol version 2 DSA authentication identity of the user.
Damien Millere247cc42000-05-07 12:03:14 +1000404This file should not be readable by anyone but the user.
405It is possible to
406specify a passphrase when generating the key; that passphrase will be
407used to encrypt the private part of this file using 3DES.
408This file is not automatically accessed by
409.Nm
410but it is offered as the default file for the private key.
Ben Lindstrombda98b02001-07-04 03:35:24 +0000411.Xr ssh 1
Damien Millere247cc42000-05-07 12:03:14 +1000412will read this file when a login attempt is made.
Damien Miller167ea5d2005-05-26 12:04:02 +1000413.It Pa ~/.ssh/id_dsa.pub
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000414Contains the protocol version 2 DSA public key for authentication.
415The contents of this file should be added to
Damien Miller167ea5d2005-05-26 12:04:02 +1000416.Pa ~/.ssh/authorized_keys
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000417on all machines
Ben Lindstrom594e2032001-09-12 18:35:30 +0000418where the user wishes to log in using public key authentication.
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000419There is no need to keep the contents of this file secret.
Damien Miller167ea5d2005-05-26 12:04:02 +1000420.It Pa ~/.ssh/id_rsa
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000421Contains the protocol version 2 RSA authentication identity of the user.
422This file should not be readable by anyone but the user.
423It is possible to
424specify a passphrase when generating the key; that passphrase will be
425used to encrypt the private part of this file using 3DES.
426This file is not automatically accessed by
427.Nm
428but it is offered as the default file for the private key.
Ben Lindstrombda98b02001-07-04 03:35:24 +0000429.Xr ssh 1
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000430will read this file when a login attempt is made.
Damien Miller167ea5d2005-05-26 12:04:02 +1000431.It Pa ~/.ssh/id_rsa.pub
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000432Contains the protocol version 2 RSA public key for authentication.
Damien Millere247cc42000-05-07 12:03:14 +1000433The contents of this file should be added to
Damien Miller167ea5d2005-05-26 12:04:02 +1000434.Pa ~/.ssh/authorized_keys
Damien Millere247cc42000-05-07 12:03:14 +1000435on all machines
Ben Lindstrom594e2032001-09-12 18:35:30 +0000436where the user wishes to log in using public key authentication.
Damien Millere247cc42000-05-07 12:03:14 +1000437There is no need to keep the contents of this file secret.
Darren Tucker019cefe2003-08-02 22:40:07 +1000438.It Pa /etc/moduli
439Contains Diffie-Hellman groups used for DH-GEX.
440The file format is described in
441.Xr moduli 5 .
Damien Miller37023962000-07-11 17:31:38 +1000442.El
Damien Miller32aa1441999-10-29 09:15:49 +1000443.Sh SEE ALSO
444.Xr ssh 1 ,
445.Xr ssh-add 1 ,
Damien Miller2e8b1c81999-11-15 23:33:56 +1100446.Xr ssh-agent 1 ,
Darren Tucker019cefe2003-08-02 22:40:07 +1000447.Xr moduli 5 ,
Ben Lindstrom77788dc2001-02-10 23:10:33 +0000448.Xr sshd 8
Ben Lindstrom5a707822001-04-22 17:15:46 +0000449.Rs
Ben Lindstrom90fd0602001-06-25 04:45:33 +0000450.%A J. Galbraith
451.%A R. Thayer
Ben Lindstrom5a707822001-04-22 17:15:46 +0000452.%T "SECSH Public Key File Format"
453.%N draft-ietf-secsh-publickeyfile-01.txt
454.%D March 2001
455.%O work in progress material
456.Re
Damien Millerf1ce5052003-06-11 22:04:39 +1000457.Sh AUTHORS
458OpenSSH is a derivative of the original and free
459ssh 1.2.12 release by Tatu Ylonen.
460Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
461Theo de Raadt and Dug Song
462removed many bugs, re-added newer features and
463created OpenSSH.
464Markus Friedl contributed the support for SSH
465protocol versions 1.5 and 2.0.