User Tools

Site Tools


other:putty_conf

Configuring and using PuTTY/Pageant

PuTTY is a free and easy to use ssh client for Windows. You can use it to connect to your favorite remote Linux servers in text mode, and start remote graphical applications if you also have a running X server

Installation

Official web site: PuTTY Web site

You can install the latest version of PuTTY directly from Microsoft Store, or download the latest 64-bit msi installer

Launching PuTTY/Pageant

You could directly launch PuTTY (StartPuTTYPuTTY), but it is actually more efficient to launch Pageant, especially if you are often going to connect to the same server(s)

Starting Pageant: StartPuTTYPageant

  • Pageant is an ssh agent for Windows, but this page also explains how to use it for easily creating and using connection profiles (aka Sessions) to connect to remote Linux servers
    • Some applications (e.g. WinSCP) will automatically try to use Pageant as an ssh-agent, instead of asking you to type your ssh passphrase
  • It will seem that nothing happens when you start Pageant, but you should get the Pageant icon at the bottom right of your screen.
  • If you right click on the Pageant icon, you can manage sessions with the New Session option, use Saved Sessions profiles and manage ssh keys (View Keys, Add Key).
    You can also view/add ssh keys by double clicking on the pageant icon

Configuring PuTTY

Launch the PuTTY Configuration manager: (Right click on) PageantNew Session

  • You can keep most PuTTY's default settings. This section will show you how to create your first session profile, with some highly recommended options.

    If you want to add another session later, just Load an existing (and properly configured) session, Save it under a new name, change the session details, and then save the session again.
  • When changing a setting, select a (sub-)Category in the left part of the PuTTY Configuration window, and change the displayed settings in the right part of the window.
  • After changing the settings of an existing Session, do not forget to go back to the Session category (at the top left of the Putty Configuration window) and click Save!

Creating a new session

In the Session Category:

  • Specify a Host Name: e.g. ssh1.lsce.ipsl.fr for the LSCE access server (also called LSCE gateway)
  • Specify a matching session name in Saved Sessions: e.g. ssh1
  • Click on Save to save the new session (that will only have default settings for now)

If you are in a hurry, you can connect to the Linux server specified in the Host Name field by clicking on Open

Changing some useful settings

  • Load an existing session (e.g. the ssh1 profile defined above), that will serve as a template (with the recommended settings) for the future sessions
  • In the WindowSelection category:
    • Select xterm in the Actions of mouse buttons section.
      This will allow you to use the mouse buttons in the PuTTY terminal the same way you would use them in an standard Linux xterm terminal:
      • Select and Copy text (at the same time) with the left button
      • Paste text with the middle button
  • In the WindowAppearance category:
    • You can choose a font more readable than the default one!
      We recommend the Cascadia Code font that comes with the Windows Terminal application (which means that you first have to install Windows Terminal first, but you will probably need it anyway)
    • Use the Change… button in the Font settings section, and select Cascadia Code and Regular (you can also experiment with styles different from Regular, and different font sizes)
  • In the ConnectionData category:
    • Specify your login name (on the LSCE servers) in Auto-login username. This way you won't have to type it when you connect to the Linux server!
  • In the ConnectionSSHKex category:
    • Unselect Attempt GSAPPI key exchange!
      If you forget to do this, connecting to a server will seem to take forever (if it works at all)…
  • In the ConnectionSSHAuth category:
  • In the ConnectionSSHX11 category:
  • When you have finished updating the settings, do not forget to go back to CategorySession and Save the session!
  • Click on Open to connect to the specified host with the updated settings, and check that things are working properly
    The first time you connect to a server, you will get a PuTTY Security Alert window, where you have to click on Accept to tell PuTTY that you trust the connection to this new server

Adding more connection profiles

Start Pageant, and then the PuTTY Configuration manager: (Right click on) PageantNew Session

