1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos">
5
<!ENTITY TIMESTAMP "2013-10-26">
6
<!ENTITY % common SYSTEM "common.ent">
8
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
<title>&COMMANDNAME;</title>
12
<title>Mandos Manual</title>
11
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
12
<productname>&COMMANDNAME;</productname>
13
<productnumber>&VERSION;</productnumber>
14
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
16
<date>&TIMESTAMP;</date>
16
19
<firstname>Björn</firstname>
17
20
<surname>Påhlsson</surname>
19
<email>belorn@fukt.bsnet.se</email>
22
<email>belorn@recompile.se</email>
23
26
<firstname>Teddy</firstname>
24
27
<surname>Hogeborn</surname>
26
<email>teddy@fukt.bsnet.se</email>
29
<email>teddy@recompile.se</email>
32
40
<holder>Teddy Hogeborn</holder>
33
41
<holder>Björn Påhlsson</holder>
37
This manual page is free software: you can redistribute it
38
and/or modify it under the terms of the GNU General Public
39
License as published by the Free Software Foundation,
40
either version 3 of the License, or (at your option) any
45
This manual page is distributed in the hope that it will
46
be useful, but WITHOUT ANY WARRANTY; without even the
47
implied warranty of MERCHANTABILITY or FITNESS FOR A
48
PARTICULAR PURPOSE. See the GNU General Public License
53
You should have received a copy of the GNU General Public
54
License along with this program; If not, see
55
<ulink url="http://www.gnu.org/licenses/"/>.
43
<xi:include href="legalnotice.xml"/>
61
47
<refentrytitle>&COMMANDNAME;</refentrytitle>
62
48
<manvolnum>8</manvolnum>
66
52
<refname><command>&COMMANDNAME;</command></refname>
68
Sends encrypted passwords to authenticated Mandos clients
54
Gives encrypted passwords to authenticated Mandos clients
74
60
<command>&COMMANDNAME;</command>
75
<arg>--interface<arg choice="plain">IF</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">IF</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>
62
<arg choice="plain"><option>--interface
63
<replaceable>NAME</replaceable></option></arg>
64
<arg choice="plain"><option>-i
65
<replaceable>NAME</replaceable></option></arg>
69
<arg choice="plain"><option>--address
70
<replaceable>ADDRESS</replaceable></option></arg>
71
<arg choice="plain"><option>-a
72
<replaceable>ADDRESS</replaceable></option></arg>
76
<arg choice="plain"><option>--port
77
<replaceable>PORT</replaceable></option></arg>
78
<arg choice="plain"><option>-p
79
<replaceable>PORT</replaceable></option></arg>
82
<arg><option>--priority
83
<replaceable>PRIORITY</replaceable></option></arg>
85
<arg><option>--servicename
86
<replaceable>NAME</replaceable></option></arg>
88
<arg><option>--configdir
89
<replaceable>DIRECTORY</replaceable></option></arg>
91
<arg><option>--debug</option></arg>
93
<arg><option>--debuglevel
94
<replaceable>LEVEL</replaceable></option></arg>
96
<arg><option>--no-dbus</option></arg>
98
<arg><option>--no-ipv6</option></arg>
100
<arg><option>--no-restore</option></arg>
102
<arg><option>--statedir
103
<replaceable>DIRECTORY</replaceable></option></arg>
105
<arg><option>--socket
106
<replaceable>FD</replaceable></option></arg>
108
<arg><option>--foreground</option></arg>
94
111
<command>&COMMANDNAME;</command>
95
112
<group choice="req">
96
<arg choice="plain">-h</arg>
97
<arg choice="plain">--help</arg>
113
<arg choice="plain"><option>--help</option></arg>
114
<arg choice="plain"><option>-h</option></arg>
101
118
<command>&COMMANDNAME;</command>
102
<arg choice="plain">--version</arg>
119
<arg choice="plain"><option>--version</option></arg>
105
122
<command>&COMMANDNAME;</command>
106
<arg choice="plain">--check</arg>
123
<arg choice="plain"><option>--check</option></arg>
108
125
</refsynopsisdiv>
110
127
<refsect1 id="description">
111
128
<title>DESCRIPTION</title>
113
130
<command>&COMMANDNAME;</command> is a server daemon which
114
131
handles incoming request for passwords for a pre-defined list of
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.
132
client host computers. For an introduction, see
133
<citerefentry><refentrytitle>intro</refentrytitle>
134
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
135
uses Zeroconf to announce itself on the local network, and uses
136
TLS to communicate securely with and to authenticate the
137
clients. The Mandos server uses IPv6 to allow Mandos clients to
138
use IPv6 link-local addresses, since the clients will probably
139
not have any other addresses configured (see <xref
140
linkend="overview"/>). Any authenticated client is then given
141
the stored pre-encrypted password for that specific client.
127
145
<refsect1 id="purpose">
128
146
<title>PURPOSE</title>
131
148
The purpose of this is to enable <emphasis>remote and unattended
132
149
rebooting</emphasis> of client host computer with an
133
150
<emphasis>encrypted root file system</emphasis>. See <xref
134
151
linkend="overview"/> for details.
139
155
<refsect1 id="options">
140
156
<title>OPTIONS</title>
144
<term><literal>-h</literal>, <literal>--help</literal></term>
159
<term><option>--help</option></term>
160
<term><option>-h</option></term>
147
163
Show a help message and exit
153
<term><literal>-i</literal>, <literal>--interface <replaceable>
154
IF</replaceable></literal></term>
169
<term><option>--interface</option>
170
<replaceable>NAME</replaceable></term>
171
<term><option>-i</option>
172
<replaceable>NAME</replaceable></term>
156
174
<xi:include href="mandos-options.xml" xpointer="interface"/>
161
<term><literal>-a</literal>, <literal>--address <replaceable>
162
ADDRESS</replaceable></literal></term>
179
<term><option>--address
180
<replaceable>ADDRESS</replaceable></option></term>
182
<replaceable>ADDRESS</replaceable></option></term>
164
184
<xi:include href="mandos-options.xml" xpointer="address"/>
169
<term><literal>-p</literal>, <literal>--port <replaceable>
170
PORT</replaceable></literal></term>
190
<replaceable>PORT</replaceable></option></term>
192
<replaceable>PORT</replaceable></option></term>
172
194
<xi:include href="mandos-options.xml" xpointer="port"/>
177
<term><literal>--check</literal></term>
199
<term><option>--check</option></term>
180
202
Run the server’s self-tests. This includes any unit
187
<term><literal>--debug</literal></term>
209
<term><option>--debug</option></term>
189
211
<xi:include href="mandos-options.xml" xpointer="debug"/>
194
<term><literal>--priority <replaceable>
195
PRIORITY</replaceable></literal></term>
197
<xi:include href="mandos-options.xml" xpointer="priority"/>
202
<term><literal>--servicename <replaceable>NAME</replaceable>
216
<term><option>--debuglevel
217
<replaceable>LEVEL</replaceable></option></term>
220
Set the debugging log level.
221
<replaceable>LEVEL</replaceable> is a string, one of
222
<quote><literal>CRITICAL</literal></quote>,
223
<quote><literal>ERROR</literal></quote>,
224
<quote><literal>WARNING</literal></quote>,
225
<quote><literal>INFO</literal></quote>, or
226
<quote><literal>DEBUG</literal></quote>, in order of
227
increasing verbosity. The default level is
228
<quote><literal>WARNING</literal></quote>.
234
<term><option>--priority <replaceable>
235
PRIORITY</replaceable></option></term>
237
<xi:include href="mandos-options.xml"
238
xpointer="priority_compat"/>
243
<term><option>--servicename
244
<replaceable>NAME</replaceable></option></term>
205
246
<xi:include href="mandos-options.xml"
206
247
xpointer="servicename"/>
211
<term><literal>--configdir <replaceable>DIR</replaceable>
252
<term><option>--configdir
253
<replaceable>DIRECTORY</replaceable></option></term>
215
256
Directory to search for configuration files. Default is
226
<term><literal>--version</literal></term>
267
<term><option>--version</option></term>
229
270
Prints the program version and exit.
276
<term><option>--no-dbus</option></term>
278
<xi:include href="mandos-options.xml" xpointer="dbus"/>
280
See also <xref linkend="dbus_interface"/>.
286
<term><option>--no-ipv6</option></term>
288
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
293
<term><option>--no-restore</option></term>
295
<xi:include href="mandos-options.xml" xpointer="restore"/>
297
See also <xref linkend="persistent_state"/>.
303
<term><option>--statedir
304
<replaceable>DIRECTORY</replaceable></option></term>
306
<xi:include href="mandos-options.xml" xpointer="statedir"/>
311
<term><option>--socket
312
<replaceable>FD</replaceable></option></term>
314
<xi:include href="mandos-options.xml" xpointer="socket"/>
319
<term><option>--foreground</option></term>
321
<xi:include href="mandos-options.xml"
322
xpointer="foreground"/>
236
329
<refsect1 id="overview">
237
330
<title>OVERVIEW</title>
238
331
<xi:include href="overview.xml"/>
240
333
This program is the server part. It is a normal server program
241
334
and will run in a normal system environment, not in an initial
242
RAM disk environment.
335
<acronym>RAM</acronym> disk environment.
246
339
<refsect1 id="protocol">
247
340
<title>NETWORK PROTOCOL</title>
301
394
</tbody></tgroup></table>
304
397
<refsect1 id="checking">
305
398
<title>CHECKING</title>
307
400
The server will, by default, continually check that the clients
308
401
are still up. If a client has not been confirmed as being up
309
402
for some time, the client is assumed to be compromised and is no
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>
403
longer eligible to receive the encrypted password. (Manual
404
intervention is required to re-enable a client.) The timeout,
405
extended timeout, checker program, and interval between checks
406
can be configured both globally and per client; see
407
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
408
<manvolnum>5</manvolnum></citerefentry>.
412
<refsect1 id="approval">
413
<title>APPROVAL</title>
415
The server can be configured to require manual approval for a
416
client before it is sent its secret. The delay to wait for such
417
approval and the default action (approve or deny) can be
418
configured both globally and per client; see <citerefentry>
313
419
<refentrytitle>mandos-clients.conf</refentrytitle>
314
<manvolnum>5</manvolnum></citerefentry>.
420
<manvolnum>5</manvolnum></citerefentry>. By default all clients
421
will be approved immediately without delay.
424
This can be used to deny a client its secret if not manually
425
approved within a specified time. It can also be used to make
426
the server delay before giving a client its secret, allowing
427
optional manual denying of this specific client.
318
432
<refsect1 id="logging">
319
433
<title>LOGGING</title>
321
435
The server will send log message with various severity levels to
322
<filename>/dev/log</filename>. With the
436
<filename class="devicefile">/dev/log</filename>. With the
323
437
<option>--debug</option> option, it will log even more messages,
324
438
and also show them on the console.
442
<refsect1 id="persistent_state">
443
<title>PERSISTENT STATE</title>
445
Client settings, initially read from
446
<filename>clients.conf</filename>, are persistent across
447
restarts, and run-time changes will override settings in
448
<filename>clients.conf</filename>. However, if a setting is
449
<emphasis>changed</emphasis> (or a client added, or removed) in
450
<filename>clients.conf</filename>, this will take precedence.
454
<refsect1 id="dbus_interface">
455
<title>D-BUS INTERFACE</title>
457
The server will by default provide a D-Bus system bus interface.
458
This interface will only be accessible by the root user or a
459
Mandos-specific user, if such a user exists. For documentation
460
of the D-Bus API, see the file <filename>DBUS-API</filename>.
328
464
<refsect1 id="exit_status">
329
465
<title>EXIT STATUS</title>
511
652
compromised if they are gone for too long.
514
If a client is compromised, its downtime should be duly noted
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
530
655
For more details on client-side security, see
531
<citerefentry><refentrytitle>password-request</refentrytitle>
656
<citerefentry><refentrytitle>mandos-client</refentrytitle>
532
657
<manvolnum>8mandos</manvolnum></citerefentry>.
537
662
<refsect1 id="see_also">
538
663
<title>SEE ALSO</title>
665
<citerefentry><refentrytitle>intro</refentrytitle>
666
<manvolnum>8mandos</manvolnum></citerefentry>,
667
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
668
<manvolnum>5</manvolnum></citerefentry>,
669
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
670
<manvolnum>5</manvolnum></citerefentry>,
671
<citerefentry><refentrytitle>mandos-client</refentrytitle>
672
<manvolnum>8mandos</manvolnum></citerefentry>,
673
<citerefentry><refentrytitle>sh</refentrytitle>
674
<manvolnum>1</manvolnum></citerefentry>
543
<refentrytitle>password-request</refentrytitle>
544
<manvolnum>8mandos</manvolnum>
549
This is the actual program which talks to this server.
550
Note that it is normally not invoked directly, and is only
551
run in the initial RAM disk environment, and not on a
552
fully started system.
558
679
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
593
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
594
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
595
Unicast Addresses</citation>
714
RFC 4291: <citetitle>IP Version 6 Addressing
715
Architecture</citetitle>
599
The clients use IPv6 link-local addresses, which are
600
immediately usable since a link-local addresses is
601
automatically assigned to a network interfaces when it is
720
<term>Section 2.2: <citetitle>Text Representation of
721
Addresses</citetitle></term>
722
<listitem><para/></listitem>
725
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
726
Address</citetitle></term>
727
<listitem><para/></listitem>
730
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
731
Addresses</citetitle></term>
734
The clients use IPv6 link-local addresses, which are
735
immediately usable since a link-local addresses is
736
automatically assigned to a network interfaces when it
608
<citation>RFC 4346: <citetitle>The Transport Layer Security
609
(TLS) Protocol Version 1.1</citetitle></citation>
746
RFC 4346: <citetitle>The Transport Layer Security (TLS)
747
Protocol Version 1.1</citetitle>