Difference between revisions of "KDE Wallet"

From ArchWiki
Jump to navigation Jump to search
m ("display manager" is not a proper noun)
(→‎Using the KDE Wallet to store ssh key passphrases: add "-q" to ssh-add to silence output on success (the messages used to show up in journal, although they don't anymore); style)
 
(25 intermediate revisions by 10 users not shown)
Line 7: Line 7:
  
 
== Unlock KDE Wallet automatically on login ==
 
== Unlock KDE Wallet automatically on login ==
 +
 
{{Note|
 
{{Note|
 +
* {{Pkg|kwallet-pam}} is not compatible with [[GnuPG]] keys, the KDE Wallet must use the standard {{ic|blowfish}} encryption.
 
* The chosen KWallet password must be the same as the current [[user]] password.
 
* The chosen KWallet password must be the same as the current [[user]] password.
* {{Pkg|kwallet-pam}} is not compatible with [[GnuPG]] keys, the KDE Wallet must use the standard {{ic|blowfish}} encryption.
+
* The wallet cannot be unlocked when using autologin.
* The wallet must be named {{ic|kdewallet}} (default name). It doesn't unlock any other wallet(s).}}
+
* The wallet cannot be unlocked when using a fingerprint reader to login
 +
* The wallet must be named {{ic|kdewallet}} (default name). It does not unlock any other wallet(s).
 +
* If using [[KDE]], one may want to disable ''Close when last application stops using it'' in KDE Wallet settings to prevent the wallet from being closed after each usage ([[WiFi]]-passphrase unlock, etc.).
 +
* It may be needed to remove the default created wallet first, thus removing all stored entries.
 +
* If the kwallet Migration Assistant asks for a password after every login, rename or delete the {{ic|~/.kde4/share/apps/kwallet}} folder.
 +
}}
  
 
[[Install]] {{Pkg|kwallet-pam}} for the [[PAM]] compatible module.
 
[[Install]] {{Pkg|kwallet-pam}} for the [[PAM]] compatible module.
 +
 +
Optional [[install]] {{Pkg|kwalletmanager}} for the wallet management tool. This tool can be used to create a KDE Wallet with {{ic|blowfish}} encryption and more settings not provided by the ''kcm-module''.
 +
 +
{{Tip|An alternative is to use KWalletManager and set an empty Kwallet-password, thus preventing the need of entering a password to unlock a wallet. Simple don't enter a password on both fields in ''Change Password..''. This may however lead to unwanted (read/write) access to the user's wallet. Enabling ''Prompt when an application accesses a wallet'' under ''Access Control'' is highly recommended to prevent unwanted access to the wallet.}}
  
 
=== Configure display manager ===
 
=== Configure display manager ===
Line 41: Line 52:
 
}}
 
}}
  
== Using the KDE Wallet to store ssh key passhprases ==
+
== Using the KDE Wallet to store ssh key passphrases ==
 
{{Note|A [[SSH agent]] should be up and running.}}
 
{{Note|A [[SSH agent]] should be up and running.}}
  
 
[[Install]] {{Pkg|ksshaskpass}} package.
 
[[Install]] {{Pkg|ksshaskpass}} package.
  
[[Create]] an [[KDE#Autostarting_applications|autostart script file]] and mark it as [[executable]]:
+
[[Create]] an [[KDE#Autostart|autostart script file]] and mark it as [[executable]]:
 
{{hc|~/.config/autostart-scripts/ssh-add.sh|
 
{{hc|~/.config/autostart-scripts/ssh-add.sh|
 
#!/bin/sh
 
#!/bin/sh
ssh-add </dev/null
+
ssh-add -q < /dev/null
 
}}
 
}}
  
Line 56: Line 67:
 
{{hc|~/.config/autostart-scripts/ssh-add.sh|
 
{{hc|~/.config/autostart-scripts/ssh-add.sh|
 
#!/bin/sh
 
#!/bin/sh
ssh-add $HOME/.ssh/key1 $HOME/.ssh/key2 $HOME/.ssh/key3 </dev/null
+
ssh-add -q ~/.ssh/key1 ~/.ssh/key2 ~/.ssh/key3 < /dev/null
 
}}
 
}}
 
}}
 
}}
  
