GitLab - SSH Key Setup

Setting up SSH keys for GitLab is an important step for secure and password-less authentication when interacting with your repositories. SSH (Secure Shell) keys provide a secure way of logging into a server and are widely used for automated processes and secure communication between GitLab and your local machine.

In this guide, we'll see the process of generating and configuring SSH keys for GitLab to streamline your development workflow.

What is SSH?

SSH (Secure Shell) can be defined as a cryptographic network protocol, which enables the secure data transmission between two parties within the context of an insecure network. They utilize two asymmetric keys; the public key and the private key that enable the identification of the user. Thanks to the SSH keys in GitLab, after setting it up, you do not enter your credentials each time when pushing, pulling or cloning a repository.

Steps to Setup SSH key

Step 1: Generate an SSH Key Pair

The process begins with creating an SSH key pair on the local desktop as shown below:

SSH key pair is a private and public key, where the private key should not be shared with anyone and the public key will be uploaded to the GitLab.

1. Open your terminal.
2. Generate the SSH key pair by running the following command:

ssh-keygen -t rsa -b 4096 -C "[email protected]"

• -t rsa specifies the type of key to create (RSA).
• -b 4096 sets the key length to 4096 bits for added security.
• -C "[email protected]" is a comment that helps identify the key. Use your GitLab email address here.

3. Save the key pair:

• You will be requested to select the file to store the key pair you have generated at the previous step. Press Enter to keep the location of the file, for example, ~ / .ssh/id_rsa).
• It is optional to enter a passphrase in order to enhance the level of security of the key. If you do not wish to use a passphrase, press ‘Enter’.

4. Verify the key files:

• At this point, you should have two files in your ~/. ssh/ directory: There we have id_rsa (private key) and id_rsa. pub (public key).

Step 2: Append the SSH key into the ssh-agent

The SSH agent is a helper program which runs in the background, and it deals with your SSH keys. In order to employ your SSH key with GitLab, they have to be added to the SSH agent.

• Start the SSH agent by running the following command:

eval "$(ssh-agent -s)"

• Add your SSH private key to the SSH agent:

ssh-add ~/.ssh/id_rsa

Step 3: Adding of the SSH Key to GitLab Account

• As you have created an SSH key pair and added the private key to the SSH-agent now it is the time to place the public key to your GitLab account.
  • This is the public key which you are to copy You can do this using the following command:

cat ~/.ssh/id_rsa.pub

• Copy the output of this command.
• Go to the GitLab website then enter your username and password to log in, then go to profile settings.
• Go to the "SSH Keys" section:
  • At the right upper corner with the icon in the form of your picture or your login, click on “User Settings.”
  • From the sidebar, click SSH Keys.”
• Add your SSH key:
  • In the “Key” field, copy the public key which was copied earlier.
  • There is also the “Title” field where you can assign a descriptive name to the key.
  • To save the entered key it is necessary to press the “Add Key” button.

Step 4: Test the SSH Connection

Once the SSH key has been created and added to GitLab, it is advisable to verify whether the connection is properly configured.

• Run the following command to test the connection:

ssh -T git@gitlab. com

• If everything is set up correctly, you should see a message like this:

Welcome to GitLab, @your_username!

This message is aimed to let you know that your SSH key is fine and you can further use SSH to manage your repositories of GitLab.

Benefits of Using SSH Keys with GitLab

• Enhanced Security: SSH keys provide a secure method of authentication that is stronger than traditional username-password pairs.
• Convenience: They enable password-less authentication, making it easier to push, pull, and clone repositories.
• Automation: SSH keys provides automated scripts and CI/CD pipelines by avoiding the need for manual password input.