How to add SSH Key to GitHub

• git

Published: 2024-02-24

Last Modified: 2024-11-11 15:46 UTC

Foreword

A couple of years ago, GitHub changed some of their security policies and now you are not able to push (and sometimes pull) code to repositories with the normal username and password login method. You now need to use SSH keys.

The method outlined here can work with Linux, Windows, Mac OS and probably other OSes too, but some of the commands and steps might differ a bit depending on your system. The good part is that what you learn here will also apply when you need to access other services that use a similar authentication method!

Prerequisites

There are a couple of things that you will need:

• A GitHub account
• Have Git installed on your system
• Have SSH installed and enabled in your system

Once you have that, you need to verify that you don’t already have existing SSH keys. You can do so by executing $ ls -al ~/.ssh | grep pub in your home directory. Another option is to check the .ssh directory with a file browser.

1
yamif@Venusaur-Win MINGW64 ~
2
$ ls -al ~/.ssh | grep pub
3
-rw-r--r-- 1 yamif 197609  574 Feb 24 16:09 id_rsa.pub

If your output looks something like that, and you already have a .pub file, you already have some keys, and most likely you will be able to use them with GitHub. Compatible filenames would be something like id_rsa.pub, id_ecdsa.pub, or id_ed25519.pub. Bear in mind that these are default file names and yours might be different.

If you don’t have keys, we will generate them in the next section. If you do, you can skip it.

Generating keys

Generating your keys will be as easy as running this command:

1
ssh-keygen -t rsa -b 4096 -C your@email.com

When you run it, it will ask for a name for the key, you can leave it blank for the default name if you want. Then it will ask for a password, you can leave this blank as well if you really want to.

It will output a bit more information, and generate two files in your .ssh directory: id_rsa.pub, which is your public key, and id_rsa, your private key.

1
yamif@Venusaur-Win MINGW64 ~
2
$ ssh-keygen -t rsa -b 4096 -C testKEY@email.com
3
Generating public/private rsa key pair.
4
Enter file in which to save the key (/c/Users/yamif/.ssh/id_rsa): testKEY
5
Enter passphrase (empty for no passphrase):
6
Enter same passphrase again:
7
Your identification has been saved in testKEY
8
Your public key has been saved in testKEY.pub
9
The key fingerprint is:
10
SHA256:ASxZ99ntr66zoeel0b4MhqzuFEZkZSITgCFAtDLY2Bc testKEY@email.com
11
The key's randomart image is:
12
+---[RSA 4096]----+
13
|*o.oE=*.=.o      |
14
|.=o o..B + o .   |
15
|=.o ..  o o . .  |
16
|.. .   . .   .   |
17
|        S     .  |
18
|       . o . . . |
19
|        . o = o .|
20
|       . . ooO . |
21
|       o+ .o==*. |
22
+----[SHA256]-----+

Adding keys to GitHub

Now you can go to your GitHub settings page and click the button that says “New SSH Key”

Now you will be given two prompts. Give a descriptive title to this key, for example, “Manjaro desktop”. In the next field, you need to paste the entire content of your .pub file (All of it).

Now just click “Add SSH Key”

From the SSH keys page, you will also be able to see information regarding all your added keys and remove them if you need to.

Testing

Now, to test if your keys are working, do the following command: ssh -T git@github.com, it will take a few seconds and then output something similar to this:

1
yamif@Venusaur-Win MINGW64 ~
2
$ ssh -T git@github.com
3
Hi USERNAME! Youve successfully authenticated, but GitHub does not provide shell access.

If so, congratulations! Your SSH keys are added and you can start using them with GitHub.

Email me about this post.