1KWALLETASKPASS(1)         BSD General Commands Manual        KWALLETASKPASS(1)
2

NAME

4     kwalletaskpass — kwallet-based pass-phrase dialog for use with OpenSSH
5

SYNOPSIS

7     kwalletaskpass [options] label
8

DESCRIPTION

10     kwalletaskpass is a kwallet- and pinentry-based pass-phrase dialog for
11     use with OpenSSH.  It is intended to be called from the ssh-add(1) pro‐
12     gram and not invoked directly.
13
14     If a passphrase is requested, kwalletaskpass works by first looking up
15     the passphrase in the KWallet by means of kwalletcli(1); using it if
16     found, then calling kwalletcli_getpin(1) to interactively retrieve an an‐
17     swer from the user via pinentry otherwise.  If the user specifies a
18     passphrase, kwalletcli_getpin(1) is run again to ask if the passphrase
19     should be stored in the KWallet.  Negative answers will be stored in the
20     KWallet to avoid being asked each time.  kwalletaskpass uses the KWallet
21     folders kwalletaskpass and kwalletaskpass-blacklist with matching entry
22     names.
23
24     If anything other than a key passphrase is requested, it is merely re‐
25     layed to kwalletcli_getpin(1).  Some requests are known to require a
26     boolean answer and are relayed using the boolean query flag; all others
27     are relayed using a PIN query.  ssh(1) accepts either the literal word
28     “yes” (case-insensitively matched) or an empty answer (both only when us‐
29     ing the OK button) as confirmation.
30
31     There are currently no options.
32

RETURN VALUES

34     kwalletaskpass exits 0 on success, 1 if the user cancelled the dialogue,
35     or >1 if an error occurred.
36

ENVIRONMENT

38     DISPLAY   The X11 display to use for child processes.  If this is unset
39               or empty, kwalletcli will not be called.
40
41     PINENTRY  The pinentry program to use.  The default is inherited from
42               kwalletcli_getpin(1).
43

SEE ALSO

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

AUTHORS

48     kwalletaskpass was written by mirabilos <m@mirbsd.org> mostly for tarent
49     solutions GmbH.  The idea came from an askpass.C file found somewhere on
50     the 'net, with no author information.  Since it was licenced less freely,
51     this is a rewrite from scratch; modular and with more functionality, too.
52
53BSD                            November 19, 2020                           BSD