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 "2013-10-23">
6
<!ENTITY % common SYSTEM "common.ent">
6
<!ENTITY TIMESTAMP "2008-08-29">
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
<title>Mandos Manual</title>
13
12
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
14
<productnumber>&VERSION;</productnumber>
16
15
<date>&TIMESTAMP;</date>
19
18
<firstname>Björn</firstname>
20
19
<surname>Påhlsson</surname>
22
<email>belorn@recompile.se</email>
21
<email>belorn@fukt.bsnet.se</email>
26
25
<firstname>Teddy</firstname>
27
26
<surname>Hogeborn</surname>
29
<email>teddy@recompile.se</email>
28
<email>teddy@fukt.bsnet.se</email>
40
34
<holder>Teddy Hogeborn</holder>
41
35
<holder>Björn Påhlsson</holder>
43
<xi:include href="legalnotice.xml"/>
39
This manual page is free software: you can redistribute it
40
and/or modify it under the terms of the GNU General Public
41
License as published by the Free Software Foundation,
42
either version 3 of the License, or (at your option) any
47
This manual page is distributed in the hope that it will
48
be useful, but WITHOUT ANY WARRANTY; without even the
49
implied warranty of MERCHANTABILITY or FITNESS FOR A
50
PARTICULAR PURPOSE. See the GNU General Public License
55
You should have received a copy of the GNU General Public
56
License along with this program; If not, see
57
<ulink url="http://www.gnu.org/licenses/"/>.
47
63
<refentrytitle>&COMMANDNAME;</refentrytitle>
48
64
<manvolnum>8</manvolnum>
52
68
<refname><command>&COMMANDNAME;</command></refname>
54
Gives encrypted passwords to authenticated Mandos clients
70
Sends encrypted passwords to authenticated Mandos clients
60
76
<command>&COMMANDNAME;</command>
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>
77
<arg>--interface<arg choice="plain">NAME</arg></arg>
78
<arg>--address<arg choice="plain">ADDRESS</arg></arg>
79
<arg>--port<arg choice="plain">PORT</arg></arg>
80
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
81
<arg>--servicename<arg choice="plain">NAME</arg></arg>
82
<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
86
<command>&COMMANDNAME;</command>
87
<arg>-i<arg choice="plain">NAME</arg></arg>
88
<arg>-a<arg choice="plain">ADDRESS</arg></arg>
89
<arg>-p<arg choice="plain">PORT</arg></arg>
90
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
91
<arg>--servicename<arg choice="plain">NAME</arg></arg>
92
<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
111
96
<command>&COMMANDNAME;</command>
112
97
<group choice="req">
113
<arg choice="plain"><option>--help</option></arg>
114
<arg choice="plain"><option>-h</option></arg>
98
<arg choice="plain">-h</arg>
99
<arg choice="plain">--help</arg>
118
103
<command>&COMMANDNAME;</command>
119
<arg choice="plain"><option>--version</option></arg>
104
<arg choice="plain">--version</arg>
122
107
<command>&COMMANDNAME;</command>
123
<arg choice="plain"><option>--check</option></arg>
108
<arg choice="plain">--check</arg>
125
110
</refsynopsisdiv>
127
112
<refsect1 id="description">
128
113
<title>DESCRIPTION</title>
130
115
<command>&COMMANDNAME;</command> is a server daemon which
131
116
handles incoming request for passwords for a pre-defined list of
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.
117
client host computers. The Mandos server uses Zeroconf to
118
announce itself on the local network, and uses TLS to
119
communicate securely with and to authenticate the clients. The
120
Mandos server uses IPv6 to allow Mandos clients to use IPv6
121
link-local addresses, since the clients will probably not have
122
any other addresses configured (see <xref linkend="overview"/>).
123
Any authenticated client is then given the stored pre-encrypted
124
password for that specific client.
145
129
<refsect1 id="purpose">
146
130
<title>PURPOSE</title>
148
133
The purpose of this is to enable <emphasis>remote and unattended
149
134
rebooting</emphasis> of client host computer with an
150
135
<emphasis>encrypted root file system</emphasis>. See <xref
151
136
linkend="overview"/> for details.
155
141
<refsect1 id="options">
156
142
<title>OPTIONS</title>
159
<term><option>--help</option></term>
160
<term><option>-h</option></term>
146
<term><literal>-h</literal>, <literal>--help</literal></term>
163
149
Show a help message and exit
169
<term><option>--interface</option>
170
<replaceable>NAME</replaceable></term>
171
<term><option>-i</option>
172
<replaceable>NAME</replaceable></term>
155
<term><literal>-i</literal>, <literal>--interface <replaceable
156
>NAME</replaceable></literal></term>
174
158
<xi:include href="mandos-options.xml" xpointer="interface"/>
179
<term><option>--address
180
<replaceable>ADDRESS</replaceable></option></term>
182
<replaceable>ADDRESS</replaceable></option></term>
163
<term><literal>-a</literal>, <literal>--address <replaceable>
164
ADDRESS</replaceable></literal></term>
184
166
<xi:include href="mandos-options.xml" xpointer="address"/>
190
<replaceable>PORT</replaceable></option></term>
192
<replaceable>PORT</replaceable></option></term>
171
<term><literal>-p</literal>, <literal>--port <replaceable>
172
PORT</replaceable></literal></term>
194
174
<xi:include href="mandos-options.xml" xpointer="port"/>
199
<term><option>--check</option></term>
179
<term><literal>--check</literal></term>
202
182
Run the server’s self-tests. This includes any unit
209
<term><option>--debug</option></term>
189
<term><literal>--debug</literal></term>
211
191
<xi:include href="mandos-options.xml" xpointer="debug"/>
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>
196
<term><literal>--priority <replaceable>
197
PRIORITY</replaceable></literal></term>
199
<xi:include href="mandos-options.xml" xpointer="priority"/>
204
<term><literal>--servicename <replaceable>NAME</replaceable>
246
207
<xi:include href="mandos-options.xml"
247
208
xpointer="servicename"/>
252
<term><option>--configdir
253
<replaceable>DIRECTORY</replaceable></option></term>
213
<term><literal>--configdir <replaceable>DIR</replaceable>
256
217
Directory to search for configuration files. Default is
267
<term><option>--version</option></term>
228
<term><literal>--version</literal></term>
270
231
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"/>
329
238
<refsect1 id="overview">
330
239
<title>OVERVIEW</title>
331
240
<xi:include href="overview.xml"/>
333
242
This program is the server part. It is a normal server program
334
243
and will run in a normal system environment, not in an initial
335
<acronym>RAM</acronym> disk environment.
244
RAM disk environment.
339
248
<refsect1 id="protocol">
340
249
<title>NETWORK PROTOCOL</title>
394
303
</tbody></tgroup></table>
397
306
<refsect1 id="checking">
398
307
<title>CHECKING</title>
400
309
The server will, by default, continually check that the clients
401
310
are still up. If a client has not been confirmed as being up
402
311
for some time, the client is assumed to be compromised and is no
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>
312
longer eligible to receive the encrypted password. The timeout,
313
checker program, and interval between checks can be configured
314
both globally and per client; see <citerefentry>
315
<refentrytitle>mandos-clients.conf</refentrytitle>
408
316
<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>
419
<refentrytitle>mandos-clients.conf</refentrytitle>
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.
432
320
<refsect1 id="logging">
433
321
<title>LOGGING</title>
435
323
The server will send log message with various severity levels to
436
<filename class="devicefile">/dev/log</filename>. With the
324
<filename>/dev/log</filename>. With the
437
325
<option>--debug</option> option, it will log even more messages,
438
326
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>.
464
330
<refsect1 id="exit_status">
465
331
<title>EXIT STATUS</title>
648
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
651
532
For more details on client-side security, see
652
<citerefentry><refentrytitle>mandos-client</refentrytitle>
533
<citerefentry><refentrytitle>password-request</refentrytitle>
653
534
<manvolnum>8mandos</manvolnum></citerefentry>.
658
539
<refsect1 id="see_also">
659
540
<title>SEE ALSO</title>
661
<citerefentry><refentrytitle>intro</refentrytitle>
662
<manvolnum>8mandos</manvolnum></citerefentry>,
663
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
664
<manvolnum>5</manvolnum></citerefentry>,
665
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
666
<manvolnum>5</manvolnum></citerefentry>,
667
<citerefentry><refentrytitle>mandos-client</refentrytitle>
668
<manvolnum>8mandos</manvolnum></citerefentry>,
669
<citerefentry><refentrytitle>sh</refentrytitle>
670
<manvolnum>1</manvolnum></citerefentry>
543
<refentrytitle>mandos.conf</refentrytitle>
544
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
<refentrytitle>mandos-clients.conf</refentrytitle>
546
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
547
<refentrytitle>password-request</refentrytitle>
548
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
549
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>