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-09-01">
5
<!ENTITY TIMESTAMP "2019-07-24">
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
46
<holder>Teddy Hogeborn</holder>
35
47
<holder>Björn Påhlsson</holder>
37
49
<xi:include href="legalnotice.xml"/>
41
53
<refentrytitle>&COMMANDNAME;</refentrytitle>
42
54
<manvolnum>8</manvolnum>
83
95
<replaceable>DIRECTORY</replaceable></option></arg>
85
97
<arg><option>--debug</option></arg>
99
<arg><option>--debuglevel
100
<replaceable>LEVEL</replaceable></option></arg>
102
<arg><option>--no-dbus</option></arg>
104
<arg><option>--no-ipv6</option></arg>
106
<arg><option>--no-restore</option></arg>
108
<arg><option>--statedir
109
<replaceable>DIRECTORY</replaceable></option></arg>
111
<arg><option>--socket
112
<replaceable>FD</replaceable></option></arg>
114
<arg><option>--foreground</option></arg>
116
<arg><option>--no-zeroconf</option></arg>
88
119
<command>&COMMANDNAME;</command>
100
131
<arg choice="plain"><option>--check</option></arg>
102
133
</refsynopsisdiv>
104
135
<refsect1 id="description">
105
136
<title>DESCRIPTION</title>
107
138
<command>&COMMANDNAME;</command> is a server daemon which
108
139
handles incoming request for passwords for a pre-defined list of
109
client host computers. The Mandos server uses Zeroconf to
110
announce itself on the local network, and uses TLS to
111
communicate securely with and to authenticate the clients. The
112
Mandos server uses IPv6 to allow Mandos clients to use IPv6
113
link-local addresses, since the clients will probably not have
114
any other addresses configured (see <xref linkend="overview"/>).
115
Any authenticated client is then given the stored pre-encrypted
116
password for that specific client.
140
client host computers. For an introduction, see
141
<citerefentry><refentrytitle>intro</refentrytitle>
142
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
143
uses Zeroconf to announce itself on the local network, and uses
144
TLS to communicate securely with and to authenticate the
145
clients. The Mandos server uses IPv6 to allow Mandos clients to
146
use IPv6 link-local addresses, since the clients will probably
147
not have any other addresses configured (see <xref
148
linkend="overview"/>). Any authenticated client is then given
149
the stored pre-encrypted password for that specific client.
121
153
<refsect1 id="purpose">
122
154
<title>PURPOSE</title>
125
156
The purpose of this is to enable <emphasis>remote and unattended
126
157
rebooting</emphasis> of client host computer with an
127
158
<emphasis>encrypted root file system</emphasis>. See <xref
128
159
linkend="overview"/> for details.
133
163
<refsect1 id="options">
134
164
<title>OPTIONS</title>
138
167
<term><option>--help</option></term>
190
219
<xi:include href="mandos-options.xml" xpointer="debug"/>
224
<term><option>--debuglevel
225
<replaceable>LEVEL</replaceable></option></term>
228
Set the debugging log level.
229
<replaceable>LEVEL</replaceable> is a string, one of
230
<quote><literal>CRITICAL</literal></quote>,
231
<quote><literal>ERROR</literal></quote>,
232
<quote><literal>WARNING</literal></quote>,
233
<quote><literal>INFO</literal></quote>, or
234
<quote><literal>DEBUG</literal></quote>, in order of
235
increasing verbosity. The default level is
236
<quote><literal>WARNING</literal></quote>.
195
242
<term><option>--priority <replaceable>
196
243
PRIORITY</replaceable></option></term>
283
<term><option>--no-dbus</option></term>
285
<xi:include href="mandos-options.xml" xpointer="dbus"/>
287
See also <xref linkend="dbus_interface"/>.
293
<term><option>--no-ipv6</option></term>
295
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
300
<term><option>--no-restore</option></term>
302
<xi:include href="mandos-options.xml" xpointer="restore"/>
304
See also <xref linkend="persistent_state"/>.
310
<term><option>--statedir
311
<replaceable>DIRECTORY</replaceable></option></term>
313
<xi:include href="mandos-options.xml" xpointer="statedir"/>
318
<term><option>--socket
319
<replaceable>FD</replaceable></option></term>
321
<xi:include href="mandos-options.xml" xpointer="socket"/>
326
<term><option>--foreground</option></term>
328
<xi:include href="mandos-options.xml"
329
xpointer="foreground"/>
334
<term><option>--no-zeroconf</option></term>
336
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
237
343
<refsect1 id="overview">
238
344
<title>OVERVIEW</title>
239
345
<xi:include href="overview.xml"/>
256
362
start a TLS protocol handshake with a slight quirk: the Mandos
257
363
server program acts as a TLS <quote>client</quote> while the
258
364
connecting Mandos client acts as a TLS <quote>server</quote>.
259
The Mandos client must supply an OpenPGP certificate, and the
260
fingerprint of this certificate is used by the Mandos server to
261
look up (in a list read from <filename>clients.conf</filename>
262
at start time) which binary blob to give the client. No other
263
authentication or authorization is done by the server.
365
The Mandos client must supply a TLS public key, and the key ID
366
of this public key is used by the Mandos server to look up (in a
367
list read from <filename>clients.conf</filename> at start time)
368
which binary blob to give the client. No other authentication
369
or authorization is done by the server.
266
372
<title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
302
408
</tbody></tgroup></table>
305
411
<refsect1 id="checking">
306
412
<title>CHECKING</title>
308
414
The server will, by default, continually check that the clients
309
415
are still up. If a client has not been confirmed as being up
310
416
for some time, the client is assumed to be compromised and is no
311
longer eligible to receive the encrypted password. The timeout,
312
checker program, and interval between checks can be configured
313
both globally and per client; see <citerefentry>
417
longer eligible to receive the encrypted password. (Manual
418
intervention is required to re-enable a client.) The timeout,
419
extended timeout, checker program, and interval between checks
420
can be configured both globally and per client; see
421
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
422
<manvolnum>5</manvolnum></citerefentry>.
426
<refsect1 id="approval">
427
<title>APPROVAL</title>
429
The server can be configured to require manual approval for a
430
client before it is sent its secret. The delay to wait for such
431
approval and the default action (approve or deny) can be
432
configured both globally and per client; see <citerefentry>
314
433
<refentrytitle>mandos-clients.conf</refentrytitle>
315
<manvolnum>5</manvolnum></citerefentry>.
434
<manvolnum>5</manvolnum></citerefentry>. By default all clients
435
will be approved immediately without delay.
438
This can be used to deny a client its secret if not manually
439
approved within a specified time. It can also be used to make
440
the server delay before giving a client its secret, allowing
441
optional manual denying of this specific client.
319
446
<refsect1 id="logging">
320
447
<title>LOGGING</title>
322
449
The server will send log message with various severity levels to
323
<filename>/dev/log</filename>. With the
450
<filename class="devicefile">/dev/log</filename>. With the
324
451
<option>--debug</option> option, it will log even more messages,
325
452
and also show them on the console.
456
<refsect1 id="persistent_state">
457
<title>PERSISTENT STATE</title>
459
Client settings, initially read from
460
<filename>clients.conf</filename>, are persistent across
461
restarts, and run-time changes will override settings in
462
<filename>clients.conf</filename>. However, if a setting is
463
<emphasis>changed</emphasis> (or a client added, or removed) in
464
<filename>clients.conf</filename>, this will take precedence.
468
<refsect1 id="dbus_interface">
469
<title>D-BUS INTERFACE</title>
471
The server will by default provide a D-Bus system bus interface.
472
This interface will only be accessible by the root user or a
473
Mandos-specific user, if such a user exists. For documentation
474
of the D-Bus API, see the file <filename>DBUS-API</filename>.
329
478
<refsect1 id="exit_status">
330
479
<title>EXIT STATUS</title>
386
<term><filename>/var/run/mandos/mandos.pid</filename></term>
389
The file containing the process id of
390
<command>&COMMANDNAME;</command>.
395
<term><filename>/dev/log</filename></term>
535
<term><filename>/run/mandos.pid</filename></term>
538
The file containing the process id of the
539
<command>&COMMANDNAME;</command> process started last.
540
<emphasis >Note:</emphasis> If the <filename
541
class="directory">/run</filename> directory does not
542
exist, <filename>/var/run/mandos.pid</filename> will be
549
class="directory">/var/lib/mandos</filename></term>
552
Directory where persistent state will be saved. Change
553
this with the <option>--statedir</option> option. See
554
also the <option>--no-restore</option> option.
559
<term><filename class="devicefile">/dev/log</filename></term>
398
562
The Unix domain socket to where local syslog messages are
421
585
backtrace. This could be considered a feature.
424
Currently, if a client is declared <quote>invalid</quote> due to
425
having timed out, the server does not record this fact onto
426
permanent storage. This has some security implications, see
427
<xref linkend="CLIENTS"/>.
430
There is currently no way of querying the server of the current
431
status of clients, other than analyzing its <systemitem
432
class="service">syslog</systemitem> output.
435
588
There is no fine-grained control over logging and debug output.
438
Debug mode is conflated with running in the foreground.
441
The console log messages does not show a timestamp.
590
<xi:include href="bugs.xml"/>
445
593
<refsect1 id="example">
455
603
<informalexample>
457
605
Run the server in debug mode, read configuration files from
458
the <filename>~/mandos</filename> directory, and use the
459
Zeroconf service name <quote>Test</quote> to not collide with
460
any other official Mandos server on this host:
606
the <filename class="directory">~/mandos</filename> directory,
607
and use the Zeroconf service name <quote>Test</quote> to not
608
collide with any other official Mandos server on this host:
480
628
</informalexample>
483
631
<refsect1 id="security">
484
632
<title>SECURITY</title>
485
<refsect2 id="SERVER">
633
<refsect2 id="server">
486
634
<title>SERVER</title>
488
636
Running this <command>&COMMANDNAME;</command> server program
489
637
should not in itself present any security risk to the host
490
computer running it. The program does not need any special
491
privileges to run, and is designed to run as a non-root user.
638
computer running it. The program switches to a non-root user
494
<refsect2 id="CLIENTS">
642
<refsect2 id="clients">
495
643
<title>CLIENTS</title>
497
645
The server only gives out its stored data to clients which
498
does have the OpenPGP key of the stored fingerprint. This is
499
guaranteed by the fact that the client sends its OpenPGP
500
public key in the TLS handshake; this ensures it to be
501
genuine. The server computes the fingerprint of the key
502
itself and looks up the fingerprint in its list of
503
clients. The <filename>clients.conf</filename> file (see
646
does have the correct key ID of the stored key ID. This is
647
guaranteed by the fact that the client sends its public key in
648
the TLS handshake; this ensures it to be genuine. The server
649
computes the key ID of the key itself and looks up the key ID
650
in its list of clients. The <filename>clients.conf</filename>
504
652
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
653
<manvolnum>5</manvolnum></citerefentry>)
506
654
<emphasis>must</emphasis> be made non-readable by anyone
507
except the user running the server.
655
except the user starting the server (usually root).
510
658
As detailed in <xref linkend="checking"/>, the status of all
512
660
compromised if they are gone for too long.
515
If a client is compromised, its downtime should be duly noted
516
by the server which would therefore declare the client
517
invalid. But if the server was ever restarted, it would
518
re-read its client list from its configuration file and again
519
regard all clients therein as valid, and hence eligible to
520
receive their passwords. Therefore, be careful when
521
restarting servers if it is suspected that a client has, in
522
fact, been compromised by parties who may now be running a
523
fake Mandos client with the keys from the non-encrypted
524
initial <acronym>RAM</acronym> image of the client host. What
525
should be done in that case (if restarting the server program
526
really is necessary) is to stop the server program, edit the
527
configuration file to omit any suspect clients, and restart
531
663
For more details on client-side security, see
532
<citerefentry><refentrytitle>password-request</refentrytitle>
664
<citerefentry><refentrytitle>mandos-client</refentrytitle>
533
665
<manvolnum>8mandos</manvolnum></citerefentry>.
538
670
<refsect1 id="see_also">
539
671
<title>SEE ALSO</title>
542
<refentrytitle>mandos-clients.conf</refentrytitle>
543
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
<refentrytitle>mandos.conf</refentrytitle>
545
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
<refentrytitle>password-request</refentrytitle>
547
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
673
<citerefentry><refentrytitle>intro</refentrytitle>
674
<manvolnum>8mandos</manvolnum></citerefentry>,
675
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
676
<manvolnum>5</manvolnum></citerefentry>,
677
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
678
<manvolnum>5</manvolnum></citerefentry>,
679
<citerefentry><refentrytitle>mandos-client</refentrytitle>
680
<manvolnum>8mandos</manvolnum></citerefentry>,
681
<citerefentry><refentrytitle>sh</refentrytitle>
682
<manvolnum>1</manvolnum></citerefentry>
642
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
647
This is implemented by GnuTLS and used by this server so
648
that OpenPGP keys can be used.
774
RFC 7250: <citetitle>Using Raw Public Keys in Transport
775
Layer Security (TLS) and Datagram Transport Layer Security
780
This is implemented by GnuTLS version 3.6.6 and is, if
781
present, used by this server so that raw public keys can be
788
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
789
Security (TLS) Authentication</citetitle>
793
This is implemented by GnuTLS before version 3.6.0 and is,
794
if present, used by this server so that OpenPGP keys can be