1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
|
<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
<refentry id="systemd-ask-password"
xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>systemd-ask-password</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>systemd-ask-password</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>systemd-ask-password</refname>
<refpurpose>Query the user for a system password</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>systemd-ask-password</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">MESSAGE</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para><command>systemd-ask-password</command> may be used to query a password or passphrase interactively
from the user, using a question prompt specified on the command line. When run from a TTY it will query a
password on the TTY and print it to standard output. When run with no TTY or with
<option>--no-tty</option> it will use a system-wide or per-user agent-based query mechanism, which allows
active users to respond via several agents, listed below.</para>
<para>The purpose of this tool is to query system-wide or per-user passwords — the former includes
passwords possibly not associated to a specific user account. Examples include: unlocking encrypted hard
disks when they are plugged in or at boot, entering an SSL certificate passphrase for web and VPN
servers.</para>
<para>Existing system-level agents are:
<itemizedlist>
<listitem><para>A boot-time password agent asking the user for passwords using <citerefentry
project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
</para></listitem>
<listitem><para>A boot-time password agent querying the user
directly on the console —
<citerefentry><refentrytitle>systemd-ask-password-console.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
</para></listitem>
<listitem><para>An agent requesting password input via a
<citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
message —
<citerefentry><refentrytitle>systemd-ask-password-wall.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
</para></listitem>
<listitem><para>A TTY agent that is temporarily spawned during
<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
invocations,</para></listitem>
<listitem><para>A command line agent which can be started
temporarily to process queued password
requests — <command>systemd-tty-ask-password-agent --query</command>.
</para></listitem>
</itemizedlist></para>
<para>Answering system-wide password queries is a privileged operation, hence
all the agents listed above (except for the last one), run as privileged
system services. The last one also needs elevated privileges, so
should be run through
<citerefentry><refentrytitle>run0</refentrytitle><manvolnum>1</manvolnum></citerefentry>
or similar.</para>
<para>Additional password agents may be implemented according to the <ulink
url="https://systemd.io/PASSWORD_AGENTS/">systemd Password Agent Specification</ulink>.</para>
<para>If a password is queried on a TTY, the user may press TAB to
hide the asterisks normally shown for each character typed.
Pressing Backspace as first key achieves the same effect.</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>--icon=</option></term>
<listitem><para>Specify an icon name alongside the password
query, which may be used in all agents supporting graphical
display. The icon name should follow the <ulink
url="https://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html">XDG
Icon Naming Specification</ulink>.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--id=</option></term>
<listitem><para>Specify an identifier for this password
query. This identifier is freely choosable and allows
recognition of queries by involved agents. It should include
the subsystem doing the query and the specific object the
query is done for. Example:
<literal>--id=cryptsetup:/dev/sda5</literal>.</para>
<xi:include href="version-info.xml" xpointer="v227"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--keyname=</option></term>
<listitem><para>Configure a kernel keyring key name to use as
cache for the password. If set, then the tool will try to push
any collected passwords into the kernel keyring of the root
user, as a key of the specified name. If combined with
<option>--accept-cached</option>, it will also try to retrieve
such cached passwords from the key in the kernel keyring
instead of querying the user right away. By using this option,
the kernel keyring may be used as effective cache to avoid
repeatedly asking users for passwords, if there are multiple
objects that may be unlocked with the same password. The
cached key will have a timeout of 2.5min set, after which it
will be purged from the kernel keyring. Note that it is
possible to cache multiple passwords under the same keyname,
in which case they will be stored as <constant>NUL</constant>-separated list of
passwords. Use
<citerefentry project='die-net'><refentrytitle>keyctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
to access the cached key via the kernel keyring
directly. Example: <literal>--keyname=cryptsetup</literal></para>
<xi:include href="version-info.xml" xpointer="v227"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--credential=</option></term>
<listitem><para>Configure a credential to read the password from – if it exists. This may be used in
conjunction with the <varname>ImportCredential=</varname>, <varname>LoadCredential=</varname> and
<varname>SetCredential=</varname> settings in unit files. See
<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
details. If not specified, defaults to <literal>password</literal>. This option has no effect if no
credentials directory is passed to the program (i.e. <varname>$CREDENTIALS_DIRECTORY</varname> is not
set) or if the no credential of the specified name exists.</para>
<xi:include href="version-info.xml" xpointer="v249"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--timeout=</option></term>
<listitem><para>Specify the query timeout in seconds. Defaults
to 90s. A timeout of 0 waits indefinitely. </para></listitem>
</varlistentry>
<varlistentry>
<term><option>--echo=yes|no|masked</option></term>
<listitem><para>Controls whether to echo user input. Takes a boolean or the special string
<literal>masked</literal>, the default being the latter. If enabled the typed characters are echoed
literally, which is useful for prompting for usernames and other non-protected data. If disabled the
typed characters are not echoed in any form, the user will not get feedback on their input. If set to
<literal>masked</literal>, an asterisk (<literal>*</literal>) is echoed for each character
typed. In this mode, if the user hits the tabulator key (<literal>↹</literal>), echo is turned
off. (Alternatively, if the user hits the backspace key (<literal>⌫</literal>) while no data has
been entered otherwise, echo is turned off, too).</para>
<xi:include href="version-info.xml" xpointer="v249"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--echo</option></term>
<term><option>-e</option></term>
<listitem><para>Equivalent to <option>--echo=yes</option>, see above.</para>
<xi:include href="version-info.xml" xpointer="v217"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--emoji=yes|no|auto</option></term>
<listitem><para>Controls whether or not to prefix the query with a
lock and key emoji (🔐), if the TTY settings permit this. The default
is <literal>auto</literal>, which defaults to <literal>yes</literal>,
unless <option>--echo=yes</option> is given.</para>
<xi:include href="version-info.xml" xpointer="v249"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-tty</option></term>
<listitem><para>Never ask for password on current TTY even if
one is available. Always use agent system.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--accept-cached</option></term>
<listitem><para>If passed, accept cached passwords, i.e.
passwords previously entered.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--multiple</option></term>
<listitem><para>When used in conjunction with
<option>--accept-cached</option> accept multiple passwords.
This will output one password per line.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-output</option></term>
<listitem><para>Do not print passwords to standard output. This is useful if you want to store a
password in kernel keyring with <option>--keyname=</option> but do not want it to show up on screen
or in logs.</para>
<xi:include href="version-info.xml" xpointer="v230"/></listitem>
</varlistentry>
<varlistentry>
<term><option>-n</option></term>
<listitem><para>By default, when the acquired password is written to standard output it is suffixed
by a newline character. This may be turned off with the <option>-n</option> switch, similarly to the
switch of the same name of the <citerefentry
project='man-pages'><refentrytitle>echo</refentrytitle><manvolnum>1</manvolnum></citerefentry>
command.</para>
<xi:include href="version-info.xml" xpointer="v249"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--user</option></term>
<term><option>--system</option></term>
<listitem><para>Controls whether to query the system-wide or the per-user password agents. By default
if invoked privileged the system-wide agents are queried, otherwise the per-user ones. These options
allow to override this automatic behaviour.</para>
<xi:include href="version-info.xml" xpointer="v257"/></listitem>
</varlistentry>
<xi:include href="standard-options.xml" xpointer="help" />
</variablelist>
</refsect1>
<refsect1>
<title>Exit status</title>
<para>On success, 0 is returned, a non-zero failure code
otherwise.</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para><simplelist type="inline">
<member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd-ask-password-console.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd-tty-ask-password-agent</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry project='die-net'><refentrytitle>keyctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
<member><citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
</simplelist></para>
</refsect1>
</refentry>
|
