GPG Sign Your Git Commits
4 June 2014
Getting started with GPG and using it on a daily basis is, when you’re using the right tools, not all that hard, but still quite technical. Today Google announced they are working on a Chrome extention to enable end-to-end encryption using OpenPGP.
As a developer, I do more than dispatching emails all day. On occasion I write code. And that code gets committed to a repository that will remember that commit forever.
Just as with emails it is remarkably easy to fake your identity when committing code.
git commit -a -m "Meh" --author "Chuck Norris <firstname.lastname@example.org>"
In theory, this would allow anyone to commit (malicious) code under your name. Meaning that you’ll get the blame for the back door you committed.
Git seems to offer a resolution by adding a
Signed-off-by field, to allow a second developer to sign off on code that gets merged into the project. But this field suffers from the same trust issues as the
You cannot trust the git Author and Signed-off-by fields.
Again, GPG offers a solution to the problem of trust. By establishing trust based on public keys, wouldn’t it be cool if you could sign a git commit just the same way you’d sign an email?
Well, you can.
git commit -a -m "Cool new feature" --gpg-sign=F713697B
This will attach your signature to the git commit message, allowing others to validate your signature. Validating this signature is quite easy as well.
git log --show-signature commit 3d53a4be3f6f955007dc056347d926067bbfa8de gpg: Signature made zo 1 jun 20:42:58 2014 CEST using RSA key ID F713697B gpg: Good signature from "Ariejan de Vroom <email@example.com>" Author: Ariejan de Vroom <firstname.lastname@example.org> Date: Sun Jun 1 20:42:58 2014 +0200
Any other developer (or your CI) can now validate your commit as coming from you, based on the trust they assigned to your public key.
Optionally to using
--gpg-sign you can use
-S. If you don’t specify a specific key, git will try to figure out what key to use based on your email address. It’s also possible to set a default signing key globally.
git config --global user.signingkey F713697B
Besides signing every commit you make, it’s also good idea to sign tags. That way you can be sure that the created tag was actually created by a trusted person.
git tag -s 1.2.3 -m "Release 1.2.3 including bug fixes."
If you are responsible for integrating features and bug fixes into the main branch of a project, you’d probably like to sign the merges you make. You have two options here.
The first is to merge and manually commit a sign the merge.
git merge feature-awesome --no-commit git commit -m "Merge feature-awesome" -S
The second is merging and signing directly.
git merge feature-awesome -S
Be sure to check out this in depth guide by Mike Gerwitz.
Where to go from here?
Trust is a hard thing to come by on the internet and it really bites you when things go wrong. Just as with email, creating a web of trust can be helpful and someday save you from disaster.