Using PuTTYgen

PuTTYgen is included in the WinSCP installation package. You can also download it separately from the WinSCP download page.

PuTTYgen originates from PuTTY and is also part of the PuTTY installation package. It does not matter if you use PuTTYgen from WinSCP or the PuTTY installation package, they are identical.

To start PuTTYgen, go to Tools > PuTTYgen on Login dialog.

When you run PuTTYgen you will see a window where you have two choices: Generate, to generate a new public/private key pair, or Load to load in an existing private key.

This is a general outline of the procedure for generating a new key pair. The following sections describe the process in more detail.

• First, you need to select which type of key you want to generate, and also select the strength of the key.
• Then press the Generate button, to actually generate the key.
• Once you have generated the key, select a comment field and a passphrase.
• Now you’re ready to save the private key to disk; press the Save private key button.

Your key pair is now ready for use. You may also want to copy the public key to your server, either by copying it out of the Public key for pasting into authorized_keys file box, or by using the Save public key button. However, you don’t need to do this immediately; if you want, you can load the private key back into PuTTYgen later and the public key will be available for copying and pasting again.

For more details refer to guide to setting up public key authentication.

-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEApXWw0kE36ZyNx8hzVG13ngH6jBTSE+8BibRW3fPdL2Pj+Fwq6Xrdh4PkRcZ5 iP3KGD3tIysghjgYox+p8yoRJk9d9m9RGYS2m4PMudDU9yxek3nRbJpuBEaY/Xbru0wFHDb9CCys b8ToUs7125hD2ZI6Wfs7C2j/AmCicqditXG0h7W8NoBCR0bLlQgQYZ420KZf+n5p7VSKjVNfISaB pXQNkmx2074AqqRbiiIir6GNVji8UF0gMGWsdlWTxOD7M7GK57PPkewpC+4AfvoYtVA3Xck68EbR IChdOv38qcO4oXs5FhzKgAhovNOTMUcwuTPi4or2hKw6WZ6FsMQRDQIDAQABAoIBAQCQKBDtrurS +5Y/iPKKjXFZVin/oChEO8lgO6IvcMe2AVbezRaKI4UdC5l3/WtoIo3QPyv7pxiIOBmnDfBZLr6Q XTflfKjxDcK3jcZx4nOaAqtH3CvNbmMKEKQ8uT67CYmuQm6Ej7+RBcLQWwaz017SEegK+6s+zrTX UnBWamXC5Kr4P+E87Jip2fPpQl36f13Fb7aEhaC092DuJCQRbESOXuHTgRAEO3w84SLb6savpkvw dn1mejyvqYJ3Fc/6PBwAdx9WGeubhpQPWZFt7Uu0O22W2KJ2SL0JZXXgYmEpWTIwJQvGngSZ8hsi fg/GZCs2CfHr0bgfhGfxVp5Q6QjBAoGBAO1bRirKooUrowRVHUDW263vTGD6TIdFjRJRg5vTJXy6 EdI4vR5SG6×1YLeEKhwKbBtRdflqmyhyzdt6F6U3xKVDIO+6KF4+Bg/T3JUcPPRVgYye1fx3ioIj cr5j0atVW3LdE9Pr0/NeUKViDeUsB17hk8+Be6KP3yXA3KtYlZ7dAoGBALJ0ujzR18AsMcCE4n9S B4UrO2RwBAXyRWtAcndOzzsPAvwXe6LIQCKOipMMfCQr35ybniCzP7WntoS0s/Cxr6tjFJKZnxKP KiL3YfO4bpyeJiF4feyofOE+z6L74ePfSOdqiEJYAxcqFKxPvfZqxcg/LbruTacL+4t2fN9Ks9/x AoGBAN5P2iWkS5pdp78cFV0woOuFsc03QsyESUB6FsGxf3AWOzDiMcgfcYoTGnZolKRU4rKnls74 mcDF3qgN7+2wkT+U41mFy9+RSk4yymzi2PikycUy1Aw2zwVbPFK03aITPacVCEg6nvdYRELS117p 4TFuKOp3RZyaEpCi1kyqmOEFAoGAGA1VgJcDzjnmpr0CTgi/TLqL8biLQkXqB0+TXfM4SQx36YQ8 vK7ivgWaNcGMBdAH/nKW+G9QWep11iMI0ZsRQzdCcZPU9cpn8niHMjMcbW1/VCmKR1haJH2zvJLY Wj8g81fPb6mvGPMqACNrRggUCi5Bup0dyDL8P0rD/9Bwt/ECgYEAxIz/w7i89BoG78nwt8pjRWIA ywKSa1YEzWiu8CvVwM5OQHKmQKVaYiNJEXLI1f/stBrOL0utOqwpLOQx3ZwCDMH8Yr2RLaFRnevQ pZYu3AaOb7wd9cgai2FC29kerSytPN+QZlgZ5rcVzcEh4m16lKJ7SBowDU8V2iTN1vt0t5o= -----END RSA PRIVATE KEY-----

