| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| other:putty_conf [2023/03/13 18:02] – [Creating ssh keys with PuTTYgen] Improved jypeter | other:putty_conf [2023/03/23 17:37] – Clarified the different types of files jypeter |
|---|
| === New profile for a direct connection to a remote server === | === New profile for a direct connection to a remote server === |
| |
| * Select an existing session (e.g. the [[#creating_a_new_session|ssh1 profile]] defined above) and click on **Load** | * Select an existing (and correctly configured) session (e.g. the [[#creating_a_new_session|ssh1 profile]] defined above) and click on **Load** |
| * Update the values of the **Host Name** and **Saved Session** (the name of the new profile you want) text fields, and settings | * Update the values of the **Host Name** and **Saved Session** (the name of the new profile you want) text fields, and settings |
| * Example: connecting to **LSCE from INSIDE LSCE**\\ (inside <=> computer connected to the wired network): | * Example: connecting to **LSCE from INSIDE LSCE**\\ (inside <=> computer connected to the wired network): |
| * ''Host Name'' => ''obelix'' | * ''Host Name'' => ''obelix'' |
| * ''Saved Session'' => ''obelix (direct connection)'' | * ''Saved Session'' => ''obelix (direct connection)'' |
| * Example: connecting to [[https://documentations.ipsl.fr/MESO_User/Quick_start.html|ciclad]]: | * Example: connecting to [[https://documentations.ipsl.fr/spirit/spirit_clusters/head_nodes.html|spirit]]: |
| * ''Host Name'' => ''ciclad.ipsl.upmc.fr'' | * ''Host Name'' => ''spirit1.ipsl.fr'' |
| * ''Saved Session'' => ''ciclad'' | * You can also use ''spirit2'', ''spiritx1'' or ''spiritx2'' depending on [[https://documentations.ipsl.fr/spirit/spirit_clusters/head_nodes.html|which IPSL server you want to access]] |
| * do not forget to **specify your ciclad login** in: ''Connection'' => ''Data'' => ''Auto-login username'' | * ''Saved Session'' => ''spirit1'' |
| * you will also need an [[other:putty_conf#using_ssh_keys|ssh key]] if you want to connect to ''ciclad'' !! | * do not forget to **specify your IPSL login** in: ''Connection'' => ''Data'' => ''Auto-login username'' |
| * Go back to ''Category'' => ''Session'' and **Save** the session | * you will also need an [[other:putty_conf#using_ssh_keys|ssh key]] if you want to connect to one of the IPSL ''spirit'' servers !! |
| | * Go back to ''Category'' => ''Session'' and <wrap em>**Save** the session</wrap> |
| |
| === New profile with a connection through a gateway === | === New profile with a connection through a gateway === |
| |
| * Select an existing //gateway// session (e.g. ''ssh1'') and click on **Load**.\\ For connecting to LSCE **from OUTSIDE LSCE**, select the [[#creating_a_new_session|ssh1 profile]]\\ If you are at LSCE, but use the //eduroam// or the //guest// **WiFi network**, you are considered as being //outside LSCE//! | * Select an existing //gateway// session (e.g. ''ssh1'') and click on **Load**.\\ For connecting to LSCE **from OUTSIDE LSCE**, select the [[#creating_a_new_session|ssh1 profile]]\\ If you are at LSCE, but use the //eduroam// or the //guest// **WiFi network**, you are considered as being //outside LSCE//! |
| * In the ''Connection'' => ''SSH'' category, specify the command used to connect to the target server in the **Remote command** field\\ e.g. **for LSCE**, use: | * In the ''Connection'' => ''SSH'' category, specify the command used to connect to the target server from the //gateway//, in the **Remote command** field\\ e.g. **for LSCE**, use: |
| * ''ssh -X -A obelix'' (check the [[other:ssh#standard_usage|useful ssh options]] for more details on the options)\\ {{ :other:putty_10b.png?direct |}} | * ''ssh -X -A obelix'' (check the [[other:ssh#standard_usage|useful ssh options]] for more details on the options)\\ {{ :other:putty_10b.png?direct |}} |
| * Go back to ''Category'' => ''Session'', <wrap hi>specify a new profile name</wrap> in **Saved Sessions** (e.g. ''obelix via ssh1'') and **Save** the session\\ {{ :other:putty_11.png?direct |}} | * Go back to ''Category'' => ''Session'', <wrap hi>specify a new profile name</wrap> in **Saved Sessions** (e.g. ''obelix via ssh1'') and <wrap em>**Save** the session</wrap>\\ {{ :other:putty_11.png?direct |}} |
| | |
| ===== Daily usage of PuTTY/Pageant ===== | ===== Daily usage of PuTTY/Pageant ===== |
| * You can now connect to the remote server just by clicking on the desktop shortcut, instead of right-clicking on the ''Pageant'' icon! | * You can now connect to the remote server just by clicking on the desktop shortcut, instead of right-clicking on the ''Pageant'' icon! |
| |
| ===== Using ssh keys ===== | ===== Using ssh keys with PuTTY/Pageant ===== |
| |
| Read the [[other:ssh#using_ssh_keys|Using ssh keys]] section if you don't know what //ssh keys// are | <WRAP center round alert 60%> |
| | In this section, we will use //key// files that have the same base name, and **different extensions**: e.g. ''id_ed25519'', ''id_ed25519**.pub**'' and ''id_ed25519**.ppk**'' |
| | |
| | You should **make sure that you can [[other:win10config#displaying_hidden_folders_and_files_and_the_files_extension|see hidden folders, and files' extensions]]** before you go further! |
| | </WRAP> |
| | |
| | |
| | Read the [[other:ssh#using_ssh_keys|Using ssh keys]] section if you don't already know what //ssh keys// are |
| <WRAP center round important 80%> | <WRAP center round important 80%> |
| * **Do not lose** the (existing) ssh keys files you have, or the keys that you will create | * **Do not lose** the (existing) ssh keys files you have, or the keys that you will create |
| * It's a very good idea to **keep a copy of these files** on another computer! | * It is recommended to **keep a copy of these files** on another computer! |
| |
| * **Do not forget** the passphrase that will be used to unlock the private key | * **Do not forget** the passphrase that will be used to unlock the private key |
| | * If you save the passphrase in a file, **do not** put this file in the same place as the ssh keys |
| | * Read [[other:ssh#some_common_sense_advice|Do not forget your passphrase!]] if you need some advice about passphrases |
| |
| * If you save the passphrase in a file, **do not** put this file in the same place as the ssh keys | * The best thing to do is probably to **store the //key// files in the standard [[other:ssh#configuration_files|ssh configuration directory]]** of each desktop/laptop/servers you use! |
| | |
| * Easiest thing to do is probably to store the key files in an ''ssh'' sub-directory somewhere | |
| * We assume below that they keys are in a sub-directory of your [[other:win10config#the_most_important_folders|local HOME FOLDER]]\\ \\ <some_disk_different_from_c>:\Users\<your_login>\ssh\ | |
| </WRAP> | </WRAP> |
| | ==== Converting existing ssh keys with PuTTYgen ==== |
| |
| | If you already have a private ssh key generated on another computer (e.g. an ''id_ed25519'' text file), you just have to use ''PuTTYgen'' to **import the existing private key**, and then export it to a //converted// ''id_ed25519.ppk'' file that ''Pageant'' can use |
| |
| | * Move the ''id_ed25519'' key file to the [[other:ssh#configuration_files|Windows ssh configuration directory]] |
| | * => ''C:\Users\your_windows_login\.ssh\id_ed25519'' |
| |
| Launching the ''PuTTY Key Generator'': ''Start'' => ''PuTTY'' => ''PuTTYgen'' | * Launch the ''PuTTY Key Generator'': ''Start'' => ''PuTTY'' => ''PuTTYgen'' |
| |
| ==== Converting existing ssh keys with PuTTYgen ==== | * Open the ''Conversions''=>''Import key'' menu\\ {{ :other:putty_21b.png?direct&300 |}} |
| |
| If you already have a private ssh keys generated on another computer (e.g. an ''id_rsa'' text file), you just have to use ''PuTTYgen'' to **import the existing private key**, and then export it to a //converted// ''.ppk'' file that ''Pageant'' can use | * Select the existing ''id_ed25519'' private key file (or another valid private key) and type the passphrase to unlock and import it |
| * Import the key (and type the passphrase, when asked) with: ''Conversions''=>''Import key''\\ {{ :other:putty_21.png?direct&300 |}} | |
| * Then click on the ''Save private key'' button, and create a ''id_rsa.ppk'' file (or ''any_name_you_want.ppk'')\\ {{ :other:putty_22.png?direct&300 |}} | * Click on the ''Save private key'' button, and create an ''id_ed25519.ppk'' file in the [[other:ssh#configuration_files|Windows ssh configuration directory]] |
| | * => ''C:\Users\your_windows_login\.ssh\id_ed25519.ppk'' |
| |
| ==== Creating ssh keys with PuTTYgen ==== | ==== Creating ssh keys with PuTTYgen ==== |
| |
| Notes: | Notes: |
| * by //recent-enough//, we mean //rsa// and preferably //ed25519// (//dsa// is deprecated) | * by //recent-enough//, we mean ssh keys of type //rsa// and preferably //ed25519// (//dsa// is deprecated) |
| * extra technical details (that you can probably safely ignore) are available in the official [[https://the.earth.li/~sgtatham/putty/0.78/htmldoc/Chapter8.html#pubkey-puttygen|Using PuTTYgen, the PuTTY key generator]] documentation | * extra technical details (that you can probably safely ignore) are available in the official [[https://the.earth.li/~sgtatham/putty/0.78/htmldoc/Chapter8.html#pubkey-puttygen|Using PuTTYgen, the PuTTY key generator]] documentation |
| |
| Steps: | Steps: |
| | |
| | * Launch the ''PuTTY Key Generator'': ''Start'' => ''PuTTY'' => ''PuTTYgen'' |
| | |
| * Make sure that the selected //Type of key to generate// (at the bottom of the ''PuTTYgen'' window) is ''EdDSA'' (short for //Edwards-curve DSA//), with the default ''255'' bits.\\ This will generate **//ed25519// keys** that are now recommended on the IPSL servers | * Make sure that the selected //Type of key to generate// (at the bottom of the ''PuTTYgen'' window) is ''EdDSA'' (short for //Edwards-curve DSA//), with the default ''255'' bits.\\ This will generate **//ed25519// keys** that are now recommended on the IPSL servers |
| * {{:other:putty_23b.png?direct&500|}} | * {{:other:putty_23b.png?direct&500|}} |
| * You could also use ''RSA'' and ''4096'' bits, but ''ed25519'' keys are now recommended on the IPSL servers | * You could also use ''RSA'' and ''4096'' bits, but ''ed25519'' keys are now recommended to access the [[https://documentations.ipsl.fr/spirit/spirit_clusters/head_nodes.html|IPSL servers]] |
| * Click on the ''Generate'' button and move your mouse to generate some random information | * Click on the ''Generate'' button and move your mouse to generate some random information |
| | |
| * Type your ''Key passphrase'' and confirm it | * Type your ''Key passphrase'' and confirm it |
| * Read [[other:ssh#some_common_sense_advice|Do not forget your passphrase!]] if you need some advice | * Read [[other:ssh#some_common_sense_advice|Do not forget your passphrase!]] if you need some advice about passphrases |
| * Click on the ''Save private key'' button, and create an ''id_ed25519**.ppk**'' file | |
| * **Important!** Click ''Conversions''=>''Export OpenSSH Key'' and create an ''id_ed25519'' file (a text file with **no** ''.ppk'' extension) | * Click on the ''Save private key'' button, and create the ''id_ed25519**.ppk**'' **Pageant //private// key file** |
| * You will not need this file when you use PuTTY, but you may need to use this private key in a standard text format later, on Linux computers/servers | * We recommend that you save this file in the the Windows [[other:ssh#configuration_files|ssh configuration directory]]\\ => ''C:\Users\your_windows_login\.ssh\id_ed25519.ppk'' |
| * Click on the ''Save public key'' button, and create a ''id_ed25519**.pub**'' file | * Note: files with a ''.ppk'' extension can only be used by ''PuTTY''/''pageant''. That's why you also need to //export// the private key, as shown below |
| * You will need to [[other:ssh#installing_ssh_keys|install the public key]] on all the remote Linux server that you want to connect to using the ssh agent, instead of typing your password | |
| | * **Important!** Click ''Conversions''=>''Export OpenSSH Key'' and create the ''id_ed25519'' **standard //private// key file** (a text file with **no** ''.ppk'' extension) |
| | * => ''C:\Users\your_windows_login\.ssh\id_ed25519'' |
| | * You will not need this file when you use ''PuTTY'', but you may need to use this private key in a standard text format later, on Linux computers/servers |
| | |
| | * Open a text editor and create the ''id_ed25519**.pub**'' **standard //public// key file** |
| | * => ''C:\Users\your_windows_login\.ssh\id_ed25519.pub'' |
| | * Save the content of the ''Public key for pasting into OpenSSH authorized_keys file'' field in the ''id_ed25519**.pub**'' file\\ Something looking like\\ <code>ssh-ed25519 AAAAC3NzaC1lZDI[... lots of characters ...]vwjLNmY eddsa-key-20230310</code> |
| | * This is the **//public// key** that you will need to [[other:ssh#installing_ssh_keys|install]] on all the remote Linux server that you want to connect to using the ssh agent, instead of typing your password |
| | |
| | * **WARNING!** Do **not** use the ''Save public key'' button to create the public key file, because the resulting file will not be standard enough to be used directly on Linux computers |
| |
| ==== Using the private key in Pageant ==== | ==== Using the private key in Pageant ==== |
