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">
4
5
<!ENTITY COMMANDNAME "mandos">
5
<!ENTITY TIMESTAMP "2012-05-26">
6
<!ENTITY % common SYSTEM "common.ent">
10
8
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
<title>Mandos Manual</title>
10
<title>&COMMANDNAME;</title>
13
11
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
16
<date>&TIMESTAMP;</date>
12
<productname>&COMMANDNAME;</productname>
13
<productnumber>&VERSION;</productnumber>
19
16
<firstname>Björn</firstname>
20
17
<surname>Påhlsson</surname>
22
<email>belorn@recompile.se</email>
19
<email>belorn@fukt.bsnet.se</email>
26
23
<firstname>Teddy</firstname>
27
24
<surname>Hogeborn</surname>
29
<email>teddy@recompile.se</email>
26
<email>teddy@fukt.bsnet.se</email>
39
32
<holder>Teddy Hogeborn</holder>
40
33
<holder>Björn Påhlsson</holder>
42
<xi:include href="legalnotice.xml"/>
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/"/>.
46
61
<refentrytitle>&COMMANDNAME;</refentrytitle>
47
62
<manvolnum>8</manvolnum>
51
66
<refname><command>&COMMANDNAME;</command></refname>
53
Gives encrypted passwords to authenticated Mandos clients
68
Sends encrypted passwords to authenticated Mandos clients
59
74
<command>&COMMANDNAME;</command>
61
<arg choice="plain"><option>--interface
62
<replaceable>NAME</replaceable></option></arg>
63
<arg choice="plain"><option>-i
64
<replaceable>NAME</replaceable></option></arg>
68
<arg choice="plain"><option>--address
69
<replaceable>ADDRESS</replaceable></option></arg>
70
<arg choice="plain"><option>-a
71
<replaceable>ADDRESS</replaceable></option></arg>
75
<arg choice="plain"><option>--port
76
<replaceable>PORT</replaceable></option></arg>
77
<arg choice="plain"><option>-p
78
<replaceable>PORT</replaceable></option></arg>
81
<arg><option>--priority
82
<replaceable>PRIORITY</replaceable></option></arg>
84
<arg><option>--servicename
85
<replaceable>NAME</replaceable></option></arg>
87
<arg><option>--configdir
88
<replaceable>DIRECTORY</replaceable></option></arg>
90
<arg><option>--debug</option></arg>
92
<arg><option>--debuglevel
93
<replaceable>LEVEL</replaceable></option></arg>
95
<arg><option>--no-dbus</option></arg>
97
<arg><option>--no-ipv6</option></arg>
99
<arg><option>--no-restore</option></arg>
101
<arg><option>--statedir
102
<replaceable>DIRECTORY</replaceable></option></arg>
104
<arg><option>--socket
105
<replaceable>FD</replaceable></option></arg>
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>
108
94
<command>&COMMANDNAME;</command>
109
95
<group choice="req">
110
<arg choice="plain"><option>--help</option></arg>
111
<arg choice="plain"><option>-h</option></arg>
96
<arg choice="plain">-h</arg>
97
<arg choice="plain">--help</arg>
115
101
<command>&COMMANDNAME;</command>
116
<arg choice="plain"><option>--version</option></arg>
102
<arg choice="plain">--version</arg>
119
105
<command>&COMMANDNAME;</command>
120
<arg choice="plain"><option>--check</option></arg>
106
<arg choice="plain">--check</arg>
122
108
</refsynopsisdiv>
124
110
<refsect1 id="description">
125
111
<title>DESCRIPTION</title>
127
113
<command>&COMMANDNAME;</command> is a server daemon which
128
114
handles incoming request for passwords for a pre-defined list of
129
client host computers. For an introduction, see
130
<citerefentry><refentrytitle>intro</refentrytitle>
131
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
132
uses Zeroconf to announce itself on the local network, and uses
133
TLS to communicate securely with and to authenticate the
134
clients. The Mandos server uses IPv6 to allow Mandos clients to
135
use IPv6 link-local addresses, since the clients will probably
136
not have any other addresses configured (see <xref
137
linkend="overview"/>). Any authenticated client is then given
138
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.
142
127
<refsect1 id="purpose">
143
128
<title>PURPOSE</title>
145
131
The purpose of this is to enable <emphasis>remote and unattended
146
132
rebooting</emphasis> of client host computer with an
147
133
<emphasis>encrypted root file system</emphasis>. See <xref
148
134
linkend="overview"/> for details.
152
139
<refsect1 id="options">
153
140
<title>OPTIONS</title>
156
<term><option>--help</option></term>
157
<term><option>-h</option></term>
144
<term><literal>-h</literal>, <literal>--help</literal></term>
160
147
Show a help message and exit
166
<term><option>--interface</option>
167
<replaceable>NAME</replaceable></term>
168
<term><option>-i</option>
169
<replaceable>NAME</replaceable></term>
153
<term><literal>-i</literal>, <literal>--interface <replaceable>
154
IF</replaceable></literal></term>
171
156
<xi:include href="mandos-options.xml" xpointer="interface"/>
176
<term><option>--address
177
<replaceable>ADDRESS</replaceable></option></term>
179
<replaceable>ADDRESS</replaceable></option></term>
161
<term><literal>-a</literal>, <literal>--address <replaceable>
162
ADDRESS</replaceable></literal></term>
181
164
<xi:include href="mandos-options.xml" xpointer="address"/>
187
<replaceable>PORT</replaceable></option></term>
189
<replaceable>PORT</replaceable></option></term>
169
<term><literal>-p</literal>, <literal>--port <replaceable>
170
PORT</replaceable></literal></term>
191
172
<xi:include href="mandos-options.xml" xpointer="port"/>
196
<term><option>--check</option></term>
177
<term><literal>--check</literal></term>
199
180
Run the server’s self-tests. This includes any unit
206
<term><option>--debug</option></term>
187
<term><literal>--debug</literal></term>
208
189
<xi:include href="mandos-options.xml" xpointer="debug"/>
213
<term><option>--debuglevel
214
<replaceable>LEVEL</replaceable></option></term>
217
Set the debugging log level.
218
<replaceable>LEVEL</replaceable> is a string, one of
219
<quote><literal>CRITICAL</literal></quote>,
220
<quote><literal>ERROR</literal></quote>,
221
<quote><literal>WARNING</literal></quote>,
222
<quote><literal>INFO</literal></quote>, or
223
<quote><literal>DEBUG</literal></quote>, in order of
224
increasing verbosity. The default level is
225
<quote><literal>WARNING</literal></quote>.
231
<term><option>--priority <replaceable>
232
PRIORITY</replaceable></option></term>
194
<term><literal>--priority <replaceable>
195
PRIORITY</replaceable></literal></term>
234
197
<xi:include href="mandos-options.xml" xpointer="priority"/>
239
<term><option>--servicename
240
<replaceable>NAME</replaceable></option></term>
202
<term><literal>--servicename <replaceable>NAME</replaceable>
242
205
<xi:include href="mandos-options.xml"
243
206
xpointer="servicename"/>
248
<term><option>--configdir
249
<replaceable>DIRECTORY</replaceable></option></term>
211
<term><literal>--configdir <replaceable>DIR</replaceable>
252
215
Directory to search for configuration files. Default is
263
<term><option>--version</option></term>
226
<term><literal>--version</literal></term>
266
229
Prints the program version and exit.
272
<term><option>--no-dbus</option></term>
274
<xi:include href="mandos-options.xml" xpointer="dbus"/>
276
See also <xref linkend="dbus_interface"/>.
282
<term><option>--no-ipv6</option></term>
284
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
289
<term><option>--no-restore</option></term>
291
<xi:include href="mandos-options.xml" xpointer="restore"/>
293
See also <xref linkend="persistent_state"/>.
299
<term><option>--statedir
300
<replaceable>DIRECTORY</replaceable></option></term>
302
<xi:include href="mandos-options.xml" xpointer="statedir"/>
307
<term><option>--socket
308
<replaceable>FD</replaceable></option></term>
310
<xi:include href="mandos-options.xml" xpointer="socket"/>
317
236
<refsect1 id="overview">
318
237
<title>OVERVIEW</title>
319
238
<xi:include href="overview.xml"/>
321
240
This program is the server part. It is a normal server program
322
241
and will run in a normal system environment, not in an initial
323
<acronym>RAM</acronym> disk environment.
242
RAM disk environment.
327
246
<refsect1 id="protocol">
328
247
<title>NETWORK PROTOCOL</title>
382
301
</tbody></tgroup></table>
385
304
<refsect1 id="checking">
386
305
<title>CHECKING</title>
388
307
The server will, by default, continually check that the clients
389
308
are still up. If a client has not been confirmed as being up
390
309
for some time, the client is assumed to be compromised and is no
391
longer eligible to receive the encrypted password. (Manual
392
intervention is required to re-enable a client.) The timeout,
393
extended timeout, checker program, and interval between checks
394
can be configured both globally and per client; see
395
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
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>
313
<refentrytitle>mandos.conf</refentrytitle>
314
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
315
<refentrytitle>mandos-clients.conf</refentrytitle>
396
316
<manvolnum>5</manvolnum></citerefentry>.
400
<refsect1 id="approval">
401
<title>APPROVAL</title>
403
The server can be configured to require manual approval for a
404
client before it is sent its secret. The delay to wait for such
405
approval and the default action (approve or deny) can be
406
configured both globally and per client; see <citerefentry>
407
<refentrytitle>mandos-clients.conf</refentrytitle>
408
<manvolnum>5</manvolnum></citerefentry>. By default all clients
409
will be approved immediately without delay.
412
This can be used to deny a client its secret if not manually
413
approved within a specified time. It can also be used to make
414
the server delay before giving a client its secret, allowing
415
optional manual denying of this specific client.
420
320
<refsect1 id="logging">
421
321
<title>LOGGING</title>
423
The server will send log message with various severity levels to
424
<filename class="devicefile">/dev/log</filename>. With the
323
The server will send log messaged with various severity levels
324
to <filename>/dev/log</filename>. With the
425
325
<option>--debug</option> option, it will log even more messages,
426
326
and also show them on the console.
430
<refsect1 id="persistent_state">
431
<title>PERSISTENT STATE</title>
433
Client settings, initially read from
434
<filename>clients.conf</filename>, are persistent across
435
restarts, and run-time changes will override settings in
436
<filename>clients.conf</filename>. However, if a setting is
437
<emphasis>changed</emphasis> (or a client added, or removed) in
438
<filename>clients.conf</filename>, this will take precedence.
442
<refsect1 id="dbus_interface">
443
<title>D-BUS INTERFACE</title>
445
The server will by default provide a D-Bus system bus interface.
446
This interface will only be accessible by the root user or a
447
Mandos-specific user, if such a user exists. For documentation
448
of the D-Bus API, see the file <filename>DBUS-API</filename>.
452
330
<refsect1 id="exit_status">
453
331
<title>EXIT STATUS</title>
639
513
compromised if they are gone for too long.
516
If a client is compromised, its downtime should be duly noted
517
by the server which would therefore declare the client
518
invalid. But if the server was ever restarted, it would
519
re-read its client list from its configuration file and again
520
regard all clients therein as valid, and hence eligible to
521
receive their passwords. Therefore, be careful when
522
restarting servers if it is suspected that a client has, in
523
fact, been compromised by parties who may now be running a
524
fake Mandos client with the keys from the non-encrypted
525
initial RAM image of the client host. What should be done in
526
that case (if restarting the server program really is
527
necessary) is to stop the server program, edit the
528
configuration file to omit any suspect clients, and restart
642
532
For more details on client-side security, see
643
<citerefentry><refentrytitle>mandos-client</refentrytitle>
533
<citerefentry><refentrytitle>password-request</refentrytitle>
644
534
<manvolnum>8mandos</manvolnum></citerefentry>.
649
539
<refsect1 id="see_also">
650
540
<title>SEE ALSO</title>
652
<citerefentry><refentrytitle>intro</refentrytitle>
653
<manvolnum>8mandos</manvolnum></citerefentry>,
654
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
655
<manvolnum>5</manvolnum></citerefentry>,
656
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
657
<manvolnum>5</manvolnum></citerefentry>,
658
<citerefentry><refentrytitle>mandos-client</refentrytitle>
659
<manvolnum>8mandos</manvolnum></citerefentry>,
660
<citerefentry><refentrytitle>sh</refentrytitle>
661
<manvolnum>1</manvolnum></citerefentry>
545
<refentrytitle>password-request</refentrytitle>
546
<manvolnum>8mandos</manvolnum>
551
This is the actual program which talks to this server.
552
Note that it is normally not invoked directly, and is only
553
run in the initial RAM disk environment, and not on a
554
fully started system.
666
560
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
701
RFC 4291: <citetitle>IP Version 6 Addressing
702
Architecture</citetitle>
595
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
596
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
597
Unicast Addresses</citation>
707
<term>Section 2.2: <citetitle>Text Representation of
708
Addresses</citetitle></term>
709
<listitem><para/></listitem>
712
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
713
Address</citetitle></term>
714
<listitem><para/></listitem>
717
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
718
Addresses</citetitle></term>
721
The clients use IPv6 link-local addresses, which are
722
immediately usable since a link-local addresses is
723
automatically assigned to a network interfaces when it
601
The clients use IPv6 link-local addresses, which are
602
immediately usable since a link-local addresses is
603
automatically assigned to a network interfaces when it is
733
RFC 4346: <citetitle>The Transport Layer Security (TLS)
734
Protocol Version 1.1</citetitle>
610
<citation>RFC 4346: <citetitle>The Transport Layer Security
611
(TLS) Protocol Version 1.1</citetitle></citation>