Generate Rsa Key For Gitlab Mac

admin

When you work with a Git repository, your project may be actively modified by a lot of people. Some of them may not be trustworthy as they may be new employees or something like that. In this case, if they need to do git pull in the server to update the changes of a commit in your production server, you may not want that everybody knows the password of the repository. Another case where you don't want to provide the password of the repository everytime you do git pull or git clone, are automatized deployments.

Sep 26, 2019 - By setting ssh key you can connect to GitLab server without using username and password each time Step 1: Run command ssh-keygen On Mac - run command on terminal.

Creating your SSH key pair; Adding your SSH public key to GitLab. Create and add your SSH key pair. It is best practice to use Git over SSH instead of Git over HTTP. In order to use SSH, you will need to: Create an SSH key pair; Add your SSH public key to GitLab. Creating your SSH key pair. Jul 25, 2019  This post will be pretty straightforward and will cover Windows, Mac, and Linux on how to generate SSH keys for Git authorization. A straightforward post covering a step-by-step approach for Windows, Mac, and Linux users. Nov 13, 2017  This New Video shows how to generate SSH keys for GitLab Profile (2017) in user settings, option just above GPG Keys for windows OS using Git Bash GUI. It actually creates a Public SSH Key.

That's why the the 'deployment keys' feature exist in Gitlab, A deploy key is an SSH key that is stored on your server and grants access to a single Gitlab repository. This key is attached directly to the repository instead of to a personal user account. In this article, we'll show you step by step how you can automatize the deployment process of your project hosted on Gitlab.

1. Find or create an SSH Key for your server

The first thing that you need to do is to verify if your server has already a public key created in the .ssh directory of the user in the server, so start a SSH session to your server and type the following command:

This will automatically search in the folder of your user that in our case is /home/vagrant/.ssh, if the output of the command shows a string that starts with ssh-rsa, then you already have an SSH Key that you can use to add to your repository, so you can skip to the step 2. If instead, you get the output : cat: ~/.ssh/id_rsa.pub: No such file or directory, then you will need to create an SSH Key first. You can create a SSH Key in Ubuntu via SSH with the following command (navigate to the .ssh directory first and type):

To make the process easy, we won't add a Keyphrase for the SSH Key, so as mentioned in the creation wizard just press enter to don't use a keyphrase:

As shown in the image, we no have the id_rsa and id_rsa.pub file in our .ssh directory. This key works as a 'pass' that allows to clone/pull your project in the current server, till this point it doesn't do anything, so you will need to follow the other steps.

2. Configure SSH client to find your GitLab private SSH in the server

As next step you need to establish that, when cloning from Gitlab, the deployment key should be used as authentication instead of an username and a password. For this you need to ensure that ssh-agent is enabled by running the following command:

Then you can proceed to add your key to the SSH registry using the following command:

To retain these settings you'll need to save them to a configuration file. Normally on OpenSSH clients you can configure this in the ~/.ssh/config file. If the file doesn't exist, you can create it:

And register your key in the file. In this tutorial we are adding a single SSH Key from the Gitlab website (non self hosted version), so our config file content will be:

As you may have multiple projects in one server or a project that uses different repositories that need to be updated, you can without a problem implement multiple SSH Keys in the same file following the notation:

3. Add the Server Key as a deployment key in your Repository configuration

Now you need the public key of your server (created in step 1), in this step you are saying to Gitlab 'Hey, if someone uses this SSH Key to clone, allow him to do it'. You can get the content of the public file using a text editor via SFTP, or just by printing the output of the file with SSH using the following command:

This would output in our case the content of the public key:

Keep that long string in the clipboard as you will need it to paste it in Gitlab. As next acccess the Settings of your Repository in Gitlab, in our case as we are using the non self hosted version of Gitlab the configuration for the Deploy Keys is in https://gitlab.com/<username>/<repository-name>/settings/repository. The menu to add a new deploy key looks like this:

logitech k350 download for mac Here you would only need to add the content of the id_rsa.pub file, provide a title and decide wheter the server can be used to push changes as well or not (normally unchecked as it is production). Once the key is added in your repository, you should be able now to clone/pull your repository in the deployment server.

4. Clone and pull repository to test

As final step, to verify if everything went right you can clone your repository to see if the credentials of the repository are requested or not, in case it does, please read the tutorial again and check what you did wrong. Otherwise, you will be able to clone your project using the following command:

Note

Remember to clone via SSH, not HTTPS, otherwise you may obviously be asked for the credentials.

By doing this you may have noticed that you didn't have to input your Gitlab username nor password thanks to the deployment key!

