Generating SSH keys in Windows: Difference between revisions

From Alliance Doc
Jump to navigation Jump to search
No edit summary
No edit summary
 
(9 intermediate revisions by 4 users not shown)
Line 6: Line 6:


<!--T:1-->
<!--T:1-->
[[File:Puttygen1.png|400px|thumb| PuTTYgen pre key generation (Click for larger image)]]
[[File:Puttygen1.png|400px|thumb| PuTTYgen before generating a key (Click for larger image)]]
[[File:Puttygen2.png|400px|thumb| PuTTYgen post key generation (Click for larger image)]]
[[File:Puttygen2.png|400px|thumb| PuTTYgen after generating a key (Click for larger image)]]
 
=Generating a key pair= <!--T:14-->


<!--T:2-->
<!--T:2-->
If using PuTTY or MobaXTerm the process of generating a key is nearly the same with only minor differences. In MobaXTerm go to the Tools->MobaKeyGen (SSH key generator), and with PuTTY run the PuTTYGen executable both of these methods will result in displaying a very similar window which can be used to generate or load an existing key.
The process of generating a key is nearly the same whether you are using PuTTY or MobaXTerm.  
* With MobaXTerm, go to the menu item Tools->MobaKeyGen (SSH key generator)
* With PuTTY, run the PuTTYGen executable.
Both of these methods will cause a window to be displayed which can be used to generate a new key or to load an existing key.
The PuTTY window is illustrated at right.  The MobaXTerm window looks almost exactly the same.


=Generating a key pair= <!--T:3-->
<!--T:3-->
# Select 'Ed25519' (RSA 2048 bits and above is acceptable too).
# For "Type of key to generate" select "Ed25519".  (Type "RSA" is also acceptable, but set the "Number of bits" to 2048 or greater.)
# Click the "Generate" button. You will then be asked to move your mouse around to generate random data to be used to create the key.
# Click the "Generate" button. You will then be asked to move your mouse around to generate random data to be used to create the key.
# Enter a passphrase for your key.
# Enter a passphrase for your key.  Remember this passphrase, you will need it every time you reload PuTTY or MobaXTerm to use this key pair.
# Click the "Save private key" button and choose a meaningful file name (e.g. compute_canada.ppk).
# Click "Save private key" and choose a meaningful file name; the extention <code>.ppk</code> is added to the file name. (e.g. compute_canada.ppk).
# Click "Save public key".  It is conventional to save the public key with the same name as the private key, but here, the extension is <code>.pub</code>.


=Installing the public part of the key pair= <!--T:6-->
=Installing the public part of the key pair= <!--T:6-->
==Installing via CCDB==
 
==Installing via CCDB== <!--T:15-->


