Help:SSH

You can manage your access to Cloud VPS instances, including adding your existing public SSH keys, via the Wikimedia Identity Management system for developers.

Once you have uploaded your public SSH key, it will be available in all the Cloud VPS projects that you have access to. Then you will be able to access the instances in those projects.

Creating a new public and private SSH key

Caution: The public key is always the file with ".pub" on the end. Always keep the private key secret and never share it with anyone else!

Generating a key in Windows

There are a few ways that you can generate an SSH keypair on Windows.

Git Bash

Download and install Git Bash
Open Git Bash
Enter the following into the terminal, substituting your email address:
```
ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
```
This creates a new SSH key, using the provided email as a label.
```
Generating public/private rsa key pair.
```
When you're prompted to "Enter a file in which to save the key," press Enter. This accepts the default file location.
```
Enter a file in which to save the key (/c/Users/you/.ssh/id_rsa):[Press enter]
```
You will then be prompted to enter a passphrase, and once you've done so your new SSH key will be in /c/Users/you/.ssh/id_rsa.pub
Enter the following in Git Bash to copy your public key to your clipboard:
```
cat /c/Users/you/.ssh/id_rsa.pub | clip
```
Log into https://idm.wikimedia.org/, select the SSH keys tab and click Upload new key. You need to paste the contents of your clipboard into the SSH public key field. If you have more than one key, you can leave an optional Comment. Finally confirm with Upload new SSH key.

PuttyGen

Download and install PuttyGen
Open PuttyGen
Select an SSH-2 RSA key
Click the Generate button
Move your mouse around until the progress bar is full
Type in a passphrase (you will need to remember this) and confirm it
Save the private key and public key onto your local machine
From the text field 'Public key for pasting into OpenSSH authorized_keys file' right click and copy
Log into https://idm.wikimedia.org/, select the SSH keys tab and click Upload new key. You need to paste the contents of your clipboard into the SSH public key field. If you have more than one key, you can leave an optional Comment. Finally confirm with Upload new SSH key.

Generating an SSH key on UNIX-based systems

Open Terminal
Enter the following into the terminal, substituting your email address:
```
ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
```
This creates a new SSH key, using the provided email as a label.
```
Generating public/private rsa key pair.
```
When you're prompted to "Enter a file in which to save the key," press Enter. This accepts the default file location.
```
Enter a file in which to save the key (/Users/you/.ssh/id_rsa):[Press enter]
```
You will then be prompted to enter a passphrase, and once you've done so your new SSH key will be in /Users/you/.ssh/id_rsa.pub.
Type the following into your terminal to copy your public key to your clipboard:

cat ~/.ssh/id_rsa.pub | pbcopy

Log into https://idm.wikimedia.org/, select the SSH keys tab and click Upload new key. You need to paste the contents of your clipboard into the SSH public key field. If you have more than one key, you can leave an optional Comment. Finally confirm with Upload new SSH key.

Troubleshooting

If you're on a network that restricts SSH out (i.e. you are getting connection errors instead of authentication ones), find out if there's an internal server you can hop to first and then SSH out. You'll likely want to set it as a jump host. You should avoid putting your SSH private key anywhere other than your local machine.
Check what your remote username should be from idm.wikimedia.org. Check what username you are actually trying to log in as - if it's not specified on your SSH command (or PuTTY session) and it's not coming from your SSH config (if you have one), it's likely defaulting to the username on your local machine, which may not be the correct username.
Check what SSH keys are on your account. If you're not specifying your key using -i on the command line (or directly in PuTTY), is it in your agent? Check ssh-add -L (or Pageant, for PuTTY users).
1. For Cloud VPS and Toolforge, you can see the SSH keys on your account at idm.wikimedia.org (other users can find them by running ldapsearch -xLLL uid=<your username> sshPublicKey from inside labs).
2. For Wikimedia production servers, you can see them at puppet.git modules/admin/data/data.yaml
Check that your SSH keys are in the right format. Wikimedia should have the OpenSSH-formatted public key, it should not begin 'BEGIN SSH2 PUBLIC KEY' etc. If you're using the OpenSSH command line (ssh on linux hosts) your local private key file should be in OpenSSH format, not SSH2/SSH.com.