Community guide to using YubiKey for GnuPG and SSH - protect secrets with hardware crypto.
This is a guide to using YubiKey as a smart card for secure encryption, signature and authentication operations.
Cryptographic keys on YubiKey are non-exportable, unlike filesystem-based credentials, while remaining convenient for regular use. YubiKey can be configured to require a physical touch for cryptographic operations, reducing the risk of unauthorized access.
* Configuration * Identity * Key * Expiration * Passphrase * Change PIN * Set attributes * Signature key * Encryption key * Authentication key * Encryption * Signature * Configure touch * SSH + Replace agents + Copy public key + Import SSH keys + SSH agent forwarding - Use ssh-agent - Use S.gpg-agent.ssh - Chained forwarding * GitHub * GnuPG agent forwarding + Legacy distributions + Chained GnuPG agent forwarding * Using multiple YubiKeys * Email + Thunderbird + Mailvelope + Mutt * Keyserver * Renew Subkeys * Rotate Subkeys * Improving entropy * Enable KDF * Network considerationsPurchase YubiKey
All YubiKeys except FIDO-only Security Key Series and Bio Series YubiKeys are compatible with this guide.
Verify YubiKey by visiting yubico.com/genuine. Select Verify Device to begin the process. Touch the YubiKey when prompted and allow the site to see the make and model of the device when prompted. This device attestation may help mitigate supply chain attacks.
Several portable storage devices (such as microSD cards) for storing encrypted backups are also recommended.
Prepare environment
A dedicated, secure operating environment is recommended to generate cryptographic keys.
The following is a general ranking of environments least to most hospitable to generating materials:
- Public, shared or other computer owned by someone else
- Daily-use personal operating system with unrestricted network access
- Virtualized operating system with limited capabilities (using virt-manager, VirtualBox or VMware, for example)
- Dedicated and hardened Debian or OpenBSD installation
- Ephemeral Debian Live or Tails booted without primary storage attached
- Hardened hardware and firmware (e.g., Coreboot, Intel ME removed)
- Air-gapped system without network capabilities, preferably ARM-based Raspberry Pi or other architecturally diverse equivalent
Download the latest Debian Live image and signature files:
export IMAGE_URL="https://cdimage.debian.org/debian-cd/current-live/amd64/iso-hybrid/"
curl -fLO "$IMAGEURL/SHA512SUMS" -O "$IMAGEURL/SHA512SUMS.sign"
curl -fLO "$IMAGE_URL/$(awk '/xfce.iso$/ {print $2}' SHA512SUMS)"
Download the Debian signing public key:
gpg --keyserver hkps://keyring.debian.org \
--recv DF9B9C49EAA9298432589D76DA87E80D6294BE9B
If the public key cannot be received, use a different keyserver or DNS server:
gpg --keyserver hkps://keyserver.ubuntu.com:443 \
--recv DF9B9C49EAA9298432589D76DA87E80D6294BE9B
The Debian Live signing public key is also available for import in pubkeys:
gpg --import pubkeys/debian-DA87E80D6294BE9B.asc
Verify the signature:
gpg --verify SHA512SUMS.sign SHA512SUMS
gpg: Good signature from "Debian CD signing key <debian-cd@lists.debian.org>" must appear in the output.
Verify the cryptographic hash of the image file matches the one in the signed file:
grep $(sha512sum debian-live-*-amd64-xfce.iso) SHA512SUMS
See Verifying authenticity of Debian CDs for more information.
Connect a portable storage device and identify the disk label - this guide uses /dev/sdc throughout, but this value may differ on your system:
Linux
$ sudo dmesg | tail
usb-storage 3-2:1.0: USB Mass Storage device detected
sd 2:0:0:0: [sdc] Attached SCSI removable disk
Copy the Debian image to the device:
sudo dd if=debian-live-*-amd64-xfce.iso of=/dev/sdc bs=4M status=progress ; sync
OpenBSD
$ dmesg | tail -n2
sd2 at scsibus4 targ 1 lun 0: <TS-RDF5, SD Transcend, TS3A> SCSI4 0/direct removable serial.0000000000000
sd2: 15193MB, 512 bytes/sector, 31116288 sectors
$ doas dd if=debian-live-*-amd64-xfce.iso of=/dev/rsd2c bs=4m 465+1 records in 465+1 records out 1951432704 bytes transferred in 139.125 secs (14026448 bytes/sec)
Power off, remove internal hard drives and all unnecessary devices, such as the wireless card.
Install software
Load the operating system and configure networking. Optional hardening steps related to networking can be found below.
[!TIP]
If the screen locks on Debian Live, unlock withuser/live
Open terminal and install required software packages.
Debian/Ubuntu
sudo apt update
sudo apt -y upgrade
sudo apt -y install \ wget gnupg2 gnupg-agent dirmngr \ cryptsetup scdaemon pcscd \ yubikey-personalization yubikey-manager
OpenBSD
doas pkg_add gnupg pcsc-tools
macOS
Download and install Homebrew and the following packages:
brew install \
gnupg yubikey-personalization ykman pinentry-mac wget
[!NOTE]
An additional Python package dependency may need to be installed to useykman-pip install yubikey-manager
Or using MacPorts, install the following packages:
sudo port install gnupg2 yubikey-manager pinentry wget
NixOS
Build an air-gapped NixOS LiveCD image:
ref=$(git ls-remote https://github.com/drduh/Yubikey-Guide refs/heads/master | awk '{print $1}')
nix build --experimental-features "nix-command flakes" \ github:drduh/YubiKey-Guide/$ref?dir=nix#nixosConfigurations.yubikeyLive.x86_64-linux.config.system.build.isoImage
If you have this repository checked out:
Recommended, but optional: update nixpkgs and drduh/config:
nix flake update --commit-lock-file
Build the image:
nix build --experimental-features "nix-command flakes" nix#nixosConfigurations.yubikeyLive.x86_64-linux.config.system.build.isoImage
Copy to USB drive:
sudo cp -v result/iso/yubikeyLive.iso /dev/sdc ; sync
Skip steps to create a temporary working directory and a hardened configuration, as they are already part of the image.
Test builds using virtualization tools like QEMU. Keep in mind a virtualized environment does not provide the same amount of security as an ephemeral system (see Prepare environment above).
Here is an example QEMU invocation after placing yubikeyLive in result/iso using the above nix build command:
# Launch with 4G memory, 2 CPUs and KVM enabled
qemu-system-x86_64 \
-enable-kvm \
-m 4G \
-smp 2 \
-drive readonly=on,media=cdrom,format=raw,file=result/iso/yubikeyLive.iso
Arch
sudo pacman -Syu --needed gnupg pcsclite ccid yubikey-personalization
RHEL7
sudo yum install -y gnupg2 pinentry-curses pcsc-lite pcsc-lite-libs gnupg2-smime
Fedora
sudo dnf install --skip-unavailable \
wget gnupg2 \
cryptsetup gnupg2-scdaemon pcsc-lite \
yubikey-personalization-gui yubikey-manager
Prepare GnuPG
Create a temporary directory which will be cleared on reboot and set it as the GnuPG directory:
export GNUPGHOME=$(mktemp -d -t $(date +%Y.%m.%d)-XXXX)
Configuration
Create or import a hardened configuration:
cd $GNUPGHOME
wget https://raw.githubusercontent.com/drduh/YubiKey-Guide/master/config/gpg.conf
The options will look similar to:
$ grep -v "^#" $GNUPGHOME/gpg.conf
personal-cipher-preferences AES256 AES192 AES
personal-digest-preferences SHA512 SHA384 SHA256
personal-compress-preferences ZLIB BZIP2 ZIP Uncompressed
default-preference-list SHA512 SHA384 SHA256 AES256 AES192 AES ZLIB BZIP2 ZIP Uncompressed
cert-digest-algo SHA512
s2k-digest-algo SHA512
s2k-cipher-algo AES256
charset utf-8
no-comments
no-emit-version
no-greeting
keyid-format 0xlong
list-options show-uid-validity
verify-options show-uid-validity
with-fingerprint
require-cross-certification
require-secmem
no-symkey-cache
armor
use-agent
throw-keyids
[!IMPORTANT]
Networking should be disabled for the remainder of the setup.
Identity
When creating an identity with GnuPG, the default options ask for a "Real name", "Email address" and optional "Comment".
Depending on how you plan to use GnuPG, set these values respectively[^1]:
export IDENTITY="YubiKey User <yubikey@example.domain>"
Or use any attribute which will uniquely identity the key (this may be incompatible with certain use cases):
export IDENTITY="My Cool YubiKey - 2025"
Key
Set the algorithm and key size - RSA/4096 is recommended:
export KEY_TYPE=rsa4096
Expiration
Determine the desired Subkey validity duration.
Setting a Subkey expiry forces identity and credential lifecycle management. However, setting an expiry on the Certify key is pointless, because it can just be used to extend itself[^2].
This guide recommends a two year expiration for Subkeys to balance security and usability, however longer durations are possible to reduce maintenance frequency.
When Subkeys expire, they may still be used to decrypt with GnuPG and authenticate with SSH, however they can not be used to encrypt nor sign new messages.
Subkeys must be renewed or rotated using the Certify key - see Updating keys.
Set Subkeys to expire on a planned date:
export EXPIRATION=2027-07-01
The expiration date may also be relative, for example set to two years from today:
export EXPIRATION=2y
Passphrase
Generate a passphrase for the Certify key. This credential will be used to manage identity Subkeys.
To improve readability, this guide recommends a passphrase consisting only of uppercase letters and numbers.
The following commands will generate a strong[^3] passphrase while avoiding certain similar-looking characters:
export CERTIFYPASS=$(LCALL=C tr -dc "A-Z2-9" < /dev/urandom | \
tr -d "IOUS5" | \
fold -w ${PASS_GROUPSIZE:-4} | \
paste -sd ${PASS_DELIMITER:--} - | \
head -c ${PASS_LENGTH:-29})
printf "\n$CERTIFY_PASS\n\n"
To change the passphrase length, delimiting character or group sizes, export the respective variable(s) prior to running the passphrase generation command, for example:
export PASS_GROUPSIZE=6
export PASS_DELIMITER=+
export PASS_LENGTH=48
Write the passphrase in a secure location - separate from the portable storage device used for key material, or memorize it.
This repository includes a passphrase.html template to help with credential transcription. Save the raw file, open in a browser to render and print.
Mark the corresponding character on sequential rows for each character in the passphrase. passphrase.txt can also be printed without a browser:
lp -d Printer-Name passphrase.txt
Diceware is another popular method for creating memorable passphrases.
Create Certify key
The primary key to generate is the Certify key, which is responsible for issuing Subkeys for encryption, signature and authentication operations.
The Certify key should be kept offline at all times and only accessed from a dedicated and secure environment to issue or revoke Subkeys.
Do not set an expiration date on the Certify key.
Generate the Certify key:
echo "$CERTIFY_PASS" | \
gpg --batch --passphrase-fd 0 \
--quick-generate-key "$IDENTITY" "$KEY_TYPE" cert never
Set and view the Certify key identifier and fingerprint for use later:
export KEYID=$(gpg -k --with-colons "$IDENTITY" | \
awk -F: '/^pub:/ { print $5; exit }')
export KEYFP=$(gpg -k --with-colons "$IDENTITY" | \ awk -F: '/^fpr:/ { print $10; exit }')
printf "\nKey ID/Fingerprint: %20s\n%s\n\n" "$KEYID" "$KEYFP"
Add additional IDs (optional)
This is an optional step for use cases requiring additional identities, for example:
- different email addresses for different languages
- different email addresses for professional versus personal but please see alternative reason below for not tying these addresses together
- anonymized email addresses for different git providers
- if you have different email addresses for professional versus personal use cases, having distinct keys allow you to disassociate the identities
- if you are also using the YubiKey as a U2F or FIDO2 device, having multiple YubiKeys is generally recommended as a backup measure
declare -a additional_uids
additional_uids=("Super Cool YubiKey 2025" "uid 1 <uid1@example.org>")
Add the additional user IDs to the Certify key:
for uid in "${additional_uids[@]}" ; do \
echo "$CERTIFY_PASS" | \
gpg --batch --passphrase-fd 0 \
--pinentry-mode=loopback --quick-add-uid "$KEYFP" "$uid"
done
Adjust the trust of the additional IDs to ultimate:
gpg --command-fd=0 --pinentry-mode=loopback --edit-key "$KEYID" <<EOF
uid *
trust
5
y
save
EOF
Create Subkeys
Generate Signature and Encryption Subkeys using the previously configured key type, passphrase and expiration:
echo "$CERTIFY_PASS" | \
gpg --batch --pinentry-mode=loopback --passphrase-fd 0 \
--quick-add-key "$KEYFP" "$KEY_TYPE" sign "$EXPIRATION"
echo "$CERTIFY_PASS" | \ gpg --batch --pinentry-mode=loopback --passphrase-fd 0 \ --quick-add-key "$KEYFP" "$KEY_TYPE" encrypt "$EXPIRATION"
Followed by the Authentication Subkey:
[!NOTE]
Some systems no longer accept RSA for SSH authentication; to use Ed25519, set theKEYTYPEvariable toed25519before generating Authentication Subkey.
echo "$CERTIFY_PASS" | \
gpg --batch --pinentry-mode=loopback --passphrase-fd 0 \
--quick-add-key "$KEYFP" "$KEY_TYPE" auth "$EXPIRATION"
Verify keys
List available secret keys:
gpg -K
The output will display [C]ertify, [S]ignature, [E]ncryption and [A]uthentication keys:
sec rsa4096/0xF0F2CFEB04341FB5 2025-07-01 [C]
Key fingerprint = 4E2C 1FA3 372C BA96 A06A C34A F0F2 CFEB 0434 1FB5
uid [ultimate] YubiKey User <yubikey@example>
ssb rsa4096/0xB3CD10E502E19637 2025-07-01 [S] [expires: 2027-07-01]
ssb rsa4096/0x30CBE8C4B085B9F7 2025-07-01 [E] [expires: 2027-07-01]
ssb rsa4096/0xAD9E24E1B8CB9600 2025-07-01 [A] [expires: 2027-07-01]
Backup keys
Save a copy of the Certify key, Subkeys and public key:
echo "$CERTIFY_PASS" | \
gpg --output $GNUPGHOME/$KEYID-Certify.key \
--batch --pinentry-mode=loopback --passphrase-fd 0 \
--armor --export-secret-keys $KEYID
echo "$CERTIFY_PASS" | \ gpg --output $GNUPGHOME/$KEYID-Subkeys.key \ --batch --pinentry-mode=loopback --passphrase-fd 0 \ --armor --export-secret-subkeys $KEYID
gpg --output $GNUPGHOME/$KEYID-$(date +%F).asc \ --armor --export $KEYID
Create an encrypted backup on portable storage to be kept offline in a secure and durable location.
The following process is recommended to be repeated several times on multiple portable storage devices, as they are likely to fail over time. As an additional backup measure, Paperkey can be used to make a physical copy of key materials for improved durability.
[!TIP]
ext2 volumes (without encryption) can be mounted on Linux and OpenBSD.
Use FAT32 or NTFS volumes for macOS and Windows compatibility instead.
Linux
Attach a portable storage device and check its label, in this case /dev/sdc:
$ sudo dmesg | tail
usb-storage 3-2:1.0: USB Mass Storage device detected
sd 2:0:0:0: [sdc] Attached SCSI removable disk
$ sudo fdisk -l /dev/sdc Disk /dev/sdc: 14.9 GiB, 15931539456 bytes, 31116288 sectors
[!CAUTION]
Confirm the destination (of) before issuing the following command - it is destructive! This guide uses/dev/sdcthroughout, but this value may be different on your system.
Zero the header to prepare for encryption:
sudo dd if=/dev/zero of=/dev/sdc bs=4M count=1
Remove and re-connect the storage device.
Erase and create a new partition table:
sudo fdisk /dev/sdc <<EOF
g
w
EOF
Create a small (at least 20 Mb is recommended to account for the LUKS header size) partition for storing secret materials:
sudo fdisk /dev/sdc <<EOF
n
+20M w EOF
Use LUKS to encrypt the new partition.
Generate another unique Passphrase (ideally different from the one used for the Certify key) to protect the encrypted volume:
export LUKSPASS=$(LCALL=C tr -dc "A-Z2-9" < /dev/urandom | \
tr -d "IOUS5" | \
fold -w ${PASS_GROUPSIZE:-4} | \
paste -sd ${PASS_DELIMITER:--} - | \
head -c ${PASS_LENGTH:-29})
printf "\n$LUKS_PASS\n\n"
This passphrase will also be used infrequently to access the Certify key and should be very strong.
Write the passphrase down or memorize it.
Format the partition:
echo $LUKS_PASS | \
sudo cryptsetup -q luksFormat /dev/sdc1
Mount the partition:
echo $LUKS_PASS | \
sudo cryptsetup -q luksOpen /dev/sdc1 gnupg-secrets
Create an ext2 filesystem:
sudo mkfs.ext2 /dev/mapper/gnupg-secrets -L gnupg-$(date +%F)
Mount the filesystem and copy the temporary GnuPG working directory with key materials:
sudo mkdir -p /mnt/encrypted-storage
sudo mount /dev/mapper/gnupg-secrets /mnt/encrypted-storage
sudo cp -av $GNUPGHOME /mnt/encrypted-storage/
Unmount and close the encrypted volume:
sudo umount /mnt/encrypted-storage
sudo cryptsetup luksClose gnupg-secrets
Repeat the process for any additional storage devices (at least two are recommended).
OpenBSD
Attach a USB disk and determine its label:
$ dmesg | grep sd.\ at
sd2 at scsibus5 targ 1 lun 0: <TS-RDF5, SD Transcend, TS37> SCSI4 0/direct removable serial.00000000000000000000
Print the existing partitions to make sure it's the right device:
doas disklabel -h sd2
Initialize the disk by creating an a partition with FS type RAID and size of 25 Megabytes:
$ doas fdisk -giy sd2
Writing MBR at offset 0.
Writing GPT.
$ doas disklabel -E sd2 Label editor (enter '?' for help at any prompt) sd2> a a offset: [64] size: [31101776] 25M FS type: [4.2BSD] RAID sd2*> w sd2> q No label changes
Encrypt with bioctl using a unique Passphrase:
$ doas bioctl -c C -l sd2a softraid0
New passphrase:
Re-type passphrase:
softraid0: CRYPTO volume attached as sd3
Create an i partition on the new crypto volume and the filesystem:
$ doas fdisk -giy sd3
Writing MBR at offset 0.
Writing GPT.
$ doas disklabel -E sd3 Label editor (enter '?' for help at any prompt) sd3> a i offset: [64] size: [16001] FS type: [4.2BSD] sd3*> w sd3> q No label changes.
$ doas newfs sd3i
Mount the filesystem and copy the temporary directory with the keyring:
doas mkdir -p /mnt/encrypted-storage
doas mount /dev/sd3i /mnt/encrypted-storage
doas cp -av $GNUPGHOME /mnt/encrypted-storage
Unmount and remove the encrypted volume:
doas umount /mnt/encrypted-storage
doas bioctl -d sd3
See OpenBSD FAQ#14 for more information.
Export public key
[!IMPORTANT]
Without the public key, it will not be possible to use GnuPG to decrypt/sign messages. However, YubiKey can still be used for SSH authentication.
Connect another portable storage device or create a new partition on the existing one.
Linux
Using the same /dev/sdc device as in the previous step, create a small (at least 20 Mb is recommended) partition for storing materials:
sudo fdisk /dev/sdc <<EOF
n
+20M w EOF
Create a filesystem and export the public key:
sudo mkfs.ext2 /dev/sdc2
sudo mkdir -p /mnt/public
sudo mount /dev/sdc2 /mnt/public
gpg --armor --export $KEYID | sudo tee /mnt/public/$KEYID-$(date +%F).asc
sudo chmod 0444 /mnt/public/*.asc
Unmount and remove the storage device:
sudo umount /mnt/public
OpenBSD
$ doas disklabel -E sd2
Label editor (enter '?' for help at any prompt)
sd2> a b
offset: [32130]
size: [31069710] 25M
FS type: [swap] 4.2BSD
sd2*> w
sd2> q
No label changes.
Create a filesystem and export the public key to it:
doas newfs sd2b
doas mkdir -p /mnt/public
doas mount /dev/sd2b /mnt/public
gpg --armor --export $KEYID | doas tee /mnt/public/$KEYID-$(date +%F).asc
Unmount and remove the storage device:
doas umount /mnt/public
Configure YubiKey
Connect YubiKey and confirm its status:
gpg --card-status
If the YubiKey is locked, Reset it.
Change PIN
YubiKey's PGP interface has its own PINs separate from other modules such as PIV:
Name | Default | Capability :---: | :---: | --- User PIN | 123456 | cryptographic operations (decrypt, sign, authenticate) Admin PIN | 12345678 | reset PIN, change Reset Code, add keys and owner information Reset Code | None | reset PIN (more information)
Determine the desired PIN values. They can be shorter than the Certify key passphrase due to limited brute-forcing opportunities; the User PIN should be convenient enough to remember for every-day use.
The User PIN must be at least 6 characters and the Admin PIN must be at least 8 characters. A maximum of 127 ASCII characters are allowed. See Managing PINs for more information.
Set PIN values, for example a 6 digit User PIN and 8 digit Admin PIN:
export ADMINPIN=$(LCALL=C tr -dc '0-9' < /dev/urandom | \
fold -w8 | head -1)
export USERPIN=$(LCALL=C tr -dc '0-9' < /dev/urandom | \ fold -w6 | head -1)
printf "\nAdmin PIN: %12s\nUser PIN: %13s\n\n" \ "$ADMINPIN" "$USERPIN"
Change the Admin PIN:
gpg --command-fd=0 --pinentry-mode=loopback --change-pin <<EOF
3
12345678
$ADMIN_PIN
$ADMIN_PIN
q
EOF
Change the User PIN:
gpg --command-fd=0 --pinentry-mode=loopback --change-pin <<EOF
1
123456
$USER_PIN
$USER_PIN
q
EOF
Remove and re-insert YubiKey.
[!CAUTION]
Three incorrect User PIN entries will cause it to become blocked and must be unblocked with either the Admin PIN or Reset Code. Three incorrect Admin PIN or Reset Code entries will destroy data on YubiKey.
The number of retry attempts can be changed, for example to 5 attempts:
ykman openpgp access set-retries 5 5 5 -f -a $ADMIN_PIN
Set attributes
Use previously set values:
gpg --command-fd=0 --pinentry-mode=loopback --edit-card <<EOF
admin
login
$IDENTITY
$ADMIN_PIN
quit
EOF
Smart card attributes can also be set with gpg --edit-card and admin mode. Use help to see available options. The login attribute is required.
Run gpg --card-status to verify results (Login data field).
Transfer Subkeys
[!IMPORTANT]
Transferring keys to YubiKey converts the on-disk key into a "stub" - making it no longer usable to transfer to subsequent YubiKeys. Ensure keys were backed up before proceeding.
The Certify key passphrase and Admin PIN are required to transfer keys.
Signature key
Transfer the Signature key:
gpg --command-fd=0 --pinentry-mode=loopback --edit-key $KEYID <<EOF
key 1
keytocard
1
$CERTIFY_PASS
$ADMIN_PIN
save
EOF
Encryption key
Repeat the process for the Encryption key:
gpg --command-fd=0 --pinentry-mode=loopback --edit-key $KEYID <<EOF
key 2
keytocard
2
$CERTIFY_PASS
$ADMIN_PIN
save
EOF
Authentication key
Repeat the process for the Authentication key:
gpg --command-fd=0 --pinentry-mode=loopback --edit-key $KEYID <<EOF
key 3
keytocard
3
$CERTIFY_PASS
$ADMIN_PIN
save
EOF
Verify transfer
Verify Subkeys are on YubiKey with gpg -K - indicated by ssb>:
sec rsa4096/0xF0F2CFEB04341FB5 2025-07-01 [C]
Key fingerprint = 4E2C 1FA3 372C BA96 A06A C34A F0F2 CFEB 0434 1FB5
uid [ultimate] YubiKey User <yubikey@example>
ssb> rsa4096/0xB3CD10E502E19637 2025-07-01 [S] [expires: 2027-07-01]
ssb> rsa4096/0x30CBE8C4B085B9F7 2025-07-01 [E] [expires: 2027-07-01]
ssb> rsa4096/0xAD9E24E1B8CB9600 2025-07-01 [A] [expires: 2027-07-01]
The > after a tag indicates the key is stored on a smart card.
Finish setup
Verify the following steps were performed correctly:
- [ ] Memorized or wrote down the Certify key (identity) passphrase to a secure and durable location
echo $CERTIFYPASS to see it again; passphrase.html or passphrase.txt to transcribe it
- [ ] Memorized or wrote down passphrase to encrypted volume on portable storage
echo $LUKSPASS to see it again; passphrase.html or passphrase.txt to transcribe it
- [ ] Saved the Certify key and Subkeys to encrypted portable storage, to be kept offline
- [ ] Exported a copy of the public key where is can be easily accessed later
- [ ] Memorized or wrote down the User PIN and Admin PIN, which are unique and changed from default values
echo $USERPIN $ADMINPIN to see them again; passphrase.html or passphrase.txt to transcribe them
- [ ] Moved Encryption, Signature and Authentication Subkeys to YubiKey
gpg -K shows ssb> for each of the 3 Subkeys
Reboot, clearing the ephemeral environment, to complete setup.
Using YubiKey
Initialize GnuPG:
gpg -k
Create or import a hardened configuration:
cd ~/.gnupg
wget https://raw.githubusercontent.com/drduh/YubiKey-Guide/master/config/gpg.conf
Set the following option. This avoids the problem where GnuPG will repeatedly prompt for the insertion of an already-inserted YubiKey:
touch scdaemon.conf
echo "disable-ccid" >>scdaemon.conf
Install the required packages:
Debian/Ubuntu
sudo apt update
sudo apt install -y gnupg gnupg-agent scdaemon pcscd
Arch
sudo pacman -S --needed gnupg pcsc-tools
sudo systemctl enable --now pcscd.service
macOS
brew install gnupg
Or using MacPorts
sudo port install gnupg2 pcsc-tools
OpenBSD
doas pkg_add gnupg pcsc-tools
doas rcctl enable pcscd
doas reboot
Mount the non-encrypted volume with the public key:
Debian/Ubuntu
sudo mkdir -p /mnt/public
sudo mount /dev/sdc2 /mnt/public
OpenBSD
doas mkdir -p /mnt/public
doas mount /dev/sd3i /mnt/public
Import the public key:
gpg --import /mnt/public/*.asc
Or download the public key from a keyserver:
gpg --recv $KEYID
Or with the URL on YubiKey, retrieve the public key using the command gpg --edit-card.
gpg/card> fetch
gpg/card> quit
Determine the key ID:
gpg -k
export KEYID=0xF0F2CFEB04341FB5
Assign ultimate trust by typing trust and selecting option 5 then quit:
gpg --command-fd=0 --pinentry-mode=loopback --edit-key $KEYID <<EOF
trust
5
y
save
EOF
Remove and re-insert YubiKey.
Verify the status with gpg --card-status which will list the available Subkeys:
Reader ...........: Yubico YubiKey OTP FIDO CCID 00 00
Application ID ...: D2760001240102010006055532110000
Application type .: OpenPGP
Version ..........: 3.4
Manufacturer .....: Yubico
Serial number ....: 05553211
Name of cardholder: YubiKey User
Language prefs ...: en
Salutation .......:
URL of public key : [not set]
Login data .......: yubikey@example
Signature PIN ....: not forced
Key attributes ...: rsa4096 rsa4096 rsa4096
Max. PIN lengths .: 127 127 127
PIN retry counter : 3 3 3
Signature counter : 0
KDF setting ......: on
Signature key ....: CF5A 305B 808B 7A0F 230D A064 B3CD 10E5 02E1 9637
created ....: 2025-07-01 12:00:00
Encryption key....: A5FA A005 5BED 4DC9 889D 38BC 30CB E8C4 B085 B9F7
created ....: 2025-07-01 12:00:00
Authentication key: 570E 1355 6D01 4C04 8B6D E2A3 AD9E 24E1 B8CB 9600
created ....: 2025-07-01 12:00:00
General key info..: sub rsa4096/0xB3CD10E502E19637 2025-07-01 YubiKey User <yubikey@example>
sec# rsa4096/0xF0F2CFEB04341FB5 created: 2025-07-01 expires: never
ssb> rsa4096/0xB3CD10E502E19637 created: 2025-07-01 expires: 2027-07-01
card-no: 0006 05553211
ssb> rsa4096/0x30CBE8C4B085B9F7 created: 2025-07-01 expires: 2027-07-01
card-no: 0006 05553211
ssb> rsa4096/0xAD9E24E1B8CB9600 created: 2025-07-01 expires: 2027-07-01
card-no: 0006 05553211
sec# indicates the corresponding key is not available (the Certify key is offline).
YubiKey is now ready for use!
Encryption
Encrypt a message to yourself (useful for storing credentials or protecting backups):
echo -e "\ntest message string" | \
gpg --encrypt --armor \
--recipient $KEYID --output encrypted.txt
Decrypt the message - a prompt for the User PIN will appear:
gpg --decrypt --armor encrypted.txt
To encrypt to multiple recipients/keys, set the preferred key ID last:
echo "test message string" | \
gpg --encrypt --armor \
--recipient $KEYID2 --recipient $KEYID1 --recipient $KEYID \
--output encrypted.txt
Use a shell function to make encrypting files easier:
secret () {
output="${1}".$(date +%s).enc
gpg --encrypt --armor --output ${output} \
-r $KEYID "${1}" && echo "${1} -> ${output}"
}
reveal () { output=$(echo "${1}" | rev | cut -c16- | rev) gpg --decrypt --output ${output} "${1}" && \ echo "${1} -> ${output}" }
Example output:
$ secret document.pdf
document.pdf -> document.pdf.1580000000.enc
$ reveal document.pdf.1580000000.enc gpg: anonymous recipient; trying secret key 0xF0F2CFEB04341FB5 ... gpg: okay, we are the anonymous recipient. gpg: encrypted with RSA key, ID 0x0000000000000000 document.pdf.1580000000.enc -> document.pdf
drduh/Purse is a password manager based on GnuPG and YubiKey to securely store and use credentials.
Signature
Sign a message:
echo "test message string" | gpg --armor --clearsign > signed.txt
Verify the signature:
gpg --verify signed.txt
The output will be similar to:
gpg: Signature made Mon 01 Jan 2025 12:00:00 PM UTC
gpg: using RSA key CF5A305B808B7A0F230DA064B3CD10E502E19637
gpg: Good signature from "YubiKey User <yubikey@example>" [ultimate]
Primary key fingerprint: 4E2C 1FA3 372C BA96 A06A C34A F0F2 CFEB 0434 1FB5
Subkey fingerprint: CF5A 305B 808B 7A0F 230D A064 B3CD 10E5 02E1 9637
Configure touch
By default, YubiKey will perform cryptographic operations without requiring any action from the user after the key is unlocked once with the PIN.
To require a touch for each key operation, use YubiKey Manager and the Admin PIN to set key policy.
Encryption:
ykman openpgp keys set-touch dec on
[!NOTE]
YubiKey Manager prior to versions 5.1.0 useencinstead ofdecfor encryption:
ykman openpgp keys set-touch enc on
Even older versions of YubiKey Manager use touch instead of set-touch
Signature:
ykman openpgp keys set-touch sig on
Authentication:
ykman openpgp keys set-touch aut on
To view and adjust policy options:
ykman openpgp keys set-touch -h
Cached or Cached-Fixed may be desirable for YubiKey use with email clients.
YubiKey will blink when it is waiting for a touch. On Linux, maximbaz/yubikey-touch-detector can be used to indicate YubiKey is waiting for a touch.
SSH
Create or import a hardened configuration:
cd ~/.gnupg
wget https://raw.githubusercontent.com/drduh/YubiKey-Guide/master/config/gpg-agent.conf
[!NOTE]
cache-ttloptions do not apply when using YubiKey as a smart card, because the PIN is cached by the smart card itself. To clear the PIN from cache (equivalent todefault-cache-ttlandmax-cache-ttl), remove YubiKey, or setforcesigwhen editing the card to be prompted for the PIN each time.
[!TIP]
Setpinentry-programto/usr/bin/pinentry-gnome3for a GUI-based prompt.
macOS
Install pinentry with brew install pinentry-mac or sudo port install pinentry then edit gpg-agent.conf to set the pinentry-program path to:
- Apple Silicon Macs:
/opt/homebrew/bin/pinentry-mac - Intel Macs:
/usr/local/bin/pinentry-macor/opt/local/bin/pinentry(MacPorts) - MacGPG Suite:
/usr/local/MacGPG2/libexec/pinentry-mac.app/Contents/MacOS/pinentry-mac
gpgconf --kill gpg-agent for the change to take effect.
To use graphical applications on macOS, additional setup is required.
Create $HOME/Library/LaunchAgents/gnupg.gpg-agent.plist with the following contents:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>Label</key>
<string>gnupg.gpg-agent</string>
<key>RunAtLoad</key>
<true/>
<key>KeepAlive</key>
<false/>
<key>EnvironmentVariables</key>
<dict>
<key>PATH</key>
<string>/opt/homebrew/bin:/usr/local/bin:/usr/bin:/usr/local/MacGPG2/bin:/bin</string>
</dict>
<key>ProgramArguments</key>
<array>
<string>/usr/bin/env</string>
<string>gpg-connect-agent</string>
<string>/bye</string>
</array>
</dict>
</plist>
Load it:
launchctl load $HOME/Library/LaunchAgents/gnupg.gpg-agent.plist
Create $HOME/Library/LaunchAgents/gnupg.gpg-agent-symlink.plist with the following contens:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/ProperyList-1.0/dtd">
<plist version="1.0">
<dict>
<key>Label</key>
<string>gnupg.gpg-agent-symlink</string>
<key>ProgramArguments</key>
<array>
<string>/bin/sh</string>
<string>-c</string>
<string>/bin/ln -sf $HOME/.gnupg/S.gpg-agent.ssh $SSHAUTHSOCK</string>
</array>
<key>RunAtLoad</key>
<true/>
</dict>
</plist>
Load it:
launchctl load $HOME/Library/LaunchAgents/gnupg.gpg-agent-symlink.plist
Reboot to activate changes.
Windows
Windows can already have some virtual smart card readers installed, like the one provided for Windows Hello. To verify YubiKey is the correct one used by scdaemon, add it to its configuration.
Find the YubiKey label using PowerShell:
PS C:\WINDOWS\system32> Get-PnpDevice -Class SoftwareDevice | Where-Object {$_.FriendlyName -like "YubiKey"} | Select-Object -ExpandProperty FriendlyName
Yubico YubiKey OTP+FIDO+CCID 0
See How to setup Signed Git Commits with a YubiKey NEO and GPG and Keybase on Windows (2018) for more information.
Edit %APPDATA%/gnupg/scdaemon.conf to add:
reader-port <device name, e.g. Yubico YubiKey OTP+FIDO+CCID 0>
Edit %APPDATA%/gnupg/gpg-agent.conf to add:
enable-ssh-support
enable-putty-support
Restart the agent:
gpg-connect-agent killagent /bye
gpg-connect-agent /bye
Verify YubiKey details:
gpg --card-status
Import the public key and set ultimate trust:
gpg --import <path to public key file>
Retrieve the public key id:
gpg --list-public-keys
Export the SSH public key:
gpg --export-ssh-key <public key id>
Copy the public SSH key to a file - it corresponds to the secret key on YubiKey and can be copied to SSH destination hosts.
Create a shortcut that points to gpg-connect-agent /bye and place it in the startup folder shell:startup to make sure the agent starts after reboot. Modify the shortcut properties so it starts in a "Minimized" window.
PuTTY can now be used for public-key SSH authentication. When the server asks for public-key verification, PuTTY will forward the request to GnuPG, which will prompt for a PIN to authorize the operation.
WSL
The goal is to configure SSH client inside WSL work together with the Windows agent, such as gpg-agent.exe.
See the WSL agent architecture illustration for an overview.
GnuPG forwarding for cryptographic operations is not supported. See vuori/weasel-pageant for more information.
One way to forward is just ssh -A (still need to eval weasel to setup local ssh-agent), and only relies on OpenSSH. In this track, ForwardAgent and AllowAgentForwarding in ssh/sshd config may be involved. However, when using ssh socket forwarding, do not enable ForwardAgent in ssh config. See SSH Agent Forwarding for more information. This requires Ubuntu 16.04 or newer for WSL and Kleopatra.
Download vuori/weasel-pageant.
Add eval $(/mnt/c/<path of extraction>/weasel-pageant -r -a /tmp/S.weasel-pageant) to the shell rc file. Use a named socket here so it can be used in the RemoteForward directive of ~/.ssh/config. Source it with source ~/.bashrc.
Display the SSH key with $ ssh-add -l
Edit ~/.ssh/config to add the following for each agent forwarding host:
RemoteForward <remote SSH socket path> /tmp/S.weasel-pageant
The remote SSH socket path can be found with gpgconf --list-dirs agent-ssh-socket
Add the following to the shell rc file:
export SSHAUTHSOCK=$(gpgconf --list-dirs agent-ssh-socket)
Add the following to /etc/ssh/sshd_config:
StreamLocalBindUnlink yes
Reload SSH daemon:
sudo service sshd reload
Remove YubiKey and reboot. Log back into Windows, open a WSL console and enter ssh-add -l - no output should appear.
Plug in YubiKey, enter the same command to display the ssh key.
Connect to the remote host and use ssh-add -l to confirm forwarding works.
Agent forwarding may be chained through multiple hosts. Follow the same protocol to configure each host.
An alternate method is the usbipd-win library. If you encounter issues with accessing the YubiKey in WSL after configuring usbipd-win, you may need to add custom polkit rules to ensure proper permissions for the pcscd service. Here's an example configuration using a scard group (the group logic is optional):
Create a new rule file at /etc/polkit-1/rules.d/99-pcscd.rules:
polkit.addRule(function(action, subject) {
if (action.id == "org.debian.pcsc-lite.access_card" &&
subject.isInGroup("scard")) {
return polkit.Result.YES;
}
});
polkit.addRule(function(action, subject) { if (action.id == "org.debian.pcsc-lite.access_pcsc" && subject.isInGroup("scard")) { return polkit.Result.YES; } });
Replace agents
To launch gpg-agent for use by SSH, use the gpg-connect-agent /bye or gpgconf --launch gpg-agent commands.
Add the following to the shell rc file:
export GPG_TTY=$(tty)
export SSHAUTHSOCK=$(gpgconf --list-dirs agent-ssh-socket)
gpgconf --launch gpg-agent
gpg-connect-agent updatestartuptty /bye > /dev/null
For fish, config.fish should look like this (consider putting them into the is-interactive block):
set -x GPG_TTY (tty)
set -x SSHAUTHSOCK (gpgconf --list-dirs agent-ssh-socket)
gpgconf --launch gpg-agent
When using ForwardAgent for ssh-agent forwarding, SSHAUTHSOCK only needs to be set on the local host, where YubiKey is connected. On the remote host, ssh will set SSHAUTHSOCK to something like /tmp/ssh-mXzCzYT2Np/agent.7541 upon connection. Do not set SSHAUTHSOCK on the remote host - doing so will break SSH Agent Forwarding.
For S.gpg-agent.ssh (see SSH Agent Forwarding for more info), SSHAUTHSOCK should also be set on the remote. However, GPG_TTY should not be set on the remote, explanation specified in that section.
Copy public key
[!TIP]
It is not necessary to import the GnuPG public key in order to use SSH only.
Copy and paste the output from ssh-add to the server's authorized_keys file:
$ ssh-add -L
ssh-rsa AAAAB4NzaC1yc2EAAAADAQABAAACAz[...]zreOKM+HwpkHzcy9DQcVG2Nw== cardno:000605553211
Optional Save the public key for identity file configuration. By default, SSH attempts to use all the identities available via the agent. It's often a good idea to manage exactly which keys SSH will use to connect to a server, for example to separate different roles or to avoid being fingerprinted by untrusted ssh servers. To do this you'll need to use the command line argument -i [identityfile] or the IdentityFile and IdentitiesOnly options in .ssh/config.
The argument provided to IdentityFile is traditionally the path to the private key file (for example IdentityFile ~/.ssh/idrsa). For YubiKey, IdentityFile must point to the public_ key file, and ssh will select the appropriate private key from those available via ssh-agent. To prevent ssh from trying all keys in the agent, use IdentitiesOnly yes along with one or more -i or IdentityFile options for the target host.
To reiterate, with IdentitiesOnly yes, ssh will not enumerate public keys loaded into ssh-agent or gpg-agent. This means public-key authentication will not proceed unless explicitly named by ssh -i [identity_file] or in .ssh/config on a per-host basis.
In the case of YubiKey usage, to extract the public key from the ssh agent:
ssh-add -L | grep "cardno:000605553211" > ~/.ssh/idrsayubikey.pub
Then explicitly associate this YubiKey-stored key for used with a host, github.com for example, as follows:
$ cat << EOF >> ~/.ssh/config
Host github.com
IdentitiesOnly yes
IdentityFile ~/.ssh/idrsayubikey.pub
EOF
Connect with public key authentication:
$ ssh git@github.com -vvv
[...]
debug2: key: cardno:000605553211 (0x1234567890),
debug1: Authentications that can continue: publickey
debug3: start over, passed a different list publickey
debug3: preferred gssapi-keyex,gssapi-with-mic,publickey,keyboard-interactive,password
debug3: authmethod_lookup publickey
debug3: remaining preferred: keyboard-interactive,password
debug3: authmethodisenabled publickey
debug1: Next authentication method: publickey
debug1: Offering RSA public key: cardno:000605553211
debug3: sendpubkeytest
debug2: we sent a publickey packet, wait for reply
debug1: Server accepts key: pkalg ssh-rsa blen 535
debug2: inputuserauthpk_ok: fp e5:de:a5:74:b1:3e:96:9b:85:46:e7:28:53:b4:82:c3
debug3: signandsend_pubkey: RSA e5:de:a5:74:b1:3e:96:9b:85:46:e7:28:53:b4:82:c3
debug1: Authentication succeeded (publickey).
[...]
[!TIP]
To enable multiple connections, use the ControlMaster SSH option.
Import SSH keys
If there are existing SSH keys to make available via gpg-agent, they will need to be imported. Then, remove the original private keys. When importing the key, gpg-agent uses the key filename as the label - this makes it easier to follow where the key originated from. In this example, we're starting with just the YubiKey in place and importing ~/.ssh/id_rsa:
$ ssh-add -l
4096 SHA256:... cardno:00060123456 (RSA)
$ ssh-add ~/.ssh/idrsa && rm ~/.ssh/idrsa
When invoking ssh-add, a prompt for the SSH key passphrase will appear, then the pinentry program will prompt and confirm a new passphrase to encrypt the converted key within the GnuPG key store.
The migrated key will be listed in ssh-add -l:
$ ssh-add -l
4096 SHA256:... cardno:00060123456 (RSA)
2048 SHA256:... /Users/username/.ssh/id_rsa (RSA)
To show the keys with MD5 fingerprints, as used by gpg-connect-agent's KEYINFO and DELETE_KEY commands:
$ ssh-add -E md5 -l
4096 MD5:... cardno:00060123456 (RSA)
2048 MD5:... /Users/username/.ssh/id_rsa (RSA)
When using the key pinentry will be invoked to request the key passphrase. The passphrase will be cached for up to 10 idle minutes between uses, up to a maximum of 2 hours.
SSH agent forwarding
[!CAUTION]
SSH Agent Forwarding can add additional risk - proceed with caution!
There are two methods for ssh-agent forwarding, one is provided by OpenSSH and the other is provided by GnuPG.
The latter one may be more insecure as raw socket is just forwarded (not like S.gpg-agent.extra with only limited functionality; if ForwardAgent implemented by OpenSSH is just forwarding the raw socket, then they are insecure to the same degree). But for the latter one, one convenience is that one may forward once and use this agent everywhere in the remote. So again, proceed with caution!
For example, tmux does not have environment variables such as $SSHAUTHSOCK when connecting to remote hosts and attaching an existing session. For each shell, find the socket and export SSHAUTHSOCK=/tmp/ssh-agent-xxx/xxxx.socket. However, with S.gpg-agent.ssh in a fixed place, it can be used as the ssh-agent in shell rc files.
Use ssh-agent
You should now be able to use ssh -A remote on the local host to log into remote host, and should then be able to use YubiKey as if it were connected to the remote host. For example, using e.g. ssh-add -l on that remote host will show the public key from the YubiKey (cardno:). Always use ForwardAgent yes only for a single host, never for all servers.
Use S.gpg-agent.ssh
First you need to go through GnuPG agent forwarding, know the conditions for gpg-agent forwarding and know the location of S.gpg-agent.ssh on both the local and the remote.
You may use the command:
$ gpgconf --list-dirs agent-ssh-socket
Edit .ssh/config to add the remote host:
Host
Hostname remote-host.tld
StreamLocalBindUnlink yes
RemoteForward /run/user/1000/gnupg/S.gpg-agent.ssh /run/user/1000/gnupg/S.gpg-agent.ssh
#RemoteForward [remote socket] [local socket]
#Note that ForwardAgent is not wanted here!
After successfully ssh into the remote host, confirm /run/user/1000/gnupg/S.gpg-agent.ssh exists.
Then in the remote you can type in command line or configure in the shell rc file with:
export SSHAUTHSOCK="/run/user/$UID/gnupg/S.gpg-agent.ssh"
After sourcing the shell rc file, ssh-add -l will return the correct public key.
In this process no gpg-agent in the remote is involved, hence gpg-agent.conf in the remote is of no use. Also pinentry is invoked locally.
Chained forwarding
If you use ssh-agent provided by OpenSSH and want to forward it into a third box, you can just ssh -A third on the remote.
Meanwhile, if you use S.gpg-agent.ssh, assume you have gone through the steps above and have S.gpg-agent.ssh on the remote, and you would like to forward this agent into a third box, first you may need to configure sshdconfig and SSHAUTH_SOCK of third in the same way as remote, then in the ssh config of remote, add the following lines
Host third
Hostname third-host.tld
StreamLocalBindUnlink yes
RemoteForward /run/user/1000/gnupg/S.gpg-agent.ssh /run/user/1000/gnupg/S.gpg-agent.ssh
#RemoteForward [remote socket] [local socket]
#Note that ForwardAgent is not wanted here!
The path must be set according to gpgconf --list-dirs agent-ssh-socket on remote and third hosts.
GitHub
YubiKey can be used to sign commits and tags, and authenticate SSH to GitHub when configured in Settings.
Configure the signing key:
git config --global user.signingkey $KEYID
Alternatively, if you are using the aforementioned IdentityFile (SSH key) for signing:
git config --global gpg.format ssh
git config --global user.signingkey ~/.ssh/idrsayubikey.pub
Configure the user.name and user.email option to match the email address associated with the PGP identity:
git config --global user.name 'YubiKey User'
git config --global user.email yubikey@example
To sign commits or tags, use the -S option, or consider enabling commit and tag signing by default:
git config --global commit.gpgsign true
git config --global tag.gpgSign true
Windows
Configure authentication:
git config --global core.sshcommand "plink -agent"
git config --global gpg.program 'C:\Program Files (x86)\GnuPG\bin\gpg.exe'
Then update the repository URL to git@github.com:USERNAME/repository
GnuPG agent forwarding
YubiKey can be used sign git commits and decrypt files on remote hosts with GnuPG Agent Forwarding. To ssh through another network, especially to push to/pull from GitHub using ssh, see Remote Machines (SSH Agent forwarding).
gpg-agent.conf is not needed on the remote host; after forwarding, remote GnuPG directly communicates with S.gpg-agent without starting gpg-agent on the remote host.
On the remote host, edit /etc/ssh/sshd_config to set StreamLocalBindUnlink yes
Optional Without root access on the remote host to edit /etc/ssh/sshdconfig, socket located at gpgconf --list-dir agent-socket on the remote host will need to be removed before forwarding works. See AgentForwarding GNUPG wiki page for more information.
Import the public key on the remote host. On the local host, copy the public keyring to the remote host:
scp ~/.gnupg/pubring.kbx remote:~/.gnupg/
On modern distributions, such as Fedora 30, there is no need to set RemoteForward in ~/.ssh/config
Legacy distributions
On the local host, run:
gpgconf --list-dirs agent-extra-socket
This should return a path to agent-extra-socket - /run/user/1000/gnupg/S.gpg-agent.extra - though on older Linux distros (and macOS) it may be /home/<user>/.gnupg/S.gpg-agent.extra
Find the agent socket on the remote host:
gpgconf --list-dirs agent-socket
This should return a path such as /run/user/1000/gnupg/S.gpg-agent
Finally, enable agent forwarding for a given host by adding the following to the local host's ~/.ssh/config (agent sockets may differ):
Host
Hostname remote-host.tld
StreamLocalBindUnlink yes
RemoteForward /run/user/1000/gnupg/S.gpg-agent /run/user/1000/gnupg/S.gpg-agent.extra
#RemoteForward [remote socket] [local socket]
It may be necessary to edit gpg-agent.conf on the local host to add the following information:
pinentry-program /usr/bin/pinentry-gtk-2
extra-socket /run/user/1000/gnupg/S.gpg-agent.extra
[!IMPORTANT]
The pinentry program starts on the local host, not remote.
Any pinentry program except pinentry-tty or pinentry-curses may be used. This is because local gpg-agent may start headlessly (by systemd without $GPG_TTY set locally telling which tty it is on), thus failed to obtain the pin. Errors on the remote may be misleading saying that there is IO Error. (Yes, internally there is actually an IO Error since it happens when writing to/reading from tty while finding no tty to use, but for end users this is not friendly.)
See Issue 85 for more information and troubleshooting.
Chained GnuPG agent forwarding
Assume you have gone through the steps above and have S.gpg-agent on the remote, and you would like to forward this agent into a third box, first you may need to configure sshd_config of third in the same way as remote, then in the ssh config of remote, add the following lines:
Host third
Hostname third-host.tld
StreamLocalBindUnlink yes
RemoteForward /run/user/1000/gnupg/S.gpg-agent /run/user/1000/gnupg/S.gpg-agent
#RemoteForward [remote socket] [local socket]
You should change the path according to gpgconf --list-dirs agent-socket on remote and third.
On local you have S.gpg-agent.extra whereas on remote and third, you only have S.gpg-agent
Using multiple YubiKeys
When a GnuPG key is added to YubiKey using keytocard, the key is deleted from the keyring and a stub is added, pointing to the YubiKey. The stub identifies the GnuPG key ID and YubiKey serial number.
When a Subkey is added to an additional YubiKey, the stub is overwritten and will now point to the latest YubiKey. GnuPG will request a specific YubiKey by serial number, as referenced by the stub, and will not recognize another YubiKey with a different serial number.
To scan an additional YubiKey and recreate the correct stub:
gpg-connect-agent "scd serialno" "learn --force" /bye
Alternatively, use a script to delete the GnuPG shadowed key, where the serial number is stored (see GnuPG #T2291):
mkdir -p ~/scripts && cat >> ~/scripts/remove-keygrips.sh <<EOF
#!/usr/bin/env bash
(( $# )) || { echo "Specify a key." >&2; exit 1; }
KEYGRIPS=$(gpg --with-keygrip --list-secret-keys "$@" | awk '/Keygrip/ { print $3 }')
for keygrip in $KEYGRIPS
do
rm "$HOME/.gnupg/private-keys-v1.d/$keygrip.key" 2> /dev/null
done
gpg --card-status EOF
chmod +x ~/scripts/remove-keygrips.sh
~/scripts/remove-keygrips.sh $KEYID
See discussion in Issues #19 and #112 for more information and troubleshooting steps.
YubiKey can be used to decrypt and sign emails and attachments using Thunderbird, Enigmail and Mutt