diff --git a/docs/additional-resources/amc_ssh_auth.md b/docs/additional-resources/amc_ssh_auth.md index 04c975f3b..f8a99309f 100644 --- a/docs/additional-resources/amc_ssh_auth.md +++ b/docs/additional-resources/amc_ssh_auth.md @@ -46,15 +46,31 @@ You can move on to [Step 2](#step-2-generate-an-ssh-key), but please make sure 1 ``` ## *Step 2: Generate an ssh key* -You are strongly encouraged to set a passphrase for your key pair. You will be prompted to enter the passphrase each time you log in. +You are strongly encouraged to set a passphrase for your key pair. You will be prompted to enter the passphrase each time you log in. You are also strongly encouraged to create an ed25519 key type. -SSH Key Generation for Windows Users: -- Using the command prompt, PowerShell, or Windows Terminal: +### SSH Key Generation for Windows Users: +- It is recommended you use Powershell, but command prompt or a basic windows terminal will also work: +Once inside Powershell (or similar), execute the following command: +``` +ssh-keygen -t ed25519 +``` +- After, create a passphrase and note the file path of the generated key. This will be important for step 3. Example output: + +![](./amc_ssh_images/windows_ssh_keygen_ex.png) +
+- - Using PuTTY: -SSH Key Generation for Mac Users: - +### SSH Key Generation for Mac and Linux Users: +- From a terminal window, execute the following command: +``` +ssh-keygen -t ed25519 +``` +- After, create a passphrase and note the file path of the generated key. This will be important for step 3. Example output: +![](./amc_ssh_images/mac_sshkeygen_real.png) +
+- NOTE for Mac users: There is a chance you need to create or alter your ssh config file (~/.ssh/config). See more in the [Troubleshooting](#troubleshooting) section below. ## *Step 3: Upload your ssh key to [registry.cilogon.org](https://registry.cilogon.org/registry/)* @@ -121,6 +137,12 @@ Log in at [registry.cilogon.org](https://registry.cilogon.org/registry/) and nav ## Troubleshooting * If you are able to get through [Step 3](#step-3-upload-your-ssh-key-to-registrycilogonorg) but unable to ssh in from your terminal, check that the ssh key in your command is the same key you uploaded to the registry. +* For Mac users: If you have set up the key and followed all the steps above but are prompted for a **__password__** instead of a **__passphrase__**, you may need to edit or create a config file (~/.ssh/config). If you don't have an ssh config file, you can create it from the terminal window with the command `touch ~/.ssh/config`. After, edit the file and add the following 3 lines before trying again: +``` +Host * +HostKeyAlgorithms ssh-ed25519 +PubkeyAcceptedAlgorithms ssh-ed25519 +``` * If you are prompted for a **__passphrase__** (not a password) when signing in from your terminal, this refers to the passphrase you set when you generated your ssh key. If you don't remember it then you will have to generate and upload a new ssh key to the registry. If you are prompted for a **__password__**, please submit a [support request form](https://colorado.service-now.com/req_portal?id=ucb_sc_rc_form), as this indicates an issue with your CILogon enrollment. Please include a screenshot of the error message and the date/time of your last login attempt. * If you receive an error message indicating that you are not in the COmanage registry (see screenshot below), please submit a [support request form](https://colorado.service-now.com/req_portal?id=ucb_sc_rc_form). diff --git a/docs/additional-resources/amc_ssh_images/mac_sshkeygen_real.png b/docs/additional-resources/amc_ssh_images/mac_sshkeygen_real.png new file mode 100644 index 000000000..98001e31c Binary files /dev/null and b/docs/additional-resources/amc_ssh_images/mac_sshkeygen_real.png differ diff --git a/docs/additional-resources/amc_ssh_images/windows_ssh_keygen_ex.png b/docs/additional-resources/amc_ssh_images/windows_ssh_keygen_ex.png new file mode 100644 index 000000000..ed3b00722 Binary files /dev/null and b/docs/additional-resources/amc_ssh_images/windows_ssh_keygen_ex.png differ diff --git a/docs/additional-resources/registrycilogon-instructions.md b/docs/additional-resources/registrycilogon-instructions.md index 343099dce..11448c432 100644 --- a/docs/additional-resources/registrycilogon-instructions.md +++ b/docs/additional-resources/registrycilogon-instructions.md @@ -27,14 +27,31 @@ You can move on to Step 2, but please make sure 10 minutes have elapsed between ## *Step 2: Generate an ssh key* -You are strongly encouraged to set a passphrase for your key pair. You will be prompted to enter the passphrase each time you log in. +You are strongly encouraged to set a passphrase for your key pair. You will be prompted to enter the passphrase each time you log in. You are also strongly encouraged to create an ed25519 key type. -SSH Key Generation instructions for Windows Users: -- Using command prompt, PowerShell, or Windows Terminal: visit [How to Generate SSH Keys in Windows 10 and Windows 11](https://www.howtogeek.com/762863/how-to-generate-ssh-keys-in-windows-10-and-windows-11/) -- Using PuTTY: visit [Use SSH Keys with PuTTY on Windows](https://devops.ionos.com/tutorials/use-ssh-keys-with-putty-on-windows/) +### SSH Key Generation for Windows Users: +- It is recommended you use Powershell, but command prompt or a basic windows terminal will also work: +Once inside Powershell (or similar), execute the following command: +``` +ssh-keygen -t ed25519 +``` +- After, create a passphrase and note the file path of the generated key. This will be important for step 3. Example output: -SSH Key Generation instructions for Mac Users: visit [Manually generating your SSH key in macOS](https://docs.tritondatacenter.com/public-cloud/getting-started/ssh-keys/generating-an-ssh-key-manually/manually-generating-your-ssh-key-in-mac-os-x) +![](./amc_ssh_images/windows_ssh_keygen_ex.png) +
+- +- Using PuTTY: + +### SSH Key Generation for Mac and Linux Users: +- From a terminal window, execute the following command: +``` +ssh-keygen -t ed25519 +``` +- After, create a passphrase and note the file path of the generated key. This will be important for step 3. Example output: +![](./amc_ssh_images/mac_sshkeygen_real.png) +
+- NOTE for Mac users: There is a chance you need to create or alter your ssh config file (~/.ssh/config). See more in the [Troubleshooting](#troubleshooting) section below. ## *Step 3: Upload your ssh key to registry.cilogon.org* @@ -73,7 +90,12 @@ A green message box will notify you that your SSH key was successfully added to Log in at [registry.cilogon.org](https://registry.cilogon.org/registry/) and navigate to the "Authenticators" section of your profile (see [Step 3](#step-3-upload-your-ssh-key-to-registrycilogonorg), above). Click "Delete", then repeat the process for adding a new key. It will take a few minutes before you can log in with your new key. ## Troubleshooting - +* For Mac users: If you have set up the key and followed all the steps above but are prompted for a **__password__** instead of a **__passphrase__**, you may need to edit or create a config file (~/.ssh/config). If you don't have an ssh config file, you can create it from the terminal window with the command `touch ~/.ssh/config`. After, edit the file and add the following 3 lines before trying again: +``` +Host * +HostKeyAlgorithms ssh-ed25519 +PubkeyAcceptedAlgorithms ssh-ed25519 +``` * If you receive an error message indicating that you are not in the COmanage registry (see screenshot below), please submit a [support request form](https://colorado.service-now.com/req_portal?id=ucb_sc_rc_form). ![](./registry-images/notregistered_error.png)