GnuPG for everything

When I work with Git, I use SSH keys for authentication with GitHub, GitLab etc. Same goes for SSH connections for terminal connections to servers.

When I want to sign or encrypt my e-mails, I use GPG. I also use GPG indirectly when using pass - The Standard Unix Password Manager. And you need GPG if you want to publish a package to Maven Central, for example. You can also use GPG to sign your git commits.

I barely used GPG in the past, but since I heard you can use the GPG key also for SSH connections, I thought that this would be a big improvement for me. I would only have to handle the single GPG key instead of having GPG and SSH simultaneously.

I have also used a Nitrokey in the past, which can be used as a GPG smartcard. That means your keys wouldn't be stored on your computer, but inaccessible on a secure device. Nice. Modern computers also have a secure chip built-in, which works similar to a Nitrokey: TPM.

I tried to put this all together to end up with a GPG key stored in the TPM which I can use for:

• Sign and encrypt files
• Sign e-mails
• SSH terminal connections
• Git authentication (GitHub, GitLab)
• Passwords (via pass)

1. Setup keys

1.1. Install gpg

The default gpg package in Manjaro/Arch is still 2.2.41, which is the latest LTS version. However, you need at least 2.3 to work with TPM 2.0. The latest version (as of today) is 2.4.0 released on 2022-12-16.

In AUR I couldn't find a 2.4 though. There is a gnupg-git which just points to the latest master. And there is gnupg23, which is not the latest, but at least an officially released version and the version just before 2.4.0. I decided to use it.

Edit: And just as I write this, there was a new package: gnupg24. Thank you, ImperatorStorm.

paru -S gnupg24

It will warn you that..

:: gnupg24 and gnupg are in conflict. Remove gnupg? [y/N]

but you can just proceed with yes.

$ gpg --version
gpg (GnuPG) 2.4.0
libgcrypt 1.10.1-unknown
Copyright (C) 2021 Free Software Foundation, Inc.
License GNU GPL-3.0-or-later <https://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

Home: /home/neonew/.gnupg
Supported algorithms:
Pubkey: RSA, ELG, DSA, ECDH, ECDSA, EDDSA
Cipher: IDEA, 3DES, CAST5, BLOWFISH, AES, AES192, AES256, TWOFISH,
        CAMELLIA128, CAMELLIA192, CAMELLIA256
Hash: SHA1, RIPEMD160, SHA256, SHA384, SHA512, SHA224
Compression: Uncompressed, ZIP, ZLIB, BZIP2

1.2. Generate primary key

We will generate one key for each usage flag of GPG. Usage flags are: cert, encrypt, sign and auth.

Our primary key will only have the cert flag, and we will have one subkey for each other flag.

You can of course decide you want to do this differently, like having just one primary key with all the flags and no subkeys to have a simpler process.

1.2.1. Using a config file

I recommend to use the method below, but for completeness, here is an alternative:

%echo Generating a OpenPGP key
%echo https://www.gnupg.org/documentation/manuals/gnupg/Unattended-GPG-key-generation.html
Key-Type: RSA
Key-Length: 4096
# Allowed values are ‘encrypt’, ‘sign’, and ‘auth’.
Key-Usage: cert
Subkey-Type: RSA
Subkey-Length: 2048
Name-Real: My Name
Name-Comment: MyComment
Name-Email: my@email.com
Expire-Date: 0
# Passphrase: <not used, passed via stdin>
# Do a commit here, so that we can later print "done" :-)
%commit
%echo done

gpg --batch --generate-key key.config

1.2.2. Using quick-generate-key (recommended)

You can also use gpg --gen-key or gpg --full-generate-key, but they require more interactive input, that's why I like gpg --quick-generate-key best.

gpg --quick-generate-key "My Name (MyComment) <my@email.com>" rsa4096 cert 1y

1.2.3. Revocation key

You should also generate a revocation key now, in case you forget your password or your key is compromised. Use the long key id as argument for gen-revoke.

