MLReef and SSH keys
Git is a distributed version control system, which means you can work locally but you can also share or "push" your changes to other servers. Before you can push your changes to the MLReef server you need a secure communication channel for sharing information.
The SSH protocol provides this security and allows you to authenticate to the GitLab remote server without supplying your username or password each time.
For a more detailed explanation of how the SSH protocol works, read this nice tutorial by DigitalOcean.
The only requirement is to have the OpenSSH client installed on your system. This comes pre-installed on GNU/Linux and macOS, but not on Windows.
Depending on your Windows version, there are different methods to work with SSH keys.
Windows 10: Windows Subsystem for Linux
Starting with Windows 10, you can install the Windows Subsystem for Linux (WSL) where you can run Linux distributions directly on Windows, without the overhead of a virtual machine. Once installed and set up, you'll have the Git and SSH clients at your disposal.
Windows 10, 8.1, and 7: Git for Windows
The easiest way to install Git and the SSH client on Windows 8.1 and Windows 7
is Git for Windows. It provides a Bash
emulation (Git Bash) used for running Git from the command line and the
ssh-keygen command that is useful to create SSH keys as you'll learn below.
NOTE: Alternative tools: Although not explored in this page, you can use some alternative tools. Cygwin is a large collection of GNU and open source tools which provide functionality similar to a Unix distribution. PuttyGen provides a graphical user interface to create SSH keys.
Types of SSH keys and which to choose
MLReef supports RSA, DSA, ECDSA, and ED25519 keys. Their difference lies on the signing algorithm, and some of them have advantages over the others. For more information, you can read this nice article on ArchWiki. We'll focus on ED25519 and RSA here.
NOTE: Note: As an admin, you can restrict which keys should be permitted and their minimum length. By default, all keys are permitted, which is also the case for MLReef.
ED25519 SSH keys
ED25519 SSH keys were introduced in OpenSSH 6.5, so any modern OS should include the option to create them. If for any reason your OS or the MLReef instance you interact with doesn't support ED25519, you can fallback to RSA.
NOTE: Note: Omnibus does not ship with OpenSSH, so it uses the version on your MLReef server. If using Omnibus, ensure the version of OpenSSH installed is version 6.5 or newer if you want to use ED25519 SSH keys.
RSA SSH keys
RSA keys are the most common ones and therefore the most compatible with servers that may have an old OpenSSH version. Use them if the MLReef server doesn't work with ED25519 keys.
The minimum key size is 1024 bits, defaulting to 2048. If you wish to generate a
stronger RSA key pair, specify the
-b flag with a higher bit value than the
Generating a new SSH key pair
Before creating an SSH key pair, make sure to understand the different types of keys.
To create a new SSH key pair:
- Open a terminal on Linux or macOS, or Git Bash / WSL on Windows.
Generate a new ED25519 SSH key pair:
ssh-keygen -t ed25519 -C "firstname.lastname@example.org"
Or, if you want to use RSA:
ssh-keygen -t rsa -b 4096 -C "email@example.com"
-Cflag adds a comment in the key in case you have multiple of them and want to tell which is which. It is optional.
Next, you will be prompted to input a file path to save your SSH key pair to. If you don't already have an SSH key pair and aren't generating a deploy key, use the suggested path by pressing Enter. Using the suggested path will normally allow your SSH client to automatically use the SSH key pair with no additional configuration.
If you already have an SSH key pair with the suggested file path, you will need to input a new file path and declare what host this SSH key pair will be used for in your
Once the path is decided, you will be prompted to input a password to secure your new SSH key pair. It's a best practice to use a password, but it's not required and you can skip creating it by pressing Enter twice.
If, in any case, you want to add or change the password of your SSH key pair, you can use the
ssh-keygen -p -f <keyname>
OpenSSH < v7.8
Pre OpenSSH 7.8, default password encoding for SSH private keys was
it's only a single round of an MD5 hash. For OpenSSH version 6.5 to version 7.8, you should
-o option to
ssh-keygen to encode your private key in a new, more
If you already have an RSA SSH key pair to use with MLReef, consider upgrading it to use the more secure password encryption format by using the following command on the private key:
ssh-keygen -o -f ~/.ssh/id_rsa
Or generate a new RSA key:
ssh-keygen -o -t rsa -b 4096 -C "firstname.lastname@example.org"
Now, it's time to add the newly created public key to your MLReef account.
Adding an SSH key to your MLReef account
Copy your public SSH key to the clipboard by using one of the commands below depending on your Operating System:
pbcopy < ~/.ssh/id_ed25519.pub
WSL / GNU/Linux (requires the xclip package):
xclip -sel clip < ~/.ssh/id_ed25519.pub
Git Bash on Windows:
cat ~/.ssh/id_ed25519.pub | clip
You can also open the key in a graphical editor and copy it from there, but be careful not to accidentally change anything.
NOTE: Note: If you opted to create an RSA key, the name might differ.
Add your public SSH key to your MLReef account by:
- Clicking your avatar in the upper right corner and selecting Settings.
- Navigating to SSH Keys and pasting your public key from the clipboard into the Key field. If you:
- Created the key with a comment, this will appear in the Title field.
- Created the key without a comment, give your key an identifiable title like Work Laptop or Home Workstation.
- Click the Add key button.
NOTE: Note: If you manually copied your public SSH key make sure you copied the entire key starting with
ssh-rsa) and ending with your email.
Testing that everything is set up correctly
To test whether your SSH key was added correctly, run the following command in
your terminal (replacing
mlreef.com with your MLReef's instance domain):
ssh -T email@example.com
The first time you connect to MLReef via SSH, you will be asked to verify the
authenticity of the MLReef host you are connecting to.
For example, when connecting to MLReef.com, answer
yes to add MLReef.com to
the list of trusted hosts:
The authenticity of host 'mlreef.com (126.96.36.199)' can't be established. ECDSA key fingerprint is SHA256:HbW3g8zUjNSksFbqTiUWPWg2Bq1x8xdGUrliXFzSnUw. Are you sure you want to continue connecting (yes/no)? yes Warning: Permanently added 'gitlab.com' (ECDSA) to the list of known hosts.
NOTE: Note: For MLReef.com, consult the SSH host keys fingerprints, to make sure you're connecting to the correct server.
Once added to the list of known hosts, you won't be asked to validate the
authenticity of MLReef's host again. Run the above command once more, and
you should only receive a Welcome to MLReef,
If the welcome message doesn't appear, run SSH's verbose mode by replacing
-vvvT to understand where the error is.
Working with non-default SSH key pair paths
If you used a non-default file path for your MLReef SSH key pair, you must configure your SSH client to find your MLReef private SSH key for connections to MLReef.
Open a terminal and use the following commands
other_id_rsa with your private SSH key):
eval $(ssh-agent -s) ssh-add ~/.ssh/other_id_rsa
To retain these settings, you'll need to save them to a configuration file.
For OpenSSH clients this is configured in the
~/.ssh/config file. In this
file you can set up configurations for multiple hosts, like MLReef.com, GitHub, Bitbucket, etc.
Below are two example host configurations using their own SSH key:
# MLReef.com Host mlreef.com Preferredauthentications publickey IdentityFile ~/.ssh/mlreef_com_rsa
Public SSH keys need to be unique to MLReef, as they will bind to your account. Your SSH key is the only identifier you'll have when pushing code via SSH, that's why it needs to uniquely map to a single user.
Per-repository SSH keys
If you want to use different keys depending on the repository you are working on, you can issue the following command while inside your repository:
git config core.sshCommand "ssh -o IdentitiesOnly=yes -i ~/.ssh/private-key-filename-for-this-repository -F /dev/null"
This will not use the SSH Agent and requires at least Git 2.10.
Multiple accounts on a single MLReef instance
The per-repository method also works for using multiple accounts within a single MLReef instance.
Alternatively, it is possible to directly assign aliases to hosts in
~.ssh/config. SSH and, by extension, Git will fail to log in if there is
IdentityFile set outside of a
Host block in
.ssh/config. This is
due to how SSH assembles
IdentityFile entries and is not changed by
IdentityFile entries should point to
the private key of an SSH key pair.
Private and public keys should be readable by the user only. Accomplish this
on Linux and macOS by running:
chmod 0400 ~/.ssh/<example_ssh_key> and
chmod 0400 ~/.ssh/<example_sh_key.pub>.
# User1 Account Identity Host <user_1.mlreef.com> Hostname mlreef.com PreferredAuthentications publickey IdentityFile ~/.ssh/<example_ssh_key1> # User2 Account Identity Host <user_2.mlreef.com> Hostname mlreef.com PreferredAuthentications publickey IdentityFile ~/.ssh/<example_ssh_key2>
Host aliases are defined as
user_2.mlreef.com for efficiency and transparency. Advanced configurations
are more difficult to maintain; using this type of alias makes it easier to
understand when using other tools such as
git remote subcommands. SSH
would understand any string as a
Host alias thus
despite giving very little context as to where they point, would also work.
mlreef repository normally looks like this:
git clone firstname.lastname@example.org:mlreef-org/mlreef.git
To clone it for
mlreef.com with the SSH alias
git clone git@<user_1.mlreef.com>:mlreef-org/mlreef.git
Fix a previously cloned repository using the
git remote command.
The example below assumes the remote repository is aliased as
git remote set-url origin git@<user_1.mlreef.com>:mlreef-org/mlreef.git
Per-repository deploy keys
Deploy keys allow read-only or read-write (if enabled) access to one or multiple projects with a single SSH key pair.
This is really useful for cloning repositories to your Continuous Integration (CI) server. By using deploy keys, you don't have to set up a dummy user account.
If you are a project maintainer or owner, you can add a deploy key in the project's Settings > Repository page by expanding the Deploy Keys section. Specify a title for the new deploy key and paste a public SSH key. After this, the machine that uses the corresponding private SSH key has read-only or read-write (if enabled) access to the project.
You can't add the same deploy key twice using the form. If you want to add the same key to another project, please enable it in the list that says 'Deploy keys from projects available to you'. All the deploy keys of all the projects you have access to are available. This project access can happen through being a direct member of the project, or through a group.
Deploy keys can be shared between projects, you just need to add them to each project.
SSH on the MLReef server
MLReef integrates with the system-installed SSH daemon, designating a user
git) through which all access requests are handled. Users
connecting to the MLReef server over SSH are identified by their SSH key instead
of their username.
SSH client operations performed on the MLReef server wil be executed as this user. Although it is possible to modify the SSH configuration for this user to, e.g., provide a private SSH key to authenticate these requests by, this practice is not supported and is strongly discouraged as it presents significant security risks.
The MLReef check process includes a check for this condition, and will direct you to this section if your server is configured like this, e.g.:
$ gitlab-rake gitlab:check # ... Git user has default SSH configuration? ... no Try fixing it: mkdir ~/gitlab-check-backup-1504540051 sudo mv /var/lib/git/.ssh/id_rsa ~/gitlab-check-backup-1504540051 sudo mv /var/lib/git/.ssh/id_rsa.pub ~/gitlab-check-backup-1504540051 For more information see: doc/ssh/README.md in section "SSH on the GitLab server" Please fix the error above and rerun the checks.
Remove the custom configuration as soon as you're able to. These customizations are explicitly not supported and may stop working at any time.
If on Git clone you are prompted for a password like
something is wrong with your SSH setup.
- Ensure that you generated your SSH key pair correctly and added the public SSH key to your MLReef profile
- Try manually registering your private SSH key using
ssh-agentas documented earlier in this document
- Try to debug the connection by running
ssh -Tv email@example.com(replacing
example.comwith your MLReef domain)