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-05">
5
<!ENTITY TIMESTAMP "2013-10-23">
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>
37
43
<xi:include href="legalnotice.xml"/>
41
47
<refentrytitle>&COMMANDNAME;</refentrytitle>
42
48
<manvolnum>8</manvolnum>
83
89
<replaceable>DIRECTORY</replaceable></option></arg>
85
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>
88
111
<command>&COMMANDNAME;</command>
100
123
<arg choice="plain"><option>--check</option></arg>
102
125
</refsynopsisdiv>
104
127
<refsect1 id="description">
105
128
<title>DESCRIPTION</title>
107
130
<command>&COMMANDNAME;</command> is a server daemon which
108
131
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.
132
client host computers. For an introduction, see
133
<citerefentry><refentrytitle>intro</refentrytitle>
134
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
135
uses Zeroconf to announce itself on the local network, and uses
136
TLS to communicate securely with and to authenticate the
137
clients. The Mandos server uses IPv6 to allow Mandos clients to
138
use IPv6 link-local addresses, since the clients will probably
139
not have any other addresses configured (see <xref
140
linkend="overview"/>). Any authenticated client is then given
141
the stored pre-encrypted password for that specific client.
186
211
<xi:include href="mandos-options.xml" xpointer="debug"/>
216
<term><option>--debuglevel
217
<replaceable>LEVEL</replaceable></option></term>
220
Set the debugging log level.
221
<replaceable>LEVEL</replaceable> is a string, one of
222
<quote><literal>CRITICAL</literal></quote>,
223
<quote><literal>ERROR</literal></quote>,
224
<quote><literal>WARNING</literal></quote>,
225
<quote><literal>INFO</literal></quote>, or
226
<quote><literal>DEBUG</literal></quote>, in order of
227
increasing verbosity. The default level is
228
<quote><literal>WARNING</literal></quote>.
191
234
<term><option>--priority <replaceable>
192
235
PRIORITY</replaceable></option></term>
194
<xi:include href="mandos-options.xml" xpointer="priority"/>
237
<xi:include href="mandos-options.xml"
238
xpointer="priority_compat"/>
199
243
<term><option>--servicename
200
244
<replaceable>NAME</replaceable></option></term>
276
<term><option>--no-dbus</option></term>
278
<xi:include href="mandos-options.xml" xpointer="dbus"/>
280
See also <xref linkend="dbus_interface"/>.
286
<term><option>--no-ipv6</option></term>
288
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
293
<term><option>--no-restore</option></term>
295
<xi:include href="mandos-options.xml" xpointer="restore"/>
297
See also <xref linkend="persistent_state"/>.
303
<term><option>--statedir
304
<replaceable>DIRECTORY</replaceable></option></term>
306
<xi:include href="mandos-options.xml" xpointer="statedir"/>
311
<term><option>--socket
312
<replaceable>FD</replaceable></option></term>
314
<xi:include href="mandos-options.xml" xpointer="socket"/>
319
<term><option>--foreground</option></term>
321
<xi:include href="mandos-options.xml"
322
xpointer="foreground"/>
233
329
<refsect1 id="overview">
234
330
<title>OVERVIEW</title>
235
331
<xi:include href="overview.xml"/>
298
394
</tbody></tgroup></table>
301
397
<refsect1 id="checking">
302
398
<title>CHECKING</title>
304
400
The server will, by default, continually check that the clients
305
401
are still up. If a client has not been confirmed as being up
306
402
for some time, the client is assumed to be compromised and is no
307
longer eligible to receive the encrypted password. The timeout,
308
checker program, and interval between checks can be configured
309
both globally and per client; see <citerefentry>
403
longer eligible to receive the encrypted password. (Manual
404
intervention is required to re-enable a client.) The timeout,
405
extended timeout, checker program, and interval between checks
406
can be configured both globally and per client; see
407
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
408
<manvolnum>5</manvolnum></citerefentry>.
412
<refsect1 id="approval">
413
<title>APPROVAL</title>
415
The server can be configured to require manual approval for a
416
client before it is sent its secret. The delay to wait for such
417
approval and the default action (approve or deny) can be
418
configured both globally and per client; see <citerefentry>
310
419
<refentrytitle>mandos-clients.conf</refentrytitle>
311
<manvolnum>5</manvolnum></citerefentry>.
420
<manvolnum>5</manvolnum></citerefentry>. By default all clients
421
will be approved immediately without delay.
424
This can be used to deny a client its secret if not manually
425
approved within a specified time. It can also be used to make
426
the server delay before giving a client its secret, allowing
427
optional manual denying of this specific client.
315
432
<refsect1 id="logging">
316
433
<title>LOGGING</title>
318
435
The server will send log message with various severity levels to
319
<filename>/dev/log</filename>. With the
436
<filename class="devicefile">/dev/log</filename>. With the
320
437
<option>--debug</option> option, it will log even more messages,
321
438
and also show them on the console.
442
<refsect1 id="persistent_state">
443
<title>PERSISTENT STATE</title>
445
Client settings, initially read from
446
<filename>clients.conf</filename>, are persistent across
447
restarts, and run-time changes will override settings in
448
<filename>clients.conf</filename>. However, if a setting is
449
<emphasis>changed</emphasis> (or a client added, or removed) in
450
<filename>clients.conf</filename>, this will take precedence.
454
<refsect1 id="dbus_interface">
455
<title>D-BUS INTERFACE</title>
457
The server will by default provide a D-Bus system bus interface.
458
This interface will only be accessible by the root user or a
459
Mandos-specific user, if such a user exists. For documentation
460
of the D-Bus API, see the file <filename>DBUS-API</filename>.
325
464
<refsect1 id="exit_status">
326
465
<title>EXIT STATUS</title>
382
<term><filename>/var/run/mandos.pid</filename></term>
385
The file containing the process id of
386
<command>&COMMANDNAME;</command>.
521
<term><filename>/run/mandos.pid</filename></term>
524
The file containing the process id of the
525
<command>&COMMANDNAME;</command> process started last.
530
<term><filename class="devicefile">/dev/log</filename></term>
534
class="directory">/var/lib/mandos</filename></term>
537
Directory where persistent state will be saved. Change
538
this with the <option>--statedir</option> option. See
539
also the <option>--no-restore</option> option.
417
570
backtrace. This could be considered a feature.
420
Currently, if a client is declared <quote>invalid</quote> due to
421
having timed out, the server does not record this fact onto
422
permanent storage. This has some security implications, see
423
<xref linkend="CLIENTS"/>.
426
There is currently no way of querying the server of the current
427
status of clients, other than analyzing its <systemitem
428
class="service">syslog</systemitem> output.
431
573
There is no fine-grained control over logging and debug output.
434
Debug mode is conflated with running in the foreground.
437
The console log messages does not show a time stamp.
440
576
This server does not check the expire time of clients’ OpenPGP
455
591
<informalexample>
457
593
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:
594
the <filename class="directory">~/mandos</filename> directory,
595
and use the Zeroconf service name <quote>Test</quote> to not
596
collide with any other official Mandos server on this host:
512
648
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
651
For more details on client-side security, see
532
<citerefentry><refentrytitle>password-request</refentrytitle>
652
<citerefentry><refentrytitle>mandos-client</refentrytitle>
533
653
<manvolnum>8mandos</manvolnum></citerefentry>.
538
658
<refsect1 id="see_also">
539
659
<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>
661
<citerefentry><refentrytitle>intro</refentrytitle>
662
<manvolnum>8mandos</manvolnum></citerefentry>,
663
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
664
<manvolnum>5</manvolnum></citerefentry>,
665
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
666
<manvolnum>5</manvolnum></citerefentry>,
667
<citerefentry><refentrytitle>mandos-client</refentrytitle>
668
<manvolnum>8mandos</manvolnum></citerefentry>,
669
<citerefentry><refentrytitle>sh</refentrytitle>
670
<manvolnum>1</manvolnum></citerefentry>