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-31">
5
<!ENTITY TIMESTAMP "2015-01-25">
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
40
<holder>Teddy Hogeborn</holder>
35
41
<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/"/>.
43
<xi:include href="legalnotice.xml"/>
63
47
<refentrytitle>&COMMANDNAME;</refentrytitle>
64
48
<manvolnum>8</manvolnum>
105
89
<replaceable>DIRECTORY</replaceable></option></arg>
107
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>
110
<arg><option>--no-zeroconf</option></arg>
110
113
<command>&COMMANDNAME;</command>
122
125
<arg choice="plain"><option>--check</option></arg>
124
127
</refsynopsisdiv>
126
129
<refsect1 id="description">
127
130
<title>DESCRIPTION</title>
129
132
<command>&COMMANDNAME;</command> is a server daemon which
130
133
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.
134
client host computers. For an introduction, see
135
<citerefentry><refentrytitle>intro</refentrytitle>
136
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
137
uses Zeroconf to announce itself on the local network, and uses
138
TLS to communicate securely with and to authenticate the
139
clients. The Mandos server uses IPv6 to allow Mandos clients to
140
use IPv6 link-local addresses, since the clients will probably
141
not have any other addresses configured (see <xref
142
linkend="overview"/>). Any authenticated client is then given
143
the stored pre-encrypted password for that specific client.
143
147
<refsect1 id="purpose">
144
148
<title>PURPOSE</title>
147
150
The purpose of this is to enable <emphasis>remote and unattended
148
151
rebooting</emphasis> of client host computer with an
149
152
<emphasis>encrypted root file system</emphasis>. See <xref
150
153
linkend="overview"/> for details.
155
157
<refsect1 id="options">
156
158
<title>OPTIONS</title>
160
161
<term><option>--help</option></term>
212
213
<xi:include href="mandos-options.xml" xpointer="debug"/>
218
<term><option>--debuglevel
219
<replaceable>LEVEL</replaceable></option></term>
222
Set the debugging log level.
223
<replaceable>LEVEL</replaceable> is a string, one of
224
<quote><literal>CRITICAL</literal></quote>,
225
<quote><literal>ERROR</literal></quote>,
226
<quote><literal>WARNING</literal></quote>,
227
<quote><literal>INFO</literal></quote>, or
228
<quote><literal>DEBUG</literal></quote>, in order of
229
increasing verbosity. The default level is
230
<quote><literal>WARNING</literal></quote>.
217
236
<term><option>--priority <replaceable>
218
237
PRIORITY</replaceable></option></term>
220
<xi:include href="mandos-options.xml" xpointer="priority"/>
239
<xi:include href="mandos-options.xml"
240
xpointer="priority_compat"/>
225
245
<term><option>--servicename
226
246
<replaceable>NAME</replaceable></option></term>
278
<term><option>--no-dbus</option></term>
280
<xi:include href="mandos-options.xml" xpointer="dbus"/>
282
See also <xref linkend="dbus_interface"/>.
288
<term><option>--no-ipv6</option></term>
290
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
295
<term><option>--no-restore</option></term>
297
<xi:include href="mandos-options.xml" xpointer="restore"/>
299
See also <xref linkend="persistent_state"/>.
305
<term><option>--statedir
306
<replaceable>DIRECTORY</replaceable></option></term>
308
<xi:include href="mandos-options.xml" xpointer="statedir"/>
313
<term><option>--socket
314
<replaceable>FD</replaceable></option></term>
316
<xi:include href="mandos-options.xml" xpointer="socket"/>
321
<term><option>--foreground</option></term>
323
<xi:include href="mandos-options.xml"
324
xpointer="foreground"/>
329
<term><option>--no-zeroconf</option></term>
331
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
259
338
<refsect1 id="overview">
260
339
<title>OVERVIEW</title>
261
340
<xi:include href="overview.xml"/>
263
342
This program is the server part. It is a normal server program
264
343
and will run in a normal system environment, not in an initial
265
RAM disk environment.
344
<acronym>RAM</acronym> disk environment.
269
348
<refsect1 id="protocol">
270
349
<title>NETWORK PROTOCOL</title>
324
403
</tbody></tgroup></table>
327
406
<refsect1 id="checking">
328
407
<title>CHECKING</title>
330
409
The server will, by default, continually check that the clients
331
410
are still up. If a client has not been confirmed as being up
332
411
for some time, the client is assumed to be compromised and is no
333
longer eligible to receive the encrypted password. The timeout,
334
checker program, and interval between checks can be configured
335
both globally and per client; see <citerefentry>
412
longer eligible to receive the encrypted password. (Manual
413
intervention is required to re-enable a client.) The timeout,
414
extended timeout, checker program, and interval between checks
415
can be configured both globally and per client; see
416
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
417
<manvolnum>5</manvolnum></citerefentry>.
421
<refsect1 id="approval">
422
<title>APPROVAL</title>
424
The server can be configured to require manual approval for a
425
client before it is sent its secret. The delay to wait for such
426
approval and the default action (approve or deny) can be
427
configured both globally and per client; see <citerefentry>
336
428
<refentrytitle>mandos-clients.conf</refentrytitle>
337
<manvolnum>5</manvolnum></citerefentry>.
429
<manvolnum>5</manvolnum></citerefentry>. By default all clients
430
will be approved immediately without delay.
433
This can be used to deny a client its secret if not manually
434
approved within a specified time. It can also be used to make
435
the server delay before giving a client its secret, allowing
436
optional manual denying of this specific client.
341
441
<refsect1 id="logging">
342
442
<title>LOGGING</title>
344
444
The server will send log message with various severity levels to
345
<filename>/dev/log</filename>. With the
445
<filename class="devicefile">/dev/log</filename>. With the
346
446
<option>--debug</option> option, it will log even more messages,
347
447
and also show them on the console.
451
<refsect1 id="persistent_state">
452
<title>PERSISTENT STATE</title>
454
Client settings, initially read from
455
<filename>clients.conf</filename>, are persistent across
456
restarts, and run-time changes will override settings in
457
<filename>clients.conf</filename>. However, if a setting is
458
<emphasis>changed</emphasis> (or a client added, or removed) in
459
<filename>clients.conf</filename>, this will take precedence.
463
<refsect1 id="dbus_interface">
464
<title>D-BUS INTERFACE</title>
466
The server will by default provide a D-Bus system bus interface.
467
This interface will only be accessible by the root user or a
468
Mandos-specific user, if such a user exists. For documentation
469
of the D-Bus API, see the file <filename>DBUS-API</filename>.
351
473
<refsect1 id="exit_status">
352
474
<title>EXIT STATUS</title>
408
<term><filename>/var/run/mandos/mandos.pid</filename></term>
411
The file containing the process id of
412
<command>&COMMANDNAME;</command>.
530
<term><filename>/run/mandos.pid</filename></term>
533
The file containing the process id of the
534
<command>&COMMANDNAME;</command> process started last.
535
<emphasis >Note:</emphasis> If the <filename
536
class="directory">/run</filename> directory does not
537
exist, <filename>/var/run/mandos.pid</filename> will be
543
<term><filename class="devicefile">/dev/log</filename></term>
547
class="directory">/var/lib/mandos</filename></term>
550
Directory where persistent state will be saved. Change
551
this with the <option>--statedir</option> option. See
552
also the <option>--no-restore</option> option.
443
583
backtrace. This could be considered a feature.
446
Currently, if a client is declared <quote>invalid</quote> due to
447
having timed out, the server does not record this fact onto
448
permanent storage. This has some security implications, see
449
<xref linkend="CLIENTS"/>.
452
There is currently no way of querying the server of the current
453
status of clients, other than analyzing its <systemitem
454
class="service">syslog</systemitem> output.
457
586
There is no fine-grained control over logging and debug output.
460
Debug mode is conflated with running in the foreground.
463
The console log messages does not show a timestamp.
589
This server does not check the expire time of clients’ OpenPGP
477
604
<informalexample>
479
606
Run the server in debug mode, read configuration files from
480
the <filename>~/mandos</filename> directory, and use the
481
Zeroconf service name <quote>Test</quote> to not collide with
482
any other official Mandos server on this host:
607
the <filename class="directory">~/mandos</filename> directory,
608
and use the Zeroconf service name <quote>Test</quote> to not
609
collide with any other official Mandos server on this host:
534
661
compromised if they are gone for too long.
537
If a client is compromised, its downtime should be duly noted
538
by the server which would therefore declare the client
539
invalid. But if the server was ever restarted, it would
540
re-read its client list from its configuration file and again
541
regard all clients therein as valid, and hence eligible to
542
receive their passwords. Therefore, be careful when
543
restarting servers if it is suspected that a client has, in
544
fact, been compromised by parties who may now be running a
545
fake Mandos client with the keys from the non-encrypted
546
initial RAM image of the client host. What should be done in
547
that case (if restarting the server program really is
548
necessary) is to stop the server program, edit the
549
configuration file to omit any suspect clients, and restart
553
664
For more details on client-side security, see
554
<citerefentry><refentrytitle>password-request</refentrytitle>
665
<citerefentry><refentrytitle>mandos-client</refentrytitle>
555
666
<manvolnum>8mandos</manvolnum></citerefentry>.
560
671
<refsect1 id="see_also">
561
672
<title>SEE ALSO</title>
564
<refentrytitle>mandos-clients.conf</refentrytitle>
565
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
566
<refentrytitle>mandos.conf</refentrytitle>
567
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
<refentrytitle>password-request</refentrytitle>
569
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
570
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
674
<citerefentry><refentrytitle>intro</refentrytitle>
675
<manvolnum>8mandos</manvolnum></citerefentry>,
676
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
677
<manvolnum>5</manvolnum></citerefentry>,
678
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
679
<manvolnum>5</manvolnum></citerefentry>,
680
<citerefentry><refentrytitle>mandos-client</refentrytitle>
681
<manvolnum>8mandos</manvolnum></citerefentry>,
682
<citerefentry><refentrytitle>sh</refentrytitle>
683
<manvolnum>1</manvolnum></citerefentry>