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-06">
5
<!ENTITY TIMESTAMP "2014-06-15">
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>
110
<arg><option>--no-zeroconf</option></arg>
88
113
<command>&COMMANDNAME;</command>
100
125
<arg choice="plain"><option>--check</option></arg>
102
127
</refsynopsisdiv>
104
129
<refsect1 id="description">
105
130
<title>DESCRIPTION</title>
107
132
<command>&COMMANDNAME;</command> is a server daemon which
108
133
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.
134
client host computers. For an introduction, see
135
<citerefentry><refentrytitle>intro</refentrytitle>
136
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
137
uses Zeroconf to announce itself on the local network, and uses
138
TLS to communicate securely with and to authenticate the
139
clients. The Mandos server uses IPv6 to allow Mandos clients to
140
use IPv6 link-local addresses, since the clients will probably
141
not have any other addresses configured (see <xref
142
linkend="overview"/>). Any authenticated client is then given
143
the stored pre-encrypted password for that specific client.
186
213
<xi:include href="mandos-options.xml" xpointer="debug"/>
218
<term><option>--debuglevel
219
<replaceable>LEVEL</replaceable></option></term>
222
Set the debugging log level.
223
<replaceable>LEVEL</replaceable> is a string, one of
224
<quote><literal>CRITICAL</literal></quote>,
225
<quote><literal>ERROR</literal></quote>,
226
<quote><literal>WARNING</literal></quote>,
227
<quote><literal>INFO</literal></quote>, or
228
<quote><literal>DEBUG</literal></quote>, in order of
229
increasing verbosity. The default level is
230
<quote><literal>WARNING</literal></quote>.
191
236
<term><option>--priority <replaceable>
192
237
PRIORITY</replaceable></option></term>
194
<xi:include href="mandos-options.xml" xpointer="priority"/>
239
<xi:include href="mandos-options.xml"
240
xpointer="priority_compat"/>
199
245
<term><option>--servicename
200
246
<replaceable>NAME</replaceable></option></term>
278
<term><option>--no-dbus</option></term>
280
<xi:include href="mandos-options.xml" xpointer="dbus"/>
282
See also <xref linkend="dbus_interface"/>.
288
<term><option>--no-ipv6</option></term>
290
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
295
<term><option>--no-restore</option></term>
297
<xi:include href="mandos-options.xml" xpointer="restore"/>
299
See also <xref linkend="persistent_state"/>.
305
<term><option>--statedir
306
<replaceable>DIRECTORY</replaceable></option></term>
308
<xi:include href="mandos-options.xml" xpointer="statedir"/>
313
<term><option>--socket
314
<replaceable>FD</replaceable></option></term>
316
<xi:include href="mandos-options.xml" xpointer="socket"/>
321
<term><option>--foreground</option></term>
323
<xi:include href="mandos-options.xml"
324
xpointer="foreground"/>
329
<term><option>--no-zeroconf</option></term>
331
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
233
338
<refsect1 id="overview">
234
339
<title>OVERVIEW</title>
235
340
<xi:include href="overview.xml"/>
298
403
</tbody></tgroup></table>
301
406
<refsect1 id="checking">
302
407
<title>CHECKING</title>
304
409
The server will, by default, continually check that the clients
305
410
are still up. If a client has not been confirmed as being up
306
411
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>
412
longer eligible to receive the encrypted password. (Manual
413
intervention is required to re-enable a client.) The timeout,
414
extended timeout, checker program, and interval between checks
415
can be configured both globally and per client; see
416
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
417
<manvolnum>5</manvolnum></citerefentry>.
421
<refsect1 id="approval">
422
<title>APPROVAL</title>
424
The server can be configured to require manual approval for a
425
client before it is sent its secret. The delay to wait for such
426
approval and the default action (approve or deny) can be
427
configured both globally and per client; see <citerefentry>
310
428
<refentrytitle>mandos-clients.conf</refentrytitle>
311
<manvolnum>5</manvolnum></citerefentry>.
429
<manvolnum>5</manvolnum></citerefentry>. By default all clients
430
will be approved immediately without delay.
433
This can be used to deny a client its secret if not manually
434
approved within a specified time. It can also be used to make
435
the server delay before giving a client its secret, allowing
436
optional manual denying of this specific client.
315
441
<refsect1 id="logging">
316
442
<title>LOGGING</title>
318
444
The server will send log message with various severity levels to
319
<filename>/dev/log</filename>. With the
445
<filename class="devicefile">/dev/log</filename>. With the
320
446
<option>--debug</option> option, it will log even more messages,
321
447
and also show them on the console.
451
<refsect1 id="persistent_state">
452
<title>PERSISTENT STATE</title>
454
Client settings, initially read from
455
<filename>clients.conf</filename>, are persistent across
456
restarts, and run-time changes will override settings in
457
<filename>clients.conf</filename>. However, if a setting is
458
<emphasis>changed</emphasis> (or a client added, or removed) in
459
<filename>clients.conf</filename>, this will take precedence.
463
<refsect1 id="dbus_interface">
464
<title>D-BUS INTERFACE</title>
466
The server will by default provide a D-Bus system bus interface.
467
This interface will only be accessible by the root user or a
468
Mandos-specific user, if such a user exists. For documentation
469
of the D-Bus API, see the file <filename>DBUS-API</filename>.
325
473
<refsect1 id="exit_status">
326
474
<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>.
530
<term><filename>/run/mandos.pid</filename></term>
533
The file containing the process id of the
534
<command>&COMMANDNAME;</command> process started last.
535
<emphasis >Note:</emphasis> If the <filename
536
class="directory">/run</filename> directory does not
537
exist, <filename>/var/run/mandos.pid</filename> will be
543
<term><filename class="devicefile">/dev/log</filename></term>
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.
417
583
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
586
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
589
This server does not check the expire time of clients’ OpenPGP
455
604
<informalexample>
457
606
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:
607
the <filename class="directory">~/mandos</filename> directory,
608
and use the Zeroconf service name <quote>Test</quote> to not
609
collide with any other official Mandos server on this host:
512
661
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
664
For more details on client-side security, see
532
665
<citerefentry><refentrytitle>mandos-client</refentrytitle>
533
666
<manvolnum>8mandos</manvolnum></citerefentry>.
538
671
<refsect1 id="see_also">
539
672
<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>mandos-client</refentrytitle>
547
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
674
<citerefentry><refentrytitle>intro</refentrytitle>
675
<manvolnum>8mandos</manvolnum></citerefentry>,
676
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
677
<manvolnum>5</manvolnum></citerefentry>,
678
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
679
<manvolnum>5</manvolnum></citerefentry>,
680
<citerefentry><refentrytitle>mandos-client</refentrytitle>
681
<manvolnum>8mandos</manvolnum></citerefentry>,
682
<citerefentry><refentrytitle>sh</refentrytitle>
683
<manvolnum>1</manvolnum></citerefentry>
added
removed
mandos.xml
