...
Initial setup and configuration
Assuming This guide assumes that you already have SSH on your target client. This comes provided pre-installed on Linux/Mac and is available on Windows via OpenSSH from https://github.com/PowerShell/Win32-OpenSSH/releases/latest (note this is pre-installed on University SWAE laptops)
...
We recommend that you install OpenSSH from https://github.com/PowerShell/Win32-OpenSSH/releases/latest and also that you use Windows Terminal from Microsoft.
We also recommend Powershell 7, but this will also install fine with Powershell 5.1.
Mac/Linux
These already have everything you need.
...
| Code Block |
|---|
invoke-webrequest -uri https://www1.essex.ac.uk/it/dev/finstall.ps1 -outfile finstall.ps1
./finstall.ps1 |
To install on Linux/Mac/Mobaxterm/WSL
| Code Block |
|---|
wget -O finstall.sh https://www1.essex.ac.uk/it/dev/finstall.sh
sh finstall.sh |
2. Run the faythe installer
On windows with powershell
| Code Block |
|---|
.\finstall.ps1 |
On Linux/Mac/Mobaxterm/WSL
| Code Block |
|---|
sh finstall.sh |
Note, you need to do this on each machine you use, but see below about copying your keys to the second or subsequent machine before running the installer on those.
The prompts are similar in both cases for both the powershell and posix sh versions - an example windows powershell setup is shown below.You are first prompted for a passphrase for a new SSH key - choose a secure passphrase and make a note of it - you may need it again. In the example below, you are prompted for this passphrase at lines 8, 9 and 11.After creating the SSH key, the installer then enrols this key with our SSH Certificate Authority. Here you are prompted for your University password at line 19 and the associated MFA code from Windows Authenticator (or similar).
| Code Block |
|---|
PS C:\Users\mylogin> .\finstall.ps1 Updating C:\Users\mylogin\Documents\PowerShell\Microsoft.PowerShell_profile.ps1... cmdlet faythe_install at command pipeline position 1 Supply values for the following parameters: Login: mylogin + Running ssh-keygen - use a memorable passphrase and make a note of it. Enter passphrase (empty for no passphrase): Enter same passphrase again: + Adding your key to your agent ... use the same passphrase as above. Enter passphrase for C:\Users\mylogin/.ssh/id_ed25519_essex.ac.uk: Identity added: C:\Users\mylogin/.ssh/id_ed25519_essex.ac.uk (mylogin@essex.ac.uk faythe key) + Creating/updating C:\Users\mylogin\AppData\Local\Temp/faythe.ps1. + Checking SSH config ... + Creating C:\Users\mylogin/.ssh/config. + Creating include file C:\Users\mylogin/.ssh/faythe_essex.ac.uk.config. + Added domain trusted host CA to C:\Users\mylogin/.ssh/known_hosts. + Enrolling your SSH public key. (mylogin@sshenrol.essex.ac.uk) Password: (mylogin@sshenrol.essex.ac.uk) Enter Your Microsoft verification code: 157479 + Open a new powershell window to start using ssh. Finished. Hit any key to continue.: |
...
If you are prompted about enabling ssh-agent on windows, follow what is said and then try again.
When finished, close the window and open a new one. Check that this has worked by running
| Code Block |
|---|
alias ssh |
...
Line 6: Provide your login name (not email alias) without the @essex.ac.uk.
Lines 8 & 9: Provide and confirm a passphrase for your newly generated SSH key. You should use something secure and ensure that you keep a record of this.
Line 11: Provide your new passphrase again to add the new key to your SSH agent.
Line 19: Provide your University of Essex password.
Line 20: Provide the MFA code from the Azure authenticator for your account.
Checking it is working
To check it worked, the simplest thing is to try the following in a new terminal window
...