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 "2012-06-17">
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
39
<holder>Teddy Hogeborn</holder>
35
40
<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/"/>.
42
<xi:include href="legalnotice.xml"/>
63
46
<refentrytitle>&COMMANDNAME;</refentrytitle>
64
47
<manvolnum>8</manvolnum>
105
88
<replaceable>DIRECTORY</replaceable></option></arg>
107
90
<arg><option>--debug</option></arg>
92
<arg><option>--debuglevel
93
<replaceable>LEVEL</replaceable></option></arg>
95
<arg><option>--no-dbus</option></arg>
97
<arg><option>--no-ipv6</option></arg>
99
<arg><option>--no-restore</option></arg>
101
<arg><option>--statedir
102
<replaceable>DIRECTORY</replaceable></option></arg>
104
<arg><option>--socket
105
<replaceable>FD</replaceable></option></arg>
107
<arg><option>--foreground</option></arg>
110
110
<command>&COMMANDNAME;</command>
122
122
<arg choice="plain"><option>--check</option></arg>
124
124
</refsynopsisdiv>
126
126
<refsect1 id="description">
127
127
<title>DESCRIPTION</title>
129
129
<command>&COMMANDNAME;</command> is a server daemon which
130
130
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.
131
client host computers. For an introduction, see
132
<citerefentry><refentrytitle>intro</refentrytitle>
133
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
134
uses Zeroconf to announce itself on the local network, and uses
135
TLS to communicate securely with and to authenticate the
136
clients. The Mandos server uses IPv6 to allow Mandos clients to
137
use IPv6 link-local addresses, since the clients will probably
138
not have any other addresses configured (see <xref
139
linkend="overview"/>). Any authenticated client is then given
140
the stored pre-encrypted password for that specific client.
143
144
<refsect1 id="purpose">
144
145
<title>PURPOSE</title>
147
147
The purpose of this is to enable <emphasis>remote and unattended
148
148
rebooting</emphasis> of client host computer with an
149
149
<emphasis>encrypted root file system</emphasis>. See <xref
150
150
linkend="overview"/> for details.
155
154
<refsect1 id="options">
156
155
<title>OPTIONS</title>
160
158
<term><option>--help</option></term>
212
210
<xi:include href="mandos-options.xml" xpointer="debug"/>
215
<term><option>--debuglevel
216
<replaceable>LEVEL</replaceable></option></term>
219
Set the debugging log level.
220
<replaceable>LEVEL</replaceable> is a string, one of
221
<quote><literal>CRITICAL</literal></quote>,
222
<quote><literal>ERROR</literal></quote>,
223
<quote><literal>WARNING</literal></quote>,
224
<quote><literal>INFO</literal></quote>, or
225
<quote><literal>DEBUG</literal></quote>, in order of
226
increasing verbosity. The default level is
227
<quote><literal>WARNING</literal></quote>.
217
233
<term><option>--priority <replaceable>
218
234
PRIORITY</replaceable></option></term>
274
<term><option>--no-dbus</option></term>
276
<xi:include href="mandos-options.xml" xpointer="dbus"/>
278
See also <xref linkend="dbus_interface"/>.
284
<term><option>--no-ipv6</option></term>
286
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
291
<term><option>--no-restore</option></term>
293
<xi:include href="mandos-options.xml" xpointer="restore"/>
295
See also <xref linkend="persistent_state"/>.
301
<term><option>--statedir
302
<replaceable>DIRECTORY</replaceable></option></term>
304
<xi:include href="mandos-options.xml" xpointer="statedir"/>
309
<term><option>--socket
310
<replaceable>FD</replaceable></option></term>
312
<xi:include href="mandos-options.xml" xpointer="socket"/>
317
<term><option>--foreground</option></term>
319
<xi:include href="mandos-options.xml"
320
xpointer="foreground"/>
259
327
<refsect1 id="overview">
260
328
<title>OVERVIEW</title>
261
329
<xi:include href="overview.xml"/>
263
331
This program is the server part. It is a normal server program
264
332
and will run in a normal system environment, not in an initial
265
RAM disk environment.
333
<acronym>RAM</acronym> disk environment.
269
337
<refsect1 id="protocol">
270
338
<title>NETWORK PROTOCOL</title>
324
392
</tbody></tgroup></table>
327
395
<refsect1 id="checking">
328
396
<title>CHECKING</title>
330
398
The server will, by default, continually check that the clients
331
399
are still up. If a client has not been confirmed as being up
332
400
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>
401
longer eligible to receive the encrypted password. (Manual
402
intervention is required to re-enable a client.) The timeout,
403
extended timeout, checker program, and interval between checks
404
can be configured both globally and per client; see
405
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
406
<manvolnum>5</manvolnum></citerefentry>.
410
<refsect1 id="approval">
411
<title>APPROVAL</title>
413
The server can be configured to require manual approval for a
414
client before it is sent its secret. The delay to wait for such
415
approval and the default action (approve or deny) can be
416
configured both globally and per client; see <citerefentry>
336
417
<refentrytitle>mandos-clients.conf</refentrytitle>
337
<manvolnum>5</manvolnum></citerefentry>.
418
<manvolnum>5</manvolnum></citerefentry>. By default all clients
419
will be approved immediately without delay.
422
This can be used to deny a client its secret if not manually
423
approved within a specified time. It can also be used to make
424
the server delay before giving a client its secret, allowing
425
optional manual denying of this specific client.
341
430
<refsect1 id="logging">
342
431
<title>LOGGING</title>
344
433
The server will send log message with various severity levels to
345
<filename>/dev/log</filename>. With the
434
<filename class="devicefile">/dev/log</filename>. With the
346
435
<option>--debug</option> option, it will log even more messages,
347
436
and also show them on the console.
440
<refsect1 id="persistent_state">
441
<title>PERSISTENT STATE</title>
443
Client settings, initially read from
444
<filename>clients.conf</filename>, are persistent across
445
restarts, and run-time changes will override settings in
446
<filename>clients.conf</filename>. However, if a setting is
447
<emphasis>changed</emphasis> (or a client added, or removed) in
448
<filename>clients.conf</filename>, this will take precedence.
452
<refsect1 id="dbus_interface">
453
<title>D-BUS INTERFACE</title>
455
The server will by default provide a D-Bus system bus interface.
456
This interface will only be accessible by the root user or a
457
Mandos-specific user, if such a user exists. For documentation
458
of the D-Bus API, see the file <filename>DBUS-API</filename>.
351
462
<refsect1 id="exit_status">
352
463
<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>.
519
<term><filename>/var/run/mandos.pid</filename></term>
522
The file containing the process id of the
523
<command>&COMMANDNAME;</command> process started last.
528
<term><filename class="devicefile">/dev/log</filename></term>
532
class="directory">/var/lib/mandos</filename></term>
535
Directory where persistent state will be saved. Change
536
this with the <option>--statedir</option> option. See
537
also the <option>--no-restore</option> option.
443
568
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
571
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.
574
This server does not check the expire time of clients’ OpenPGP
477
589
<informalexample>
479
591
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:
592
the <filename class="directory">~/mandos</filename> directory,
593
and use the Zeroconf service name <quote>Test</quote> to not
594
collide with any other official Mandos server on this host:
534
646
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
649
For more details on client-side security, see
554
<citerefentry><refentrytitle>password-request</refentrytitle>
650
<citerefentry><refentrytitle>mandos-client</refentrytitle>
555
651
<manvolnum>8mandos</manvolnum></citerefentry>.
560
656
<refsect1 id="see_also">
561
657
<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>
659
<citerefentry><refentrytitle>intro</refentrytitle>
660
<manvolnum>8mandos</manvolnum></citerefentry>,
661
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
662
<manvolnum>5</manvolnum></citerefentry>,
663
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
664
<manvolnum>5</manvolnum></citerefentry>,
665
<citerefentry><refentrytitle>mandos-client</refentrytitle>
666
<manvolnum>8mandos</manvolnum></citerefentry>,
667
<citerefentry><refentrytitle>sh</refentrytitle>
668
<manvolnum>1</manvolnum></citerefentry>