Happy coding !

PuTTYgen is a key generator tool for creating pairs of public and private SSH keys. It is one of the components of the open-source networking client PuTTY. Although originally written for Microsoft Windows operating system, it is now officially available for multiple operating systems including macOS, Linux. PuTTYgen.exe is the graphical tool on Windows OS. While on the other side, Linux OS has the only command-line version could be accessible using SSH commands.

  • 1 Download PuTTYgen
    • 1.1 Download PuTTYgen on Windows
    • 1.2 Download PuTTYgen for Mac
    • 1.3 Download PuTTYgen for Ubuntu/Linux
      • 1.3.3 Types of Keys Supported on PuTTYgen

Puttygen aka Putty Key Generator

How To Add Ssh Key To Gitlab

The key generation utility – PuTTYgen can create various public-key cryptosystems including Rivest–Shamir–Adleman (RSA), Digital Signature Algorithm (DSA), Elliptic Curve Digital Signature Algorithm (ECDSA), and Edwards-curve Digital Signature Algorithm (EdDSA) keys.

The aforementioned public-key cryptosystems principally focus on secure data transmission and digital signatures.

Although PuTTYgen collects keys in its native file format i.e. .ppk files, the keys can easily be converted to any file format. For Windows, the software interface is PuTTYgen.exe, whereas, for Linux OS the command-line adaptation is available using SSH commands.

How to use PuTTYgen?

PuTTYgen is used to generate public or private key pair for creating SSH keys. Below is the complete guidance about how to generate RSA key in the Windows operating system:

Ssh Key For Gitlab

  1. Once you install the PuTTY on your machine, you can easily run PuTTYgen. For the same, go to Windows -> Start Menu -> All Programs -> PuTTY -> PuTTYgen.
  2. You will see the PuTTY key generator dialog box on your screen
  3. You will find a “Generate” button in that dialog. Clicking on it will lead to generating the keys for you.
  4. Now you will need to add a unique key passphrase in the Key passphrase and Confirm passphrase field.
  5. Click on the “Save Public Key” and “Save Private Key” buttons to save your public and private keys.
  6. You will see the text starting with ssh-RSA in the Public key for pasting into OpenSSH authorized_keys file field which is located at the top of the window. Copy that entire text to your clipboard by pressing ctrl+c as you will require the key to paste on your clipboard in the public key tool of control panel or directly on the cloud server.

Various Ways to Use RSA Key Pair

RSA key pair generated through PuTTYgen is used in two various ways defined as below:

  1. To assign while creating a new cloud server
    You can choose the public key from the given list of keys at the time of creating a cloud server. If you don’t find your key in that list, then first add and then assign it.
  2. Assign to an existing cloud server
    At the time of connecting to the cloud server, first of all, you need to tell PuTTY to use it for utilizing your newly created RSA key pair.

PuTTYgen being a component of the terminal emulator PuTTY does not have to be downloaded separately, hence, comes with the PuTTY .msi installation package. You can follow the simple steps to download PuTTYgen software for your system. That is the reason why you don’t need to download PuTTYgen separately. Once you download PuTTY software, you will be able to install and run PuTTYgen easily in no time. Below is the complete instruction about how to download and install PuTTY on Windows.

Apart from that, it is also integrated into third-party programs such as WinSCP installation package. Below you can find a complete PuTTYgen download and installation guide for all operating systems.

Generate Rsa Key For Gitlab Mac 2017

Download PuTTYgen on Windows

To download PuTTYgen the primary requisite is to acquire the copy of PuTTY installation package. For the 64-bit operating system, one must install the 64-bit version of PuTTY, i.e. putty-64bit-<version>-installer.msi.Similarly, for the 32-bit operating system, the respective 32-bit version of PuTTY, i.e. putty-<version>-installer.msi needs to be installed.

To get PuTTY, go to PuTTY Installation Download page, whereby the complete installation package will be available with setup instructions, installation guide, and download links to all other components of PuTTY such as putty.exe, pscp.exe, psftp.exe, puttytel.exe, plink.exe, pageant.exe and putty.zip.


Following the successful download of the PuTTY installation package. It is time to install the program. Go to How to install PuTTY on Windows, whereby you will find the step by step guidance for PuTTY installation for Windows operating system.

After successfully downloading and installing PuTTY on your Windows machine, you are just 2-3 clicks away to run PuTTYgen. Follow the below-given step by step guidance to run PuTTYgen:

Run PuTTYgen on Windows

Generate Rsa Key For Gitlab Mac 2017

