Changes between Version 70 and Version 71 of Documentation/bAccountManagement/DSSHConf

Timestamp:

May 31, 2022, 8:01:40 PM (2 years ago)

Author:

yuezhenglingluan

Comment:

Add a new method for ssh into orbit on Windows

Documentation/bAccountManagement/DSSHConf

@@ -13 +13 @@
 
 [[CollapsibleStart(Linux)]]
-''NOTE: These instructions are NOT for Ubuntu running on Windows using Windows Subsystem for Linux (WSL).''
+''NOTE: These instructions are NOT for Ubuntu running on Windows using Windows Subsystem for Linux (WSL).
+
+Tested and this method works for Ubuntu running on Windows Subsystem for Linux 2 (WSL2)''
 
 These instructions assume you will be using a standard command-line SSH client for linux. If you have not already done so, ensure that you have it installed by running the following commands in a command-line terminal:
@@ -97 +99 @@
 
 [[CollapsibleStart(Windows)]]
+
+Method 1 uses the components integrated into Windows and doesn't need any additional software to be installed
+
+Method 2 uses Putty and requires Putty to be installed 
+[[CollapsibleStart(Method 1)]]
+==== Install OpenSSH client on your Computer ====
+These instructions assume that you are using a currently supported version of Windows 10 and Windows 11
+
+1. Go to Settings-->Apps-->Optional Features] in Windows Settings.
+
+2. If "OpenSSH Client" is listed under the Installed features, you are all set and can go to the next step.
+
+3. If "OpenSSH Client" is not listed under the Installed features, click on the View features button right next to the Add an optional feature text.
+
+4. In the Search bar on top of the Add an optional feature, type in "OpenSSH Client", and click on the checkbox next to it, and click next.
+
+5. Review details of what will be installed and click Install.
+
+6. Wait for it to be installed, you might need to restart your PC according to what it says in Settings.
+
+==== Generating keys ====
+1. Open Powershell in Windows as Admin.
+
+''Steps 2-5 is to make sure that you save your key files in the correct location''
+
+2. Type in 
+{{{
+cd C:\Users
+}}}
+
+3. Type in 
+{{{
+ls
+}}}
+to see what is your user name
+
+4. Type in 
+{{{
+cd <your Username>
+}}}
+
+5. Type in
+{{{
+cd .ssh
+}}}
+(if this folder doesn't exist then create it)
+
+6. type in
+{{{
+ssh-keygen -t rsa
+}}}
+ You will be prompted for a location to save the keys, and a passphrase for the keys which we highly recommend using. This passphrase does not have to be the same as your ORBIT account password.
+{{{
+Generating public/private rsa key pair.
+Enter file in which to save the key (...):
+Enter passphrase (empty for no passphrase):
+Enter same passphrase again:
+Your identification has been saved in ...
+Your public key has been saved in ...
+The key fingerprint is:
+SHA256:...
+The key's randomart image is:
+...
+}}}
+
+==== Uploading your public key to your ORBIT account ====
+ To upload you public key to your orbit account, do the following:
+ 1. Go to [https://www.orbit-lab.org/cPanel/controlPanel/start] and sign in with your ORBIT username and password
+
+ 2. Click on "Change My Profile" option in the left side menu
+
+ 3. Click the "Choose File" button next to "Public key file"
+ 
+ 4. Navigate to where your '''public key file''' is stored (typically C:\Users\your_username\.ssh)
+
+ 5. Select the .pub file corresponding to the key you wish to use for ORBIT access
+
+ 6. Click "Open"
+
+ 7. Click the "Update Profile" button
+
+ As a side note, expect to see a default auto generated public key in the list (ends with @internal1). This is used for SSH access between machines inside the ORBIT network. Please do NOT delete this key.
+
+ [[Image(ControlPanel.jpg, width=700)]]
+
+==== Configuring your SSH client ====
+  Under normal circumstances, as long as the private key file is located in the C:\Users\your_username\.ssh\ folder, the command line SSH client will use the correct key when connecting.
+ To test your setup, open Powershell and (replacing ''your_orbit_username'' with your own ORBIT username) type:
+{{{
+ssh your_orbit_username@gw.orbit-lab.org
+}}}
+ You should be prompted to enter your key file passphrase and be able to successfully connect.
+
+ Type {{{exit}}} and press the Enter key to end the SSH session.
+
+[[BR]]
+==== Common issues and how to solve them ====
+ * If you receive a message like the following:
+{{{
+The authenticity of host 'gw.orbit-lab.org (128.6.192.134)' can't be established.
+ECDSA key fingerprint is SHA256:iLKtq2Z8wB3ADJdEyM1CwoU85gOeqIUyB4GOJ2YloQg.
+Are you sure you want to continue connecting (yes/no)?
+}}}
+ This is a normal message that occurs when your computer connects via SSH to another that it has never connected to before or if the "fingerprint" of the other machine changed (due to replacement or reconfiguration). Simply type {{{yes}}} and connection will proceed normally.
+[[BR]]
+ * If you receive a message like the following:
+{{{
+Permission denied (publickey).
+}}}
+ Try connecting again but manually specifying the location where your private SSH key is stored as in the following example:
+{{{
+ssh -i /path_to_where_key_is_stored/private_ssh_key_name your_orbit_username@gw.orbit-lab.org
+}}}
+[[CollapsibleEnd]]
+[[CollapsibleStart(Method 2)]]
 These instructions assume that you are using [https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html PuTTY] as your SSH client.
 
@@ -207 +324 @@
  This is a normal message that occurs when your computer connects via SSH to another that it has never connected to before or if the "fingerprint" of the other machine changed (due to replacement or reconfiguration). Simply type {{{yes}}} or click "Yes" and connection will proceed normally.
 [[BR]]
+
+[[CollapsibleEnd]]
 
 [[CollapsibleEnd]]