KWALLETASKPASS(1)

💖 KWALLETASKPASS 💖

okay so bestie, meet kwalletaskpass — the kwallet-based pass-phrase dialog for use with OpenSSH. it's giving backstage-pass-for-your-keys energy 🔑✨ (manual page one, section one, iykyk)

✨ SYNOPSIS ✨

kwalletaskpass [options] label

🌸 DESCRIPTION 🌸

so kwalletaskpass is a kwallet- and pinentry-based pass-phrase dialog for use with OpenSSH. no cap. it's literally designed to be called from the ssh-add(1) program — it is not meant to be invoked directly by you, bestie. it has main character energy but only when summoned. 🙈

when a passphrase is requested, kwalletaskpass does this little routine:

1. first it looks up the passphrase in the KWallet by means of kwalletcli(1) — and if it's found, slay, it uses it 💅
2. if it's not found, it calls kwalletcli_getpin(1) to interactively retrieve an answer from the user via pinentry instead

and if the user specifies a passphrase, kwalletcli_getpin(1) is run again to ask if the passphrase should be stored in the KWallet. negative answers will be stored in the KWallet too, so you don't get asked every single time — the way that's so considerate of it, honestly. 🥹

kwalletaskpass uses the KWallet folders kwalletaskpass and kwalletaskpass-blacklist with matching entry names. yes, there's a whole blacklist folder, it's very organized, we love a structured queen 👑

now, if anything other than a key passphrase is requested, it is merely relayed to kwalletcli_getpin(1). some requests are known to require a boolean answer and are relayed using the boolean query flag; all others are relayed using a PIN query. and heads up — ssh(1) accepts either the literal word “yes” (case-insensitively matched) or an empty answer (both only when using the OK button) as confirmation. noted. important. don't forget it. 📝

and the tea? there are currently no options. that's it. that's the whole options section. iconic minimalism, we stan a low-maintenance binary 🎀

💀 RETURN VALUES 💀

• exits 0 on success ✅
• exits 1 if the user cancelled the dialogue 🙅
• exits >1 if an error occurred 😭

🌈 ENVIRONMENT 🌈

• DISPLAY — the X11 display to use for child processes. if this is unset or empty, kwalletcli will not be called. so like… keep it set or nothing happens, bestie 🫶
• PINENTRY — the pinentry program to use. the default is inherited from kwalletcli_getpin(1). ✨

👑 SEE ALSO 👑

kwalletcli(1), kwalletcli_getpin(1), ssh-add(1), ssh-askpass(1)

go read them, they're the supporting cast and they ate 🔥

🎀 AUTHORS 🎀

kwalletaskpass was written by mirabilos <m@mirbsd.org> mostly for tarent solutions GmbH. the idea came from an askpass.C file found somewhere on the 'net, with no author information. and since it was licenced less freely, this is a rewrite from scratch — modular and with more functionality, too. a glow-up fr fr 💖

and that's the whole vibe check, bestie — this page came from the Debian crew, dated November 19, 2020, and it's the manual for KWALLETASKPASS(1). periodt. 💅✨