New profile for a direct connection to a remote server

  • Select an existing session (e.g. the 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
    • Example: connecting to LSCE from INSIDE LSCE
      (inside ⇔ computer connected to the wired network):
      • Host Nameobelix
      • Saved Sessionobelix (direct connection)
    • Example: connecting to ciclad:
      • Host Nameciclad.ipsl.upmc.fr
      • Saved Sessionciclad
      • do not forget to specify your ciclad login in: ConnectionDataAuto-login username
      • you will also need an ssh key if you want to connect to ciclad !!
  • Go back to CategorySession and Save the session

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 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 ConnectionSSH category, specify the command used to connect to the target server in the Remote command field
    e.g. for LSCE, use:
  • Go back to CategorySession, specify a new profile name in Saved Sessions (e.g. obelix via ssh1) and Save the session

Daily usage of PuTTY/Pageant

Note: PuTTY will ask your password each time you open a session, unless you have ssh keys, and you use Pageant to store your passphrase

Starting a session from Pageant

Once you have started pageant, and configured sessions, you can easily open terminals on the remote servers by right-clicking on the pageant icon, and selecting a Saved Session.

Starting a session from a desktop shortcut

It is possible to create a shortcut on the desktop to start a specific session!

  • Right-click on the desktop and select NewShortcut
  • Specify the location of putty.exe in the path field, and click Next:
    "C:\Program Files\PuTTY\putty.exe" (with the quotes!)
  • Specify the name of the shortcut (as it will appear on the desktop), and save the shortcut
    e.g. obelix via ssh1
  • Right-click on the shortcut and select Properties, then add the name of the desired profile to the content of the Target field
    • Warning:
      • you have to use an existing session name (as it appears in PageantSessionSaved Sessions)
      • you have to use quotes correctly, otherwise you will get an error message!
    • Examples:
      • "C:\Program Files\PuTTY\putty.exe" -load "obelix via ssh1"
      • "C:\Program Files\PuTTY\putty.exe" -load "obelix (direct)"
  • Click OK to save the changes
  • 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

Read the Using ssh keys section if you don't know what ssh keys are

  • 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!
  • 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
  • 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 local HOME FOLDER

      <some_disk_different_from_c>:\Users\<your_login>\ssh\

Launching the PuTTY Key Generator: StartPuTTYPuTTYgen

Converting existing ssh keys with PuTTYgen

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

  • Import the key (and type the passphrase, when asked) with: ConversionsImport key
  • Then click on the Save private key button, and create a id_rsa.ppk file (or any_name_you_want.ppk)

Creating ssh keys with PuTTYgen

If you don't have a set of ssh keys, follow the steps below to create private and public keys

  • Make sure that the type of key (at the bottom of the PuTTYgen window) is RSA and that the number of bits is 4096
  • Click on the Generate button and move your mouse to generate some random information
  • Type your Key passphrase and confirm it
  • Click on the Save private key button, and create a id_rsa.ppk file (or any_name_you_want.ppk)
  • Click on the Save public key button, and create a id_rsa.pub file
    • You will need to 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
  • Click on ConversionsExport OpenSSH key, and create a (standard) id_rsa file
    You will not need this file with Putty, but it is just in case you need to use your private key later on a Linux computer

Using the private key in Pageant

We assume that the private key file is available locally in <some_disk_different_from_c>:\Users\<your_login>\ssh\

  • Start Pageant and open the Pageant Key List window by:
    • Double-clicking (left mouse button) on Pageant
    • Or right-clicking on Pageant and choosing View keys
  • Click on Add Key, navigate to the directory where you have stored the .ppk converted private key file (e.g. \Users\<your_login>\ssh\), open it and type your passphrase. You can Close the Pageant Key List once the key appears there
  • If everything was done correctly, you should now be able to open the Sessions defined in Pageant, on remote servers where the public key matching the private key used in Pageant was installed correctly





[ PMIP3 Wiki Home ] - [ Help! ] - [ Wiki syntax ]

other/putty_conf.txt · Last modified: 2022/08/08 15:54 by jypeter