1SYSTEMD-ASK-PASSWORD(1)      systemd-ask-password      SYSTEMD-ASK-PASSWORD(1)
2
3
4

NAME

6       systemd-ask-password - Query the user for a system password
7

SYNOPSIS

9       systemd-ask-password [OPTIONS...] [MESSAGE]
10

DESCRIPTION

12       systemd-ask-password may be used to query a system password or
13       passphrase from the user, using a question message specified on the
14       command line. When run from a TTY it will query a password on the TTY
15       and print it to standard output. When run with no TTY or with --no-tty
16       it will query the password system-wide and allow active users to
17       respond via several agents. The latter is only available to privileged
18       processes.
19
20       The purpose of this tool is to query system-wide passwords -- that is
21       passwords not attached to a specific user account. Examples include:
22       unlocking encrypted hard disks when they are plugged in or at boot,
23       entering an SSL certificate passphrase for web and VPN servers.
24
25       Existing agents are: a boot-time password agent asking the user for
26       passwords using Plymouth; a boot-time password agent querying the user
27       directly on the console; an agent requesting password input via a
28       wall(1) message; an agent suitable for running in a GNOME session; a
29       command line agent which can be started temporarily to process queued
30       password requests; a TTY agent that is temporarily spawned during
31       systemctl(1) invocations.
32
33       Additional password agents may be implemented according to the systemd
34       Password Agent Specification[1].
35
36       If a password is queried on a TTY, the user may press TAB to hide the
37       asterisks normally shown for each character typed. Pressing Backspace
38       as first key achieves the same effect.
39

OPTIONS

41       The following options are understood:
42
43       --icon=
44           Specify an icon name alongside the password query, which may be
45           used in all agents supporting graphical display. The icon name
46           should follow the XDG Icon Naming Specification[2].
47
48       --timeout=
49           Specify the query timeout in seconds. Defaults to 90s. A timeout of
50           0 waits indefinitely.
51
52       --echo
53           Echo the user input instead of masking it. This is useful when
54           using systemd-ask-password to query for usernames.
55
56       --no-tty
57           Never ask for password on current TTY even if one is available.
58           Always use agent system.
59
60       --accept-cached
61           If passed, accept cached passwords, i.e. passwords previously typed
62           in.
63
64       --multiple
65           When used in conjunction with --accept-cached accept multiple
66           passwords. This will output one password per line.
67
68       -h, --help
69           Print a short help text and exit.
70

EXIT STATUS

72       On success, 0 is returned, a non-zero failure code otherwise.
73

SEE ALSO

75       systemd(1), systemctl(1), plymouth(8), wall(1)
76

NOTES

78        1. systemd Password Agent Specification
79           http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents
80
81        2. XDG Icon Naming Specification
82           http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html
83
84
85
86systemd 219                                            SYSTEMD-ASK-PASSWORD(1)
Impressum