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 "2011-11-26">
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>
38
34
<holder>Teddy Hogeborn</holder>
39
35
<holder>Björn Påhlsson</holder>
41
37
<xi:include href="legalnotice.xml"/>
45
41
<refentrytitle>&COMMANDNAME;</refentrytitle>
46
42
<manvolnum>8</manvolnum>
87
83
<replaceable>DIRECTORY</replaceable></option></arg>
89
85
<arg><option>--debug</option></arg>
91
<arg><option>--debuglevel
92
<replaceable>LEVEL</replaceable></option></arg>
94
<arg><option>--no-dbus</option></arg>
96
<arg><option>--no-ipv6</option></arg>
98
<arg><option>--no-restore</option></arg>
100
<arg><option>--statedir
101
<replaceable>DIRECTORY</replaceable></option></arg>
104
88
<command>&COMMANDNAME;</command>
116
100
<arg choice="plain"><option>--check</option></arg>
118
102
</refsynopsisdiv>
120
104
<refsect1 id="description">
121
105
<title>DESCRIPTION</title>
123
107
<command>&COMMANDNAME;</command> is a server daemon which
124
108
handles incoming request for passwords for a pre-defined list of
125
client host computers. For an introduction, see
126
<citerefentry><refentrytitle>intro</refentrytitle>
127
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
128
uses Zeroconf to announce itself on the local network, and uses
129
TLS to communicate securely with and to authenticate the
130
clients. The Mandos server uses IPv6 to allow Mandos clients to
131
use IPv6 link-local addresses, since the clients will probably
132
not have any other addresses configured (see <xref
133
linkend="overview"/>). Any authenticated client is then given
134
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.
138
121
<refsect1 id="purpose">
139
122
<title>PURPOSE</title>
141
125
The purpose of this is to enable <emphasis>remote and unattended
142
126
rebooting</emphasis> of client host computer with an
143
127
<emphasis>encrypted root file system</emphasis>. See <xref
144
128
linkend="overview"/> for details.
148
133
<refsect1 id="options">
149
134
<title>OPTIONS</title>
152
138
<term><option>--help</option></term>
204
190
<xi:include href="mandos-options.xml" xpointer="debug"/>
209
<term><option>--debuglevel
210
<replaceable>LEVEL</replaceable></option></term>
213
Set the debugging log level.
214
<replaceable>LEVEL</replaceable> is a string, one of
215
<quote><literal>CRITICAL</literal></quote>,
216
<quote><literal>ERROR</literal></quote>,
217
<quote><literal>WARNING</literal></quote>,
218
<quote><literal>INFO</literal></quote>, or
219
<quote><literal>DEBUG</literal></quote>, in order of
220
increasing verbosity. The default level is
221
<quote><literal>WARNING</literal></quote>.
227
195
<term><option>--priority <replaceable>
228
196
PRIORITY</replaceable></option></term>
268
<term><option>--no-dbus</option></term>
270
<xi:include href="mandos-options.xml" xpointer="dbus"/>
272
See also <xref linkend="dbus_interface"/>.
278
<term><option>--no-ipv6</option></term>
280
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
285
<term><option>--no-restore</option></term>
287
<xi:include href="mandos-options.xml" xpointer="restore"/>
292
<term><option>--statedir
293
<replaceable>DIRECTORY</replaceable></option></term>
295
<xi:include href="mandos-options.xml" xpointer="statedir"/>
301
237
<refsect1 id="overview">
302
238
<title>OVERVIEW</title>
303
239
<xi:include href="overview.xml"/>
305
241
This program is the server part. It is a normal server program
306
242
and will run in a normal system environment, not in an initial
307
<acronym>RAM</acronym> disk environment.
243
RAM disk environment.
311
247
<refsect1 id="protocol">
312
248
<title>NETWORK PROTOCOL</title>
366
302
</tbody></tgroup></table>
369
305
<refsect1 id="checking">
370
306
<title>CHECKING</title>
372
308
The server will, by default, continually check that the clients
373
309
are still up. If a client has not been confirmed as being up
374
310
for some time, the client is assumed to be compromised and is no
375
longer eligible to receive the encrypted password. (Manual
376
intervention is required to re-enable a client.) The timeout,
377
extended timeout, checker program, and interval between checks
378
can be configured both globally and per client; see
379
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
380
<manvolnum>5</manvolnum></citerefentry>. A client successfully
381
receiving its password will also be treated as a successful
386
<refsect1 id="approval">
387
<title>APPROVAL</title>
389
The server can be configured to require manual approval for a
390
client before it is sent its secret. The delay to wait for such
391
approval and the default action (approve or deny) can be
392
configured both globally and per client; see <citerefentry>
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>
393
314
<refentrytitle>mandos-clients.conf</refentrytitle>
394
<manvolnum>5</manvolnum></citerefentry>. By default all clients
395
will be approved immediately without delay.
398
This can be used to deny a client its secret if not manually
399
approved within a specified time. It can also be used to make
400
the server delay before giving a client its secret, allowing
401
optional manual denying of this specific client.
315
<manvolnum>5</manvolnum></citerefentry>.
406
319
<refsect1 id="logging">
407
320
<title>LOGGING</title>
409
322
The server will send log message with various severity levels to
410
<filename class="devicefile">/dev/log</filename>. With the
323
<filename>/dev/log</filename>. With the
411
324
<option>--debug</option> option, it will log even more messages,
412
325
and also show them on the console.
416
<refsect1 id="dbus_interface">
417
<title>D-BUS INTERFACE</title>
419
The server will by default provide a D-Bus system bus interface.
420
This interface will only be accessible by the root user or a
421
Mandos-specific user, if such a user exists. For documentation
422
of the D-Bus API, see the file <filename>DBUS-API</filename>.
426
329
<refsect1 id="exit_status">
427
330
<title>EXIT STATUS</title>
483
<term><filename>/var/run/mandos.pid</filename></term>
486
The file containing the process id of the
487
<command>&COMMANDNAME;</command> process started last.
492
<term><filename class="devicefile">/dev/log</filename></term>
496
class="directory">/var/lib/mandos</filename></term>
499
Directory where persistent state will be saved. Change
500
this with the <option>--statedir</option> option. See
501
also the <option>--no-restore</option> option.
386
<term><filename>/var/run/mandos/mandos.pid</filename></term>
389
The file containing the process id of
390
<command>&COMMANDNAME;</command>.
532
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.
535
435
There is no fine-grained control over logging and debug output.
538
438
Debug mode is conflated with running in the foreground.
541
This server does not check the expire time of clients’ OpenPGP
441
The console log messages does not show a timestamp.
556
455
<informalexample>
558
457
Run the server in debug mode, read configuration files from
559
the <filename class="directory">~/mandos</filename> directory,
560
and use the Zeroconf service name <quote>Test</quote> to not
561
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:
581
480
</informalexample>
584
483
<refsect1 id="security">
585
484
<title>SECURITY</title>
586
<refsect2 id="server">
485
<refsect2 id="SERVER">
587
486
<title>SERVER</title>
589
488
Running this <command>&COMMANDNAME;</command> server program
590
489
should not in itself present any security risk to the host
591
computer running it. The program switches to a non-root user
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.
595
<refsect2 id="clients">
494
<refsect2 id="CLIENTS">
596
495
<title>CLIENTS</title>
598
497
The server only gives out its stored data to clients which
605
504
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
606
505
<manvolnum>5</manvolnum></citerefentry>)
607
506
<emphasis>must</emphasis> be made non-readable by anyone
608
except the user starting the server (usually root).
507
except the user running the server.
611
510
As detailed in <xref linkend="checking"/>, the status of all
613
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
616
531
For more details on client-side security, see
617
<citerefentry><refentrytitle>mandos-client</refentrytitle>
532
<citerefentry><refentrytitle>password-request</refentrytitle>
618
533
<manvolnum>8mandos</manvolnum></citerefentry>.
623
538
<refsect1 id="see_also">
624
539
<title>SEE ALSO</title>
626
<citerefentry><refentrytitle>intro</refentrytitle>
627
<manvolnum>8mandos</manvolnum></citerefentry>,
628
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
629
<manvolnum>5</manvolnum></citerefentry>,
630
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
631
<manvolnum>5</manvolnum></citerefentry>,
632
<citerefentry><refentrytitle>mandos-client</refentrytitle>
633
<manvolnum>8mandos</manvolnum></citerefentry>,
634
<citerefentry><refentrytitle>sh</refentrytitle>
635
<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>
added
removed
mandos.xml
