Changes between Version 51 and Version 52 of Documentation/bAccountManagement/DSSHConf

Timestamp:

Jun 21, 2018, 8:59:31 PM (6 years ago)

Author:

jkol

Comment:

—

Documentation/bAccountManagement/DSSHConf

@@ -14 +14 @@
 [[CollapsibleStart(Linux)]]
 
-''NOTE: These instructions are NOT for Ubuntu installed using Windows Susbsystem for Linux (WSL).''
+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:
+{{{
+sudo apt-get update
+sudo apt-get install openssh-client
+}}}
+
+''NOTE: These instructions are NOT for Ubuntu running on Windows using Windows Subsystem for Linux (WSL).''
 
 ==== Generating keys ====
@@ -23 +29 @@
 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. This passphrase will protect your private key while it's stored on the hard drive:
+ 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.
@@ -38 +44 @@
 [[BR]]
 ==== 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/loginService/ControlPanel]
- 1. Click on "Change My Profile" option in the left side menu
- 1. Click the "Choose File" button next to "Public key file"
- 1. Navigate to where your public key file is stored (typically /home/your_username/.ssh)
- 1. Select the .pub file corresponding to the key you wish to use for ORBIT access
- 1. Click "Open"
- 1. Click the "Update Profile" button
-
- As a side note, expect to see a default auto generated ORBIT 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.
+
+ 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 /home/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)]]
@@ -81 +92 @@
 
 [[CollapsibleEnd]]
-[[BR]]
+
+[[BR]]
+
 [[CollapsibleStart(Windows)]]
-==== PuTTY ====
-
-In putty the key generation is handled by a separate program named puttygen.exe. If you've installed putty via the installer there may be an icon for it in the putty menu group, otherwise download it [http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html here]. Generating a public/private key pair on your host by using PuTTYgen as illustrated in the following table (for more details on configuration please csee [http://www.chiark.greenend.org.uk/~sgtatham/putty/ putty documentation]):
-
-|| 1. || Start PuTTYgen; The running executable windows is shown on the left.  || [[Image(PuTTYgen1.jpg, width=300)]] ||
-|| 2. || Click the Generate button. You will be asked to move mouse to generate some randomness. After that the program will generate key and display the result.[[BR]] You can leave blank "Key passphrase" and "Confirm passphrase" to be able to authenticate without passphrase.[[BR]] Save public and private key (you can recover the public key from the private key with PuTTYgen by clicking the Load button). || [[Image(PuTTYgen2.jpg, width=300)]] ||
-|| 3. || [#Upload Upload] your new public key to your orbit account. ||||
-|| 4. || To connect to remote host by using newly minted keys configure your session in PuTTY: '''Load''' the session profile, go to Connection > SSH > Auth window and select the newly created private key; click '''Save''' to update session profile and then proceed to connect. If you didn't specify the passphrase in step 2, you won't be prompted for the password.  || [[Image(PuTTYgen5.jpg, width=300)]] ||
-
-==== SSH Secure Shell ====
-
-|| 1. || Start the ssh client || [[Image(SecSh1.jpg, width=300)]][[BR]] ||
-|| 2. || From the menu choose Edit> Settings option and then Key || [[Image(SecSh2.jpg, width=300)]] ||
-|| 3. || Click the Generate button, click Next, select RSA type of the key and click Next and wait until key is generated || [[Image(SecSh3.jpg,width=300)]] ||
-|| 4. || Enter file name for private key and comment. Leave passphrase blank. Click Next, Next and then save public key into file by clicking Export button and then click Finish || [[Image(SecSh6.jpg, width=300)]] ||
-|| 5. || [#Upload Upload] your new public key to your orbit account. ||||
-|| 6. || After you upload public key you can connect to host choosing Public Key option for Authentication Method. ||[[Image(SecSh8.jpg, width=300)]] ||
+
+These instructions assume that you are using [https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html PuTTY] as your SSH client.
+
+==== Generating keys ====
+ In PuTTY, the key generation is handled by a separate program named ''puttygen.exe''. If you installed PuTTY via the installer, there should be an icon for PuTTYgen in your Start menu, otherwise [http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html download it from here].
+
+ 1. Open PuTTYgen
+
+ 2. Click the "Generate" button and follow the instructions in the "Key" section of the window
+
+ 3. Type a passphrase of your choice in the "Key passphrase" and "Confirm passphrase" fields. This passphrase does not have to be the same as your ORBIT account password.
+
+ 4. Click the "Save private key" button
+
+ 5. Save the private key file somewhere you will remember on your computer. Do not share this key with anyone!
+
+ 6. After saving the private key file, right-click in the big text box labeled "Public key for pasting into OpenSSH authorized_keys file"
+
+ 7. Click "Select All" from the popup menu to highlight the entire public key
+
+ 8. Right-click again in the same big box and select "Copy" from the popup menu
+
+ 9. Open Notepad from your Start menu
+
+ 10. Paste what you just copied from PuTTYgen into Notepad. The contents should start with {{{ssh-rsa}}} and end with something like {{{rsa-key-20180621}}}
+
+ 11. Save this file somewhere you will remember on your computer. This is your public key file.
+
+ 12. Close PuTTYgen
 
 [[BR]]
@@ -107 +132 @@
  To upload you public key to your orbit account, do the following:
  1. Go to [https://www.orbit-lab.org/loginService/ControlPanel]
- 1. Click on "Change My Profile" option in the left side menu
- 1. Click the "Choose File" button next to "Public key file"
- 1. Navigate to where your public key file is stored (typically /home/your_username/.ssh)
- 1. Select the .pub file corresponding to the key you wish to use for ORBIT access
- 1. Click "Open"
- 1. Click the "Update Profile" button
-
- As a side note, expect to see a default auto generated ORBIT 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.
+
+ 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 (the file you saved with Notepad in the previous section)
+
+ 5. Select the public key file 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)]]
 
+[[BR]]
+==== Configuring your SSH client ====
+
+ 1. Open PuTTY
+
+ 2. 
+|| 4. || To connect to remote host by using newly minted keys configure your session in PuTTY: '''Load''' the session profile, go to Connection > SSH > Auth window and select the newly created private key; click '''Save''' to update session profile and then proceed to connect. If you didn't specify the passphrase in step 2, you won't be prompted for the password.  || [[Image(PuTTYgen5.jpg, width=300)]] ||
+
+[[BR]]
+==== Common issues and how to solve them ====
+ * TODO
+
 [[CollapsibleEnd]]
-[[BR]]
+
+[[BR]]
+
 [[CollapsibleStart(Mac)]]
-TODO
+Mac instrucstions are currently under development. We apologize for the inconvenience.
+
+==== Generating keys ====
+ TODO
+
+[[BR]]
+==== Uploading your public key to you ORBIT account ====
+ To upload you public key to your orbit account, do the following:
+ 1. Go to [https://www.orbit-lab.org/loginService/ControlPanel]
+
+ 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 /home/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)]]
+
+[[BR]]
+==== Configuring your SSH client ====
+ TODO
+
+[[BR]]
+==== Common issues and how to solve them ====
+ * TODO
 [[CollapsibleEnd]]