kwalletcli_getpin(1)

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

NAME

4     kwalletcli_getpin — command line interface to pinentry
5

SYNOPSIS

7     kwalletcli_getpin [-q] [-b | -m | -p prompt] [-E | -e errortext]
8                       [-N NoText] [-t desctext] [-Y YesText]
9

DESCRIPTION

11     The kwalletcli_getpin utility is a shell wrapper speaking to pinentry us‐
12     ing the Assuan protocol.  It will ask the user for a passphrase and print
13     it, without any trailing newline, to standard output.  There are options
14     for asking a boolean question or displaying a message.
15
16     If PINENTRY is not empty but points to a non-existing or failing program,
17     pinentry is not called.  Instead, xmessage(1) is used for boolean queries
18     and messages if DISPLAY is set; otherwise, kwalletcli_getpin uses simple
19     terminal I/O on GPG_TTY using stty(1) to disable echo of terminal input
20     for passphrase queries.
21
22     The options are as follows:
23
24     -b          Ask for a confirmation (boolean) instead of a passphrase.
25
26     -E          Unset a previously set error text.
27
28     -E errtxt   Set the error text to errtxt, displaying a dialogue box with
29                 a red X icon indicating that this is a retry question.
30
31     -m          Display a message (one-button query) instead of asking.
32
33     -N NoText   Use NoText instead of Cancel for the text of the abort but‐
34                 ton, if any.
35
36     -p prompt   Set the small descriptive text shown in front of the input
37                 field (“the Prompt”) to prompt.
38
39     -q          Be more quiet.
40
41     -t desctxt  Set the descriptive text (the input challenge) to desctxt.
42
43     -Y YesText  Use YesText instead of OK for the text of the confirm button.
44
45     All input and output is assumed to be in UTF-8.
46

RETURN VALUES

48     The kwalletcli_getpin utility exits 0 on success, 1 if the passphrase in‐
49     put was cancelled by the user, or >1 if an error occurred.  Confirmation
50     (boolean) error codes are 0 for Yes, 1 for No, or >1 if an error oc‐
51     curred.  Messages return >0 if an error occurred, 0 otherwise.
52
53     A summary of the error codes follows:
54     0  Read password successfully.  Boolean question returned Yes/OK.
55     1  Boolean question returned No/Cancel.
56     2  Wrong command line syntax.
57     3  The process reading user input unexpectedly terminated or errored out.
58     4  Unexpected result reading from pinentry.
59     5  Unable to determine controlling tty, caller must set GPG_TTY.
60     6  Caught SIGHUP, SIGINT, SIGQUIT, SIGTRAP, SIGPIPE, or SIGTERM.
61

ENVIRONMENT

63     DISPLAY      If not set, pass current terminal information to pinentry.
64
65     GPG_TERM     Terminal type of the current tty.  Defaults to the value of
66                  the environment variable TERM, or “vt100” if unset.
67
68     GPG_TTY      The current terminal, determined by tty(1) if unset.
69
70     LC_CTYPE     Passed to pinentry.  Default: “en_US.UTF-8”
71
72     LC_MESSAGES  Passed to pinentry.  Unset by default.
73
74     PINENTRY     The pinentry program to use.  Default: “pinentry”
75

AUTHORS

80     kwalletcli_getpin was written by mirabilos <m@mirbsd.org> mostly for tar‐
81     ent solutions GmbH.
82

CAVEATS

84     Some newer pinentry features, such as three-button operation or setting
85     the window title, are not supported yet.
86

BUGS

88     Some pinentry programs may not support messages correctly and display
89     them as boolean queries instead.
90
91     Some implementations display labels with the wrong charset.
92
93     Neither of these two problems is an issue in kwalletcli_getpin but a bug
94     of the backend implementation.
95
96BSD                            November 19, 2020                           BSD