[WINDOWS] How to enable auto-signing Git commits with GnuPG for programs that don't support it natively

README.md

[WINDOWS] How to enable auto-signing Git commits with GnuPG for programs that don't support it natively

This is a step-by-step guide on how to enable auto-signing Git commits with GPG for every applications that don't support it natively (eg. GitHub Desktop, Eclipse, Git Tower, ...)

Requirements

• Install GPG4Win: this software is a bundle with latest version of GnuPG v2, Kleopatra v3 certificate manager, GNU Privacy Assistant (GPA) v0.9 which is a GUI that uses GTK+, GpgOL and GpgEX that are respectively an extension for MS Outlook and an extension for Windows Explorer shell
• Install Git for Windows: so you can have a *nix based shell, this software is a bundle with latest version of Git which use MINGW environment, a Git bash shell, a Git GUI and an extension for Windows Explorer shell (Make sure your local version of Git is at least 2.0, otherwise Git don't have support for automatically sign your commits)
• Verify if Git was successfully installed with:

  $ git --version
  # git version 2.15.1.windows.2

Remember that Git for Windows install old 1.4.xx version of GnuPG (provided through MINGW environment), but this is irrelevant, as we are going to manually specify which GnuPG program our Git must be using (which is the GnuPG version installed by GPG4Win)!

Setup

• Install your favorite IDE with Git support, like:
  • GitHub Desktop: https://desktop.github.com/
  • Eclipse: https://www.eclipse.org/downloads/ with one of Git plugin (mandatory)
• Generate your GPG keys: visit https://help.github.com/articles/generating-a-new-gpg-key/ for a completed and detailed instructions, or otherwise use Kleopatra manager (Notes: key size should be at least 2048 bits, but 4096 is better; key should probably not expire; and you can append multiple email addresses to your GPG key)
• Verify installation of your key:

  $ gpg --list-secret-keys --keyid-format LONG
  # /c/Users/BoGnY/.gnupg/secring.gpg
  # ----------------------------------
  # sec   4096R/E870EE00B5D90537 2017-12-31 [expires: 2021-12-31]
  # uid                          John Smith <[email protected]>
  # ssb   4096R/F9E3E72EBBFDCFD6 2017-12-31

• Generate your revocation certificate: this command create a .rev file, that is needed to revocate a public key shared in a key server.

  $ gpg --gen-revoke E870EE00B5D90537

• Share your public key: this command will never send a private key!!!

  $ gpg --send-keys E870EE00B5D90537

• Add public GPG key to GitHub: open https://github.com/settings/keys then click "New GPG key", paste your public key and click "Add GPG key"
• Set up Git to auto-sign all commits: this change your global configuration of Git, if you would like to add auto-sign on a single repository, remove --global from command

  $ git config --global user.signingkey E870EE00B5D90537
  $ git config --global commit.gpgsign true

• Set up Git to use a custom GPG program:

  $ git config --global gpg.program "/c/Program Files (x86)/GnuPG/bin/gpg.exe"

• Optional: try disable TTY if you have problems with making auto-signed commits from your IDE or other software

  $ echo 'no-tty' >> ~/.gnupg/gpg.conf

  In my specific case, this point was mandatory.

Usage

Simple press "Commit" button on your favorite IDE, you see a simple window that ask your key password!

Remember that GPG4Win install also a GPG agent, that remember your password for a limited times (I think 30 minutes) by default, so you don't have to enter your password every time!! (IMHO there is a setting for change it, but I haven't search it yet).

That's all!

When I am trying to generate a new key I am the following error
gpg: Sorry, no terminal at all requested - can't get input
can anyone help me out to solve this issue

Im trying to make it work on Pycharm, however it still displays the same error message.

Commit failed with error
0 file committed, 1 file failed to commit: Block D Factories created, pending implementation - TESTE
gpg: skipped "USERNAME ": No secret key
gpg: signing failed: No secret key
gpg failed to sign the data
failed to write commit object

This is my local .gitconfig file. Anyone with the same issue?

everything worked fine until you had to tell git here the exe was for gpg. The command I used instead was:
git config --global gpg.program "C:\Program Files (x86)\GnuPG\bin\gpg.exe"

thank you full , i am worked git config --global gpg.program "C:\Program Files\GnuPG\bin\gpg.exe"

everything worked fine until you had to tell git here the exe was for gpg. The command I used instead was:
git config --global gpg.program "C:\Program Files (x86)\GnuPG\bin\gpg.exe"

This was my issue as well. Got it working, thanks!

Follow the below url to setup signed commit https://help.github.com/en/articles/telling-git-about-your-signing-key

if still getting gpg failed to sign the data fatal: failed to write commit object

this is not issue with git ,this is with GPG follow below steps

1. gpg --version

2. echo "test" | gpg --clearsign

if it is showing:

gpg: signing failed: Inappropriate ioctl for device
gpg: [stdin]: clear-sign failed: Inappropriate ioctl for device

3. then use export GPG_TTY=$(tty)

4. then try again echo "test" | gpg --clearsign in which PGP signature is.

Output:

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

test
-----BEGIN PGP SIGNATURE-----

iLMEAQEKAB0WIQS2V0SFHi18psvDbo7uFF+LP7qc1gUCYLjB2QAKCRDuFF+LP7qc
1r5LBACB1m3Lpl21379qAvVamWcn9isdgdg34t34t43t34t34t434yGQHqikxWL7A5
Ls7giKZYscb30o0rkY6I1W9MjBBW96R2pnaYsioFpsf434dfg54rfdgfdgdfgdfpaIoU3k
JKrYxR7yMjqUv0a2jE+97kh+bSuzqwIkMHyikbABI90lY+4OLw==
=UHKx
-----END PGP SIGNATURE-----

