ui_puttygen » Revisions »
Differences
This shows you the differences between the selected revisions of the page.
ui_puttygen 2023-04-26 | ui_puttygen 2024-07-19 (current) | ||
Line 2: | Line 2: | ||
PuTTYgen is a key generator. It generates pairs of [[public_key|public and private keys]] to be used with WinSCP. PuTTYgen generates RSA, DSA, ECDSA, and EdDSA keys.((&puttydoccite)) | PuTTYgen is a key generator. It generates pairs of [[public_key|public and private keys]] to be used with WinSCP. PuTTYgen generates RSA, DSA, ECDSA, and EdDSA keys.((&puttydoccite)) | ||
- | wtf guys? | + | ===== Obtaining and Starting PuTTYgen ===== |
+ | PuTTYgen is included in the [[ui_installer_selectcomponents|WinSCP installation package]]. You can also download it separately from the [[&downloads#putty_additional|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 [[ui_login|Login dialog]]. | ||
+ | |||
+ | ===== [[window]] PuTTYgen Window ===== | ||
+ | |||
+ | &screenshotpict(puttygen) | ||
+ | |||
+ | When you run PuTTYgen you will see a window where you have two main choices: //Generate//, to generate a new public/private key pair, or //Load// to load in an existing private key. | ||
+ | |||
+ | ===== [[generating]] Generating a New 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 [[#size|the strength of the key]]. | ||
+ | * Then press the //Generate// button, to actually [[#generate|generate the key]]. | ||
+ | * Once you have generated the key, select [[#comment|a comment]] field and [[#passphrase|a passphrase]]. | ||
+ | * Now you're ready to [[#saving_private|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 //[[#authorized_keys|Public key for pasting into OpenSSH authorized_keys file]]// box, or by using the //[[#saving_public|Save public key]]// button. However, you don't need to do this immediately; if you want, you can [[#reloading|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 [[guide_public_key|setting up public key authentication]]. | ||
===== [[type]] Selecting the Type of Key ===== | ===== [[type]] Selecting the Type of Key ===== | ||
Line 108: | Line 131: | ||
When the currently loaded key in PuTTYgen contains a certificate, the large [[#authorized_keys|//Public key for pasting// edit box]] is replaced by a button that brings up an information box telling you about the certificate, such as who it certifies your key as belonging to, when it expires (if ever), and the fingerprint of the CA key that signed it in turn. | When the currently loaded key in PuTTYgen contains a certificate, the large [[#authorized_keys|//Public key for pasting// edit box]] is replaced by a button that brings up an information box telling you about the certificate, such as who it certifies your key as belonging to, when it expires (if ever), and the fingerprint of the CA key that signed it in turn. | ||
- | |||
- | //This feature is available in PuTTYgen 0.78 included with latest beta version only.// &beta | ||
===== [[saving_private]] Saving Your Private Key to a Disk File ===== | ===== [[saving_private]] Saving Your Private Key to a Disk File ===== | ||
Line 185: | Line 206: | ||
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_private|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. | 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_private|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)//. | + | For OpenSSH there are two options. Modern OpenSSH actually has two formats it uses for storing private keys: an older ("PEM-style") format, and a newer "native" format with better resistance to passphrase guessing and support for comments. //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 – for instance, you know your file will only be used by OpenSSH 6.5 or newer (released in 2014), and want the extra security – you can choose //Export OpenSSH key (force new file format)//. |
You can also use WinSCP ''[[commandline#keygen|/keygen]]'' command-line switch to convert the private key from other formats. | You can also use WinSCP ''[[commandline#keygen|/keygen]]'' command-line switch to convert the private key from other formats. | ||
Line 198: | Line 219: | ||
The options supported on the PuTTYgen command line are: | The options supported on the PuTTYgen command line are: | ||
- | | ''-t <keytype>'' | [[#type|Type of key]] to generate. You can select ''rsa'', ''dsa'', ''ecdsa'', ''eddsa'', ''ed25519'' or ''ed448'' //(the last three in PuTTYgen 0.78 included with latest beta version only)// &beta | | + | | ''-t <keytype>'' | [[#type|Type of key]] to generate. You can select ''rsa'', ''dsa'', ''ecdsa'', ''eddsa'', ''ed25519'' or ''ed448'' | |
| ''-b <bits>'' | [[#size|Size of the key]] to generate, in bits. | | | ''-b <bits>'' | [[#size|Size of the key]] to generate, in bits. | | ||
| ''%%--primes <method>%%'' | [[#method|Method for generating prime numbers]]. You can select ''probable'', ''proven'', and ''proven-even''. | | | ''%%--primes <method>%%'' | [[#method|Method for generating prime numbers]]. You can select ''probable'', ''proven'', and ''proven-even''. | |