You also have to set the {{ic|SSH_ASKPASS}} [[environment variable]], see [[Environment variables#Defining variables]]. E.g.:
+
You also have to set the {{ic|SSH_ASKPASS}} [[environment variable]] to {{ic|ksshaskpass}}. For example, create the following [[KDE#Autostart|autostart script file]] and mark it [[executable]]:
  
{{bc|<nowiki>
+
{{hc|~/.config/plasma-workspace/env/askpass.sh|2=
export SSH_ASKPASS="/usr/bin/ksshaskpass"
+
#!/bin/sh
</nowiki>}}
+
 
 +
export SSH_ASKPASS='/usr/bin/ksshaskpass'
 +
}}
  
 
It will ask for your password and unlock your SSH keys. Upon restart your SSH keys should be unlocked once you give your kwallet password.  
 
It will ask for your password and unlock your SSH keys. Upon restart your SSH keys should be unlocked once you give your kwallet password.  
Line 70: Line 83:
 
To add a new key and store the password with kwallet use the following command
 
To add a new key and store the password with kwallet use the following command
  
  $ ssh-add /path/to/new/key </dev/null
+
  $ ssh-add ''/path/to/new/key'' </dev/null
  
 
and append the key to the list of keys in {{ic|~/.config/autostart-scripts/ssh-add.sh}} as explained above to have it unlocked upon providing the kwallet password.
 
and append the key to the list of keys in {{ic|~/.config/autostart-scripts/ssh-add.sh}} as explained above to have it unlocked upon providing the kwallet password.
  
== KDE Wallet for Firefox ==
+
== Using the KDE Wallet to store Git http/https credentials ==
{{Note|As of Firefox 57 this addon is not supported anymore. Use Firefox ESR if wanting to use this addon.}}
 
  
There is an unofficial [[Firefox]] addon for [https://addons.mozilla.org/addon/kde5-wallet-password-integrati/ KDE5 Wallet] integration.
+
[[Git]] can delegate credentials handling to KDE Wallet using a helper like {{Pkg|ksshaskpass}}
  
== KDE Wallet for Chrome and Chromium ==
+
[[Install]] the {{Pkg|ksshaskpass}} package.
  
Chrome/Chromium has built in wallet integration. To enable it, run Chromium with the {{ic|1=--password-store=kwallet}} or {{ic|1=--password-store=detect}} argument. To make the change persistent, see [[Chromium/Tips and tricks#Making flags persistent]]. (Setting CHROMIUM_USER_FLAGS will not work.)
+
Configure Git by setting the {{ic|GIT_ASKPASS}} [[environment variable]]:
  
== Troubleshooting ==
+
{{hc|~/.config/plasma-workspace/env/askpass.sh|2=
 +
#!/bin/sh
  
=== Inotify folder watch limit ===
+
export GIT_ASKPASS='/usr/bin/ksshaskpass'
 +
}}
  
If you get the following error:
+
See {{man|7|gitcredentials}} for alternatives and more details.
  
KDE Baloo Filewatch service reached the inotify folder watch limit. File changes may be ignored.
+
== KDE Wallet for Chrome and Chromium ==
  
Then you will need to increase the inotify folder watch limit:
+
Chrome/Chromium has built in wallet integration. To enable it, run Chromium with the {{ic|1=--password-store=kwallet}} or {{ic|1=--password-store=detect}} argument. To make the change persistent, see [[Chromium/Tips and tricks#Making flags persistent]]. (Setting CHROMIUM_USER_FLAGS will not work.)
 
 
# echo 524288 > /proc/sys/fs/inotify/max_user_watches
 
 
 
To make changes permanent, create a {{ic|40-max-user-watches.conf}} file:
 
 
 
{{hc|/etc/sysctl.d/40-max-user-watches.conf|2=
 
fs.inotify.max_user_watches=524288
 
}}
 
  
 
== See also ==
 
== See also ==
  
 
* [https://www.dennogumi.org/2014/04/unlocking-kwallet-with-pam/ Unlocking KWallet with PAM]
 
* [https://www.dennogumi.org/2014/04/unlocking-kwallet-with-pam/ Unlocking KWallet with PAM]

Latest revision as of 07:05, 28 September 2019

KDE Wallet Manager is a tool to manage passwords on the KDE Plasma system. By using the KWallet subsystem it not only allows you to keep your own secrets but also to access and manage the passwords of every application that integrates with KWallet.

Unlock KDE Wallet automatically on login

Note:
  • kwallet-pam is not compatible with GnuPG keys, the KDE Wallet must use the standard blowfish encryption.
  • The chosen KWallet password must be the same as the current user password.
  • The wallet cannot be unlocked when using autologin.
  • The wallet cannot be unlocked when using a fingerprint reader to login
  • The wallet must be named kdewallet (default name). It does not unlock any other wallet(s).
  • If using KDE, one may want to disable Close when last application stops using it in KDE Wallet settings to prevent the wallet from being closed after each usage (WiFi-passphrase unlock, etc.).
  • It may be needed to remove the default created wallet first, thus removing all stored entries.
  • If the kwallet Migration Assistant asks for a password after every login, rename or delete the ~/.kde4/share/apps/kwallet folder.

Install kwallet-pam for the PAM compatible module.

Optional install kwalletmanager for the wallet management tool. This tool can be used to create a KDE Wallet with blowfish encryption and more settings not provided by the kcm-module.

Tip: An alternative is to use KWalletManager and set an empty Kwallet-password, thus preventing the need of entering a password to unlock a wallet. Simple don't enter a password on both fields in Change Password... This may however lead to unwanted (read/write) access to the user's wallet. Enabling Prompt when an application accesses a wallet under Access Control is highly recommended to prevent unwanted access to the wallet.

Configure display manager

The following lines must be present under their corresponding sections:

auth            optional        pam_kwallet5.so
session         optional        pam_kwallet5.so auto_start

It may be needed to edit the display manager configuration:

  • For SDDM no further edits should be needed because the lines are already present in /etc/pam.d/sddm.
  • For GDM edit /etc/pam.d/gdm-password accordingly.
  • For LightDM edit /etc/pam.d/lightdm and /etc/pam.d/lightdm-greeter files:
/etc/pam.d/lightdm
#%PAM-1.0
auth            include         system-login
auth            optional        pam_kwallet5.so

account         include         system-login

password        include         system-login

session         include         system-login
session         optional        pam_kwallet5.so auto_start

Using the KDE Wallet to store ssh key passphrases

Note: A SSH agent should be up and running.

Install ksshaskpass package.

Create an autostart script file and mark it as executable:

~/.config/autostart-scripts/ssh-add.sh
#!/bin/sh
ssh-add -q < /dev/null
Tip: The above ssh-add.sh script will only add the default key ~/.ssh/id_rsa. Assuming you have different SSH keys named key1, key2, key3 in ~/.ssh/, you may add them automatically on login by changing the above script to:
~/.config/autostart-scripts/ssh-add.sh
#!/bin/sh
ssh-add -q ~/.ssh/key1 ~/.ssh/key2 ~/.ssh/key3 < /dev/null

You also have to set the SSH_ASKPASS environment variable to ksshaskpass. For example, create the following autostart script file and mark it executable:

~/.config/plasma-workspace/env/askpass.sh
#!/bin/sh

export SSH_ASKPASS='/usr/bin/ksshaskpass'

It will ask for your password and unlock your SSH keys. Upon restart your SSH keys should be unlocked once you give your kwallet password.

To add a new key and store the password with kwallet use the following command

$ ssh-add /path/to/new/key </dev/null

and append the key to the list of keys in ~/.config/autostart-scripts/ssh-add.sh as explained above to have it unlocked upon providing the kwallet password.

Using the KDE Wallet to store Git http/https credentials

Git can delegate credentials handling to KDE Wallet using a helper like ksshaskpass

Install the ksshaskpass package.

Configure Git by setting the GIT_ASKPASS environment variable:

~/.config/plasma-workspace/env/askpass.sh
#!/bin/sh

export GIT_ASKPASS='/usr/bin/ksshaskpass'

See gitcredentials(7) for alternatives and more details.

KDE Wallet for Chrome and Chromium

Chrome/Chromium has built in wallet integration. To enable it, run Chromium with the --password-store=kwallet or --password-store=detect argument. To make the change persistent, see Chromium/Tips and tricks#Making flags persistent. (Setting CHROMIUM_USER_FLAGS will not work.)

See also