ARDEN-documentation/arednHow-toGuides/puttygen_ssh_keys.rst

=============================
Use PuTTYGen to Make SSH Keys
=============================

This How-to will show you a method for generating SSH key pairs on a Windows computer, saving them to a USB flash drive, installing the SSH key on an AREDN |trade| node and using the SSH keys with a PuTTY terminal session.

The use of Secure Shell (SSH) keys when using PuTTY or another SSH client is a useful aid to managing a group of AREDN |trade| nodes.

First, obtain the PuTTY suite of applications from the `PuTTY Download Page <https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html>`_ and install them on your computer.

Second, obtain and prepare to use a text editor such as `Notepad++ <https://notepad-plus-plus.org/downloads/>`_ that does not insert unwanted characters and metadata into a text file.

Next, follow the steps below.

1. Start the PuTTYGen application. Confirm that you are going to generate an SSH-2 RSA key.

.. image:: _images/01A-puttygen.png
   :alt:  Confirm SSH-2 RSA key
   :align: center

2. Select the *Generate* button to get the prompt asking you to make some random mouse movements. After a short while you get a message asking you to wait while the keys are generated. It finishes and you now have a new key pair.

.. image:: _images/02-puttygen.png
   :alt:  Generate some randomness
   :align: center

3. Give the key pair a suitable comment so that you will remember what the keys are used for. Here we just entered testkey@wu2s.com for an example. Whatever you enter in the "Key Comment" field must look like an email address with no spaces and the "@" present as in *callsign@example.com*. Also enter a suitable passphrase to use when accessing the private key. Record this passphrase so you will remember it for future use.

.. image:: _images/06-puttygen.png
   :alt:  Label key pair and create pass phrase
   :align: center

4. Now copy and save the public key. Open Notepad++ and confirm that the End Of Line (EOL) format is set to UNIX/OSX Format. This will ensure that there are no extraneous characters in the public key file.

.. image:: _images/07-puttygen.png
   :alt:  Create new file for public key
   :align: center

5. Back in your PuTTYGen window, select and copy (Control-C) the complete text in the boxed labeled “Public key for pasting into OpenSSH authorized keys file”

.. image:: _images/08-puttygen.png
   :alt:  Select public key for copying
   :align: center

6. Switch back to your Notepad++ window and Paste (Control-V) the public key text you just copied from PuTTYGen.

.. image:: _images/09-puttygen.png
   :alt: Paste public key into file
   :align: center

7. From the Notepad++ menu bar, select File -> Save As to save the public key to a suitable location. Many people save their keys on a USB flash drive to maintain physical possession of them at all times. Give the public key file a suitable name. You can exit Notepad++ now since you will not need it again.

.. image:: _images/10-puttygen.png
   :alt: Save public key
   :align: center

8. Switch back to the PuTTYGen window again and select the “Save Private Key” button. This will let you save the private key just as you did in the previous step with the public key. You are finished generating and saving your SSH keys. Exit PuTTYGen.

.. image:: _images/11-puttygen.png
   :alt: Save private key
   :align: center

9. In order to use your new SSH key pair, login to your AREDN |trade| node and go to the *Setup -> Administration* screen. At the bottom you will see the Authorized SSH Keys section where you will install the public keys to use on this node.

.. image:: _images/12-puttygen.png
   :alt: Node Administration page
   :align: center

10. When you press the Select File button you see a dialog box which enables you to locate the public SSH key that you want to install.

.. image:: _images/13-puttygen.png
   :alt: Select key to install
   :align: center

11. After choosing the desired public key file. Select the *Upload* button to install the key on the AREDN |trade| node.

.. image:: _images/14-puttygen.png
   :alt: Upload and install key
   :align: center

12. After installing the new public key, confirm that it is ready for use by looking in the dropdown list at the *Remove Key* section. If your SSH key filename appears, then it is installed properly. DO NOT remove it. In the example below there are two SSH keys currently installed on this node.

.. image:: _images/15-puttygen.png
   :alt: Confirm that node has SSH key
   :align: center

13. To use your SSH keys, open a new PuTTY session. In the Hostname box enter *localnode* and in the Port box enter 2222. It is helpful to save this session definition as something you will remember. Select the Save button.

.. image:: _images/16-puttygen.png
   :alt: Create new Putty session
   :align: center

14. Now, using the menu at the left, go to the SSH section and then select the *Auth* item. This shows a number of Options. The only one we need is the very last – the location of the Private key file for authentication. Browse for it and select the correct filename as before. Remember that the PRIVATE key files end in .ppk  Go back to top of the menu on the left and select *Session*.
SAVE the session definition again.

.. image:: _images/17-puttygen.png
   :alt: Session definition, location of private key
   :align: center

15. Now you can use the session information you saved by clicking the *Load* or *Open* button in the main PuTTY session screen. This will open a terminal session box as shown below. Login to the AREDN |trade| node as `root`.

.. image:: _images/18-puttygen.png
   :alt: Login as root
   :align: center

16. If you configured the PuTTY session correctly, it will find your private key file and ask you for the passphrase. If PuTTY cannot find the private key file, it will revert to prompting you for the `root` password that you normally use on the node.

.. image:: _images/19-puttygen.png
   :alt: Enter passphrase to use SSH key
   :align: center

17. The correct passphrase was entered. The node’s banner appears in the terminal session window and you can now do any command line tasks on the node.

.. image:: _images/20-puttygen.png
   :alt: Logged into node
   :align: center


.. |trade|  unicode:: U+00AE .. Registered Trademark SIGN
   :ltrim: