Track1Agenda: a_exercise_ssh_key.html

<h1>SSH with private/public key authentication</h1>

<p>In this exercise we'll show how you can eliminate passwords by using ssh key
authentication.</p>

<p>Choose the version of the exercises depending on what OS you are running on
your laptop.</p>

<p>Remember: the <code>$</code> character before commands indicates that they are to be
run as your normal login user, not as root.</p>

<h1>For laptops running Windows</h1>

<p>Download the following onto your desktop or into a downloads folder:</p>

<ul>
<li>putty.exe (you should already have this)</li>
<li>psftp.exe</li>
<li>pageant.exe</li>
<li>puttygen.exe</li>
</ul>

<p>from <a href="http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html">http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html</a> 
(Or you can try the installer bundle which gets them all)</p>

<p>Alternately you can use <a href="http://noc.ws.nsrc.org/downloads/">http://noc.ws.nsrc.org/downloads/</a> to download these files if the
public download site is not available or too slow.</p>


<h2>1. Generate an ssh public/private key pair</h2>

<p>Double-click on <code>puttygen.exe</code></p>

<p>At the bottom of the dialog box, under "Parameters":</p>

<ul>
<li>Make sure the type of key to generate is "SSH-2 RSA"</li>
<li>Set the number of bits to 2048</li>
</ul>

<p>Click on "Generate". Move the mouse randomly over the blank area until the
progress bar reaches 100%</p>

<pre><code>Key comment:        [Your Name &lt;your@email.address&gt;   ]
Key passphrase:     [chooose a passphrase             ]
Confirm passphrase: [choose same passphrase           ]
</code></pre>

<p>The passphrase is used to keep your private key encrypted on disk. It can be
pretty much anything you want and as long as you want - including spaces -
but if you forget it, your key becomes worthless.  For now pick something
that you will easily remember.  You can change it at any time you want in
the future.</p>

<p>Click "Save public key". Give a filename of "id_rsa.pub" (please save
files into the same directory as where the executables are)</p>

<p>Click "Save private key". Give a filename of "id_rsa.ppk"</p>

<p>Use the mouse to highlight all the text in the box "Public key for pasting
into OpenSSH authorized_keys file", and copy it to the clipboard.</p>

<p>Exit puttygen.</p>

<p>NOTE: Key generation is a one-off exercise. The more you deploy your public
key, the more work it to be if you were to lose it and have to start again
with a new one.  I suggest you keep a secure backup of it somewhere, e.g. 
on a CD-ROM or a safe USB key that you lock away.</p>

<h2>2. Copy the PUBLIC key onto your Unix server</h2>

<p>You have two ways of doing this.</p>

<h3>Copy-paste</h3>

<p>Use putty.exe to make a normal ssh connection to your host as the 'sysadm'
user.</p>

<pre><code>$ cat &gt;&gt;.ssh/authorized_keys
*** PASTE KEY FROM CLIPBOARD ***
*** If the cursor is still at the end of the line, hit Enter ***
*** hit ctrl-D ***
</code></pre>

<p>The key consists of one very long line, which looks like</p>

<pre><code>ssh-rsa &lt;lots of base64 data&gt; &lt;comment&gt;
</code></pre>

<p>As a quick check that it hasn't been corrupted, count the lines in the file:</p>

<pre><code>$ wc -l .ssh/authorized_keys
1 .ssh/authorized_keys
</code></pre>

<p>If you don't see "1", then you'll need to fix it (possibly with an editor,
or else just rm the file and start again)</p>

<p>Now logout.</p>

