es:KDE Wallet ja:KDE Wallet zh-hans:KDE Wallet KDE Wallet Manager is a tool to manage passwords on the KDE Plasma system. Using the KWallet subsystem allows a user to keep its own secrets, but also allows a user to access passwords stored by every application that integrates with KWallet.

A wallet (in the KDE's terminology, sometimes called vault or keyring) is an encrypted volume protected by a user-defined password where user and/or software can store secrets (often, credentials when the user checked "Remember the account" in an application). Those vaults can be created and used manually by the user or created and used automatically in the background by some software that integrates with the wallet subsystem (e.g. mail applications or games). Vaults are often decrypted automatically at the user login using a PAM module (see below).

Tips:

• If you only need to have a wallet available for applications using it, it is suggested to use the default name (i.e. kdewallet) and the same password as the user (for PAM).

• Wallets are stored as encrypted files using the .kwl extension in the ~/.local/share/kwalletd directory by default.

Installation

KDE Wallet is often shipped with the KDE Plasma desktop environment. The wallet subsystem can be manually installed with the kwallet package.

Optionally install the kwalletmanager package for the wallet management tool. This tool can be used to graphically create and manage a KDE Wallet.

Configuration

Configure PAM on Plasma 6 (KF6)

Plasma 6 uses ksecretd as secret service API for kwallet. Therefore PAM must explicitly point to the daemon.

Add to the relevant PAM files (e.g. system-login, sddm, login depending on setup):

auth            optional        pam_kwallet5.so
session         optional        pam_kwallet5.so auto_start kwalletd=/usr/bin/ksecretd

Without the kwalletd parameter, pam_kwallet5.so falls back to default and tries to use kwallet5.

Edit the PAM configuration corresponding to your situation:

• For SDDM, no further edits should be needed because the lines are already present in /etc/pam.d/sddm.

• For LightDM, no further edits should be needed because the lines are already present in /etc/pam.d/lightdm and /etc/pam.d/lightdm-autologin.

• For GDM, edit /etc/pam.d/gdm-password accordingly.

• For greetd, edit /etc/pam.d/greetd accordingly.

• For unlocking on tty login (no display manager, or like greetd-tuigreet), edit /etc/pam.d/login accordingly. You will need to specify the force_run parameter.

auth            optional        pam_kwallet5.so
session         optional        pam_kwallet5.so auto_start force_run kwalletd=/usr/bin/ksecretd

/etc/pam.d/login

#%PAM-1.0

auth       required     pam_securetty.so
auth       requisite    pam_nologin.so
auth       include      system-local-login
auth       optional     pam_kwallet5.so
account    include      system-local-login
session    include      system-local-login
session    optional     pam_kwallet5.so auto_start force_run kwalletd=/usr/bin/ksecretd

/etc/pam.d/greetd

Plasma 5 (KF5) – legacy

Older Plasma versions use kwalletd5 and do not require specifying the daemon.

auth     optional  pam_kwallet5.so
session  optional  pam_kwallet5.so auto_start

/etc/pam.d/login

Unlock KDE Wallet automatically on login

To unlock KDE Wallet automatically on login, install kwallet-pam for the PAM compatible module. The chosen KWallet password must be the same as the current user password.

Using Plasma Login Manager autologin and LUKS encryption

Copy /usr/lib/pam.d/plasmalogin-autologin to /etc/pam.d/plasmalogin-autologin then add pam_systemd_loadkey(8) before pam_kwallet5.so:

-auth       optional    pam_systemd_loadkey.so
-auth       optional    pam_gnome_keyring.so
-auth       optional    pam_kwallet5.so

/etc/pam.d/plasmalogin-autologin

Then add the following to plasmalogin.service:

[Service]
KeyringModeinherit

/etc/systemd/system/plasmalogin.service.d/keyringmode.conf

Using SDDM autologin and LUKS encryption

When the system is encrypted using dm-crypt it is possible to automatically unlock KDE Wallet using the passphrase that decrypts the disk. When SDDM#Autologin is configured, the wallet can still be unlocked automatically. Edit /etc/pam.d/sddm-autologin to add pam_systemd_loadkey(8):

-auth       optional    pam_systemd_loadkey.so
-auth       optional    pam_gnome_keyring.so
-auth       optional    pam_kwallet5.so
-session    optional    pam_gnome_keyring.so auto_start
-session    optional    pam_kwallet5.so auto_start kwalletd=/usr/bin/ksecretd

/etc/pam.d/sddm-autologin

Then edit sddm.service, and add:

[Service]
KeyringModeinherit

/etc/systemd/system/sddm.service.d/keyringmode.conf

Tips and tricks

Using the KDE Wallet to store ssh key passphrases

Install ksshaskpass package.

Set the SSH_ASKPASS environment variable to ksshaskpass and SSH_ASKPASS_REQUIRE to prefer (prefer to use the askpass program instead of the TTY). To set it automatically on each login, create the following environment.d(5) file:

SSH_ASKPASS=/usr/bin/ksshaskpass
SSH_ASKPASS_REQUIRE=prefer

~/.config/environment.d/ssh_askpass.conf

Restart your session (i.e. relogin) so that the environment variables take effect.

The first time you try to use an SSH key, you will get asked for its passphrase. Make sure to check the Remember password checkbox. Next time, the passphrase will be read from KDE Wallet.

Using the KDE Wallet to store Git credentials

Git can delegate credential handling to a credential helper. By using ksshaskpass as a credential helper, the HTTP/HTTPS and SMTP passwords can be safely stored in the KDE Wallet.

Install the ksshaskpass package.

Configure Git by setting the GIT_ASKPASS environment variable:

GIT_ASKPASS=/usr/bin/ksshaskpass

~/.config/environment.d/git_askpass.conf

See gitcredentials(7) for alternatives and more details.

Store GPG key passphrases

Native KDE windows can be used to prompt for GPG key passphrases and save them in KDE Wallet.

Configure gpg-agent to use /usr/bin/pinentry-qt.

Enable the Secret Service interface. There are two ways to do this:

• Go to System Settings > KDE Wallet and enable Use KWallet for the Secret Service interface.

• Edit the KDE Wallet configuration file:

[org.freedesktop.secrets]
apiEnabled=true

~/.config/kwalletrc

Close the wallet and reopen it to affect these changes. You can do this using kwalletmanager or by issuing commands to Qt D-Bus directly:

$ qdbus org.kde.kwalletd6 /modules/kwalletd6 closeAllWallets
$ qdbus org.kde.kwalletd6 /modules/kwalletd6 open kdewallet 0 $0

KDE Wallet for Chromium and VSCode

Chromium-based browsers have built-in wallet integration. VSCode-based IDEs rely on the same Chromium oscrypt module for keyring detection. https://code.visualstudio.com/docs/configure/settings-sync#_troubleshooting-keychain-issues

To enable it, run the program with either the --password-store=kwallet5 or --password-store=kwallet6 or --password-store=detect argument. https://source.chromium.org/chromium/chromium/src/+/main:docs/linux/password_storage.md

To make the change persistent, see Chromium#Making flags persistent (Setting CHROMIUM_USER_FLAGS will not work).

Query passwords from the terminal

Instead of storing passwords in plain text files, you can manually add new entries in your wallet and retrieve them with kwallet-query.

For example, if you want to log into the Docker Hub registry with Podman, which supports getting the passwords from stdin with the --password-stdin flag, you can use the following command to login:

$ kwallet-query -r folder_entry wallet_name -f folder_name | podman login docker.io -u dockerhub_username --password-stdin

This way, your password is not stored in any text file and neither is it stored in the terminal history file.

In order to run kwallet-query outside of a graphical session (for instance as part of an unattended backup script), set the QT_QPA_PLATFORMoffscreen environment variable:

$ QT_QPA_PLATFORM=offscreen kwallet-query -r folder_entry wallet_name -f folder_name

Unlocking KWallet automatically in a window manager

To unlock KWallet protected by the login password, it is necessary to start /usr/lib/pam_kwallet_init in the autostart portion of your window manager's configuration file in addition to configuring PAM.

Disable KWallet

In case you want to permanently disable kwallet:

[Wallet]
Enabled=false

~/.config/kwalletrc

Automatic D-Bus activation

Most applications use org.freedesktop.secrets.service D-Bus service. KWallet does not provide a service file for it out of the box.

You can achieve automatic activation by creating such service file:

[D-BUS Service]
Name=org.freedesktop.secrets
Exec=/usr/bin/kwalletd6

~/.local/share/dbus-1/services/org.freedesktop.secrets.service

See also

• Wikipedia:KWallet

• dennogumi.org: Unlocking KWallet with PAM

• org.freedesktop.secrets DBus API initial support