<!--T:10-->
<!--T:10-->
We encourage all users to leverage the new CCDB feature to upload their SSH public key. Grab the content from the text box under "Public key for pasting into OpenSSH authorized_keys" and upload it to CCDB as per instructions in [[SSH_Keys#Installing_your_key| SSH Keys Installing your key]] in the section "Using CCDB", STEP 3.
We encourage you to register your SSH public key with the CCDB.  This will let you to use it to log in to any of our HPC clusters. Copy the contents of the box titled "Public key for pasting into OpenSSH ..." and paste it into the box at [https://ccdb.computecanada.ca/ssh_authorized_keys CCDB -> Manage SSH Keys].  For more about this, see [[SSH_Keys#Using_CCDB| SSH Keys: Using CCDB]].
 
==Installing locally== <!--T:16-->


==Installing locally== <!--T:11-->
<!--T:11-->
This method below is still available, but we encourage all users to [[Generating_SSH_keys_in_Windows#Installing via CCDB|install it via CCDB]].
If for some reason you do not want to use the CCDB method, you may upload your public key onto <em>each</em> cluster as follows:
If for some reasons you still want to upload the public key locally on a specific cluster, the steps are described below:


<!--T:13-->
<!--T:13-->
# Add the public key from the text box under "Public key for pasting into OpenSSH authorized_keys", by copying and pasting it, as a single line to the end of the <code>/home/USERNAME/.ssh/authorized_keys</code> on the server you wish to connect to as the user <code>USERNAME</code> with WinSCP or an editor launched from that server such as vim or nano.
# Copy the contents of the box titled "Public key for pasting into OpenSSH ..." and paste it as a single line at the end of <code>/home/USERNAME/.ssh/authorized_keys</code> on the cluster you wish to connect to.
# Ensure directory, file permissions are correct and have the correct owner as described in steps 2 and 3 of [[Using SSH keys in Linux#Connecting using a Key Pair|these instructions]].
# Ensure the permissions and ownership of the <code>~/.ssh</code> directory and files therein are correct, as described in [[Using SSH keys in Linux#Installing_locally|these instructions]].
 
<!--T:17-->
You may also use <code>ssh-copy-id</code> for this purpose, if it is available on your personal computer.
 
=Connecting using a key pair= <!--T:18-->
 
<!--T:12-->
Test the new key by connecting to the server using SSH.
See [[Connecting with PuTTY#Using a Key Pair| connecting with PuTTY using a key pair]]; [[Connecting with MobaXTerm#Using a Key Pair| connecting with MobaXTerm using a key pair]]; or [https://winscp.net/eng/docs/ui_login_authentication connecting with WinSCP].


<!--T:4-->
<!--T:4-->
Key generation and usage is demonstrated in this youtube video with PuTTY: [https://www.youtube.com/watch?v=2nkAQ9M6ZF8 Easily setup PuTTY SSH keys for passwordless logins using Pageant].
Key generation and usage with PuTTY is demonstrated in this video : [https://www.youtube.com/watch?v=2nkAQ9M6ZF8 Easily setup PuTTY SSH keys for passwordless logins using Pageant].
 
=Connecting using a key pair= <!--T:12-->
Test the new key by connecting to the server as <code>USERNAME</code> using ssh (see [[Connecting with PuTTY#Using a Key Pair| connecting with PuTTY using a key pair]] or [[Connecting with MobaXTerm#Using a Key Pair| connecting with MobaXTerm using a key pair]]).


=Converting an OpenStack key= <!--T:19-->


=Converting an OpenStack key= <!--T:5-->
<!--T:5-->
When a key is created on [[OpenStack]] you obtain a key with a ".pem" extension. This key can be converted to a format used by PuTTY by clicking the "Load" button in PuTTYGen. Then select the "All Files (*.*)" filter and select your ".pem" file downloaded from OpenStack and click "Open". You should also add a "Key passphrase" at this point to use when accessing your private key and then click "Save private key".
When a key is created on [[Managing_your_cloud_resources_with_OpenStack|OpenStack]] you obtain a key with a ".pem" extension. This key can be converted to a format used by PuTTY by clicking the "Load" button in PuTTYGen. Then select the "All Files (*.*)" filter, select the ".pem" file you downloaded from OpenStack, and click "Open". You should also add a "Key passphrase" at this point to use when accessing your private key and then click "Save private key".


<!--T:7-->
<!--T:7-->
This private key can be used with PuTTY to connect to a VM that OpenStack injects with the matching public key under the "Key Pairs" tab under the "Access & Security" tab when launching a new VM. You can read more about connecting using [[Connecting with PuTTY#Connecting Using a Key Pair | PuTTY]] or [[Connecting with MobaXTerm#Using a Key Pair | MobaXterm]].
This private key can be used with PuTTY to connect to a VM created with OpenStack. For more about this, see "Launching a VM" on the [[Cloud Quick Start]] page.


<!--T:8-->
<!--T:8-->
[[Category:Connecting]] [[Category:Pages with video links]]
[[Category:Connecting]] [[Category:Pages with video links]]
</translate>
</translate>

Latest revision as of 20:50, 31 January 2023

Other languages:

Parent page: SSH

PuTTYgen before generating a key (Click for larger image)
PuTTYgen after generating a key (Click for larger image)

Generating a key pair[edit]

The process of generating a key is nearly the same whether you are using PuTTY or MobaXTerm.

  • With MobaXTerm, go to the menu item Tools->MobaKeyGen (SSH key generator)
  • With PuTTY, run the PuTTYGen executable.

Both of these methods will cause a window to be displayed which can be used to generate a new key or to load an existing key. The PuTTY window is illustrated at right. The MobaXTerm window looks almost exactly the same.

  1. For "Type of key to generate" select "Ed25519". (Type "RSA" is also acceptable, but set the "Number of bits" to 2048 or greater.)
  2. Click the "Generate" button. You will then be asked to move your mouse around to generate random data to be used to create the key.
  3. Enter a passphrase for your key. Remember this passphrase, you will need it every time you reload PuTTY or MobaXTerm to use this key pair.
  4. Click "Save private key" and choose a meaningful file name; the extention .ppk is added to the file name. (e.g. compute_canada.ppk).
  5. Click "Save public key". It is conventional to save the public key with the same name as the private key, but here, the extension is .pub.

Installing the public part of the key pair[edit]

Installing via CCDB[edit]

We encourage you to register your SSH public key with the CCDB. This will let you to use it to log in to any of our HPC clusters. Copy the contents of the box titled "Public key for pasting into OpenSSH ..." and paste it into the box at CCDB -> Manage SSH Keys. For more about this, see SSH Keys: Using CCDB.

Installing locally[edit]

If for some reason you do not want to use the CCDB method, you may upload your public key onto each cluster as follows:

  1. Copy the contents of the box titled "Public key for pasting into OpenSSH ..." and paste it as a single line at the end of /home/USERNAME/.ssh/authorized_keys on the cluster you wish to connect to.
  2. Ensure the permissions and ownership of the ~/.ssh directory and files therein are correct, as described in these instructions.

You may also use ssh-copy-id for this purpose, if it is available on your personal computer.

Connecting using a key pair[edit]

Test the new key by connecting to the server using SSH. See connecting with PuTTY using a key pair; connecting with MobaXTerm using a key pair; or connecting with WinSCP.

Key generation and usage with PuTTY is demonstrated in this video : Easily setup PuTTY SSH keys for passwordless logins using Pageant.

Converting an OpenStack key[edit]

When a key is created on OpenStack you obtain a key with a ".pem" extension. This key can be converted to a format used by PuTTY by clicking the "Load" button in PuTTYGen. Then select the "All Files (*.*)" filter, select the ".pem" file you downloaded from OpenStack, and click "Open". You should also add a "Key passphrase" at this point to use when accessing your private key and then click "Save private key".

This private key can be used with PuTTY to connect to a VM created with OpenStack. For more about this, see "Launching a VM" on the Cloud Quick Start page.

Compute Canada Data Base

Retrieved from "https://docs.alliancecan.ca/mediawiki/index.php?title=Generating_SSH_keys_in_Windows&oldid=128613"