50
66
<refname><command>&COMMANDNAME;</command></refname>
52
Gives encrypted passwords to authenticated Mandos clients
68
Sends encrypted passwords to authenticated Mandos clients
58
74
<command>&COMMANDNAME;</command>
60
<arg choice="plain"><option>--interface
61
<replaceable>NAME</replaceable></option></arg>
62
<arg choice="plain"><option>-i
63
<replaceable>NAME</replaceable></option></arg>
67
<arg choice="plain"><option>--address
68
<replaceable>ADDRESS</replaceable></option></arg>
69
<arg choice="plain"><option>-a
70
<replaceable>ADDRESS</replaceable></option></arg>
74
<arg choice="plain"><option>--port
75
<replaceable>PORT</replaceable></option></arg>
76
<arg choice="plain"><option>-p
77
<replaceable>PORT</replaceable></option></arg>
80
<arg><option>--priority
81
<replaceable>PRIORITY</replaceable></option></arg>
83
<arg><option>--servicename
84
<replaceable>NAME</replaceable></option></arg>
86
<arg><option>--configdir
87
<replaceable>DIRECTORY</replaceable></option></arg>
89
<arg><option>--debug</option></arg>
91
<arg><option>--debuglevel
92
<replaceable>LEVEL</replaceable></option></arg>
94
<arg><option>--no-dbus</option></arg>
96
<arg><option>--no-ipv6</option></arg>
75
<arg>--interface<arg choice="plain">NAME</arg></arg>
76
<arg>--address<arg choice="plain">ADDRESS</arg></arg>
77
<arg>--port<arg choice="plain">PORT</arg></arg>
78
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
79
<arg>--servicename<arg choice="plain">NAME</arg></arg>
80
<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
84
<command>&COMMANDNAME;</command>
85
<arg>-i<arg choice="plain">NAME</arg></arg>
86
<arg>-a<arg choice="plain">ADDRESS</arg></arg>
87
<arg>-p<arg choice="plain">PORT</arg></arg>
88
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
89
<arg>--servicename<arg choice="plain">NAME</arg></arg>
90
<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
99
94
<command>&COMMANDNAME;</command>
100
95
<group choice="req">
101
<arg choice="plain"><option>--help</option></arg>
102
<arg choice="plain"><option>-h</option></arg>
96
<arg choice="plain">-h</arg>
97
<arg choice="plain">--help</arg>
106
101
<command>&COMMANDNAME;</command>
107
<arg choice="plain"><option>--version</option></arg>
102
<arg choice="plain">--version</arg>
110
105
<command>&COMMANDNAME;</command>
111
<arg choice="plain"><option>--check</option></arg>
106
<arg choice="plain">--check</arg>
113
108
</refsynopsisdiv>
115
110
<refsect1 id="description">
116
111
<title>DESCRIPTION</title>
118
113
<command>&COMMANDNAME;</command> is a server daemon which
119
114
handles incoming request for passwords for a pre-defined list of
120
client host computers. For an introduction, see
121
<citerefentry><refentrytitle>intro</refentrytitle>
122
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
123
uses Zeroconf to announce itself on the local network, and uses
124
TLS to communicate securely with and to authenticate the
125
clients. The Mandos server uses IPv6 to allow Mandos clients to
126
use IPv6 link-local addresses, since the clients will probably
127
not have any other addresses configured (see <xref
128
linkend="overview"/>). Any authenticated client is then given
129
the stored pre-encrypted password for that specific client.
115
client host computers. The Mandos server uses Zeroconf to
116
announce itself on the local network, and uses TLS to
117
communicate securely with and to authenticate the clients. The
118
Mandos server uses IPv6 to allow Mandos clients to use IPv6
119
link-local addresses, since the clients will probably not have
120
any other addresses configured (see <xref linkend="overview"/>).
121
Any authenticated client is then given the stored pre-encrypted
122
password for that specific client.
133
127
<refsect1 id="purpose">
134
128
<title>PURPOSE</title>
136
131
The purpose of this is to enable <emphasis>remote and unattended
137
132
rebooting</emphasis> of client host computer with an
138
133
<emphasis>encrypted root file system</emphasis>. See <xref
139
134
linkend="overview"/> for details.
143
139
<refsect1 id="options">
144
140
<title>OPTIONS</title>
147
<term><option>--help</option></term>
148
<term><option>-h</option></term>
144
<term><literal>-h</literal>, <literal>--help</literal></term>
151
147
Show a help message and exit
157
<term><option>--interface</option>
158
<replaceable>NAME</replaceable></term>
159
<term><option>-i</option>
160
<replaceable>NAME</replaceable></term>
153
<term><literal>-i</literal>, <literal>--interface <replaceable
154
>NAME</replaceable></literal></term>
162
156
<xi:include href="mandos-options.xml" xpointer="interface"/>
167
<term><option>--address
168
<replaceable>ADDRESS</replaceable></option></term>
170
<replaceable>ADDRESS</replaceable></option></term>
161
<term><literal>-a</literal>, <literal>--address <replaceable>
162
ADDRESS</replaceable></literal></term>
172
164
<xi:include href="mandos-options.xml" xpointer="address"/>
178
<replaceable>PORT</replaceable></option></term>
180
<replaceable>PORT</replaceable></option></term>
169
<term><literal>-p</literal>, <literal>--port <replaceable>
170
PORT</replaceable></literal></term>
182
172
<xi:include href="mandos-options.xml" xpointer="port"/>
187
<term><option>--check</option></term>
177
<term><literal>--check</literal></term>
190
180
Run the server’s self-tests. This includes any unit
197
<term><option>--debug</option></term>
187
<term><literal>--debug</literal></term>
199
189
<xi:include href="mandos-options.xml" xpointer="debug"/>
204
<term><option>--debuglevel
205
<replaceable>LEVEL</replaceable></option></term>
208
Set the debugging log level.
209
<replaceable>LEVEL</replaceable> is a string, one of
210
<quote><literal>CRITICAL</literal></quote>,
211
<quote><literal>ERROR</literal></quote>,
212
<quote><literal>WARNING</literal></quote>,
213
<quote><literal>INFO</literal></quote>, or
214
<quote><literal>DEBUG</literal></quote>, in order of
215
increasing verbosity. The default level is
216
<quote><literal>WARNING</literal></quote>.
222
<term><option>--priority <replaceable>
223
PRIORITY</replaceable></option></term>
194
<term><literal>--priority <replaceable>
195
PRIORITY</replaceable></literal></term>
225
197
<xi:include href="mandos-options.xml" xpointer="priority"/>
230
<term><option>--servicename
231
<replaceable>NAME</replaceable></option></term>
202
<term><literal>--servicename <replaceable>NAME</replaceable>
233
205
<xi:include href="mandos-options.xml"
234
206
xpointer="servicename"/>
239
<term><option>--configdir
240
<replaceable>DIRECTORY</replaceable></option></term>
211
<term><literal>--configdir <replaceable>DIR</replaceable>
243
215
Directory to search for configuration files. Default is
346
301
</tbody></tgroup></table>
349
304
<refsect1 id="checking">
350
305
<title>CHECKING</title>
352
307
The server will, by default, continually check that the clients
353
308
are still up. If a client has not been confirmed as being up
354
309
for some time, the client is assumed to be compromised and is no
355
longer eligible to receive the encrypted password. (Manual
356
intervention is required to re-enable a client.) The timeout,
357
extended timeout, checker program, and interval between checks
358
can be configured both globally and per client; see
359
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
360
<manvolnum>5</manvolnum></citerefentry>. A client successfully
361
receiving its password will also be treated as a successful
366
<refsect1 id="approval">
367
<title>APPROVAL</title>
369
The server can be configured to require manual approval for a
370
client before it is sent its secret. The delay to wait for such
371
approval and the default action (approve or deny) can be
372
configured both globally and per client; see <citerefentry>
310
longer eligible to receive the encrypted password. The timeout,
311
checker program, and interval between checks can be configured
312
both globally and per client; see <citerefentry>
373
313
<refentrytitle>mandos-clients.conf</refentrytitle>
374
<manvolnum>5</manvolnum></citerefentry>. By default all clients
375
will be approved immediately without delay.
378
This can be used to deny a client its secret if not manually
379
approved within a specified time. It can also be used to make
380
the server delay before giving a client its secret, allowing
381
optional manual denying of this specific client.
314
<manvolnum>5</manvolnum></citerefentry>.
386
318
<refsect1 id="logging">
387
319
<title>LOGGING</title>
590
514
If a client is compromised, its downtime should be duly noted
591
by the server which would therefore disable the client. But
592
if the server was ever restarted, it would re-read its client
593
list from its configuration file and again regard all clients
594
therein as enabled, and hence eligible to receive their
595
passwords. Therefore, be careful when restarting servers if
596
it is suspected that a client has, in fact, been compromised
597
by parties who may now be running a fake Mandos client with
598
the keys from the non-encrypted initial <acronym>RAM</acronym>
599
image of the client host. What should be done in that case
600
(if restarting the server program really is necessary) is to
601
stop the server program, edit the configuration file to omit
602
any suspect clients, and restart the server program.
515
by the server which would therefore declare the client
516
invalid. But if the server was ever restarted, it would
517
re-read its client list from its configuration file and again
518
regard all clients therein as valid, and hence eligible to
519
receive their passwords. Therefore, be careful when
520
restarting servers if it is suspected that a client has, in
521
fact, been compromised by parties who may now be running a
522
fake Mandos client with the keys from the non-encrypted
523
initial RAM image of the client host. What should be done in
524
that case (if restarting the server program really is
525
necessary) is to stop the server program, edit the
526
configuration file to omit any suspect clients, and restart
605
530
For more details on client-side security, see
606
<citerefentry><refentrytitle>mandos-client</refentrytitle>
531
<citerefentry><refentrytitle>password-request</refentrytitle>
607
532
<manvolnum>8mandos</manvolnum></citerefentry>.
612
537
<refsect1 id="see_also">
613
538
<title>SEE ALSO</title>
615
<citerefentry><refentrytitle>intro</refentrytitle>
616
<manvolnum>8mandos</manvolnum></citerefentry>,
617
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
618
<manvolnum>5</manvolnum></citerefentry>,
619
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
620
<manvolnum>5</manvolnum></citerefentry>,
621
<citerefentry><refentrytitle>mandos-client</refentrytitle>
622
<manvolnum>8mandos</manvolnum></citerefentry>,
623
<citerefentry><refentrytitle>sh</refentrytitle>
624
<manvolnum>1</manvolnum></citerefentry>
541
<refentrytitle>mandos.conf</refentrytitle>
542
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
543
<refentrytitle>mandos-clients.conf</refentrytitle>
544
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
<refentrytitle>password-request</refentrytitle>
546
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
547
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
664
RFC 4291: <citetitle>IP Version 6 Addressing
665
Architecture</citetitle>
588
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
589
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
590
Unicast Addresses</citation>
670
<term>Section 2.2: <citetitle>Text Representation of
671
Addresses</citetitle></term>
672
<listitem><para/></listitem>
675
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
676
Address</citetitle></term>
677
<listitem><para/></listitem>
680
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
681
Addresses</citetitle></term>
684
The clients use IPv6 link-local addresses, which are
685
immediately usable since a link-local addresses is
686
automatically assigned to a network interfaces when it
594
The clients use IPv6 link-local addresses, which are
595
immediately usable since a link-local addresses is
596
automatically assigned to a network interfaces when it is
696
RFC 4346: <citetitle>The Transport Layer Security (TLS)
697
Protocol Version 1.1</citetitle>
603
<citation>RFC 4346: <citetitle>The Transport Layer Security
604
(TLS) Protocol Version 1.1</citetitle></citation>