gpg --list-secret-keys --keyid-format long --with-keygrip --with-subkey-fingerprints
gpg --output primary.revoke.asc --gen-revoke 1111111190ABCDEF1234567890ABCDEF11111111

Revoke certificate generation is not possible in batch mode. :/

1.2.4. Add photo

This is the command I used to generate my small photo, which is just under 6.144 bytes.

magick convert -auto-orient -strip -gaussian-blur 0.05 -gravity center -crop 240:288 +repage -resize "240x288" -sampling-factor 4:2:0 -interlace JPEG -colorspace YUV -quality 52 input.jpg gpg.jpg

Verify the sampling factor via identify:

identify -format "%[jpeg:sampling-factor]" gpg.jpg

See here: How to find out the chroma subsampling of a jpg?. In my case, the output was just 2x2.

If you are happy with the result, add the jpg to your key via:

gpg --edit-key 1111111190ABCDEF1234567890ABCDEF11111111 addphoto save

Here is my photo, a 6.109 bytes file:

1.3. Generate Subkeys

gpg --batch --quick-add-key 1111111190ABCDEF1234567890ABCDEF11111111 rsa2048 sign 1y
gpg --batch --quick-add-key 1111111190ABCDEF1234567890ABCDEF11111111 rsa2048 encrypt 1y
gpg --batch --quick-add-key 1111111190ABCDEF1234567890ABCDEF11111111 rsa2048 auth 1y

1.4. Backup all your keys

This is very important. In the following steps, we are going to delete all keys from GPG, so you need to have a backup of your keys!

Please be aware you should take precautions during this step to make sure your keys don't get stolen. For example disable network connections, bluetooth etc. and use a strong password.

1.4.1. Reset password (optional)

I case you do not want to use a strong password (for example when you fear you might forget it) and can make sure nobody gets access to the plain key files, you can reset your password from your key like this:

gpg --change-passphrase 1111111190ABCDEF1234567890ABCDEF11111111

1.4.2. Backup to file

gpg --output primary-with-subkeys.public.asc --armor --export 1111111190ABCDEF1234567890ABCDEF11111111
gpg --output primary-with-subkeys.secret.asc --armor --export-secret-keys --export-options export-backup 1111111190ABCDEF1234567890ABCDEF11111111
gpg --output subkeys-only.secret.asc --armor --export-secret-subkeys --export-options export-backup 1111111190ABCDEF1234567890ABCDEF11111111

# Validate:
gpg --show-keys primary-with-subkeys.public.asc
gpg --list-packets primary-with-subkeys.public.asc
pgpdump primary-with-subkeys.public.asc

Please note that the exported files will still be password protected by the same password as the original key.

1.4.3. Paperkey backup

A paperkey is a method to keep an offline, non-electronic backup of your identity. You can either print is as text or as a QR code.

Unfortunately there is no widespread way to save your private key as mnemonic to make the whole process easier. Something like BIP39 for Bitcoin.

Maybe this project mnemonikey is promoising in this regard. I haven't tried it yet though.

1.4.3.1. Text paperkey

gpg --export-secret-key 1111111190ABCDEF1234567890ABCDEF11111111 | paperkey > paperkey.txt

1.4.3.2. QR code paperkey

1.4.3.2.1. Generate QR code paperkey

gpg --export-secret-key 1111111190ABCDEF1234567890ABCDEF11111111 | paperkey --output-type raw | qrencode --8bit --output secret-key.qr.png

It is possible to increase the error correction level to maximum with the --level H option. This provides a lost data restoration rate of about 30% at the cost of reduced capacity. Should the secret key not fit in the QR code, the lower Q and M error correction levels are also available and give restoration rates of about 25% and 15% respectively. The default error correction level is L which allows restoration of about 7% of lost data.

1.4.3.2.2. Big private keys

qrencode might fail with Failed to encode the input data: Input data too large. If the files are too big, you can split them into multiple parts in order to generate multiple QR codes.

