contrib/putty/DOC/MAN-PG.BUT

   1 \cfg{man-identity}{puttygen}{1}{2004-03-24}{PuTTY tool suite}{PuTTY tool suite}\r
   2 \r
   3 \H{puttygen-manpage} Man page for PuTTYgen\r
   4 \r
   5 \S{puttygen-manpage-name} NAME\r
   6 \r
   7 \cw{puttygen} - public-key generator for the PuTTY tools\r
   8 \r
   9 \S{puttygen-manpage-synopsis} SYNOPSIS\r
  10 \r
  11 \c puttygen ( keyfile | -t keytype [ -b bits ] )\r
  12 \e bbbbbbbb   iiiiiii   bb iiiiiii   bb iiii\r
  13 \c          [ -C new-comment ] [ -P ] [ -q ]\r
  14 \e            bb iiiiiiiiiii     bb     bb\r
  15 \c          [ -O output-type | -l | -L | -p ]\r
  16 \e            bb iiiiiiiiiii   bb   bb   bb\r
  17 \c          [ -o output-file ]\r
  18 \e            bb iiiiiiiiiii\r
  19 \r
  20 \S{puttygen-manpage-description} DESCRIPTION\r
  21 \r
  22 \c{puttygen} is a tool to generate and manipulate SSH public and\r
  23 private key pairs. It is part of the PuTTY suite, although it can\r
  24 also interoperate with the private key formats used by some other\r
  25 SSH clients.\r
  26 \r
  27 When you run \c{puttygen}, it does three things. Firstly, it either\r
  28 loads an existing key file (if you specified \e{keyfile}), or\r
  29 generates a new key (if you specified \e{keytype}). Then, it\r
  30 optionally makes modifications to the key (changing the comment\r
  31 and/or the passphrase); finally, it outputs the key, or some\r
  32 information about the key, to a file.\r
  33 \r
  34 All three of these phases are controlled by the options described in\r
  35 the following section.\r
  36 \r
  37 \S{puttygen-manpage-options} OPTIONS\r
  38 \r
  39 In the first phase, \c{puttygen} either loads or generates a key.\r
  40 Note that generating a key requires random data (from\r
  41 \c{/dev/random}), which can cause \c{puttygen} to pause, possibly for\r
  42 some time if your system does not have much randomness available.\r
  43 \r
  44 The options to control this phase are:\r
  45 \r
  46 \dt \e{keyfile}\r
  47 \r
  48 \dd Specify a private key file to be loaded. This private key file can\r
  49 be in the (de facto standard) SSH-1 key format, or in PuTTY's SSH-2\r
  50 key format, or in either of the SSH-2 private key formats used by\r
  51 OpenSSH and ssh.com's implementation.\r
  52 \r
  53 \dt \cw{\-t} \e{keytype}\r
  54 \r
  55 \dd Specify a type of key to generate. The acceptable values here are\r
  56 \c{rsa} and \c{dsa} (to generate SSH-2 keys), and \c{rsa1} (to\r
  57 generate SSH-1 keys).\r
  58 \r
  59 \dt \cw{\-b} \e{bits}\r
  60 \r
  61 \dd Specify the size of the key to generate, in bits. Default is 1024.\r
  62 \r
  63 \dt \cw{\-q}\r
  64 \r
  65 \dd Suppress the progress display when generating a new key.\r
  66 \r
  67 In the second phase, \c{puttygen} optionally alters properties of\r
  68 the key it has loaded or generated. The options to control this are:\r
  69 \r
  70 \dt \cw{\-C} \e{new\-comment}\r
  71 \r
  72 \dd Specify a comment string to describe the key. This comment string\r
  73 will be used by PuTTY to identify the key to you (when asking you to\r
  74 enter the passphrase, for example, so that you know which passphrase\r
  75 to type).\r
  76 \r
  77 \dt \cw{\-P}\r
  78 \r
  79 \dd Indicate that you want to change the key's passphrase. This is\r
  80 automatic when you are generating a new key, but not when you are\r
  81 modifying an existing key.\r
  82 \r
  83 In the third phase, \c{puttygen} saves the key or information\r
  84 about it. The options to control this are:\r
  85 \r
  86 \dt \cw{\-O} \e{output\-type}\r
  87 \r
  88 \dd Specify the type of output you want \c{puttygen} to produce.\r
  89 Acceptable options are:\r
  90 \r
  91 \lcont{\r
  92 \r
  93 \dt \cw{private}\r
  94 \r
  95 \dd Save the private key in a format usable by PuTTY. This will either\r
  96 be the standard SSH-1 key format, or PuTTY's own SSH-2 key format.\r
  97 \r
  98 \dt \cw{public}\r
  99 \r
 100 \dd Save the public key only. For SSH-1 keys, the standard public key\r
 101 format will be used (\q{\cw{1024 37 5698745}...}). For SSH-2 keys, the\r
 102 public key will be output in the format specified by RFC 4716,\r
 103 which is a multi-line text file beginning with the line\r
 104 \q{\cw{---- BEGIN SSH2 PUBLIC KEY ----}}.\r
 105 \r
 106 \dt \cw{public-openssh}\r
 107 \r
 108 \dd Save the public key only, in a format usable by OpenSSH. For SSH-1\r
 109 keys, this output format behaves identically to \c{public}. For\r
 110 SSH-2 keys, the public key will be output in the OpenSSH format,\r
 111 which is a single line (\q{\cw{ssh-rsa AAAAB3NzaC1yc2}...}).\r
 112 \r
 113 \dt \cw{fingerprint}\r
 114 \r
 115 \dd Print the fingerprint of the public key. All fingerprinting\r
 116 algorithms are believed compatible with OpenSSH.\r
 117 \r
 118 \dt \cw{private-openssh}\r
 119 \r
 120 \dd Save an SSH-2 private key in OpenSSH's format. This option is not\r
 121 permitted for SSH-1 keys.\r
 122 \r
 123 \dt \cw{private-sshcom}\r
 124 \r
 125 \dd Save an SSH-2 private key in ssh.com's format. This option is not\r
 126 permitted for SSH-1 keys.\r
 127 \r
 128 If no output type is specified, the default is \c{private}.\r
 129 \r
 130 }\r
 131 \r
 132 \dt \cw{\-o} \e{output\-file}\r
 133 \r
 134 \dd Specify the file where \c{puttygen} should write its output. If\r
 135 this option is not specified, \c{puttygen} will assume you want to\r
 136 overwrite the original file if the input and output file types are\r
 137 the same (changing a comment or passphrase), and will assume you\r
 138 want to output to stdout if you are asking for a public key or\r
 139 fingerprint. Otherwise, the \c{\-o} option is required.\r
 140 \r
 141 \dt \cw{\-l}\r
 142 \r
 143 \dd Synonym for \q{\cw{-O fingerprint}}.\r
 144 \r
 145 \dt \cw{\-L}\r
 146 \r
 147 \dd Synonym for \q{\cw{-O public-openssh}}.\r
 148 \r
 149 \dt \cw{\-p}\r
 150 \r
 151 \dd Synonym for \q{\cw{-O public}}.\r
 152 \r
 153 The following options do not run PuTTYgen as normal, but print\r
 154 informational messages and then quit:\r
 155 \r
 156 \dt \cw{\-h}, \cw{\-\-help}\r
 157 \r
 158 \dd Display a message summarizing the available options.\r
 159 \r
 160 \dt \cw{\-V}, \cw{\-\-version}\r
 161 \r
 162 \dd Display the version of PuTTYgen.\r
 163 \r
 164 \dt \cw{\-\-pgpfp}\r
 165 \r
 166 \dd Display the fingerprints of the PuTTY PGP Master Keys, to aid\r
 167 in verifying new files released by the PuTTY team.\r
 168 \r
 169 \S{puttygen-manpage-examples} EXAMPLES\r
 170 \r
 171 To generate an SSH-2 RSA key pair and save it in PuTTY's own format\r
 172 (you will be prompted for the passphrase):\r
 173 \r
 174 \c puttygen -t rsa -C "my home key" -o mykey.ppk\r
 175 \r
 176 To generate a larger (2048-bit) key:\r
 177 \r
 178 \c puttygen -t rsa -b 2048 -C "my home key" -o mykey.ppk\r
 179 \r
 180 To change the passphrase on a key (you will be prompted for the old\r
 181 and new passphrases):\r
 182 \r
 183 \c puttygen -P mykey.ppk\r
 184 \r
 185 To change the comment on a key:\r
 186 \r
 187 \c puttygen -C "new comment" mykey.ppk\r
 188 \r
 189 To convert a key into OpenSSH's private key format:\r
 190 \r
 191 \c puttygen mykey.ppk -O private-openssh -o my-openssh-key\r
 192 \r
 193 To convert a key \e{from} another format (\c{puttygen} will\r
 194 automatically detect the input key type):\r
 195 \r
 196 \c puttygen my-ssh.com-key -o mykey.ppk\r
 197 \r
 198 To display the fingerprint of a key (some key types require a\r
 199 passphrase to extract even this much information):\r
 200 \r
 201 \c puttygen -l mykey.ppk\r
 202 \r
 203 To add the OpenSSH-format public half of a key to your authorised\r
 204 keys file:\r
 205 \r
 206 \c puttygen -L mykey.ppk >> $HOME/.ssh/authorized_keys\r
 207 \r
 208 \S{puttygen-manpage-bugs} BUGS\r
 209 \r
 210 There's currently no way to supply passphrases in batch mode, or\r
 211 even just to specify that you don't want a passphrase at all.\r