Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1 | .\" -*- nroff -*- |
| 2 | .\" |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 3 | .\" Author: Tatu Ylonen <ylo@cs.hut.fi> |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 4 | .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
| 5 | .\" All rights reserved |
| 6 | .\" |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 7 | .\" As far as I am concerned, the code I have written for this software |
| 8 | .\" can be used freely for any purpose. Any derived versions of this |
| 9 | .\" software must be clearly marked as such, and if the derived work is |
| 10 | .\" incompatible with the protocol description in the RFC file, it must be |
| 11 | .\" called by a name other than "ssh" or "Secure Shell". |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 12 | .\" |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 13 | .\" |
| 14 | .\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved. |
| 15 | .\" Copyright (c) 1999 Aaron Campbell. All rights reserved. |
| 16 | .\" Copyright (c) 1999 Theo de Raadt. All rights reserved. |
| 17 | .\" |
| 18 | .\" Redistribution and use in source and binary forms, with or without |
| 19 | .\" modification, are permitted provided that the following conditions |
| 20 | .\" are met: |
| 21 | .\" 1. Redistributions of source code must retain the above copyright |
| 22 | .\" notice, this list of conditions and the following disclaimer. |
| 23 | .\" 2. Redistributions in binary form must reproduce the above copyright |
| 24 | .\" notice, this list of conditions and the following disclaimer in the |
| 25 | .\" documentation and/or other materials provided with the distribution. |
| 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 Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 37 | .\" |
| 38 | .Dd September 25, 1999 |
| 39 | .Dt SSH-KEYGEN 1 |
| 40 | .Os |
| 41 | .Sh NAME |
| 42 | .Nm ssh-keygen |
| 43 | .Nd authentication key generation |
| 44 | .Sh SYNOPSIS |
| 45 | .Nm ssh-keygen |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame^] | 46 | .Op Fl q |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 47 | .Op Fl b Ar bits |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame^] | 48 | .Op Fl t Ar type |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 49 | .Op Fl N Ar new_passphrase |
| 50 | .Op Fl C Ar comment |
Damien Miller | 1a425f3 | 2000-09-02 10:08:09 +1100 | [diff] [blame] | 51 | .Op Fl f Ar output_keyfile |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 52 | .Nm ssh-keygen |
| 53 | .Fl p |
| 54 | .Op Fl P Ar old_passphrase |
| 55 | .Op Fl N Ar new_passphrase |
Damien Miller | 10f6f6b | 1999-11-17 17:29:08 +1100 | [diff] [blame] | 56 | .Op Fl f Ar keyfile |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 57 | .Nm ssh-keygen |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 58 | .Fl x |
Damien Miller | 1a425f3 | 2000-09-02 10:08:09 +1100 | [diff] [blame] | 59 | .Op Fl f Ar input_keyfile |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 60 | .Nm ssh-keygen |
| 61 | .Fl X |
Damien Miller | 1a425f3 | 2000-09-02 10:08:09 +1100 | [diff] [blame] | 62 | .Op Fl f Ar input_keyfile |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 63 | .Nm ssh-keygen |
| 64 | .Fl y |
Damien Miller | 1a425f3 | 2000-09-02 10:08:09 +1100 | [diff] [blame] | 65 | .Op Fl f Ar input_keyfile |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 66 | .Nm ssh-keygen |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 67 | .Fl c |
| 68 | .Op Fl P Ar passphrase |
| 69 | .Op Fl C Ar comment |
Damien Miller | 10f6f6b | 1999-11-17 17:29:08 +1100 | [diff] [blame] | 70 | .Op Fl f Ar keyfile |
| 71 | .Nm ssh-keygen |
| 72 | .Fl l |
Damien Miller | 1a425f3 | 2000-09-02 10:08:09 +1100 | [diff] [blame] | 73 | .Op Fl f Ar input_keyfile |
Damien Miller | eba71ba | 2000-04-29 23:57:08 +1000 | [diff] [blame] | 74 | .Nm ssh-keygen |
| 75 | .Fl R |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 76 | .Sh DESCRIPTION |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 77 | .Nm |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 78 | generates and manages authentication keys for |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 79 | .Xr ssh 1 . |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 80 | .Nm |
| 81 | defaults to generating an RSA key for use by protocols 1.3 and 1.5; |
| 82 | specifying the |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame^] | 83 | .Fl t |
| 84 | allows you to create a key for use by protocol 2.0. |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 85 | .Pp |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 86 | Normally each user wishing to use SSH |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 87 | with RSA or DSA authentication runs this once to create the authentication |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 88 | key in |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 89 | .Pa $HOME/.ssh/identity |
| 90 | or |
| 91 | .Pa $HOME/.ssh/id_dsa . |
| 92 | Additionally, the system administrator may use this to generate host keys, |
| 93 | as seen in |
| 94 | .Pa /etc/rc . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 95 | .Pp |
| 96 | Normally this program generates the key and asks for a file in which |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 97 | to store the private key. |
| 98 | The public key is stored in a file with the same name but |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 99 | .Dq .pub |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 100 | appended. |
| 101 | The program also asks for a passphrase. |
| 102 | The passphrase may be empty to indicate no passphrase |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 103 | (host keys must have empty passphrase), or it may be a string of |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 104 | arbitrary length. |
| 105 | Good passphrases are 10-30 characters long and are |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 106 | not simple sentences or otherwise easily guessable (English |
| 107 | prose has only 1-2 bits of entropy per word, and provides very bad |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 108 | passphrases). |
| 109 | The passphrase can be changed later by using the |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 110 | .Fl p |
| 111 | option. |
| 112 | .Pp |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 113 | There is no way to recover a lost passphrase. |
| 114 | If the passphrase is |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 115 | lost or forgotten, you will have to generate a new key and copy the |
| 116 | corresponding public key to other machines. |
| 117 | .Pp |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 118 | For RSA, there is also a comment field in the key file that is only for |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 119 | convenience to the user to help identify the key. |
| 120 | The comment can tell what the key is for, or whatever is useful. |
| 121 | The comment is initialized to |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 122 | .Dq user@host |
| 123 | when the key is created, but can be changed using the |
| 124 | .Fl c |
| 125 | option. |
| 126 | .Pp |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 127 | After a key is generated, instructions below detail where the keys |
| 128 | should be placed to be activated. |
| 129 | .Pp |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 130 | The options are as follows: |
| 131 | .Bl -tag -width Ds |
| 132 | .It Fl b Ar bits |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 133 | Specifies the number of bits in the key to create. |
| 134 | Minimum is 512 bits. |
| 135 | Generally 1024 bits is considered sufficient, and key sizes |
| 136 | above that no longer improve security but make things slower. |
| 137 | The default is 1024 bits. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 138 | .It Fl c |
| 139 | Requests changing the comment in the private and public key files. |
| 140 | The program will prompt for the file containing the private keys, for |
| 141 | passphrase if the key has one, and for the new comment. |
Damien Miller | 10f6f6b | 1999-11-17 17:29:08 +1100 | [diff] [blame] | 142 | .It Fl f |
| 143 | Specifies the filename of the key file. |
| 144 | .It Fl l |
| 145 | Show fingerprint of specified private or public key file. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 146 | .It Fl p |
| 147 | Requests changing the passphrase of a private key file instead of |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 148 | creating a new private key. |
| 149 | The program will prompt for the file |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 150 | containing the private key, for the old passphrase, and twice for the |
| 151 | new passphrase. |
| 152 | .It Fl q |
| 153 | Silence |
| 154 | .Nm ssh-keygen . |
| 155 | Used by |
| 156 | .Pa /etc/rc |
| 157 | when creating a new key. |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame^] | 158 | .It Fl t Ar type |
| 159 | Specifies the type of the key to create. |
| 160 | The possible values are |
| 161 | .Dq rsa1 |
| 162 | for protocol version 1 and |
| 163 | .Dq rsa |
| 164 | or |
| 165 | .Dq dsa |
| 166 | for protocol version 2. |
| 167 | The default is |
| 168 | .Dq rsa . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 169 | .It Fl C Ar comment |
| 170 | Provides the new comment. |
| 171 | .It Fl N Ar new_passphrase |
| 172 | Provides the new passphrase. |
| 173 | .It Fl P Ar passphrase |
| 174 | Provides the (old) passphrase. |
Damien Miller | eba71ba | 2000-04-29 23:57:08 +1000 | [diff] [blame] | 175 | .It Fl R |
| 176 | If RSA support is functional, immediately exits with code 0. If RSA |
| 177 | support is not functional, exits with code 1. This flag will be |
| 178 | removed once the RSA patent expires. |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 179 | .It Fl x |
| 180 | This option will read a private |
Damien Miller | 30c3d42 | 2000-05-09 11:02:59 +1000 | [diff] [blame] | 181 | OpenSSH DSA format file and print a SSH2-compatible public key to stdout. |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 182 | .It Fl X |
Damien Miller | 874d77b | 2000-10-14 16:23:11 +1100 | [diff] [blame] | 183 | This option will read a unencrypted |
| 184 | SSH2-compatible private (or public) key file and |
| 185 | print an OpenSSH compatible private (or public) key to stdout. |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 186 | .It Fl y |
| 187 | This option will read a private |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame^] | 188 | OpenSSH format file and print an OpenSSH public key to stdout. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 189 | .El |
| 190 | .Sh FILES |
| 191 | .Bl -tag -width Ds |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 192 | .It Pa $HOME/.ssh/identity |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 193 | Contains the RSA authentication identity of the user. |
| 194 | This file should not be readable by anyone but the user. |
| 195 | It is possible to |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 196 | specify a passphrase when generating the key; that passphrase will be |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 197 | used to encrypt the private part of this file using 3DES. |
| 198 | This file is not automatically accessed by |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 199 | .Nm |
| 200 | but it is offered as the default file for the private key. |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 201 | .Xr sshd 8 |
| 202 | will read this file when a login attempt is made. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 203 | .It Pa $HOME/.ssh/identity.pub |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 204 | Contains the public key for authentication. |
| 205 | The contents of this file should be added to |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 206 | .Pa $HOME/.ssh/authorized_keys |
| 207 | on all machines |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 208 | where you wish to log in using RSA authentication. |
| 209 | There is no need to keep the contents of this file secret. |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 210 | .It Pa $HOME/.ssh/id_dsa |
| 211 | Contains the DSA authentication identity of the user. |
| 212 | This file should not be readable by anyone but the user. |
| 213 | It is possible to |
| 214 | specify a passphrase when generating the key; that passphrase will be |
| 215 | used to encrypt the private part of this file using 3DES. |
| 216 | This file is not automatically accessed by |
| 217 | .Nm |
| 218 | but it is offered as the default file for the private key. |
| 219 | .Xr sshd 8 |
| 220 | will read this file when a login attempt is made. |
| 221 | .It Pa $HOME/.ssh/id_dsa.pub |
| 222 | Contains the public key for authentication. |
| 223 | The contents of this file should be added to |
| 224 | .Pa $HOME/.ssh/authorized_keys2 |
| 225 | on all machines |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame^] | 226 | where you wish to log in using public key authentication. |
Damien Miller | e247cc4 | 2000-05-07 12:03:14 +1000 | [diff] [blame] | 227 | There is no need to keep the contents of this file secret. |
Damien Miller | 3702396 | 2000-07-11 17:31:38 +1000 | [diff] [blame] | 228 | .El |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame^] | 229 | .Sh AUTHORS |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 230 | Tatu Ylonen <ylo@cs.hut.fi> |
| 231 | .Pp |
| 232 | OpenSSH |
| 233 | is a derivative of the original (free) ssh 1.2.12 release, but with bugs |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 234 | removed and newer features re-added. |
| 235 | Rapidly after the 1.2.12 release, |
| 236 | newer versions bore successively more restrictive licenses. |
| 237 | This version of OpenSSH |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 238 | .Bl -bullet |
| 239 | .It |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 240 | has all components of a restrictive nature (i.e., patents, see |
| 241 | .Xr crypto 3 ) |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 242 | directly removed from the source code; any licensed or patented components |
| 243 | are chosen from |
| 244 | external libraries. |
| 245 | .It |
| 246 | has been updated to support ssh protocol 1.5. |
| 247 | .It |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 248 | contains added support for |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 249 | .Xr kerberos 8 |
| 250 | authentication and ticket passing. |
| 251 | .It |
| 252 | supports one-time password authentication with |
| 253 | .Xr skey 1 . |
| 254 | .El |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 255 | .Sh SEE ALSO |
| 256 | .Xr ssh 1 , |
| 257 | .Xr ssh-add 1 , |
Damien Miller | 2e8b1c8 | 1999-11-15 23:33:56 +1100 | [diff] [blame] | 258 | .Xr ssh-agent 1 , |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 259 | .Xr sshd 8 , |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 260 | .Xr crypto 3 |