SSH Keys
========

SSH Keys are encryption keys which grant access to servers using the **S**\ecure **SH**\ell protocol.  
They are more secure than using regular passwords, and strongly recommended.  

Keys added to your account appear on the :doc:`slice create <../slices/create>` pages.  You can select
SSH keys to preinstall on your slice, eliminating the need for passwords.  

.. Note::
    When creating a slice, all SSH keys account-wide are presented to :ref:`Admin <users_overview>` 
    users.  For :ref:`subusers <users_overview>`, only their own SSH keys are available.  

.. Hint::
   You can add *any* public SSH key.  For example if you have a subcontractor, they can send you their 
   public key and you can add it to your account.  You can then preinstall their key(s) when 
   :doc:`creating slices <../slices/create>`.  Regular :doc:`users <../users/index>` can use the same 
   method, so they can preinstall their team members keys onto servers they create.


SSH Key List
------------

.. image:: ../_static/images/ssh_key_list.png
    :target: ../_static/images/ssh_key_list.png

The SSH Keys page displays a list of all your current keys and their MD5 fingerprints for verification.
SSH key fingerprints can be verified by running the following command on the key(s), and comparing: 

.. code-block:: shell

    ssh-keygen -E md5 -lf PUBLIC_KEY_FILENAME.pub


Add an SSH Key
--------------

Click :guilabel:`Add SSH Key` to add a key to the system.  A window will open requesting the following:
    
#. **Name**: Give your key a name.
#. **SSH Public Key**: Paste your SSH Public Key here.

Click :guilabel:`Add SSH Key` at the bottom of the window, and it should appear in your SSH Key List.


Delete an SSH Key
-----------------

You can **delete** a key from your SSH Key List by clicking ``Delete`` in the row for that key.

.. Caution::
    Deleting a key only deletes it from the system for future creates.  *It has no effect on slices 
    that already have the key installed.*