kwalletcli(1)

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

NAME

4     kwalletcli — command line interface to the KDE Wallet
5

SYNOPSIS

7     kwalletcli [-q] -hV
8     kwalletcli [-q] -f folder -e entry [-P | -p password]
9

DESCRIPTION

11     The kwalletcli utility is a command line interface to KWallet.  It will
12     only work if KDE is running (DCOP) and reachable (via X11).  kwalletcli
13     can be used to get password entries from the default Wallet, or to write
14     them there.
15
16     The options are as follows:
17
18     -e entry     Define the key (entry) to use when accessing the Wallet.
19                  Mandatory.
20
21     -f folder    Set the folder to use when accessing the Wallet.  Mandatory.
22
23     -h           Display the usage.
24
25     -P           Read the password to write from standard input.  Currently
26                  limited to 65535 octets.
27
28     -p password  Write password into the designated location in the Wallet.
29
30     -q           Be more quiet.  In combination with -V, do not display any‐
31                  thing.
32
33     -V           Display the kwalletcli version information.
34
35     Default mode of operation, that is, unless -P or -p are used, is to read
36     the password from the default Wallet and print it to standard output as-
37     is, without any trailing newline.
38
39     There is currently no way to specify a Wallet other than the default.
40
41     All input and output is assumed to be in UTF-8.  The password string
42     (whether read from standard input or command line) is now converted from
43     “possibly UTF-8 but binary transparent” to standards-conformant UTF-8 for
44     the Qt side, and back upon reading out.
45

RETURN VALUES

47     The kwalletcli utility exits 0 on success or >0 if an error occurred:
48
49     1    The entry specified cannot be found (read access).
50
51     2    The usage was shown.
52
53     3    The Wallet could not be opened.  May be a missing DCOP connection.
54          Perhaps DISPLAY is not set.
55
56     4    The folder specified cannot be found (read access).
57
58     5    The folder specified cannot be opened.
59
60     6    The value to the key specified could not be retrieved.
61
62     8    An error occurred trying to write the value.
63
64     The exit codes 1 and 4, on reading, are not fatal; they merely indicate
65     that the folder or entry specified does not exist.  The other errors are
66     fatal and may be used to indicate the user that the KWallet should not be
67     used any more during the current session.
68

ENVIRONMENT

70     DISPLAY  The X11 display to use for communicating with the KDE Wallet.
71

EXAMPLES

73     The following command...
74
75           $ printf '%s\n' "secret" | kwalletcli -f passwords -e sitename -P
76
77     ... stores the password “secret” as passwords\sitename inside the default
78     Wallet.  To read it out, use:
79
80           $ password=$(kwalletcli -f passwords -e sitename)
81

AUTHORS

86     kwalletcli was written by mirabilos <m@mirbsd.org> mostly for tarent so‐
87     lutions GmbH.
88

CAVEATS

90     Do not use -p password to store it, unless you absolutely must.  It is a
91     security risk, because the command line invocation is public information
92     in a normal Unix environment.  Use -P instead and provide the password on
93     standard input.
94
95     Beware of trailing newlines, especially outside of mksh(1) scripts!
96

BUGS

98     If DISPLAY is not set, not valid, or kdeinit or kdeinit4 cannot start for
99     other reasons, kwalletcli may not recover gracefully.  In KDE 4 versions,
100     this may even result in a Segmentation fault.  The author does not know
101     of a way to catch this early; patches are welcome.
102
103BSD                            November 19, 2020                           BSD