5. git config -l | grep gpg

Output:

commit.gpgsign=true
gpg.program=gpg
tag.gpgsign=true

6. apply git commit -S -m "initial commit 🚀🚀🚀🚀"
7. or git config --global commit.gpgsign true

https://stackoverflow.com/questions/39494631/gpg-failed-to-sign-the-data-fatal-failed-to-write-commit-object-git-2-10-0/55993078#55993078

Thank so much!
I changed
git config --global gpg.program "/c/Program Files (x86)/GnuPG/bin/gpg.exe"
to
git config --global gpg.program "C:\Program Files (x86)\GnuPG\bin\gpg.exe"

on windows

Thank so much!
I changed
git config --global gpg.program "/c/Program Files (x86)/GnuPG/bin/gpg.exe"
to
git config --global gpg.program "C:\Program Files (x86)\GnuPG\bin\gpg.exe"

on windows

same.
Setting this config entry also was mandatory. I wasn't sure what issued the "git gpg skipped ... no secret key" error message, but now I know it was this line.

Thank you ! It worked for me.

Couldn't get this to work even after reading all the comments.
I've posted a related question on https://stackoverflow.com/questions/70212042/eclipse-unable-to-find-a-gpg-key-for-signing-verify-through-eclipse

If it will be answered there, then it'll help those who still can't get this to work from Eclipse.

When another GPG instance (same major version, though!) uses a different directory for the databases, you can always point them to the correct one using the GNUPGHOME environment variable.

Another way is to create a junction point or symbolic link from %USERPROFILE%\.gnupg to %USERPROFILE%\.gnupg, that is either (after moving the old %USERPROFILE%\.gnupg out of the way):

mklink /j "%USERPROFILE%\.gnupg" "%USERPROFILE%\.gnupg"

or (this requires to be run in an elevated prompt, unless the option to create symbolic links was enabled for the current user, e.g. via the Git for Windows installer):

mklink /d "%USERPROFILE%\.gnupg" "%USERPROFILE%\.gnupg"

From experience the respective files can live side by side peacefully. I have not heard of another location used by GnuPG flavors on Windows. But if they exist, you can always point them all to the same directory. However, keep in mind that 1.x and 2.x versions use different databases altogether, so this still doesn't iron out all issues.

Great !

Thx a lot and works.
ps. I use

git config --global gpg.program "C:\Program Files (x86)\GnuPG\bin\gpg.exe"

for Git-SCM.

I figured out my issue. I was using Git Bash instead of cmd.exe or PowerShell. This was using a different gpg which was putting the GPG keys in a location that /c/Program Files (x86)/GnuPG/bin/gpg.exe didn't know about. All I had to do was change

$ git config --global gpg.program "/c/Program Files (x86)/GnuPG/bin/gpg.exe"

to

$ git config --global gpg.program "/c/Program Files/Git/usr/bin/gpg.exe"

and everything worked. I've uninstalled GPG4Win as it seems that it wasn't actually needed.

My version of git is now 2.19.0.windows.1, and gpg is 2.2.9-unknown

Thank you so much! It works. However, if you continue having problems, repeat these steps again: Telling Git about your GPG key.

Thx a lot and works. ps. I use

git config --global gpg.program "C:\Program Files (x86)\GnuPG\bin\gpg.exe"

for Git-SCM.

Another alternative without quotes:

 git config --global gpg.program C:\PROGRA~2\GnuPG\bin\gpg.exe

Another alternative without quotes:

 git config --global gpg.program C:\PROGRA~2\GnuPG\bin\gpg.exe

Thanks for the addition!

Another alternative without quotes:

 git config --global gpg.program C:\PROGRA~2\GnuPG\bin\gpg.exe

A word of caution: 1.) short file name creation may be disabled (fsutil 8dot3name set 1) 2.) technically C:\PROGRA~2 could be another directory than C:\Program Files (x86). That said, if it works this should be fine anyway. But these are caveats to be aware of.

I figured out my issue. I was using Git Bash instead of cmd.exe or PowerShell. This was using a different gpg which was putting the GPG keys in a location that /c/Program Files (x86)/GnuPG/bin/gpg.exe didn't know about. All I had to do was change
$ git config --global gpg.program "/c/Program Files (x86)/GnuPG/bin/gpg.exe"
to
$ git config --global gpg.program "/c/Program Files/Git/usr/bin/gpg.exe"
and everything worked. I've uninstalled GPG4Win as it seems that it wasn't actually needed.
My version of git is now 2.19.0.windows.1, and gpg is 2.2.9-unknown

Yep, this was also my problem. If you manually install GPG command line tools, you end up having two gpg.exe inside git-bash.exe. This can be verified by typing where gpg inside Git Bash. Cheers, mate!

THISS x 1000000 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

THANK YOU!!!! - Windows 10 , Followed GitHub Instuctions, Got Wrecked before this helpfull post. Thanks!!

But you have to enter the passphrase again and again?

@KayvanShah1 commented on Jun 25, 2024, 8:15 PM GMT+2:

But you have to enter the passphrase again and again?

must be entered the first time you make a commit after every start/reboot..
the first sign starts the gpg-agent which keep passphrase in memory until shutdown/reboot

however, I don't use anymore gpg4win, I use the gpg bundled with git for windows (C:\Program Files\Git\usr\bin\gpg.exe)