]>
Commit | Line | Data |
---|---|---|
f3bc7fdc LP |
1 | <?xml version='1.0'?> <!--*-nxml-*--> |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | |
4 | ||
5 | <!-- | |
6 | This file is part of systemd. | |
7 | ||
8 | Copyright 2011 Lennart Poettering | |
9 | ||
10 | systemd is free software; you can redistribute it and/or modify it | |
5430f7f2 LP |
11 | under the terms of the GNU Lesser General Public License as published by |
12 | the Free Software Foundation; either version 2.1 of the License, or | |
f3bc7fdc LP |
13 | (at your option) any later version. |
14 | ||
15 | systemd is distributed in the hope that it will be useful, but | |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
5430f7f2 | 18 | Lesser General Public License for more details. |
f3bc7fdc | 19 | |
5430f7f2 | 20 | You should have received a copy of the GNU Lesser General Public License |
f3bc7fdc LP |
21 | along with systemd; If not, see <http://www.gnu.org/licenses/>. |
22 | --> | |
23 | ||
24 | <refentry id="systemd-ask-password"> | |
25 | ||
26 | <refentryinfo> | |
27 | <title>systemd-ask-password</title> | |
28 | <productname>systemd</productname> | |
29 | ||
30 | <authorgroup> | |
31 | <author> | |
32 | <contrib>Developer</contrib> | |
33 | <firstname>Lennart</firstname> | |
34 | <surname>Poettering</surname> | |
35 | <email>lennart@poettering.net</email> | |
36 | </author> | |
37 | </authorgroup> | |
38 | </refentryinfo> | |
39 | ||
40 | <refmeta> | |
41 | <refentrytitle>systemd-ask-password</refentrytitle> | |
42 | <manvolnum>1</manvolnum> | |
43 | </refmeta> | |
44 | ||
45 | <refnamediv> | |
46 | <refname>systemd-ask-password</refname> | |
47 | <refpurpose>Query the user for a system password</refpurpose> | |
48 | </refnamediv> | |
49 | ||
50 | <refsynopsisdiv> | |
51 | <cmdsynopsis> | |
52 | <command>systemd-ask-password <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">MESSAGE</arg></command> | |
53 | </cmdsynopsis> | |
54 | </refsynopsisdiv> | |
55 | ||
56 | <refsect1> | |
57 | <title>Description</title> | |
58 | ||
59 | <para><command>systemd-ask-password</command> may be | |
60 | used to query a system password or passphrase from the | |
61 | user, using a question message specified on the | |
62 | command line. When run from a TTY it will query a | |
63 | password on the TTY and print it to STDOUT. When run | |
64 | with no TTY or with <option>--no-tty</option> it will | |
65 | query the password system-wide and allow active users | |
66 | to respond via several agents. The latter is | |
67 | only available to privileged processes.</para> | |
68 | ||
69 | <para>The purpose of this tool is to query system-wide | |
70 | passwords -- that is passwords not attached to a | |
71 | specific user account. Examples include: unlocking | |
72 | encrypted hard disks when they are plugged in or at | |
73 | boot, entering an SSL certificate passphrase for web | |
74 | and VPN servers.</para> | |
75 | ||
76 | <para>Existing agents are: a boot-time password agent | |
77 | asking the user for passwords using Plymouth; a | |
78 | boot-time password agent querying the user directly on | |
79 | the console; an agent requesting password input via a | |
80 | <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
81 | message; an agent suitable for running in a GNOME | |
82 | session; a command line agent which can be started | |
83 | temporarily to process queued password requests; a TTY | |
84 | agent that is temporarily spawned during | |
85 | <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
86 | invocations.</para> | |
87 | ||
88 | <para>Additional password agents may be implemented | |
89 | according to the <ulink | |
90 | url="http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents">systemd | |
91 | Password Agent Specification</ulink>.</para> | |
92 | ||
bb31a4ac | 93 | <para>If a password is queried on a TTY the user may |
f3bc7fdc LP |
94 | press TAB to hide the asterisks normally shown for |
95 | each character typed. Pressing Backspace as first key | |
96 | achieves the same effect.</para> | |
97 | ||
98 | </refsect1> | |
99 | ||
100 | <refsect1> | |
101 | <title>Options</title> | |
102 | ||
103 | <para>The following options are understood:</para> | |
104 | ||
105 | <variablelist> | |
106 | <varlistentry> | |
a45ad38b | 107 | <term><option>-h</option></term> |
f3bc7fdc LP |
108 | <term><option>--help</option></term> |
109 | ||
110 | <listitem><para>Prints a short help | |
111 | text and exits.</para></listitem> | |
112 | </varlistentry> | |
113 | ||
114 | <varlistentry> | |
115 | <term><option>--icon=</option></term> | |
116 | ||
117 | <listitem><para>Specify an icon name | |
9f7dad77 | 118 | alongside the password query, which may |
f3bc7fdc LP |
119 | be used in all agents supporting |
120 | graphical display. The icon name | |
121 | should follow the <ulink | |
122 | url="http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html">XDG | |
123 | Icon Naming | |
124 | Specification</ulink>.</para></listitem> | |
125 | </varlistentry> | |
126 | ||
127 | <varlistentry> | |
128 | <term><option>--timeout=</option></term> | |
129 | ||
130 | <listitem><para>Specify the query | |
7f434cf4 | 131 | timeout in seconds. Defaults to |
c9335072 TG |
132 | 90s. A timeout of 0 waits indefinitely. |
133 | </para></listitem> | |
f3bc7fdc LP |
134 | </varlistentry> |
135 | ||
136 | <varlistentry> | |
137 | <term><option>--no-tty</option></term> | |
138 | ||
139 | <listitem><para>Never ask for password | |
140 | on current TTY even if one is | |
141 | available. Always use agent | |
142 | system.</para></listitem> | |
143 | </varlistentry> | |
144 | ||
145 | <varlistentry> | |
146 | <term><option>--accept-cached</option></term> | |
147 | ||
148 | <listitem><para>If passed accept | |
149 | cached passwords, i.e. passwords | |
150 | previously typed in.</para></listitem> | |
151 | </varlistentry> | |
152 | ||
153 | <varlistentry> | |
154 | <term><option>--multiple</option></term> | |
155 | ||
156 | <listitem><para>When used in | |
157 | conjunction with | |
158 | <option>--accept-cached</option> | |
159 | accept multiple passwords. This will | |
160 | output one password per | |
161 | line.</para></listitem> | |
162 | </varlistentry> | |
163 | </variablelist> | |
164 | ||
165 | </refsect1> | |
166 | ||
167 | <refsect1> | |
168 | <title>Exit status</title> | |
169 | ||
170 | <para>On success 0 is returned, a non-zero failure | |
171 | code otherwise.</para> | |
172 | </refsect1> | |
173 | ||
174 | <refsect1> | |
175 | <title>See Also</title> | |
176 | <para> | |
177 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
178 | <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
179 | <citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
180 | <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
181 | </para> | |
182 | </refsect1> | |
183 | ||
184 | </refentry> |