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 "2012-05-26">
6
<!ENTITY % common SYSTEM "common.ent">
6
<!ENTITY TIMESTAMP "2008-09-12">
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>
39
34
<holder>Teddy Hogeborn</holder>
40
35
<holder>Björn Påhlsson</holder>
88
83
<replaceable>DIRECTORY</replaceable></option></arg>
90
85
<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>
108
88
<command>&COMMANDNAME;</command>
127
107
<command>&COMMANDNAME;</command> is a server daemon which
128
108
handles incoming request for passwords for a pre-defined list of
129
client host computers. For an introduction, see
130
<citerefentry><refentrytitle>intro</refentrytitle>
131
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
132
uses Zeroconf to announce itself on the local network, and uses
133
TLS to communicate securely with and to authenticate the
134
clients. The Mandos server uses IPv6 to allow Mandos clients to
135
use IPv6 link-local addresses, since the clients will probably
136
not have any other addresses configured (see <xref
137
linkend="overview"/>). Any authenticated client is then given
138
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.
213
<term><option>--debuglevel
214
<replaceable>LEVEL</replaceable></option></term>
217
Set the debugging log level.
218
<replaceable>LEVEL</replaceable> is a string, one of
219
<quote><literal>CRITICAL</literal></quote>,
220
<quote><literal>ERROR</literal></quote>,
221
<quote><literal>WARNING</literal></quote>,
222
<quote><literal>INFO</literal></quote>, or
223
<quote><literal>DEBUG</literal></quote>, in order of
224
increasing verbosity. The default level is
225
<quote><literal>WARNING</literal></quote>.
231
191
<term><option>--priority <replaceable>
232
192
PRIORITY</replaceable></option></term>
272
<term><option>--no-dbus</option></term>
274
<xi:include href="mandos-options.xml" xpointer="dbus"/>
276
See also <xref linkend="dbus_interface"/>.
282
<term><option>--no-ipv6</option></term>
284
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
289
<term><option>--no-restore</option></term>
291
<xi:include href="mandos-options.xml" xpointer="restore"/>
293
See also <xref linkend="persistent_state"/>.
299
<term><option>--statedir
300
<replaceable>DIRECTORY</replaceable></option></term>
302
<xi:include href="mandos-options.xml" xpointer="statedir"/>
307
<term><option>--socket
308
<replaceable>FD</replaceable></option></term>
310
<xi:include href="mandos-options.xml" xpointer="socket"/>
388
304
The server will, by default, continually check that the clients
389
305
are still up. If a client has not been confirmed as being up
390
306
for some time, the client is assumed to be compromised and is no
391
longer eligible to receive the encrypted password. (Manual
392
intervention is required to re-enable a client.) The timeout,
393
extended timeout, checker program, and interval between checks
394
can be configured both globally and per client; see
395
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
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>
310
<refentrytitle>mandos-clients.conf</refentrytitle>
396
311
<manvolnum>5</manvolnum></citerefentry>.
400
<refsect1 id="approval">
401
<title>APPROVAL</title>
403
The server can be configured to require manual approval for a
404
client before it is sent its secret. The delay to wait for such
405
approval and the default action (approve or deny) can be
406
configured both globally and per client; see <citerefentry>
407
<refentrytitle>mandos-clients.conf</refentrytitle>
408
<manvolnum>5</manvolnum></citerefentry>. By default all clients
409
will be approved immediately without delay.
412
This can be used to deny a client its secret if not manually
413
approved within a specified time. It can also be used to make
414
the server delay before giving a client its secret, allowing
415
optional manual denying of this specific client.
420
315
<refsect1 id="logging">
421
316
<title>LOGGING</title>
423
318
The server will send log message with various severity levels to
424
<filename class="devicefile">/dev/log</filename>. With the
319
<filename>/dev/log</filename>. With the
425
320
<option>--debug</option> option, it will log even more messages,
426
321
and also show them on the console.
430
<refsect1 id="persistent_state">
431
<title>PERSISTENT STATE</title>
433
Client settings, initially read from
434
<filename>clients.conf</filename>, are persistent across
435
restarts, and run-time changes will override settings in
436
<filename>clients.conf</filename>. However, if a setting is
437
<emphasis>changed</emphasis> (or a client added, or removed) in
438
<filename>clients.conf</filename>, this will take precedence.
442
<refsect1 id="dbus_interface">
443
<title>D-BUS INTERFACE</title>
445
The server will by default provide a D-Bus system bus interface.
446
This interface will only be accessible by the root user or a
447
Mandos-specific user, if such a user exists. For documentation
448
of the D-Bus API, see the file <filename>DBUS-API</filename>.
452
325
<refsect1 id="exit_status">
453
326
<title>EXIT STATUS</title>
509
382
<term><filename>/var/run/mandos.pid</filename></term>
512
The file containing the process id of the
513
<command>&COMMANDNAME;</command> process started last.
518
<term><filename class="devicefile">/dev/log</filename></term>
522
class="directory">/var/lib/mandos</filename></term>
525
Directory where persistent state will be saved. Change
526
this with the <option>--statedir</option> option. See
527
also the <option>--no-restore</option> option.
385
The file containing the process id of
386
<command>&COMMANDNAME;</command>.
558
417
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.
561
431
There is no fine-grained control over logging and debug output.
564
434
Debug mode is conflated with running in the foreground.
437
The console log messages does not show a time stamp.
567
440
This server does not check the expire time of clients’ OpenPGP
582
455
<informalexample>
584
457
Run the server in debug mode, read configuration files from
585
the <filename class="directory">~/mandos</filename> directory,
586
and use the Zeroconf service name <quote>Test</quote> to not
587
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:
639
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 <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
642
531
For more details on client-side security, see
643
532
<citerefentry><refentrytitle>mandos-client</refentrytitle>
644
533
<manvolnum>8mandos</manvolnum></citerefentry>.
649
538
<refsect1 id="see_also">
650
539
<title>SEE ALSO</title>
652
<citerefentry><refentrytitle>intro</refentrytitle>
653
<manvolnum>8mandos</manvolnum></citerefentry>,
654
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
655
<manvolnum>5</manvolnum></citerefentry>,
656
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
657
<manvolnum>5</manvolnum></citerefentry>,
658
<citerefentry><refentrytitle>mandos-client</refentrytitle>
659
<manvolnum>8mandos</manvolnum></citerefentry>,
660
<citerefentry><refentrytitle>sh</refentrytitle>
661
<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>mandos-client</refentrytitle>
547
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
added
removed
mandos.xml
