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 "2017-02-23">
6
<!ENTITY % common SYSTEM "common.ent">
6
<!ENTITY TIMESTAMP "2008-08-31">
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>
44
34
<holder>Teddy Hogeborn</holder>
45
35
<holder>Björn Påhlsson</holder>
47
37
<xi:include href="legalnotice.xml"/>
51
41
<refentrytitle>&COMMANDNAME;</refentrytitle>
52
42
<manvolnum>8</manvolnum>
93
83
<replaceable>DIRECTORY</replaceable></option></arg>
95
85
<arg><option>--debug</option></arg>
97
<arg><option>--debuglevel
98
<replaceable>LEVEL</replaceable></option></arg>
100
<arg><option>--no-dbus</option></arg>
102
<arg><option>--no-ipv6</option></arg>
104
<arg><option>--no-restore</option></arg>
106
<arg><option>--statedir
107
<replaceable>DIRECTORY</replaceable></option></arg>
109
<arg><option>--socket
110
<replaceable>FD</replaceable></option></arg>
112
<arg><option>--foreground</option></arg>
114
<arg><option>--no-zeroconf</option></arg>
117
88
<command>&COMMANDNAME;</command>
129
100
<arg choice="plain"><option>--check</option></arg>
131
102
</refsynopsisdiv>
133
104
<refsect1 id="description">
134
105
<title>DESCRIPTION</title>
136
107
<command>&COMMANDNAME;</command> is a server daemon which
137
108
handles incoming request for passwords for a pre-defined list of
138
client host computers. For an introduction, see
139
<citerefentry><refentrytitle>intro</refentrytitle>
140
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
141
uses Zeroconf to announce itself on the local network, and uses
142
TLS to communicate securely with and to authenticate the
143
clients. The Mandos server uses IPv6 to allow Mandos clients to
144
use IPv6 link-local addresses, since the clients will probably
145
not have any other addresses configured (see <xref
146
linkend="overview"/>). Any authenticated client is then given
147
the stored pre-encrypted password for that specific client.
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.
151
121
<refsect1 id="purpose">
152
122
<title>PURPOSE</title>
154
125
The purpose of this is to enable <emphasis>remote and unattended
155
126
rebooting</emphasis> of client host computer with an
156
127
<emphasis>encrypted root file system</emphasis>. See <xref
157
128
linkend="overview"/> for details.
161
133
<refsect1 id="options">
162
134
<title>OPTIONS</title>
165
138
<term><option>--help</option></term>
217
190
<xi:include href="mandos-options.xml" xpointer="debug"/>
222
<term><option>--debuglevel
223
<replaceable>LEVEL</replaceable></option></term>
226
Set the debugging log level.
227
<replaceable>LEVEL</replaceable> is a string, one of
228
<quote><literal>CRITICAL</literal></quote>,
229
<quote><literal>ERROR</literal></quote>,
230
<quote><literal>WARNING</literal></quote>,
231
<quote><literal>INFO</literal></quote>, or
232
<quote><literal>DEBUG</literal></quote>, in order of
233
increasing verbosity. The default level is
234
<quote><literal>WARNING</literal></quote>.
240
195
<term><option>--priority <replaceable>
241
196
PRIORITY</replaceable></option></term>
281
<term><option>--no-dbus</option></term>
283
<xi:include href="mandos-options.xml" xpointer="dbus"/>
285
See also <xref linkend="dbus_interface"/>.
291
<term><option>--no-ipv6</option></term>
293
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
298
<term><option>--no-restore</option></term>
300
<xi:include href="mandos-options.xml" xpointer="restore"/>
302
See also <xref linkend="persistent_state"/>.
308
<term><option>--statedir
309
<replaceable>DIRECTORY</replaceable></option></term>
311
<xi:include href="mandos-options.xml" xpointer="statedir"/>
316
<term><option>--socket
317
<replaceable>FD</replaceable></option></term>
319
<xi:include href="mandos-options.xml" xpointer="socket"/>
324
<term><option>--foreground</option></term>
326
<xi:include href="mandos-options.xml"
327
xpointer="foreground"/>
332
<term><option>--no-zeroconf</option></term>
334
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
341
237
<refsect1 id="overview">
342
238
<title>OVERVIEW</title>
343
239
<xi:include href="overview.xml"/>
345
241
This program is the server part. It is a normal server program
346
242
and will run in a normal system environment, not in an initial
347
<acronym>RAM</acronym> disk environment.
243
RAM disk environment.
351
247
<refsect1 id="protocol">
352
248
<title>NETWORK PROTOCOL</title>
406
302
</tbody></tgroup></table>
409
305
<refsect1 id="checking">
410
306
<title>CHECKING</title>
412
308
The server will, by default, continually check that the clients
413
309
are still up. If a client has not been confirmed as being up
414
310
for some time, the client is assumed to be compromised and is no
415
longer eligible to receive the encrypted password. (Manual
416
intervention is required to re-enable a client.) The timeout,
417
extended timeout, checker program, and interval between checks
418
can be configured both globally and per client; see
419
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
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>
314
<refentrytitle>mandos-clients.conf</refentrytitle>
420
315
<manvolnum>5</manvolnum></citerefentry>.
424
<refsect1 id="approval">
425
<title>APPROVAL</title>
427
The server can be configured to require manual approval for a
428
client before it is sent its secret. The delay to wait for such
429
approval and the default action (approve or deny) can be
430
configured both globally and per client; see <citerefentry>
431
<refentrytitle>mandos-clients.conf</refentrytitle>
432
<manvolnum>5</manvolnum></citerefentry>. By default all clients
433
will be approved immediately without delay.
436
This can be used to deny a client its secret if not manually
437
approved within a specified time. It can also be used to make
438
the server delay before giving a client its secret, allowing
439
optional manual denying of this specific client.
444
319
<refsect1 id="logging">
445
320
<title>LOGGING</title>
447
322
The server will send log message with various severity levels to
448
<filename class="devicefile">/dev/log</filename>. With the
323
<filename>/dev/log</filename>. With the
449
324
<option>--debug</option> option, it will log even more messages,
450
325
and also show them on the console.
454
<refsect1 id="persistent_state">
455
<title>PERSISTENT STATE</title>
457
Client settings, initially read from
458
<filename>clients.conf</filename>, are persistent across
459
restarts, and run-time changes will override settings in
460
<filename>clients.conf</filename>. However, if a setting is
461
<emphasis>changed</emphasis> (or a client added, or removed) in
462
<filename>clients.conf</filename>, this will take precedence.
466
<refsect1 id="dbus_interface">
467
<title>D-BUS INTERFACE</title>
469
The server will by default provide a D-Bus system bus interface.
470
This interface will only be accessible by the root user or a
471
Mandos-specific user, if such a user exists. For documentation
472
of the D-Bus API, see the file <filename>DBUS-API</filename>.
476
329
<refsect1 id="exit_status">
477
330
<title>EXIT STATUS</title>
533
<term><filename>/run/mandos.pid</filename></term>
536
The file containing the process id of the
537
<command>&COMMANDNAME;</command> process started last.
538
<emphasis >Note:</emphasis> If the <filename
539
class="directory">/run</filename> directory does not
540
exist, <filename>/var/run/mandos.pid</filename> will be
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.
557
<term><filename class="devicefile">/dev/log</filename></term>
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>
560
398
The Unix domain socket to where local syslog messages are
583
421
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.
586
435
There is no fine-grained control over logging and debug output.
589
This server does not check the expire time of clients’ OpenPGP
592
<xi:include href="bugs.xml"/>
438
Debug mode is conflated with running in the foreground.
441
The console log messages does not show a timestamp.
595
445
<refsect1 id="example">
605
455
<informalexample>
607
457
Run the server in debug mode, read configuration files from
608
the <filename class="directory">~/mandos</filename> directory,
609
and use the Zeroconf service name <quote>Test</quote> to not
610
collide with any other official Mandos server on this host:
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:
662
512
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 RAM image of the client host. What should be done in
525
that case (if restarting the server program really is
526
necessary) is to stop the server program, edit the
527
configuration file to omit any suspect clients, and restart
665
531
For more details on client-side security, see
666
<citerefentry><refentrytitle>mandos-client</refentrytitle>
532
<citerefentry><refentrytitle>password-request</refentrytitle>
667
533
<manvolnum>8mandos</manvolnum></citerefentry>.
672
538
<refsect1 id="see_also">
673
539
<title>SEE ALSO</title>
675
<citerefentry><refentrytitle>intro</refentrytitle>
676
<manvolnum>8mandos</manvolnum></citerefentry>,
677
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
678
<manvolnum>5</manvolnum></citerefentry>,
679
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
680
<manvolnum>5</manvolnum></citerefentry>,
681
<citerefentry><refentrytitle>mandos-client</refentrytitle>
682
<manvolnum>8mandos</manvolnum></citerefentry>,
683
<citerefentry><refentrytitle>sh</refentrytitle>
684
<manvolnum>1</manvolnum></citerefentry>
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>