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">
6
<!ENTITY TIMESTAMP "2008-08-30">
5
<!ENTITY TIMESTAMP "2018-02-08">
6
<!ENTITY % common SYSTEM "common.ent">
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
<title>Mandos Manual</title>
12
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
<productname>Mandos</productname>
14
<productnumber>&VERSION;</productnumber>
15
<productnumber>&version;</productnumber>
15
16
<date>&TIMESTAMP;</date>
18
19
<firstname>Björn</firstname>
19
20
<surname>Påhlsson</surname>
21
<email>belorn@fukt.bsnet.se</email>
22
<email>belorn@recompile.se</email>
25
26
<firstname>Teddy</firstname>
26
27
<surname>Hogeborn</surname>
28
<email>teddy@fukt.bsnet.se</email>
29
<email>teddy@recompile.se</email>
34
45
<holder>Teddy Hogeborn</holder>
35
46
<holder>Björn Påhlsson</holder>
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/"/>.
48
<xi:include href="legalnotice.xml"/>
63
52
<refentrytitle>&COMMANDNAME;</refentrytitle>
64
53
<manvolnum>8</manvolnum>
105
94
<replaceable>DIRECTORY</replaceable></option></arg>
107
96
<arg><option>--debug</option></arg>
98
<arg><option>--debuglevel
99
<replaceable>LEVEL</replaceable></option></arg>
101
<arg><option>--no-dbus</option></arg>
103
<arg><option>--no-ipv6</option></arg>
105
<arg><option>--no-restore</option></arg>
107
<arg><option>--statedir
108
<replaceable>DIRECTORY</replaceable></option></arg>
110
<arg><option>--socket
111
<replaceable>FD</replaceable></option></arg>
113
<arg><option>--foreground</option></arg>
115
<arg><option>--no-zeroconf</option></arg>
110
118
<command>&COMMANDNAME;</command>
111
119
<group choice="req">
120
<arg choice="plain"><option>--help</option></arg>
112
121
<arg choice="plain"><option>-h</option></arg>
113
<arg choice="plain"><option>--help</option></arg>
122
130
<arg choice="plain"><option>--check</option></arg>
124
132
</refsynopsisdiv>
126
134
<refsect1 id="description">
127
135
<title>DESCRIPTION</title>
129
137
<command>&COMMANDNAME;</command> is a server daemon which
130
138
handles incoming request for passwords for a pre-defined list of
131
client host computers. The Mandos server uses Zeroconf to
132
announce itself on the local network, and uses TLS to
133
communicate securely with and to authenticate the clients. The
134
Mandos server uses IPv6 to allow Mandos clients to use IPv6
135
link-local addresses, since the clients will probably not have
136
any other addresses configured (see <xref linkend="overview"/>).
137
Any authenticated client is then given the stored pre-encrypted
138
password for that specific client.
139
client host computers. For an introduction, see
140
<citerefentry><refentrytitle>intro</refentrytitle>
141
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
142
uses Zeroconf to announce itself on the local network, and uses
143
TLS to communicate securely with and to authenticate the
144
clients. The Mandos server uses IPv6 to allow Mandos clients to
145
use IPv6 link-local addresses, since the clients will probably
146
not have any other addresses configured (see <xref
147
linkend="overview"/>). Any authenticated client is then given
148
the stored pre-encrypted password for that specific client.
143
152
<refsect1 id="purpose">
144
153
<title>PURPOSE</title>
147
155
The purpose of this is to enable <emphasis>remote and unattended
148
156
rebooting</emphasis> of client host computer with an
149
157
<emphasis>encrypted root file system</emphasis>. See <xref
150
158
linkend="overview"/> for details.
155
162
<refsect1 id="options">
156
163
<title>OPTIONS</title>
166
<term><option>--help</option></term>
160
167
<term><option>-h</option></term>
161
<term><option>--help</option></term>
164
170
Show a help message and exit
176
<term><option>--interface</option>
177
<replaceable>NAME</replaceable></term>
170
178
<term><option>-i</option>
171
179
<replaceable>NAME</replaceable></term>
172
<term><option>--interface</option>
173
<replaceable>NAME</replaceable></term>
175
181
<xi:include href="mandos-options.xml" xpointer="interface"/>
180
<term><literal>-a</literal>, <literal>--address <replaceable>
181
ADDRESS</replaceable></literal></term>
186
<term><option>--address
187
<replaceable>ADDRESS</replaceable></option></term>
189
<replaceable>ADDRESS</replaceable></option></term>
183
191
<xi:include href="mandos-options.xml" xpointer="address"/>
188
<term><literal>-p</literal>, <literal>--port <replaceable>
189
PORT</replaceable></literal></term>
197
<replaceable>PORT</replaceable></option></term>
199
<replaceable>PORT</replaceable></option></term>
191
201
<xi:include href="mandos-options.xml" xpointer="port"/>
196
<term><literal>--check</literal></term>
206
<term><option>--check</option></term>
199
209
Run the server’s self-tests. This includes any unit
206
<term><literal>--debug</literal></term>
216
<term><option>--debug</option></term>
208
218
<xi:include href="mandos-options.xml" xpointer="debug"/>
213
<term><literal>--priority <replaceable>
214
PRIORITY</replaceable></literal></term>
223
<term><option>--debuglevel
224
<replaceable>LEVEL</replaceable></option></term>
227
Set the debugging log level.
228
<replaceable>LEVEL</replaceable> is a string, one of
229
<quote><literal>CRITICAL</literal></quote>,
230
<quote><literal>ERROR</literal></quote>,
231
<quote><literal>WARNING</literal></quote>,
232
<quote><literal>INFO</literal></quote>, or
233
<quote><literal>DEBUG</literal></quote>, in order of
234
increasing verbosity. The default level is
235
<quote><literal>WARNING</literal></quote>.
241
<term><option>--priority <replaceable>
242
PRIORITY</replaceable></option></term>
216
244
<xi:include href="mandos-options.xml" xpointer="priority"/>
221
<term><literal>--servicename <replaceable>NAME</replaceable>
249
<term><option>--servicename
250
<replaceable>NAME</replaceable></option></term>
224
252
<xi:include href="mandos-options.xml"
225
253
xpointer="servicename"/>
230
<term><literal>--configdir <replaceable>DIR</replaceable>
258
<term><option>--configdir
259
<replaceable>DIRECTORY</replaceable></option></term>
234
262
Directory to search for configuration files. Default is
245
<term><literal>--version</literal></term>
273
<term><option>--version</option></term>
248
276
Prints the program version and exit.
282
<term><option>--no-dbus</option></term>
284
<xi:include href="mandos-options.xml" xpointer="dbus"/>
286
See also <xref linkend="dbus_interface"/>.
292
<term><option>--no-ipv6</option></term>
294
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
299
<term><option>--no-restore</option></term>
301
<xi:include href="mandos-options.xml" xpointer="restore"/>
303
See also <xref linkend="persistent_state"/>.
309
<term><option>--statedir
310
<replaceable>DIRECTORY</replaceable></option></term>
312
<xi:include href="mandos-options.xml" xpointer="statedir"/>
317
<term><option>--socket
318
<replaceable>FD</replaceable></option></term>
320
<xi:include href="mandos-options.xml" xpointer="socket"/>
325
<term><option>--foreground</option></term>
327
<xi:include href="mandos-options.xml"
328
xpointer="foreground"/>
333
<term><option>--no-zeroconf</option></term>
335
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
255
342
<refsect1 id="overview">
256
343
<title>OVERVIEW</title>
257
344
<xi:include href="overview.xml"/>
259
346
This program is the server part. It is a normal server program
260
347
and will run in a normal system environment, not in an initial
261
RAM disk environment.
348
<acronym>RAM</acronym> disk environment.
265
352
<refsect1 id="protocol">
266
353
<title>NETWORK PROTOCOL</title>
320
407
</tbody></tgroup></table>
323
410
<refsect1 id="checking">
324
411
<title>CHECKING</title>
326
413
The server will, by default, continually check that the clients
327
414
are still up. If a client has not been confirmed as being up
328
415
for some time, the client is assumed to be compromised and is no
329
longer eligible to receive the encrypted password. The timeout,
330
checker program, and interval between checks can be configured
331
both globally and per client; see <citerefentry>
416
longer eligible to receive the encrypted password. (Manual
417
intervention is required to re-enable a client.) The timeout,
418
extended timeout, checker program, and interval between checks
419
can be configured both globally and per client; see
420
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
421
<manvolnum>5</manvolnum></citerefentry>.
425
<refsect1 id="approval">
426
<title>APPROVAL</title>
428
The server can be configured to require manual approval for a
429
client before it is sent its secret. The delay to wait for such
430
approval and the default action (approve or deny) can be
431
configured both globally and per client; see <citerefentry>
332
432
<refentrytitle>mandos-clients.conf</refentrytitle>
333
<manvolnum>5</manvolnum></citerefentry>.
433
<manvolnum>5</manvolnum></citerefentry>. By default all clients
434
will be approved immediately without delay.
437
This can be used to deny a client its secret if not manually
438
approved within a specified time. It can also be used to make
439
the server delay before giving a client its secret, allowing
440
optional manual denying of this specific client.
337
445
<refsect1 id="logging">
338
446
<title>LOGGING</title>
340
448
The server will send log message with various severity levels to
341
<filename>/dev/log</filename>. With the
449
<filename class="devicefile">/dev/log</filename>. With the
342
450
<option>--debug</option> option, it will log even more messages,
343
451
and also show them on the console.
455
<refsect1 id="persistent_state">
456
<title>PERSISTENT STATE</title>
458
Client settings, initially read from
459
<filename>clients.conf</filename>, are persistent across
460
restarts, and run-time changes will override settings in
461
<filename>clients.conf</filename>. However, if a setting is
462
<emphasis>changed</emphasis> (or a client added, or removed) in
463
<filename>clients.conf</filename>, this will take precedence.
467
<refsect1 id="dbus_interface">
468
<title>D-BUS INTERFACE</title>
470
The server will by default provide a D-Bus system bus interface.
471
This interface will only be accessible by the root user or a
472
Mandos-specific user, if such a user exists. For documentation
473
of the D-Bus API, see the file <filename>DBUS-API</filename>.
347
477
<refsect1 id="exit_status">
348
478
<title>EXIT STATUS</title>
404
<term><filename>/var/run/mandos/mandos.pid</filename></term>
407
The file containing the process id of
408
<command>&COMMANDNAME;</command>.
413
<term><filename>/dev/log</filename></term>
534
<term><filename>/run/mandos.pid</filename></term>
537
The file containing the process id of the
538
<command>&COMMANDNAME;</command> process started last.
539
<emphasis >Note:</emphasis> If the <filename
540
class="directory">/run</filename> directory does not
541
exist, <filename>/var/run/mandos.pid</filename> will be
548
class="directory">/var/lib/mandos</filename></term>
551
Directory where persistent state will be saved. Change
552
this with the <option>--statedir</option> option. See
553
also the <option>--no-restore</option> option.
558
<term><filename class="devicefile">/dev/log</filename></term>
416
561
The Unix domain socket to where local syslog messages are
439
584
backtrace. This could be considered a feature.
442
Currently, if a client is declared <quote>invalid</quote> due to
443
having timed out, the server does not record this fact onto
444
permanent storage. This has some security implications, see
445
<xref linkend="CLIENTS"/>.
448
There is currently no way of querying the server of the current
449
status of clients, other than analyzing its <systemitem
450
class="service">syslog</systemitem> output.
453
587
There is no fine-grained control over logging and debug output.
456
Debug mode is conflated with running in the foreground.
459
The console log messages does not show a timestamp.
590
This server does not check the expire time of clients’ OpenPGP
593
<xi:include href="bugs.xml"/>
463
596
<refsect1 id="example">
473
606
<informalexample>
475
608
Run the server in debug mode, read configuration files from
476
the <filename>~/mandos</filename> directory, and use the
477
Zeroconf service name <quote>Test</quote> to not collide with
478
any other official Mandos server on this host:
609
the <filename class="directory">~/mandos</filename> directory,
610
and use the Zeroconf service name <quote>Test</quote> to not
611
collide with any other official Mandos server on this host:
530
663
compromised if they are gone for too long.
533
If a client is compromised, its downtime should be duly noted
534
by the server which would therefore declare the client
535
invalid. But if the server was ever restarted, it would
536
re-read its client list from its configuration file and again
537
regard all clients therein as valid, and hence eligible to
538
receive their passwords. Therefore, be careful when
539
restarting servers if it is suspected that a client has, in
540
fact, been compromised by parties who may now be running a
541
fake Mandos client with the keys from the non-encrypted
542
initial RAM image of the client host. What should be done in
543
that case (if restarting the server program really is
544
necessary) is to stop the server program, edit the
545
configuration file to omit any suspect clients, and restart
549
666
For more details on client-side security, see
550
<citerefentry><refentrytitle>password-request</refentrytitle>
667
<citerefentry><refentrytitle>mandos-client</refentrytitle>
551
668
<manvolnum>8mandos</manvolnum></citerefentry>.
556
673
<refsect1 id="see_also">
557
674
<title>SEE ALSO</title>
560
<refentrytitle>mandos-clients.conf</refentrytitle>
561
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
562
<refentrytitle>mandos.conf</refentrytitle>
563
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
564
<refentrytitle>password-request</refentrytitle>
565
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
566
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
676
<citerefentry><refentrytitle>intro</refentrytitle>
677
<manvolnum>8mandos</manvolnum></citerefentry>,
678
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
679
<manvolnum>5</manvolnum></citerefentry>,
680
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
681
<manvolnum>5</manvolnum></citerefentry>,
682
<citerefentry><refentrytitle>mandos-client</refentrytitle>
683
<manvolnum>8mandos</manvolnum></citerefentry>,
684
<citerefentry><refentrytitle>sh</refentrytitle>
685
<manvolnum>1</manvolnum></citerefentry>