<h3>Alternative way (if you're having problems with copy-paste)</h3>

<p>Double-click on psftp.exe. Open a connection to your server, and upload
your public key:</p>

<pre><code>psftp&gt; open pcN.ws.nsrc.org
login as: sysadm
sysadm@pcN.ws.nsrc.org's password: &lt;usual one&gt;
Remote working directory is /home/sysadm
psftp&gt; put id_rsa.pub
local:id_rsa.pub =&gt; remote:/home/sysadm/id_rsa.pub
psftp&gt; quit
</code></pre>

<p>Unfortunately, this public key is not in the format which openssh requires,
so now login again using putty.exe, and use the following command to convert
it and put it in the right place.</p>

<pre><code>$ ssh-keygen -i -f id_rsa.pub &gt;&gt;.ssh/authorized_keys
</code></pre>

<h2>3. Login using your private key</h2>

<p>Start putty.exe again. Enter the hostname as usual, but before clicking
Open, browse in the left hand column to Connection > SSH > Auth</p>

<pre><code>[-] Connection
     |
    [-] SSH
     |  |- Keyex
     |  |- Auth    &lt;--- CLICK HERE
</code></pre>

<p>Next to "Private key for authentication", click Browse. Find your
id_rsa.ppk file, open it, then click Open to start the connection.</p>

<p>You should be prompted for your username as before (sysadm), but then
instead of being prompted for a password, you are asked for the passphrase
for your private key. Enter it, and you should be logged in.</p>

<p>This is quite painful (both locating the private key and entering the
passphrase), so as the final step of the exercise we're going automate it
using an agent.</p>

<h2>4. Use a passphrase agent</h2>

<p>Run <code>pageant.exe</code></p>

<p>It runs in the background, and adds an icon to your task tray (a PC with
a black hat at a jaunty angle). You may need to select "Show hidden icons"
to see it.</p>

<p>Right-click on the icon, and select "Add Key". Browse to your id_rsa.ppk
and open it. You will be prompted for the passphrase - enter it. (If you
make a mistake, you'll be prompted again until you get it right)</p>

<p>Now run putty.exe again, enter your hostname, click Open, and enter your
username (sysadm).  You should be logged in immediately, with no prompt for
either a password or a passphrase!</p>

<p>Try logging in again. Also try using psftp.exe (when it runs, enter
"open pcN.ws.nsrc.org" to start a connection). No passphrase is needed
until you tell Pageant to forget the private key.</p>

<h1>For laptops running Linux (or BSD or OSX)</h1>

<h2>1. Generate an ssh public/private key pair</h2>

<pre><code>$ ssh-keygen -t rsa -b 2048
Generating public/private rsa key pair.
Enter file in which to save the key (/home/sysadm/.ssh/id_rsa): &lt;HIT ENTER&gt;
Created directory '/home/sysadm/.ssh'.
Enter passphrase (empty for no passphrase): &lt;CHOOSE PASSPHRASE&gt;
Enter same passphrase again: &lt;SAME PASSPHRASE&gt;
Your identification has been saved in /home/sysadm/.ssh/id_rsa.
Your public key has been saved in /home/sysadm/.ssh/id_rsa.pub.
The key fingerprint is:
32:2b:e3:0e:14:fb:60:38:a6:e2:73:95:53:9d:a8:0f sysadm@pcN.ws.nsrc.org
</code></pre>

<p>The passphrase is used to keep your private key encrypted on disk. It can be
pretty much anything you want and as long as you want - including spaces -
but if you forget it, your key becomes worthless.  For now pick something
that you will easily remember.  You can change it at any time you want in
the future (using <code>ssh-keygen -p</code>)</p>

<p>NOTE: Key generation is a one-off exercise. The more you deploy your public
key, the more work it to be if you were to lose it and have to start again
with a new one.  I suggest you keep a secure backup of it somewhere, e.g. 
on a CD-ROM that you lock away.</p>

<h2>2. Copy the PUBLIC key onto your Unix server</h2>

<p>The simplest way to copy the public key is with scp:</p>

<pre><code>$ scp .ssh/id_rsa.pub sysadm@pcN.ws.nsrc.org:.ssh/authorized_keys
</code></pre>

<p>Note that .ssh/authorized_keys can contain multiple keys, one per line,
so on a shared system you might want to append your key instead:</p>

<pre><code>$ cat .ssh/id_rsa.pub | ssh sysadm@pcN.ws.nsrc.org 'cat &gt;&gt;.ssh/authorized_keys'
</code></pre>

<h2>3. Login using your private key</h2>

<p>Open an ssh connection to your server as normal:</p>

<pre><code>$ ssh sysadm@pcN.ws.nsrc.org
</code></pre>

<p>This time, instead of being prompted for your password, you should be
prompted for the passphrase on your private key. Enter it. You should be
logged in.</p>

<h2>4. Use a passphrase agent</h2>

<p>Entering a passphrase every time you connect would be painful, but this
isn't necessary if you have an agent which decrypts the private key and
keeps it in memory.</p>

<p>If you are running under a modern graphical environment like Gnome, you
probably already got a dialog box prompting you for a passphrase, and this
means you're already running an agent.  You should be able to logout and
login to the remote server, without being prompted for your passphrase
again.</p>

<p>To see what identities (decrypted private keys) your agent has in memory:</p>

<pre><code>$ ssh-add -l
</code></pre>

<p>To forget all identities:</p>

<pre><code>$ ssh-add -d
</code></pre>

<p>If you don't have an agent, then you can start a new subshell with ssh-agent
as its parent:</p>

<pre><code>$ ssh-agent bash
$ ssh-add
... prompted for your passphrase
$
</code></pre>

<p>Now the agent will handle future connections for you.</p>

<p>If you are running an older graphical environment, and you normally start
X using <code>startx</code>, then start it using <code>ssh-agent startx</code> instead. Then type
'ssh-add' in an xterm.</p>

<hr />

<h1>Disable Password Access to your Machine</h1>

<h2>Connect Only With SSH Keys</h2>

<p>Only do this exercise if you have successfully copied your public key to your machine and you
are being prompted for your ssh private key passphrase when you log in and not your password.</p>

<p>Log in on your machine. Once logged in become the root user:</p>

<pre><code>$ sudo bash</pre></code>

<p>As the root user copy authorized_keys file to the directory /root/.ssh.</p>

<pre><code># mkdir /root/.ssh
# chmod 700 /root/.ssh
# cp /home/sysadm/.ssh/authorized_keys /root/.ssh/.
# chown root:root /root/.ssh/authorized_keys
# chmod 644 /root/.ssh/authorized_keys
</pre></code>

<p>Now log out of your machine and try to log back in, but this time as the "root" user, 
not as the "sysadm" user. If you are prompted for your ssh private key passphrase and not a 
password, then you are ready to disable password access to your machine.</p>

<p>Log in on your machine as the root user. Now we are going to edit the file /etc/ssh/sshd_config.</p>

<pre><code># vi /etc/ssh/sshd_config</pre></code>

<p>Insie the file look for the following line:</p>

<code>#PasswordAuthentication yes</code>

<p>Just after this line add a line that says:</p>

<code>PasswordAuthentication no</code>

<p>Save and exit from the file. The reload the ssh server:</p>

<pre><code># service ssh reload</pre></code>

<p>Before logging out we recommend you leave your current session open in case there are problems. You 
could lock yourself out of your machine. If you do let your instructor know. Now use ssh or putty on your laptop 
and try connecting to your server. You should get prompted for your ssh private key's passphrase and 
be able to log in. If you did, everthing is working. At this point all new users on your machine must 
use ssh keys to connect and not passwords. If you wish to verify this you can do the following:</p>

<pre><code># adduser testuser</pre></code>

<p>Answer the on-screen prompts. Once the user has been created and you have given it a new password of 
your choosing, try to open a new ssh session to your machine as that user. You should either be rejected 
or your password attempts will have not affect (depends on the ssh server version).</p>

<p>To log in as this user you would need to copy your public ssh key to their account as we did for 
your sysadm user. This <b>greatly</b> enhances the security of your system.


<hr />

<h1>Additional information [not part of exercises]</h1>

<h2>Agent forwarding</h2>

<p>Using an agent, you can access across multiple ssh hops without having to
copy your key or enter your passphrase anywhere.</p>

<p>If you enable "agent forwarding" when you login to host X, you can then
login from X to Y without any prompting (assuming Y has your public key in
authorized_keys).  The request to authenticate is forwarded securely back
along your original ssh session to the agent running on your workstation.</p>

<p>Under Unix:</p>

<pre><code>$ ssh -o ForwardAgent=yes user@host
</code></pre>

<p>If you do this frequently, it's easier to configure it in <code>.ssh/hosts</code></p>

<pre><code>host foo
hostname foo.example.com
user sysadm
ForwardAgent yes
</code></pre>

<p>Then you only have to type <code>ssh foo</code> to get a connection with those options.</p>

<h2>Advanced: X11 forwarding and port forwarding</h2>

<p>ssh can securely carry arbitrary forwarded TCP connections and X11 graphics.</p>

<pre><code>$ ssh -L8080:some.where:80 user@remote.host
... while ssh connection is open, a connection to 127.0.0.1 port 8080
... will be tunneled, and the far end will open a connection to
... some.where port 80

$ ssh -X user@remote.host
...
$ xclock   # graphical output redirected back through ssh tunnel
</code></pre>