Never share your private ssh keys even with Support staff. Your private ssh key works as your password and it must be kept in a non-shareable space with r/w permissions at the owner level (-rw------- or 600).

Introduction

After a new account is created on HiPerGator (HPG) you, as the account's owner, can log in using your credentials (GatorLink username and password for UF users). Mis-typing the credentials several times will result in a security system block of the user's IP address and can be slow. For convenience and speed, it may be useful to set up a SSH key pair to use. If you're on windows you can accomplish this with Putty instead following the guide at Create SSH Keys Using Putty.

SSH key pair means there are two keys:

A private key is stored in the ~/.ssh/ directory on the computer you are connecting from
1. The private key acts as the identity file (the key part of the lock/key mechanism).
2. Use a good passphrase to protect the private key in case it is accessed by someone else
3. Use an SSH agent to store it, so you only have to type the passphrase in once when starting the computer or the terminal application.
A public key gets copied to every system you want to connect to and can be described as a specification for the 'lock' part of the lock/key ssh mechanism to allow the receiving computer connections to your account from a system that uses the private key part of the pair as its identify file.

The private key is not used automatically, although most systems are configured to use ~/.ssh/id_rsa by default. See how to configure your ssh setup to use the correct private key as the IdentityFile below.

Create SSH Keys

Note: You can also use a text editor (vi, vscode, etc) in a terminal or a console session in Open OnDemand to edit ~/.ssh/authorized_keys file. On MacOS these steps can be done using either the built-in MacOS terminal application or iTerm2.

The default cipher for ssh keys is RSA. However, this no longer recommended as it is less secure. We recommend users to use a ED25519 cipher when generating new keys in HiPerGator.

Generate a key on Linux/Mac

ssh-keygen -o -a 100 -t ed25519 -f ~/.ssh/id_ed25519 -C "Comment to make the key recognizable among many"

Generate key from Windows Command Line

ssh-keygen -t ed25519 -C "Comment to make the key recognizable among many"

SSH Keys Permissions

Learn more about Linux file permissions at (external resource): Linux File Permissions Explained.

SSH requires a certain permission configuration for files in the ~/.ssh path. SSH refuses connection to HPG if the permission of said files doesn't match the expected value, resulting in output such as:

@         WARNING: UNPROTECTED PRIVATE KEY FILE!          @
Permissions (XXXX) for '/home/*******/.ssh/id_rsa' are too open.
It is required that your private key files are NOT accessible by others.
This private key will be ignored.
Load key "/home/******/.ssh/id_rsa": bad permissions
"******@hpg.rc.ufl.edu": Permission denied (publickey).
Your connection to the remote server has been terminated.

If you're having issues with SSH, try accessing HPG using Open OnDemand's console and ensure that your files are set as follows:

    [$USER@login12~]$ ls -la ~/.ssh
    ...
    -rw-r--r--  1 ... authorized_keys
    -rw-------  1 ... id_ed25519
    -rw-r--r--  1 ... id_ed25519.pub
    -rw-------  1 ... known_hosts

If your permission configuration looks different, run the chmod command to adjust the permissions. I.e.:

    [$USER@login12~]$ chmod 644 authorized_keys

Where:

644 = -rw-r--r--

600 = -rw-------

It is also recommended to check the permissions on the .ssh directory as well:

[$USER@login12 ~]$ chmod 650 /home/$USER/.ssh

If your ~/.ssh directory is missing the "authorized_keys" file, you should create it and populated with the contents of your public ($ cat ~/.ssh/id_ed25519.pub) either by copy/paste or $ cat ~/.ssh/id_ed25519.pub > authorized_keys.

SSH Configuration

Add the following configuration at the top of the ~/.ssh/config file.

Host *
  AddKeysToAgent yes
  IdentityFile ~/.ssh/id_ed25519

If you're on Mac, add new line with
- ```
UseKeychain yes
```

If you're on Mac/ Linux, add the following under the previous text in config, but replace your username in the User line. A convenient configuration for your ssh client on your local computer. In all commands below you can now use 'hpg' instead of USER@hpg.rc.ufl.edu. If you would like to use multiplexing, consider following the guide at SSH Multiplexing
Windows users only need to add port 2222 to the config they added at setup, but can paste it all if that was not done.

Host hpg
    User albertgator
    HostName hpg.rc.ufl.edu
    Port 2222
    ControlPath ~/.ssh/cm-%r@%l-%h:%p
    ControlMaster auto

Enable Key Access on HPG

Configure your account on HiPerGator to accept the key instead of the username/password. If you are already logged in you can manually edit the ~/.ssh/authorized_keys file and add the new public ssh key.

Alternatively on Mac or Linux, you can type the following command on your local computer, replacing your username for USER.
- ```
ssh-copy-id -i ~/.ssh/id_ed25519 USER@hpg.rc.ufl.edu
```
In order to enable key-based login to HPG on Windows, you will need to copy the public key content into your authorized_keys file on HPG. To do this you will need to SSH as explain in Intefaces. From the hpg terminal, type the following to edit your authorized_keys file. Note: You can also use a text editor in a terminal or a console session in Open OnDemand to edit ~/.ssh/authorized_keys file.
- ```
nano $HOME/.ssh/authorized_keys
```
There will likely already be entries for keys that were generated for your account automatically. Please select copy the data from your locally generated key file in .ssh folder. Use the arrow keys to navigate to the bottom of the list in the authorized_keys file and paste the data using right click. After you have pasted the information in the file, press the CTRL and o keys at the same time followed by Enter to write out the file. Then press the CTRL and x keys at the same time to exit the editor.

Congratulations your key is now authorized to login to your account on HPG.

SSH to HPG Using SSH Keys

To SSH into HPG using SSH keys use the following command: ssh -p 2222 username@hpg.rc.ufl.edu

Note: Federated users must use the default port 22 with ssh key authentication. If you are a federated user do not specify the port in your command.

Using SSH Keys To Access HPG