The Number of bits input box allows you to choose the strength of the key PuTTYgen will generate.

For RSA, 2048 bits should currently be sufficient for most purposes.

For ECDSA, only 256, 384, and 521 bits are supported. (ECDSA offers equivalent security to RSA with smaller key sizes.)

For Ed25519, the only valid size is 256 bits.

Once you have chosen the type of key you want, and the strength of the key, press the Generate button and PuTTYgen will begin the process of actually generating the key.

First, a progress bar will appear and PuTTYgen will ask you to move the mouse around to generate randomness. Wave the mouse in circles over the blank area in the PuTTYgen window, and the progress bar will gradually fill up as PuTTYgen collects enough randomness. You don’t need to wave the mouse in particularly imaginative patterns (although it can’t hurt); PuTTYgen will collect enough randomness just from the fine detail of exactly how far the mouse has moved each time Windows samples its position.

When the progress bar reaches the end, PuTTYgen will begin creating the key. The progress bar will reset to the start, and gradually move up again to track the progress of the key generation. It will not move evenly, and may occasionally slow down to a stop; this is unfortunately unavoidable, because key generation is a random process and it is impossible to reliably predict how long it will take.

When the key generation is complete, a new set of controls will appear in the window to indicate this.

The Key fingerprint box shows you a fingerprint value for the generated key. This is derived cryptographically from the public key value, so it doesn’t need to be kept secret; it is supposed to be more manageable for human beings than the public key itself.

The fingerprint value is intended to be cryptographically secure, in the sense that it is computationally infeasible for someone to invent a second key with the same fingerprint, or to find a key with a particular fingerprint.

If you have more than one key and use them for different purposes, you don’t need to memorize the key fingerprints in order to tell them apart. PuTTYgen allows you to enter a comment for your key, which will be displayed whenever WinSCP or Pageant asks you for the passphrase.

The default comment format, if you don’t specify one, contains the key type and the date of generation, such as rsa-key-20011212. Another commonly used approach is to use your name and the name of the computer the key will be used on, such as simon@simons-pc.

To alter the key comment, just type your comment text into the Key comment box before saving the private key. If you want to change the comment later, you can load the private key back into PuTTYgen, change the comment, and save it again.

The Key passphrase and Confirm passphrase boxes allow you to choose a passphrase for your key. The passphrase will be used to encrypt the key on disk, so you will not be able to use the key without first entering the passphrase.

When you save the key, PuTTYgen will check that the Key passphrase and Confirm passphrase boxes both contain exactly the same passphrase, and will refuse to save the key otherwise.

If you leave the passphrase fields blank, the key will be saved unencrypted. You should not do this without good reason; if you do, your private key file on disk will be all an attacker needs to gain access to any machine configured to accept that key. If you want to be able to passwordless log in without having to type a passphrase every time, you should consider using Pageant so that your decrypted key is only held in memory rather than on disk.

Under special circumstances you may genuinely need to use a key with no passphrase; for example, if you need to run an automated batch script that needs to make an SSH connection, you can’t be there to type the passphrase. In this case we recommend you generate a special key for each specific batch script (or whatever) that needs one, and on the server side you should arrange that each key is restricted so that it can only be used for that specific purpose. The documentation for your SSH server should explain how to do this (it will probably vary between servers).

Choosing a good passphrase is difficult. Just as you shouldn’t use a dictionary word as a password because it’s easy for an attacker to run through a whole dictionary, you should not use a song lyric, quotation or other well-known sentence as a passphrase. If you want your passphrase to make grammatical sense, this cuts down the possibilities a lot and you should use a longer one as a result.

Do not forget your passphrase. There is no way to recover it.

Once you have generated a key, set a comment field and set a passphrase, you are ready to save your private key to disk.

Press the Save private key button. PuTTYgen will put up a dialog box asking you where to save the file. Select a directory, type in a file name, and press Save.

This file is in PuTTY’s native format (*.PPK); it is the one you will need to tell WinSCP to use for authentication.

RFC 4716 specifies a standard format for storing SSH-2 public keys on disk. Some SSH servers (such as ssh.com’s) require a public key in this format in order to accept authentication with the corresponding private key. (Others, such as OpenSSH, use a different format)

To save your public key in the SSH-2 standard format, press the Save public key button in PuTTYgen. PuTTYgen will put up a dialog box asking you where to save the file. Select a directory, type in a file name, and press Save.

You will then probably want to copy the public key file to your SSH server machine.

If you use this option with an SSH-1 key, the file PuTTYgen saves will contain exactly the same text that appears in the Public key for pasting box. This is the only existing standard for SSH-1 public keys.

All SSH-1 servers require your public key to be given to it in a one-line format before it will accept authentication with your private key. The OpenSSH server also requires this for SSH-2.

The Public key for pasting into authorized_keys file gives the public-key data in the correct one-line format.

For more details refer to guide to setting up public key authentication.

PuTTYgen allows you to load an existing private key file into memory. If you do this, you can then change the passphrase and comment before saving it again; you can also make extra copies of the public key.

To load an existing key, press the Load button. PuTTYgen will display a dialog box where you can browse around the file system and find your key file. Once you select the file, PuTTYgen will ask you for a passphrase (if necessary) and will then display the key details in the same way as if it had just generated the key.

If you use the Load command to load a foreign key format, it will work, but you will see a message box warning you that the key you have loaded is not a PuTTY native key. See below for information about importing foreign key formats.

Most SSH-1 clients use a standard format for storing private keys on disk. WinSCP uses this format as well; so if you have generated an SSH-1 private key using OpenSSH or ssh.com’s client, you can use it with WinSCP, and vice versa.

However, SSH-2 private keys have no standard format. OpenSSH and ssh.com have different formats, and WinSCP’s is different again. So a key generated with one client cannot immediately be used with another.

Using the Import command from the Conversions menu, PuTTYgen can load SSH-2 private keys in OpenSSH’s format and ssh.com’s format. Once you have loaded one of these key types, you can then save it back out as a PuTTY-format key (*.PPK) so that you can use it with the WinSCP. The passphrase will be unchanged by this process (unless you deliberately change it). You may want to change the key comment before you save the key, since OpenSSH’s SSH-2 key format contains no space for a comment and ssh.com’s default comment format is long and verbose.

PuTTYgen can also export private keys in OpenSSH format and in ssh.com format. To do so, select one of the Export options from the Conversions menu. Exporting a key works exactly like saving it - you need to have typed your passphrase in beforehand, and you will be warned if you are about to save a key without a passphrase.

For OpenSSH there are two options. Modern OpenSSH actually has two formats it uses for storing private keys. Export OpenSSH key will automatically choose the oldest format supported for the key type, for maximum backward compatibility with older versions of OpenSSH; for newer key types like Ed25519, it will use the newer format as that is the only legal option. If you have some specific reason for wanting to use OpenSSH’s newer format even for RSA, DSA, or ECDSA keys, you can choose Export OpenSSH key (force new file format).

Note that since only SSH-2 keys come in different formats; the export options are not available if you have generated an SSH-1 key.1

You can also use WinSCP /keygen command-line switch to convert the private key from other formats.