gpg --export-secret-key 1111111190ABCDEF1234567890ABCDEF11111111 | paperkey --output-type raw > paper.key
split -n 2 -d paper.key paper.key-part-
qrencode --8bit --level H --read-from paper.key-part-00 --output secret-key.qr.level-h.part-00.png
qrencode --8bit --level H --read-from paper.key-part-01 --output secret-key.qr.level-h.part-01.png

1.4.3.2.3. Re-import QR code paperkey on a different machine

Make sure to have the public key available on that machine, as it is not part of the QR code, only the secret parts are.

The public key must be in gpg format (and not an armored asc file).

zbarimg -1 --raw -q -Sbinary secret-key.qr.png | paperkey --pubring paperkey.public.gpg | gpg --import

If no or the wrong public key is used, you might see this error message:

Error: unable to parse OpenPGP packets (is this armored data?)
Unable to find secret key packet

1.5. Delete private key

Please, make sure you have a working backup before executing this.

gpg --delete-secret-keys 1111111190ABCDEF1234567890ABCDEF11111111

# Validate:
gpg --list-secret-keys --keyid-format long --with-keygrip --with-subkey-fingerprints

# To delete a sub-key only, you need the exclamation mark!
# gpg --delete-secret-keys 5555ABCDEFAB5555!

1.6. Re-Import the Sub-Keys only

We want to put the primary key backup in a secure place and only leave the sub-keys on our system for everyday use.

gpg --import subkeys-only.secret.asc

# Validate:
gpg --list-secret-keys --keyid-format long --with-keygrip --with-subkey-fingerprints