To run PuTTYgen, Go to Windows -> Start Menu -> All Programs -> PuTTY -> PuTTYgen. You will see a window for the PuTTY Key Generator on your screen.

Voila! Now you can generate public or private key pair using PuTTYgen.

Download PuTTYgen for Mac


Below is the detailed guide to download PuTTYgen on Mac operating system. Mac OS has a built-in command-line SSH client known as Terminal. To utilize it, go to Finder and then opt for Go -> utilities from the top menu. After that find the terminal which supports SSH connections to remote servers.

However, to run PuTTYgen for mac, the first one must have to install PuTTY. There are multiple ways to install PuTTY, which are Homebrew or MacPorts. Both alternatives will also install the command-line of adaptations of PuTTYgen.

Ported PuTTY for Mac

Mac has the port of PuTTY which can be installed in various ways described as below:

  1. Installation using Homebrew:
    First, install the ‘brew command line’ Once installed use the below-given command to install PuTTY:-
    sudo brew install putty
  2. Installation using MacPorts:
    First of all, one must install MacPorts and then use the command-line to install PuTTY. Here is the command to install PuTTY via MacPorts
    sudo port install putty
    Additionally, a user can also add a shortcut to the desktop by writing the following command line
    –cp /opt/local/bin/putty ~/Desktop/PuTTY

However, there is an alternative way to install PuTTY on Mac OS. Cyberduck is a widely used Mac OS SSH Client. Once PuTTY installed on the Mac OS, a user can convert PuTTY derived private key format to OpenSSH.

To convert the private key to standard PEM format, type the following command –

puttygen privatekey.ppk -O private-openssh -o privatekey.pem

You can also read the guide to convert .pem file to .ppk using puttygen.

Download PuTTYgen for Ubuntu/Linux

To download PuTTYgen for Ubuntu (Linux) operating system, a user to first install PuTTY. However, in some Linux distributions, the SSH key generation tool – PuTTYgen needs to be installed independently from the PuTTY client.

For example, Debian Linux requires the below-given code to install PuTTYgen:

sudo apt install putty-tools

Generate Key Pair for Authentication in Linux

To create the key pair for authentication in Linux use the below command:-

puttygen -t rsa -b 2048 -C 'user@host' -o keyfile.ppk

Various Command Line Options of PuTTY in Linux

Below are few important command line options in the Linux operating system for PuTTY:

PuTTYgen [-t keytype [-b bits] [-q] keyfile]
[-C new-comment] [-P]
[-O output-type -p -l -L]
[-o output-file]

Options:

  1. Keyfile – It is the name of the existing key file to read at the time of changing the current key.
  2. –t keytype – The command specifies the type of key to creating. Its acceptable values are RSA and dsa.rsa1.
  3. -b bits – This command specifies a total number of bit in a particular key. 1024 is the perfect size for DSA key, while 2048 or 4096 are the perfect size for RSA keys.
  4. –q – The command suppresses the message about progress at the time of key generation.
  5. -C new-comment – The command will specify the comment to describe the key. It can be used for the new and/or existing key. Key operation is not affected by a comment. However, it is used to recognize the key owner, it’s not reliable completely as any value can be applied to it.
  6. –P – Using the command will update the passphrase of a key. Passphrase helps to encrypt the private key. As passphrase can’t add or update on a command line, it prompts a new passphrase tool to alter it.
  7. –old-passphrase-file – The old password of the key remains in this file. The command is used when the key is protected by a passphrase.
  8. –new-passphrase file – This command prompts the new passphrase of the key. It comes in the action either at the time of generating a new key or while applying –P command to change the passphrase.
  9. -O output-type – This command defines what to give in output. By default, the private key is the output.

Thus, above are the prominent commands of PuTTYgen in Linux operating system. Besides that, there are many other commands available to perform various tasks from the command prompt in Linux at flank speed.

Generate Rsa Key For Gitlab Mac Update

Types of Keys Supported on PuTTYgen

It is important to know the types of key PuTTYgen supports prior to using it. Below are the key types that it currently supports for SSH-2 and SSH-1 protocol:-

Generate Rsa Key For Gitlab Mac 10

  • SSH-1 protocol:- For SSH-1 only supports one key i.e. Rivest–Shamir–Adleman (RSA)
  • SSH-2 protocol: – SSH-2 supports multiple key types that include – Digital Signature Algorithm (DSA), Elliptic Curve Digital Signature Algorithm (ECDSA) and Ed25519.

The above description is a detailed brief on downloading and running PuTTYgen on all major operating systems. For further details please check the Download PuTTY page.