ssh-keygen.1

   1 .\"     $OpenBSD: ssh-keygen.1,v 1.30 2001/02/08 19:22:38 itojun Exp $
   2 .\"
   3 .\"  -*- nroff -*-
   4 .\"
   5 .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
   6 .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   7 .\"                    All rights reserved
   8 .\"
   9 .\" 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".
  14 .\"
  15 .\"
  16 .\" 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.
  19 .\"
  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.
  39 .\"
  40 .Dd September 25, 1999
  41 .Dt SSH-KEYGEN 1
  42 .Os
  43 .Sh NAME
  44 .Nm ssh-keygen
  45 .Nd authentication key generation
  46 .Sh SYNOPSIS
  47 .Nm ssh-keygen
  48 .Op Fl q
  49 .Op Fl b Ar bits
  50 .Op Fl t Ar type
  51 .Op Fl N Ar new_passphrase
  52 .Op Fl C Ar comment
  53 .Op Fl f Ar output_keyfile
  54 .Nm ssh-keygen
  55 .Fl p
  56 .Op Fl P Ar old_passphrase
  57 .Op Fl N Ar new_passphrase
  58 .Op Fl f Ar keyfile
  59 .Nm ssh-keygen
  60 .Fl x
  61 .Op Fl f Ar input_keyfile
  62 .Nm ssh-keygen
  63 .Fl X
  64 .Op Fl f Ar input_keyfile
  65 .Nm ssh-keygen
  66 .Fl y
  67 .Op Fl f Ar input_keyfile
  68 .Nm ssh-keygen
  69 .Fl c
  70 .Op Fl P Ar passphrase
  71 .Op Fl C Ar comment
  72 .Op Fl f Ar keyfile
  73 .Nm ssh-keygen
  74 .Fl l
  75 .Op Fl f Ar input_keyfile
  76 .Sh DESCRIPTION
  77 .Nm
  78 generates and manages authentication keys for
  79 .Xr ssh 1 .
  80 .Nm
  81 defaults to generating an RSA key for use by protocols 1.3 and 1.5;
  82 specifying the
  83 .Fl t
  84 option allows you to create a key for use by protocol 2.0.
  85 .Pp
  86 Normally each user wishing to use SSH
  87 with RSA or DSA authentication runs this once to create the authentication
  88 key in
  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 .
  95 .Pp
  96 Normally this program generates the key and asks for a file in which
  97 to store the private key.
  98 The public key is stored in a file with the same name but
  99 .Dq .pub
 100 appended.
 101 The program also asks for a passphrase.
 102 The passphrase may be empty to indicate no passphrase
 103 (host keys must have an empty passphrase), or it may be a string of
 104 arbitrary length.
 105 Good passphrases are 10-30 characters long and are
 106 not simple sentences or otherwise easily guessable (English
 107 prose has only 1-2 bits of entropy per word, and provides very bad
 108 passphrases).
 109 The passphrase can be changed later by using the
 110 .Fl p
 111 option.
 112 .Pp
 113 There is no way to recover a lost passphrase.
 114 If the passphrase is
 115 lost or forgotten, you will have to generate a new key and copy the
 116 corresponding public key to other machines.
 117 .Pp
 118 For RSA, there is also a comment field in the key file that is only for
 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
 122 .Dq user@host
 123 when the key is created, but can be changed using the
 124 .Fl c
 125 option.
 126 .Pp
 127 After a key is generated, instructions below detail where the keys
 128 should be placed to be activated.
 129 .Pp
 130 The options are as follows:
 131 .Bl -tag -width Ds
 132 .It Fl b Ar bits
 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.
 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.
 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.
 146 .It Fl p
 147 Requests changing the passphrase of a private key file instead of
 148 creating a new private key.
 149 The program will prompt for the file
 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.
 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 .
 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.
 175 .It Fl x
 176 This option will read a private
 177 OpenSSH DSA format file and print a SSH2-compatible public key to stdout.
 178 .It Fl X
 179 This option will read a unencrypted
 180 SSH2-compatible private (or public) key file and
 181 print an OpenSSH compatible private (or public) key to stdout.
 182 .It Fl y
 183 This option will read a private
 184 OpenSSH format file and print an OpenSSH public key to stdout.
 185 .El
 186 .Sh FILES
 187 .Bl -tag -width Ds
 188 .It Pa $HOME/.ssh/identity
 189 Contains the RSA authentication identity of the user.
 190 This file should not be readable by anyone but the user.
 191 It is possible to
 192 specify a passphrase when generating the key; that passphrase will be
 193 used to encrypt the private part of this file using 3DES.
 194 This file is not automatically accessed by
 195 .Nm
 196 but it is offered as the default file for the private key.
 197 .Xr sshd 8
 198 will read this file when a login attempt is made.
 199 .It Pa $HOME/.ssh/identity.pub
 200 Contains the public key for authentication.
 201 The contents of this file should be added to
 202 .Pa $HOME/.ssh/authorized_keys
 203 on all machines
 204 where you wish to log in using RSA authentication.
 205 There is no need to keep the contents of this file secret.
 206 .It Pa $HOME/.ssh/id_dsa
 207 Contains the DSA authentication identity of the user.
 208 This file should not be readable by anyone but the user.
 209 It is possible to
 210 specify a passphrase when generating the key; that passphrase will be
 211 used to encrypt the private part of this file using 3DES.
 212 This file is not automatically accessed by
 213 .Nm
 214 but it is offered as the default file for the private key.
 215 .Xr sshd 8
 216 will read this file when a login attempt is made.
 217 .It Pa $HOME/.ssh/id_dsa.pub
 218 Contains the public key for authentication.
 219 The contents of this file should be added to
 220 .Pa $HOME/.ssh/authorized_keys2
 221 on all machines
 222 where you wish to log in using public key authentication.
 223 There is no need to keep the contents of this file secret.
 224 .El
 225 .Sh AUTHORS
 226 OpenSSH is a derivative of the original and free
 227 ssh 1.2.12 release by Tatu Ylonen.
 228 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
 229 Theo de Raadt and Dug Song
 230 removed many bugs, re-added newer features and
 231 created OpenSSH.
 232 Markus Friedl contributed the support for SSH
 233 protocol versions 1.5 and 2.0.
 234 .Sh SEE ALSO
 235 .Xr ssh 1 ,
 236 .Xr ssh-add 1 ,
 237 .Xr ssh-agent 1 ,
 238 .Xr sshd 8