ssh-keygen.1

   1 .\"     $OpenBSD: ssh-keygen.1,v 1.76 2008/06/11 21:01:35 grunk 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 $Mdocdate$
  41 .Dt SSH-KEYGEN 1
  42 .Os
  43 .Sh NAME
  44 .Nm ssh-keygen
  45 .Nd authentication key generation, management and conversion
  46 .Sh SYNOPSIS
  47 .Nm ssh-keygen
  48 .Bk -words
  49 .Op Fl q
  50 .Op Fl b Ar bits
  51 .Fl t Ar type
  52 .Op Fl N Ar new_passphrase
  53 .Op Fl C Ar comment
  54 .Op Fl f Ar output_keyfile
  55 .Ek
  56 .Nm ssh-keygen
  57 .Fl p
  58 .Op Fl P Ar old_passphrase
  59 .Op Fl N Ar new_passphrase
  60 .Op Fl f Ar keyfile
  61 .Nm ssh-keygen
  62 .Fl i
  63 .Op Fl f Ar input_keyfile
  64 .Nm ssh-keygen
  65 .Fl e
  66 .Op Fl f Ar input_keyfile
  67 .Nm ssh-keygen
  68 .Fl y
  69 .Op Fl f Ar input_keyfile
  70 .Nm ssh-keygen
  71 .Fl c
  72 .Op Fl P Ar passphrase
  73 .Op Fl C Ar comment
  74 .Op Fl f Ar keyfile
  75 .Nm ssh-keygen
  76 .Fl l
  77 .Op Fl f Ar input_keyfile
  78 .Nm ssh-keygen
  79 .Fl B
  80 .Op Fl f Ar input_keyfile
  81 .Nm ssh-keygen
  82 .Fl D Ar reader
  83 .Nm ssh-keygen
  84 .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
  93 .Fl U Ar reader
  94 .Op Fl f Ar input_keyfile
  95 .Nm ssh-keygen
  96 .Fl r Ar hostname
  97 .Op Fl f Ar input_keyfile
  98 .Op Fl g
  99 .Nm ssh-keygen
 100 .Fl G Ar output_file
 101 .Op Fl v
 102 .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
 108 .Op Fl v
 109 .Op Fl a Ar num_trials
 110 .Op Fl W Ar generator
 111 .Sh DESCRIPTION
 112 .Nm
 113 generates, manages and converts authentication keys for
 114 .Xr ssh 1 .
 115 .Nm
 116 can create RSA keys for use by SSH protocol version 1 and RSA or DSA
 117 keys for use by SSH protocol version 2.
 118 The type of key to be generated is specified with the
 119 .Fl t
 120 option.
 121 If invoked without any arguments,
 122 .Nm
 123 will generate an RSA key for use in SSH protocol 2 connections.
 124 .Pp
 125 .Nm
 126 is also used to generate groups for use in Diffie-Hellman group
 127 exchange (DH-GEX).
 128 See the
 129 .Sx MODULI GENERATION
 130 section for details.
 131 .Pp
 132 Normally each user wishing to use SSH
 133 with RSA or DSA authentication runs this once to create the authentication
 134 key in
 135 .Pa ~/.ssh/identity ,
 136 .Pa ~/.ssh/id_dsa
 137 or
 138 .Pa ~/.ssh/id_rsa .
 139 Additionally, the system administrator may use this to generate host keys,
 140 as seen in
 141 .Pa /etc/rc .
 142 .Pp
 143 Normally this program generates the key and asks for a file in which
 144 to store the private key.
 145 The public key is stored in a file with the same name but
 146 .Dq .pub
 147 appended.
 148 The program also asks for a passphrase.
 149 The passphrase may be empty to indicate no passphrase
 150 (host keys must have an empty passphrase), or it may be a string of
 151 arbitrary length.
 152 A passphrase is similar to a password, except it can be a phrase with a
 153 series of words, punctuation, numbers, whitespace, or any string of
 154 characters you want.
 155 Good passphrases are 10-30 characters long, are
 156 not simple sentences or otherwise easily guessable (English
 157 prose has only 1-2 bits of entropy per character, and provides very bad
 158 passphrases), and contain a mix of upper and lowercase letters,
 159 numbers, and non-alphanumeric characters.
 160 The passphrase can be changed later by using the
 161 .Fl p
 162 option.
 163 .Pp
 164 There is no way to recover a lost passphrase.
 165 If the passphrase is
 166 lost or forgotten, a new key must be generated and copied to the
 167 corresponding public key to other machines.
 168 .Pp
 169 For RSA1 keys,
 170 there is also a comment field in the key file that is only for
 171 convenience to the user to help identify the key.
 172 The comment can tell what the key is for, or whatever is useful.
 173 The comment is initialized to
 174 .Dq user@host
 175 when the key is created, but can be changed using the
 176 .Fl c
 177 option.
 178 .Pp
 179 After a key is generated, instructions below detail where the keys
 180 should be placed to be activated.
 181 .Pp
 182 The options are as follows:
 183 .Bl -tag -width Ds
 184 .It Fl a Ar trials
 185 Specifies the number of primality tests to perform when screening DH-GEX
 186 candidates using the
 187 .Fl T
 188 command.
 189 .It Fl B
 190 Show the bubblebabble digest of specified private or public key file.
 191 .It Fl b Ar bits
 192 Specifies the number of bits in the key to create.
 193 For RSA keys, the minimum size is 768 bits and the default is 2048 bits.
 194 Generally, 2048 bits is considered sufficient.
 195 DSA keys must be exactly 1024 bits as specified by FIPS 186-2.
 196 .It Fl C Ar comment
 197 Provides a new comment.
 198 .It Fl c
 199 Requests changing the comment in the private and public key files.
 200 This operation is only supported for RSA1 keys.
 201 The program will prompt for the file containing the private keys, for
 202 the passphrase if the key has one, and for the new comment.
 203 .It Fl D Ar reader
 204 Download the RSA public key stored in the smartcard in
 205 .Ar reader .
 206 .It Fl e
 207 This option will read a private or public OpenSSH key file and
 208 print the key in
 209 RFC 4716 SSH Public Key File Format
 210 to stdout.
 211 This option allows exporting keys for use by several commercial
 212 SSH implementations.
 213 .It Fl F Ar hostname
 214 Search for the specified
 215 .Ar hostname
 216 in a
 217 .Pa known_hosts
 218 file, listing any occurrences found.
 219 This option is useful to find hashed host names or addresses and may also be
 220 used in conjunction with the
 221 .Fl H
 222 option to print found keys in a hashed format.
 223 .It Fl f Ar filename
 224 Specifies the filename of the key file.
 225 .It Fl G Ar output_file
 226 Generate candidate primes for DH-GEX.
 227 These primes must be screened for
 228 safety (using the
 229 .Fl T
 230 option) before use.
 231 .It Fl g
 232 Use generic DNS format when printing fingerprint resource records using the
 233 .Fl r
 234 command.
 235 .It Fl H
 236 Hash a
 237 .Pa known_hosts
 238 file.
 239 This replaces all hostnames and addresses with hashed representations
 240 within the specified file; the original content is moved to a file with
 241 a .old suffix.
 242 These hashes may be used normally by
 243 .Nm ssh
 244 and
 245 .Nm sshd ,
 246 but they do not reveal identifying information should the file's contents
 247 be disclosed.
 248 This option will not modify existing hashed hostnames and is therefore safe
 249 to use on files that mix hashed and non-hashed names.
 250 .It Fl i
 251 This option will read an unencrypted private (or public) key file
 252 in SSH2-compatible format and print an OpenSSH compatible private
 253 (or public) key to stdout.
 254 .Nm
 255 also reads the
 256 RFC 4716 SSH Public Key File Format.
 257 This option allows importing keys from several commercial
 258 SSH implementations.
 259 .It Fl l
 260 Show fingerprint and ASCII art representation of specified public key file.
 261 Private RSA1 keys are also supported.
 262 For RSA and DSA keys
 263 .Nm
 264 tries to find the matching public key file and prints its fingerprint
 265 and representation.
 266 .It Fl M Ar memory
 267 Specify the amount of memory to use (in megabytes) when generating
 268 candidate moduli for DH-GEX.
 269 .It Fl N Ar new_passphrase
 270 Provides the new passphrase.
 271 .It Fl P Ar passphrase
 272 Provides the (old) passphrase.
 273 .It Fl p
 274 Requests changing the passphrase of a private key file instead of
 275 creating a new private key.
 276 The program will prompt for the file
 277 containing the private key, for the old passphrase, and twice for the
 278 new passphrase.
 279 .It Fl q
 280 Silence
 281 .Nm ssh-keygen .
 282 Used by
 283 .Pa /etc/rc
 284 when creating a new key.
 285 .It Fl R Ar hostname
 286 Removes all keys belonging to
 287 .Ar hostname
 288 from a
 289 .Pa known_hosts
 290 file.
 291 This option is useful to delete hashed hosts (see the
 292 .Fl H
 293 option above).
 294 .It Fl r Ar hostname
 295 Print the SSHFP fingerprint resource record named
 296 .Ar hostname
 297 for the specified public key file.
 298 .It Fl S Ar start
 299 Specify start point (in hex) when generating candidate moduli for DH-GEX.
 300 .It Fl T Ar output_file
 301 Test DH group exchange candidate primes (generated using the
 302 .Fl G
 303 option) for safety.
 304 .It Fl t Ar type
 305 Specifies the type of key to create.
 306 The possible values are
 307 .Dq rsa1
 308 for protocol version 1 and
 309 .Dq rsa
 310 or
 311 .Dq dsa
 312 for protocol version 2.
 313 .It Fl U Ar reader
 314 Upload an existing RSA private key into the smartcard in
 315 .Ar reader .
 316 .It Fl v
 317 Verbose mode.
 318 Causes
 319 .Nm
 320 to print debugging messages about its progress.
 321 This is helpful for debugging moduli generation.
 322 Multiple
 323 .Fl v
 324 options increase the verbosity.
 325 The maximum is 3.
 326 .It Fl W Ar generator
 327 Specify desired generator when testing candidate moduli for DH-GEX.
 328 .It Fl y
 329 This option will read a private
 330 OpenSSH format file and print an OpenSSH public key to stdout.
 331 .El
 332 .Sh MODULI GENERATION
 333 .Nm
 334 may be used to generate groups for the Diffie-Hellman Group Exchange
 335 (DH-GEX) protocol.
 336 Generating these groups is a two-step process: first, candidate
 337 primes are generated using a fast, but memory intensive process.
 338 These candidate primes are then tested for suitability (a CPU-intensive
 339 process).
 340 .Pp
 341 Generation of primes is performed using the
 342 .Fl G
 343 option.
 344 The desired length of the primes may be specified by the
 345 .Fl b
 346 option.
 347 For example:
 348 .Pp
 349 .Dl # ssh-keygen -G moduli-2048.candidates -b 2048
 350 .Pp
 351 By default, the search for primes begins at a random point in the
 352 desired length range.
 353 This may be overridden using the
 354 .Fl S
 355 option, which specifies a different start point (in hex).
 356 .Pp
 357 Once a set of candidates have been generated, they must be tested for
 358 suitability.
 359 This may be performed using the
 360 .Fl T
 361 option.
 362 In this mode
 363 .Nm
 364 will read candidates from standard input (or a file specified using the
 365 .Fl f
 366 option).
 367 For example:
 368 .Pp
 369 .Dl # ssh-keygen -T moduli-2048 -f moduli-2048.candidates
 370 .Pp
 371 By default, each candidate will be subjected to 100 primality tests.
 372 This may be overridden using the
 373 .Fl a
 374 option.
 375 The DH generator value will be chosen automatically for the
 376 prime under consideration.
 377 If a specific generator is desired, it may be requested using the
 378 .Fl W
 379 option.
 380 Valid generator values are 2, 3, and 5.
 381 .Pp
 382 Screened DH groups may be installed in
 383 .Pa /etc/moduli .
 384 It is important that this file contains moduli of a range of bit lengths and
 385 that both ends of a connection share common moduli.
 386 .Sh FILES
 387 .Bl -tag -width Ds
 388 .It Pa ~/.ssh/identity
 389 Contains the protocol version 1 RSA authentication identity of the user.
 390 This file should not be readable by anyone but the user.
 391 It is possible to
 392 specify a passphrase when generating the key; that passphrase will be
 393 used to encrypt the private part of this file using 3DES.
 394 This file is not automatically accessed by
 395 .Nm
 396 but it is offered as the default file for the private key.
 397 .Xr ssh 1
 398 will read this file when a login attempt is made.
 399 .It Pa ~/.ssh/identity.pub
 400 Contains the protocol version 1 RSA public key for authentication.
 401 The contents of this file should be added to
 402 .Pa ~/.ssh/authorized_keys
 403 on all machines
 404 where the user wishes to log in using RSA authentication.
 405 There is no need to keep the contents of this file secret.
 406 .It Pa ~/.ssh/id_dsa
 407 Contains the protocol version 2 DSA authentication identity of the user.
 408 This file should not be readable by anyone but the user.
 409 It is possible to
 410 specify a passphrase when generating the key; that passphrase will be
 411 used to encrypt the private part of this file using 3DES.
 412 This file is not automatically accessed by
 413 .Nm
 414 but it is offered as the default file for the private key.
 415 .Xr ssh 1
 416 will read this file when a login attempt is made.
 417 .It Pa ~/.ssh/id_dsa.pub
 418 Contains the protocol version 2 DSA public key for authentication.
 419 The contents of this file should be added to
 420 .Pa ~/.ssh/authorized_keys
 421 on all machines
 422 where the user wishes to log in using public key authentication.
 423 There is no need to keep the contents of this file secret.
 424 .It Pa ~/.ssh/id_rsa
 425 Contains the protocol version 2 RSA authentication identity of the user.
 426 This file should not be readable by anyone but the user.
 427 It is possible to
 428 specify a passphrase when generating the key; that passphrase will be
 429 used to encrypt the private part of this file using 3DES.
 430 This file is not automatically accessed by
 431 .Nm
 432 but it is offered as the default file for the private key.
 433 .Xr ssh 1
 434 will read this file when a login attempt is made.
 435 .It Pa ~/.ssh/id_rsa.pub
 436 Contains the protocol version 2 RSA public key for authentication.
 437 The contents of this file should be added to
 438 .Pa ~/.ssh/authorized_keys
 439 on all machines
 440 where the user wishes to log in using public key authentication.
 441 There is no need to keep the contents of this file secret.
 442 .It Pa /etc/moduli
 443 Contains Diffie-Hellman groups used for DH-GEX.
 444 The file format is described in
 445 .Xr moduli 5 .
 446 .El
 447 .Sh SEE ALSO
 448 .Xr ssh 1 ,
 449 .Xr ssh-add 1 ,
 450 .Xr ssh-agent 1 ,
 451 .Xr moduli 5 ,
 452 .Xr sshd 8
 453 .Rs
 454 .%R RFC 4716
 455 .%T "The Secure Shell (SSH) Public Key File Format"
 456 .%D 2006
 457 .Re
 458 .Sh AUTHORS
 459 OpenSSH is a derivative of the original and free
 460 ssh 1.2.12 release by Tatu Ylonen.
 461 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
 462 Theo de Raadt and Dug Song
 463 removed many bugs, re-added newer features and
 464 created OpenSSH.
 465 Markus Friedl contributed the support for SSH
 466 protocol versions 1.5 and 2.0.