Creating SSH keys
This page describes how to create SSH keys.
SSH keys can be used to establish a secure connection with Bitbucket Server for:
- when you are performing Git operations from your local machine
- when another system or process needs access to repositories in Bitbucket Server (for example your build server)
The SSH key needs to be added to Bitbucket Server, and your Bitbucket Server administrator must have enabled SSH access to Git repositories before you can make use of the key.
Bitbucket Server supports DSA, RSA2, and Ed25519 key types. RSA1 is not supported
You can use an existing SSH key with Bitbucket Server if you want, in which case you can go straight to either SSH user keys for personal use or SSH access keys for system use.
On this page:
Creating an SSH key on Windows
1. Check for existing SSH keys
You should check for existing SSH keys on your local computer. You can use an existing SSH key with Bitbucket Server if you want, in which case you can go straight to either SSH user keys for personal use or SSH access keys for system use.
Open a command prompt, and run:
cd %userprofile%/.sshIf you see "No such file or directory", then there aren't any existing keys: go to step 3.
Check to see if you have a key already:
dir id_*If there are existing keys, you may want to use those: go to either SSH user keys for personal use or SSH access keys for system use.
2. Back up old SSH keys
If you have existing SSH keys, but you don't want to use them when connecting to Bitbucket Server, you should back those up.
In a command prompt on your local computer, run:
mkdir key_backup
copy id_ed25519* key_backup3. Generate a new SSH key
If you don't have an existing SSH key that you wish to use, generate one as follows:
- Log in to your local computer as an administrator.
In a command prompt, run:
ssh-keygen -t ed25519 -C "your_email@example.com"Associating the key with your email address helps you to identify the key later on.
Note that the
ssh-keygencommand is only available if you have already installed Git (with Git Bash).
You'll see a response similar to this:C:\Users\ASUS>ssh-keygen -t ed25519 -C "your_email@example.com" Generating public/private ed25519 key pair. Enter file in which to save the key (/c/Users/ASUS/.ssh/id_ed25519):- Just press <Enter> to accept the default location and file name. If the
.sshdirectory doesn't exist, the system creates one for you. Enter, and re-enter, a passphrase when prompted. The whole interaction will look similar to this:
C:\Users\ASUS>ssh-keygen -t ed25519 -C "your_email@example.com" Generating public/private ed25519 key pair. Enter file in which to save the key (/c/Users/ASUS/.ssh/id_ed25519): Created directory '/c/Users/ASUS/.ssh'. Enter passphrase (empty for no passphrase): Enter same passphrase again: Your identification has been saved in c/Users/ASUS/.ssh/id_ed25519. Your public key has been saved in c/Users/ASUS/.ssh/id_ed25519.pub. The key fingerprint is: SHA256:wvaHYeLtY6+DlvV5sFZgDi3RTAe8R2KY23N78qrGqJE your_email@example.comYou're done! Now go to either SSH user keys for personal use or SSH access keys for system use.
Creating an SSH key on Linux & macOS
1. Check for existing SSH keys
You should check for existing SSH keys on your local computer. You can use an existing SSH key with Bitbucket Server if you want, in which case you can go straight to either SSH user keys for personal use or SSH access keys for system use.
Open a terminal and run the following:
cd ~/.ssh- If you see "No such file or directory, then there aren't any existing keys: go to step 3.
Check to see if you have a key already:
ls id_*- If there are existing keys, you may want to use them; go to either SSH user keys for personal use or SSH access keys for system use.
2. Back up old SSH keys
If you have existing SSH keys, but you don't want to use them when connecting to Bitbucket Server, you should back those up.
Do this in a terminal on your local computer, by running:
mkdir key_backup
cp id_ed25519* key_backup
3. Generate a new key
If you don't have an existing SSH key that you wish to use, generate one as follows:
Open a terminal on your local computer and enter the following:
ssh-keygen -t ed25519 -C "your_email@example.com"Associating the key with your email address helps you to identify the key later on.
You'll see a response similar to this:
chaiss@C02FP1JWMD6V ~ % ssh-keygen -t ed25519 -C chaiss@email.com Generating public/private ed25519 key pair. Enter file in which to save the key (/Users/chaiss/.ssh/id_ed25519):- Just press <Enter> to accept the default location and file name. If the
.sshdirectory doesn't exist, the system creates one for you. Enter, and re-enter, a passphrase when prompted.
The whole interaction will look similar to this:chaiss@C02FP1JWMD6V ~ % ssh-keygen -t ed25519 -C chaiss@email.com Generating public/private ed25519 key pair. Enter file in which to save the key (/Users/chaiss/.ssh/id_ed25519): Enter passphrase (empty for no passphrase): Enter same passphrase again: Your identification has been saved in /Users/chaiss/.ssh/id_ed25519. Your public key has been saved in /Users/chaiss/.ssh/id_ed25519.pub. The key fingerprint is: SHA256:gTVWKbn41z6JgBNu3wYjLC4H6oW5bmhaXyaVABwmEtE chaiss@email.com The key's randomart image is: +--[ED25519 256]--+ |==+. +o.. | |.oE. +o.. | | . ...o | | .o... | | oo+S . | | + ..B = . . | |.+.+.oo+ * o . | |o++.o+ . + + | |B+ o. . . | +----[SHA256]-----+ chaiss@C02FP1JWMD6V ~ %- You're done! Now go to either SSH user keys for personal use or SSH access keys for system use.