Skip to main content

KDE Wallet and SSH keys

In KDE Plasma, the KDE Wallet is responsible for securely storing and supplying user credentials to the various KDE applications that request them.

Out of the box, the Solus KDE Plasma Desktop is already configured to use the KDE Wallet PAM module, which unlocks the KDE Wallet on session login.

However, additional configuration is needed to make the KDE Wallet manage SSH key passphrases.

Prerequisites​

This document assumes that you are familiar with utilising SSH key passphrases.

For more information, see working with SSH key passphrases

The SSH_ASKPASS environment variable​

The SSH_ASKPASS environment variable tells the SSH subsystem which application to use when prompting the user for SSH key passphrases.

On the Solus KDE Plasma Desktop spin, ksshaskpass is installed out of the box and SSH_ASKPASS is set to ksshaskpass in the file /usr/share/xdg/plasma-workspace/env/50-solus-defaults.sh by default.

Create ~/.config/autostart/ssh-add.desktop​

The contents of ~/.config/autostart/ssh-add.desktop should reflect the SSH keys you want to manage using the KDE Wallet.

Example​

Below is an example of the contents of ~/.config/autostart/ssh-add.desktop:

[Desktop Entry]
Exec=ssh-add -q
Name=ssh-add
Type=Application

Tip: The above ssh-add.desktop file will only add the default key ~/.ssh/id_rsa. Assuming you have different keys named key1, key2 etc you need to change the above desktop file to

[Desktop Entry]
Exec=ssh-add -q ~/.ssh/key1 ~/.ssh/key2 ~/.ssh/key3
Name=ssh-add
Type=Application

Set correct permissions​

After you created your file inside the autostart folder you have to give it the correct permissions

chmod 700 ~/.config/autostart/ssh-add.desktop

with this the file should appear inside the autostart settings

Re-log to test your changes​

After logging out and back in, you should now be prompted by the KDE Wallet to input your SSH key passphrases.

Unlock SSH key passphrases automatically on login​

KDE Wallet supports automatically unlocking your SSH key passphrases on login.

For this to work, your KDE Wallet password needs to be identical to your login password.

Troubleshooting​

ssh key doesn't get triggered, you can force this manually by running this command.

SSH_ASKPASS=/usr/bin/ksshaskpass ssh-add < /dev/null