SSH Keys

This guide will take you through everything related to the management of SSH Keys in Keystash. Each user has access to their keys only. Administrators cannot access other users keys, only their own.

A user will require an SSH Key to access a server. Users in Keystash cannot access servers with password only access.

You can read more about the different types of SSH keys here.

Create a SSH Key

A user will require an SSH Key to access a server. Keystash can create an strong and secure SSH key pair for you:

1. Click "Keys and Codes" on the menu and then "SSH Keys".

2. If you don't have any keys already created then you will be prompted to "Create" or "Upload" a key. Otherwise click "Add SSH Key" on the top left of the table.

   

3. Click the "Create" button.

4. Provide a name for the key that will help you distinguish this key from others.

5. Enter in a passphrase for the key, this is basically a password to be able to use this key. Setting a passphrase will encrypt the key for the highest security, however this is not required, you can elect to not use a passphrase.

   Note

   Encrypted keys need to be unencrypted before using them by entering in the passphrase. Ensure you save your passphrase in a safe place.

6. "Advanced Options" allows you to choose the key bit length. Larger bit lengths create more secure keys however they take significantly longer to generate. Keystash will create a strong key by default, so you don't have to change the default setting. You can read more about the different types of SSH keys here.

7. Click "Create Key" and wait for the key to generate. This can take a while as your browser will generate the key and the time required depends on the speed of your computer.

8. Once the key has been created you are then provided with two options to download the private key. If you are using Windows and Putty as your terminal, then download the Putty version. Otherwise download the OpenSSH format which will work with most SSH terminal applications on Linux, Mac and Windows.

   

Upload a SSH Key

If you already have a SSH key pair that you will like to use with Keystash then simply upload the public key into Keystash.

1. Click "Keys and Codes" on the menu and then "SSH Keys".

2. If you don't have any keys already created then you will be prompted to "Create" a key or "Upload" a key. Otherwise click "Add SSH Key" on the top left of the table.

   

3. Click the "Upload" button.

4. Provide a friendly name for the key that will help you distinguish this key from others.

5. Copy and paste the text from your public key into the "Public Key" box. Once you have pasted the key, click outside the "Public Key" box, Keystash will read the key and let you know if the key is valid and provide you with any suggestions in terms of it's strength and compatibility. You can read more about the different types of SSH keys here.

   

6. Click "Save" to complete the upload process. Your Public key has now been saved into Keystash and will be distributed to the servers you have been given access to.

Edit a SSH Key

If you would like to change the name of your SSH key or upload a new public key then you can use the edit page to change an existing SSH Key.

1. Click "Keys and Codes" on the menu and then "SSH Keys".
2. Click "Edit" in the actions column of the SSH key you would like to edit.
3. You can now change the "Name" of the key and upload a new key into the "Public Key" box.

4. Click "Save" to complete your changes.

   

Delete a SSH Key

To delete a users SSH key off all servers:

1. Click "Keys and Codes" on the menu and then "SSH Keys".
2. Click "Delete" in the actions column of the SSH Key you would like to delete.
3. Click "Yes, please!" when prompted.