Courtesy: https://kb.iu.edu/d/aews
Overview
Using SSH public-key authentication to connect to a remote system is a robust, more secure alternative to logging in with an account password or passphrase. SSH public-key authentication relies on asymmetric cryptographic algorithms that generate a pair of separate keys (i.e., a key pair), one "private" and the other "public". You keep the private key a secret and store it on the computer you use to connect to the remote system. Conceivably, you can share the public key with anyone without compromising the private key; you store it on the remote system in a.ssh/authorized_keys directory.To use SSH public-key authentication:
- The remote system must have a version of SSH installed. The information in this document assumes the remote system uses OpenSSH, which is generally the case for UITS central systems at Indiana University. If the remote system is using a different version of SSH (e.g., Tectia SSH), the process outlined below may not be correct.
- The computer you use to connect to the remote server must have a version of SSH installed. This document includes instructions for generating a key pair with command-line SSH on a Linux or OS X computer, and with PuTTY on a Windows computer.
- You need to be able to transfer your public key to the remote
system. Therefore, you must either be able to log into the remote system
with an established account username and password/passphrase, or have
an administrator on the remote system add the public key to the
~/.ssh/authorized_keysfile in your account.
Setting up public-key authentication using SSH on a Linux or OS X computer
To set up public-key authentication using SSH on a Linux or OS X computer:- Log into the computer you'll use to access the remote host, and then
use command-line SSH to generate a key pair using either the DSA or RSA
algorithm:
- To generate DSA keys, on the command line, enter:
ssh-keygen -t dsa
- To generate RSA keys, on the command line, enter:
ssh-keygen -t rsa
- To generate DSA keys, on the command line, enter:
- You will be prompted to supply a filename (for saving the key pair) and a password (for protecting your private key):
- Filename: To accept the default filename (and location) for your key pair, press
EnterorReturnwithout entering a filename. Alternatively, you can enter a filename (e.g.,my_ssh_key) at the prompt, and then pressEnterorReturn. However, many remote hosts (including IU's research computing systems) are configured to accept private keys with the default filename and path (~/.ssh/id_rsafor RSA keys;~/.ssh/id_dsafor DSA keys) by default. Consequently, to authenticate with a private key that has a different filename, or one that is not stored in the default location, you must explicitly invoke it either on the SSH command line or in an SSH client configuration file (~/.ssh/config); see below for instructions.
- Password: Enter a password that contains at least five characters, and then press
EnterorReturn. If you pressEnterorReturnwithout entering a password, your private key will be generated without password-protection.Note: UITS strongly recommends password-protecting your private key. If you don't password-protect your private key, anyone with access to your computer conceivably can SSH (without being prompted for a password) to your account on any remote system that has the corresponding public key.
id_rsa) or the filename you specified (e.g.,my_ssh_key), and stored on your computer in a.sshdirectory off your home directory (e.g.,~/.ssh/id_rsaor~/.ssh/my_ssh_key).
The corresponding public key will be generated using the same filename (but with a.pubextension added) and stored in the same location (e.g.,~/.ssh/id_rsa.pubor~/.ssh/my_ssh_key.pub).
- Filename: To accept the default filename (and location) for your key pair, press
- Use SFTP or SCP to copy the public key file (e.g.,
~/.ssh/id_rsa.pub) to your account on the remote system (e.g.,darvader@deathstar.empire.gov); for example, using command-line SCP:scp ~/.ssh/id_rsa.pub darvader@deathstar.empire.gov:
Or, to use IU's Karst cluster as an example (replaceusernamewith your Network ID username):scp ~/.ssh/id_rsa.pub username@karst.uits.iu.edu:
You'll be prompted for your account password (or, if you're copying to an IU system, your Network ID passphrase). Your public key will be copied to your home directory (and saved with the same filename) on the remote system.
- Log into the remote system using your account username and password. For an IU system, log in with your
Network ID username and passphrase.
Note: If the remote system is not configured to
support password-based authentication, you will need to ask system
administrators to add your public key to the
~/.ssh/authorized_keysfile in your account (if your account doesn't have~/.ssh/authorized_keysfile, system administrators can create one for you). Once your public key is added to your~/.ssh/authorized_keysfile on the remote system, the setup process is complete, and you should now be able to SSH to your account from the computer that has your private key.
- If your account on the remote system doesn't already contain a
~/.ssh/authorized_keysfile, create one; on the command line, enter the following commands:mkdir -p ~/.ssh touch ~/.ssh/authorized_keys
Note: If your account on the remote system already has a~/.ssh/authorized_keysfile, executing these commands will not damage the existing directory or file.
- On the remote system, add the contents of your public key file (e.g.,
~/id_rsa.pub) to a new line in your~/.ssh/authorized_keysfile; on the command line, enter:cat ~/id_rsa.pub >> ~/.ssh/authorized_keys
You may want to check the contents of~/.ssh/authorized_keysto make sure your public key was added properly; on the command line, enter:
more ~/.ssh/authorized_keys
- You may now safely delete the public key file (e.g.,
~/id_rsa.pub) from your account on the remote system; on the command line, enter:rm ~/id_rsa.pub
Alternatively, if you prefer to keep a copy of your public key on the remote system, move it to your.sshdirectory; on the command line, enter:
mv ~/id_rsa.pub ~/.ssh/
- Optionally, repeat steps 3-7 to add your public key to other remote systems that you want to access from the computer that has your private key using SSH public-key authentication.
- You now should be able to SSH to your account on the remote system (e.g.,
username@host2.somewhere.edu) from the computer (e.g.,host1) that has your private key (e.g.,~/.ssh/id_dsa):- If your private key is password-protected, the remote system will
prompt you for the password or passphrase (your private key
password/passphrase is not transmitted to the remote system):
[username@host1 ~]$ ssh username@host2.somewhere.edu Enter passphrase for key '/username/Host1/.ssh/id_dsa': Last login: Mon Oct 20 09:23:17 2014 from host1.somewhere_else.edu
- If your private key is not password-protected, the remote system
will place you on the command line in your home directory without
prompting you for a password or passphrase:
[username@host1 ~]$ ssh username@host2.somewhere.edu Last login: Mon Oct 20 09:23:17 2014 from host1.somewhere_else.edu
~/.ssh/id_rsaor~/.ssh/id_dsa), you must explicitly invoke it in one of two ways:
- On the SSH command line: Add the
-iflag and the path to your private key. For example, to invoke the private keyhost2_key, stored in the~/.ssh/old_keysdirectory, when connecting to your account on a remote host (e.g.,username@host2.somewhere.edu), enter:
ssh -i ~/.ssh/old_keys/host2_key username@host2.somewhere.edu
- In an SSH client configuration file: SSH gets configuration data from the following sources (in this order):
- From command-line options
- From the user's client configuration file (
~/.ssh/config), if it exists - From the system-wide client configuration file (
/etc/ssh/ssh_config)
~/.ssh/configthat includes theHostandIdentityFilekeywords.
For example, for connections tohost2.somewhere.edu, to make SSH automatically invoke the private keyhost2_key, stored in the~/.ssh/old_keysdirectory, create a~/.ssh/configfile with these lines included:
Host host2.somewhere.edu IdentityFile ~/.ssh/old_keys/host2_keyOnce you save the file, SSH will use the specified private key for future connections to that host.
You can add multipleHostandIdentityFiledirectives to specify a different private key for each host listed; for example:
Host host2.somewhere.edu IdentityFile ~/.ssh/old_keys/host2_key Host host4.somewhere.edu IdentityFile ~/.ssh/old_keys/host4_key Host host6.somewhere.edu IdentityFile ~/.ssh/old_keys/host6_keyAlternatively, you can use a single asterisk (*) to provide global defaults for all hosts (i.e., specify one private key for several hosts); for example:
Host *.somewhere.edu IdentityFile ~/.ssh/old_keys/all_hosts_keyFor more about the SSH client configuration file, see the manual page for the OpenSSH SSH client configuration file on the web or from the command line (man ssh_config).
- If your private key is password-protected, the remote system will
prompt you for the password or passphrase (your private key
password/passphrase is not transmitted to the remote system):
Setting up public-key authentication using PuTTY on a Windows computer
Note: The PuTTY command-line SSH client, the PuTTYgen key generation utility, the Pageant SSH authentication agent, and the PuTTY SCP and SFTP utilities are packaged together in a Windows installer available under The MIT License for free download from the PuTTY development team.To set up public-key authentication using PuTTY on a Windows computer:
- Log into your computer and open the PuTTYgen key generation utility.
- Under "Parameters", select either or ; next to "Number of bits in a generated key", leave the default value (
1024). - Under "Actions", click , and
then, when prompted use your mouse (or trackpad) to move your cursor
around the blank area under "Key" (this generates randomness the utility
uses to create your key pair).
When the utility has generated your key pair, it will display the public key in the area under "Key".
- In the "Key passphrase" and "Confirm passphrase" text boxes, enter a passphrase to passphrase-protect your private key.
Note: UITS strongly
recommends passphrase-protecting your private key. If you don't
passphrase-protect your private key, anyone with access to your computer
will be able to SSH (without being prompted for a passphrase) to your
account on any remote system that has the corresponding public key.
- Save your public key:
- Under "Actions", next to "Save the generated key", click .
- Give the file a name (e.g.,
putty_key), select a location on your computer to store it, and then click .
- Save your private key:
- Under "Actions", next to "Save the generated key", click .
Note: If you didn't passphrase-protect your private
key, the utility will ask whether you're sure you want to save it
without a passphrase. Click to proceed or to go back and create a passphrase for your private key.
- Keep "Save as type" set to , give the file a name (e.g.,
putty_private_key), select a location on your computer to store it, and then click .
- Under "Actions", next to "Save the generated key", click .
Note: If you didn't passphrase-protect your private
key, the utility will ask whether you're sure you want to save it
without a passphrase. Click to proceed or to go back and create a passphrase for your private key.
- Log into the remote system using your account username and password. (On IU systems, use your Network ID
username and passphrase.)
Note: If the remote system does not support
password-based authentication, you will need to ask system
administrators to add your public key to the
~/.ssh/authorized_keysfile in your account (if your account doesn't have~/.ssh/authorized_keysfile, system administrators can create one for you). Once your public key is added to your account's~/.ssh/authorized_keysfile on the remote system...
- If your account on the remote system doesn't already contain a
~/.ssh/authorized_keysfile, create one; on the command line, enter the following commands:mkdir -p ~/.ssh touch ~/.ssh/authorized_keys
Note: If your account on the remote system already has~/.ssh/authorized_keys, executing these commands will not damage the existing directory or file.
- On your computer, in the PuTTYgen utility, copy the contents of the
public key (displayed in the area under "Key") onto your Clipboard.
Then, on the remote system, use your favorite text editor to paste it
onto a new line in your
~/.ssh/authorized_keysfile, and then save and close the file. - On your computer, open the Pageant SSH authentication agent. This utility runs in the background, so when it opens, you should see its icon displayed in the Windows notification area.
- In the Windows notification area, right-click on the icon, select , navigate to the location where you saved your private key (e.g.,
putty_private_key.ppk), select the file, and then click . - If your private key is passphrase-protected, Pageant will prompt you
to enter the passphrase; enter the passphrase for your private key, and
then click .
If your private key is not passphrase-protected, Pageant will add your private key without prompting you for a passphrase.
Either way, Pageant stores the unencrypted private key in memory for use by PuTTY when you initiate an SSH session to the remote system that has your public key.
- On your computer, open the PuTTY SSH client:
- On the screen:
- Under "Host Name (or IP address)", enter your username coupled with
the host name of the remote server that has your public key; for
example:
dsidious@deathstar.empire.gov
Or, to use an account on IU's Karst research cluster as an example (replaceusernamewith your Network ID username):username@karst.uits.iu.edu
- Under "Connection type", make sure is selected.
- Under "Host Name (or IP address)", enter your username coupled with
the host name of the remote server that has your public key; for
example:
- In the "Category" list on the left, navigate to the screen (). On the screen, under "Authentication methods", select .
- Return to the screen, and under "Saved Sessions", enter a name (e.g.,
Deathstar), and then click . - Click to connect to your account on the remote system. With Pageant running in the background, PuTTY will retrieve the unencrypted private key automatically from Pageant and use it to authenticate. Because Pageant has your private key's passphrase saved (if applicable), the remote system will place you on the command line in your account without prompting you for the passphrase.
Startupfolder to launch Pageant and load your private key automatically whenever you log into your desktop. For instructions, finish the rest of the following steps.
- On the screen:
- Open your
Startupfolder:- In Windows 8, press
Win-r, and in the "Open" field, typeshell:startup, and then pressEnter. - In Windows 7, from the menu, click , scroll to find , right-click on it, and then select .
Startupfolder (replaceuser_profilewith the name of your Windows user profile):
C:\Users\user_profile\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup
- In Windows 8, press
- Right-click inside the
Startupfolder, and then select and . - In the "Type the location of the item" text box, enter the path to the Pageant executable (
pageant.exe) followed by the path to your private key file (e.g.,putty_private_key.ppk); enclose both paths in double quotes; for example:"C:\Program Files (x86)\PuTTY\pageant.exe" "C:\Users\user_profile\ssh_key\putty_private.ppk"
- Click , and then, in the "Type a name for this shortcut" text box, enter a name for the shortcut (e.g.,
PAGEANT). - Click .



