Is there a way to “autosign” commits in Git with a GPG key?

Note: if you don’t want to add -S all the time to make sure your commits are signed, there is a proposal (branch ‘pu‘ for now, December 2013, so no guarantee it will make it to a git release) to add a config which will take care of that option for you.
Update May 2014: it is in Git 2.0 (after being resend in this patch series)

See commit 2af2ef3 by Nicolas Vigier (boklm):

Add the commit.gpgsign option to sign all commits

If you want to GPG sign all your commits, you have to add the -S option all the time.
The commit.gpgsign config option allows to sign all commits automatically.

commit.gpgsign

A boolean to specify whether all commits should be GPG signed.
Use of this option when doing operations such as rebase can result in a large number of commits being signed. It may be convenient to use an agent to avoid typing your GPG passphrase several times.


That config is usually set per repo (you don’t need to sign your private experimental local repos):

cd /path/to/repo/needing/gpg/signature
git config commit.gpgsign true

You would combine that with user.signingKey used as a global setting (unique key used for all repo where you want to sign commit)

git config --global user.signingkey F2C7AB29!
                                           ^^^

As ubombi suggests in the comments (and explain in “GPG Hardware Key and Git Signing“, based on “How to Specify a User Id“)

When using gpg an exclamation mark (!) may be appended to force using the specified primary or secondary key, and not to try and calculate which primary or secondary key to use.

Note that Rik adds in the comments:

If you’re using something like a YubiKey (as recommended) you don’t need to worry about the exclamation point because the only signing key(s) you should have available for a primary key-pair are:

  • the primary key itself, which should have a # after it indicating it’s not available,
  • and the secret subkey with a > after it indicating it’s a stub that points to the YubiKey as the only available signing key in its applet.

Only if you keep all your private keys available on your system (bad practice), then probably it would be a good idea to prevent auto-selection between available signing keys


user.signingKey was introduced in git 1.5.0 (Jan. 2007) with commit d67778e:

There shouldn’t be a requirement that I use the same form of my name in
my git repository and my gpg key.
Further I might have multiple keys in my keyring, and might want to use one that doesn’t match up with the address I use in commit messages.

This patch adds a configuration entry “user.signingKey” which, if present, will be passed to the “-u” switch for gpg, allowing the tag signing key to be overridden.

This is enforced with commit aba9119 (git 1.5.3.2) in order to catch the case where If the user has misconfigured user.signingKey in their .git/config or just doesn’t have any secret keys on their keyring.

Notes:

Leave a Comment