All pages
Powered by GitBook
1 of 2

Loading...

Integration with Git

Keeper SSH Agent integration for Git Authentication and Commit Signing

Keeper's SSH Agent integrates seamlessly with Git for authentication and commit signing, ensuring private keys are securely stored in the Keeper Vault instead of being saved locally on the device. This approach enhances security by protecting sensitive keys from local exposure.

In this guide, we'll create and configure separate authentication and signing keys for use with GitHub, all managed securely by Keeper. Using distinct keys for authentication and signing helps maintain a clear separation of roles, further strengthening your security posture.

Prerequisites

Features

Github Authentication

To authenticate with GitHub using Keeper, follow the below steps.

1

Create a Keeper record

  • Create a record in Keeper such as an SSH Key type or PAM User type.

  • Generate a strong password

2

Generate SSH Key

Generate SSH key on your terminal with the password generated by Keeper. For example:

ssh-keygen -t ecdsa -b 521 -C "craig@keeperdemo.io"

Enter passphrase (empty for no passphrase): *********
Enter same passphrase again: *********

This will create the public and private keys locally on your machine.

For example:

/Users/craig/.ssh/id_ecdsa
/Users/craig/.ssh/id_ecdsa.pub
3

Add Key to Record

Add the contents from the public and private keys generated in Step 2 into the Keeper record. Copy paste the Public Key and Private Key into the fields of Keeper.

4

Add Key to Github

  • From Github.com, go to Settings > SSH and GPG keys > New SSH Key > and select Key type of "Authentication Key".

  • Assign a title, and paste the public key contents from id_ecdsa.pub in Step 2.

  • Save the key.

5

Add Key to SSH Agent

From the Keeper Desktop App, open Settings > Developer > SSH Agent > Edit and select your "Github Auth key" created in step3 from the list of available keys.

Click "Update" to save the settings.

6

Delete the local key

At this point, it's a good idea to delete the local key, since it is now stored and managed by Keeper. In this case, you can delete both the public and private key.

rm /Users/craig/.ssh/id_ecdsa
rm /Users/craig/.ssh/id_ecdsa.pub
7

Authenticating with Github

From a terminal in some repo, perform an authorized request with Github:

git pull
8

This immediately will trigger a Keeper dialog to authorize the Github Authentication key.

Clicking "Authorize" will use the key stored in Keeper to authenticate with Github.

Your setup is complete.

Signing Commits

To sign GitHub commits with Keeper, we will create a separate key that is specifically used for the signing process. Follow the steps below.

1

Create a Keeper record

  • Create a record in Keeper such as an SSH Key type or PAM User type.

  • Generate a strong password

2

Generate SSH Key

Generate SSH key on your terminal with the password generated by Keeper. For example:

ssh-keygen -t ecdsa -b 521 -C "craig@keeperdemo.io"

Enter passphrase (empty for no passphrase): *********
Enter same passphrase again: *********

This will create the public and private keys locally on your machine.

For example:

/Users/craig/.ssh/id_ecdsa
/Users/craig/.ssh/id_ecdsa.pub
3

Add Key to Record

Add the contents from the public and private keys generated in Step 2 into the Keeper record. Copy paste the Public Key and Private Key into the fields of Keeper.

4

Add Key to Github

  • From Github, go to Settings > SSH and GPG keys > New SSH Key > and select Key type of "Signing Key".

  • Assign a title, and paste the public key contents from Step 2.

  • Save the key.

5

Add Key to SSH Agent

From Keeper, open Settings > Developer > SSH Agent > Edit and select the Github signing key.

Click "Update" to save the settings.

6

Delete the local private key

We will only delete the local private key, since it is now stored and managed by Keeper. The public key (xxx.pub) needs to stay, as it will be used for identifying which key to use for signing.

rm /Users/craig/.ssh/id_ecdsa

Let's also rename the public key to something more specific:

cd ~/.ssh
mv id_ecdsa.pub git_signing_key.pub

Place the username and the contents of the public key into a file called ~/.ssh/allowed_signers. For example:

craig@keeperdemo.io <contents of git_signing_key.pub>

In this example, the file looks like this:

craig@keeperdemo.io ecdsa-sha2-nistp521 AAAAE2VjZHNhLXNoYTItbmlzdHA1MjEAAAAIbmlzdHA1MjEAAACFBAD2VeqOZ9bk2ABF6AZ63qJY2sDfz0kJJPfDW0zpres0/p1YGGJBYtyU4l3nIgwx0K2iEKFty429N2NNfIMBsqI+ngDq3/VGaexmZxymJnCzOl9+J1IQr6u05jZHLsk1FOALjOSm9jv4bF/DyK4oh5shKMlTHAeDWPfqMd3JwncSYBzKfA== craig@keeperdemo.io
7

Enable Git Signing

From the terminal, instruct Github to sign commits using this new key and allowed signers.

git config --global user.signingkey ~/.ssh/git_signing_key.pub
git config --global gpg.format ssh
git config --global commit.gpgsign true
git config --global gpg.ssh.allowedSignersFile ~/.ssh/allowed_signers

This basically has the effect of adding several lines to ~/.gitconfig and applies the changes globally. You can also configure individual repos instead of making these changes globally.

8

Verify Signing

From a repository, let's do a quick empty commit to test the signing process:

git commit --allow-empty -m "Test commit with SSH signing"

This immediately will trigger a Keeper dialog to authorize the key.

To verify that the signature was applied to the commit, run the following:

git log --show-signature

The response will display something like this:

commit 52319faf2e7c02a (HEAD -> main)
Good "git" signature for craig@keeperdemo.io with ECDSA key SHA256:xxxxxxx
Author: Craig Lurey <craig@keeperdemo.io>
Date:   Fri Jan 17 20:18:19 2025 -0800

    Test commit with SSH signing

Setup is complete.