Not the hash sign (#) after the primary key, which indicates it is not stored on the disk.

1.7. Trust the key

In order to sign and encrypt, we need to trust this key. Just set the trust level to ultimate (5).

gpg --edit-key 1111111190ABCDEF1234567890ABCDEF11111111 trust quit

1.8. Optional: Publish key to keyserver

If you like, you can share your public key to others by uploading it on a keyserver, like keyserver.ubuntu.com

gpg --send-keys 1111111190ABCDEF1234567890ABCDEF11111111

See my published key here:

Download

2. Key ID: Short vs. Long vs. Keygrip vs. Fingerprint

-> Always use the fingerprint for the Key ID

What is the Keygrip then?

Also, the keygrip has the same length as a fingerprint:

7196E08194D53FCBFD15D960FA6C71F9A73DBE0B
69B7D1FBF6F48ACA54531CB771088109C081C081

Pff...confuse me more. gpg cli in my opinion should never display the short and long key ids if they are not to be trusted. --with-subkey-fingerprints should be the default. And gpg should put a prefix/name if it outputs a (seemingly) random number to the user. But well.

3. Thoughts on multiple identities

I would love to only use a single identity for all purposes, because I am a single person.

However, I do use a separate GPG key for personal and business usages. I might even split up my personal keys further, depending on how secret something should really be.

The reason is (as someone on the internet pointed out): You need to expose your whole social network with GPG. You need to connect all your personal and business e-mail addresses to your UIDs, if you decide to use a single key. You cannot keep like a single e-mail-address private or disconnect it. It would need to be a UID in a different key then.

It is by design.

I would like to see a combined key which expresses "I am Andreas and I am using my personal laptop", which is pretty much the same as please confirm your new device messages from various services. My identity would still be Andreas, but I'd need a second secret to get access to some service. I'm not sure whether this is possible with GPG.

4. Thoughts on pinentry

I dislike you cannot see which process asked for the key when doing a decryption or signing. pinentry just pops ups and asks for a your passphrase.

The user cannot see which process (maybe with PID and icon) wants to use the key for what reason.

5. Use TPM 2.0

See this guide from the official gnupg.org page.

Important: TPM only supports a specific set of algorithms for encryption and hashing. Make sure you use algorithms supported by your hardware.

TPM 2.0 gurantees RSA-2048 and SHA-256 will work.

Make sure to add yourself to the tss group:

sudo pacman -S tpm2-tools
sudo usermod -aG tss $USER

One thing I'd like to see is TPM with a smartcard interface. I can't understand why there need to be keytocard and keytotpm commands, when they are essentially doing the same thing. I do understand TPM is different from a smartcard and maybe offers more features, but it just would be nice to support the smartcard interface. On Windows for example, there is a thing like a TPM virtual smart card. That's what I mean, but it should be part of TPM, in my opinion.

Regarding the trustworthiness of TPM: I can't really tell, and there might be backdoors. I just like the concept that the private key is never accessible in the RAM of the computer. That's the main reason I prefer it over password-protected keys (without TPM), even though the latter might be more trustworthy.

5.1. Move subkeys

gpg --edit-key 1111111190ABCDEF1234567890ABCDEF11111111 "key 5555ABCDEFAB5555" keytotpm quit
gpg --edit-key 1111111190ABCDEF1234567890ABCDEF11111111 "key 6666ABCDEFAB6666" keytotpm quit
gpg --edit-key 1111111190ABCDEF1234567890ABCDEF11111111 "key 7777725CD5447777" keytotpm quit

You need to enter the original password of your gpg key and then you can choose the same (or different) password used by the TPM. Note the > signs after ssb in the gpg --list-secret-keys output, which tells the key is now stored inside the TPM and cannot be accessed directly anymore.

5.2. Test signing

Make sure the subkey still works:

echo Test > test.txt
gpg --clear-sign --local-user my@email.com --output test.txt.asc test.txt
cat test.txt.asc
rm test.txt test.txt.asc

You are now asked to enter the TPM password.

5.3. Troubleshooting SHA-512

I had a problem connecting to my server via SSH after I moved the keys to the TPM.

It took me some time to find the reason: SSH tried to do the signature with SHA-512, which is not supported by my TPM.

$ ssh -vvvv nuc@nuc
debug1: Server accepts key: (none) RSA SHA256:++3tZOdzV9LhXrOHIkn8Cvfm4OknxQ8UYT7vjg7PQDw agent
debug3: sign_and_send_pubkey: using publickey with RSA SHA256:++3tZOdzV9LhXrOHIkn8Cvfm4OknxQ8UYT7vjg7PQDw
debug3: sign_and_send_pubkey: signing using rsa-sha2-512 SHA256:++3tZOdzV9LhXrOHIkn8Cvfm4OknxQ8UYT7vjg7PQDw
sign_and_send_pubkey: signing failed for RSA "(none)" from agent: agent refused operation

$ systemctl --user status gpg-agent
● gpg-agent.service - GnuPG cryptographic agent and passphrase cache
     Loaded: loaded (/usr/lib/systemd/user/gpg-agent.service; static)
     Active: active (running) since Tue 2023-03-28 23:39:17 CEST; 33min ago
TriggeredBy: ● gpg-agent-extra.socket
             ● gpg-agent-ssh.socket
             ● gpg-agent-browser.socket
             ● gpg-agent.socket
       Docs: man:gpg-agent(1)
   Main PID: 1316 (gpg-agent)
      Tasks: 8 (limit: 38083)
     Memory: 16.6M
        CPU: 6.257s
     CGroup: /user.slice/user-1000.slice/user@1000.service/app.slice/gpg-agent.service
             ├─1316 /usr/bin/gpg-agent --supervised
             ├─3031 scdaemon --multi-server
             └─3034 tpm2daemon --multi-server

Mär 29 00:12:57 andreas-peac gpg-agent[3034]: ERROR:esys:src/tss2-esys/esys_iutil.c:394:iesys_handle_to_tpm_handle() Error: Esys invalid ESAPI handle (ff).
Mär 29 00:12:57 andreas-peac gpg-agent[3034]: ERROR:esys:src/tss2-esys/esys_iutil.c:1105:esys_GetResourceObject() Unknown ESYS handle. ErrorCode (0x0007000b)
Mär 29 00:12:57 andreas-peac gpg-agent[3034]: ERROR:esys:src/tss2-esys/esys_tr.c:522:Esys_TRSess_SetAttributes() Object not found ErrorCode (0x0007000b)
Mär 29 00:12:57 andreas-peac gpg-agent[3034]: tpm2daemon[3034]: DBG: asking for PIN 'TPM Key Passphrase'
Mär 29 00:12:58 andreas-peac gpg-agent[3034]: WARNING:esys:src/tss2-esys/api/Esys_Sign.c:311:Esys_Sign_Finish() Received TPM Error
Mär 29 00:12:58 andreas-peac gpg-agent[3034]: ERROR:esys:src/tss2-esys/api/Esys_Sign.c:105:Esys_Sign() Esys Finish ErrorCode (0x000001d5)
Mär 29 00:12:58 andreas-peac gpg-agent[3034]: TPM2_Sign failed with 469
Mär 29 00:12:58 andreas-peac gpg-agent[3034]: tpm:parameter(1):structure is the wrong size
Mär 29 00:12:58 andreas-peac gpg-agent[1316]: smartcard signing failed: Kartenfehler
Mär 29 00:12:58 andreas-peac gpg-agent[1316]: ssh sign request failed: Kartenfehler <Quelle nicht angegeben>

The important bits here are TPM2_Sign failed with 469 and structure is the wrong size. See here: lists.archive.carbon60.com/gnupg/devel/91138

Depending on the sshd_config, you might need to specify the algorithm. SHA-512 is not compatible with TPM2.0, so you might try this:

ssh -vvvv -o PubkeyAcceptedKeyTypes=rsa-sha2-256 nuc@nuc

Or, alternatively you can set this option for all connections (you might need to append the file):

Host *
  PubkeyAcceptedKeyTypes rsa-sha2-256

5.4. Use tpm2 from command line

Test supported algorithms:

# List supported algorithms:
tpm2_getcap algorithms

# Test specific algorithm
tpm2_testparms rsa2048
tpm2_testparms rsa4096

To use TPM without GPG you can run this example.

openssl genrsa -out private.pem 2048
openssl rsa -in private.pem -outform PEM -pubout -out public.pem
tpm2_createprimary --hierarchy=e --key-algorithm=rsa2048 --key-context=primary.ctx
tpm2_import -C primary.ctx -G rsa -i private.pem -u key.pub -r key.priv # e stands for TPM_RH_ENDORSEMENT
rm private.pem

echo "This is the secret" > test.txt
openssl pkeyutl -encrypt -pubin -inkey public.pem -in test.txt -out test.txt.enc

tpm2_load -C primary.ctx -u key.pub -r key.priv -c key.ctx
tpm2_rsadecrypt -c key.ctx -o test.decrypted.txt test.txt.enc
cat test.decrypted.txt
rm test.txt test.txt.enc test.decrypted.txt public.pem primary.ctx key.pub key.priv

My TPM2 does not support RSA with 4096-bits keys. I get the same error as described here.

Which is a pity, because tools like forgejo require at least 3072 bits.

6. gpg-agent log

systemctl --user status gpg-agent

7. SSH via GPG

GPG Key with usage flag Authentication is needed.

Here is my setup for gpg-agent and the fish shell.

echo enable-ssh-support >> ~/.gnupg/gpg-agent.conf
echo <SSH-SUBKEY-KEYGRIP> >> ~/.gnupg/sshcontrol
gpg --export-ssh-key 1111111190ABCDEF1234567890ABCDEF11111111

set --erase SSH_AGENT_PID
set --erase SSH_AUTH_SOCK
set --universal --export SSH_AUTH_SOCK (gpgconf --list-dirs agent-ssh-socket)
set --export GPG_TTY (tty)
gpg-connect-agent updatestartuptty /bye >/dev/null

8. pass

pass automatically works with GPG, so all you need to do is set up the right key:

pass init [-p subfolder] 1111111190ABCDEF1234567890ABCDEF11111111

8.1. PassFF for Firefox

To automatically fill passwords in your browser, use this sweet extension: github.com/passff/passff

Unfortunately, it requires a host service to run on your machine. It works well, though.

I prefer it over github.com/browserpass/browserpass-extension, because it doesn't require your filename to match the URL of a service. I prefer to have a paypal.gpg rather than a paypal.com.gpg.

Reason: I have an account for a service, not a domain. Domains might change, and to support multiple domains, you need hacks.

This specific problem is not solved for passff either, but I like the approach to specify the URL inside the data just better.

Make sure to enable the configuration option Index URL fields on startup.

Installation and example usage of passff:

sudo pacman -S passff-host firefox-extension-passff

$ pass insert -m someservice
Enter contents of someservice and press Ctrl+D when finished:

my-secret-password
login: my@email.com
url: someservice.com
[master 6e0d7a4] Add given password for someservice to store.
 1 file changed, 2 insertions(+)
 create mode 100644 someservice.gpg

8.2. pass-otp

There is also the neat pass-otp extension for pass, which can generate your 2FA numbers. However, I prefer to keep a real second factor with my Android phone and Aegis. I dislike the idea of having all secrets on the same device for a reason.

9. git: Sign commits SSH vs. GPG

Since 2021 it is also possible to use SSH (and not just GPG) to sign commits.

I like GPG better though: It can contain your uid (or multiple), a photo, sharing via keyservers is easier..

Also, I'm not sure if common other tools like Thunderbird support signing via SSH key, so I want to have a GPG key anyway.

10. E-Mails

I'd love to use OpenPGP signing with Thunderbird. I don't really care about encryption here, but signing would be nice.

However, I wasn't able to connect Thunderbird to my GPG-managed TPM key.

Previous to Thunderbird 78 there was a plugin named Enigmail, which worked great in combination with GnuPG. Since then, Thunderbird decided to not use GnuPG any longer "to avoid licensing issues" source.

They chose to integrate OpenPGP directly into the program (so no additional plugin needed -> yay), but their library RNP does not support SmartCards at all, and also no TPM (boo!). To me it is not understandable how you strip an important feature like that from a working extension without replacement.

Sooo....Thunderbird added a hidden feature allow_external_gnupg which uses the GPGME library to access the GnuPG keys. See their guide here.

I tried to use it and failed, and in general it seemed not user-friendly to me yet. Duplicating the public keys in another keychain is bad enough, you can only configure one Key-ID, there is no check the Key-ID you enter is valid and the error message I got when signing a message was only visible in the Error Console.

It complained that GPGME.allDependenciesLoaded() returned false, however I had the gpgme package installed on my machine.

$ ls -lah /usr/lib/libgpgme.so
lrwxrwxrwx 1 root root 19 20. Mär 14:58 /usr/lib/libgpgme.so -> libgpgme.so.11.28.0*

$ gpgme-tool
OK GPGME-Tool 1.19.0 ready
KEYLIST
D <?xml version="1.0" encoding="UTF-8" standalone="yes"?>%0A
D <gpgme>%0A
D   <keylist>%0A
D     <key>%0A
D       <revoked value="0x0" />%0A
D       <expired value="0x0" />%0A

Maybe in an incompatible version, because I have updated gpg manually..? I don't know, and I didn't investigate further.

Update: After restarting my system and re-configuring the GPG key in Thunderbird I got it working. I needed to use the Long Key ID. I use multiple e-mail addresses, so I had to make sure to configure the right one (via Manage identities...):

11. Chat

XMPP supports an experimental extension for OpenPGP support.

I've tried to use it with the Gajim client, which did not work well.

The OpenPGP plugin for Gajim tries to create a new key and fails. I wasn't able to re-use my existing key.

I did install sudo pacman -S python-gpgme beforehand and I was able to call gpgme in the python interpreter successfully (gpg.Context().create_key('myname')), so I don't know what went wrong here.

12. Links

• https://wxcafe.net/posts/yubikey_for_everything/ (Post title was inspired by this)
• https://mikeross.xyz/create-gpg-key-pair-with-subkeys/
• https://wiki.archlinux.org/title/GnuPG#SSH_agent
• https://gist.github.com/mcattarinussi/834fc4b641ff4572018d0c665e5a94d3
• https://opensource.com/article/19/4/gpg-subkeys-ssh
• https://www.foxk.it/blog/gpg-ssh-agent-fish/