19
19
<firstname>Björn</firstname>
20
20
<surname>Påhlsson</surname>
22
<email>belorn@fukt.bsnet.se</email>
22
<email>belorn@recompile.se</email>
26
26
<firstname>Teddy</firstname>
27
27
<surname>Hogeborn</surname>
29
<email>teddy@fukt.bsnet.se</email>
29
<email>teddy@recompile.se</email>
36
40
<holder>Teddy Hogeborn</holder>
37
41
<holder>Björn Påhlsson</holder>
87
91
<arg><option>--debug</option></arg>
93
<arg><option>--debuglevel
94
<replaceable>LEVEL</replaceable></option></arg>
89
96
<arg><option>--no-dbus</option></arg>
91
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>
94
113
<command>&COMMANDNAME;</command>
113
132
<command>&COMMANDNAME;</command> is a server daemon which
114
133
handles incoming request for passwords for a pre-defined list of
115
client host computers. The Mandos server uses Zeroconf to
116
announce itself on the local network, and uses TLS to
117
communicate securely with and to authenticate the clients. The
118
Mandos server uses IPv6 to allow Mandos clients to use IPv6
119
link-local addresses, since the clients will probably not have
120
any other addresses configured (see <xref linkend="overview"/>).
121
Any authenticated client is then given the stored pre-encrypted
122
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.
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>.
197
236
<term><option>--priority <replaceable>
198
237
PRIORITY</replaceable></option></term>
250
289
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
294
<term><option>--no-restore</option></term>
296
<xi:include href="mandos-options.xml" xpointer="restore"/>
298
See also <xref linkend="persistent_state"/>.
304
<term><option>--statedir
305
<replaceable>DIRECTORY</replaceable></option></term>
307
<xi:include href="mandos-options.xml" xpointer="statedir"/>
312
<term><option>--socket
313
<replaceable>FD</replaceable></option></term>
315
<xi:include href="mandos-options.xml" xpointer="socket"/>
320
<term><option>--foreground</option></term>
322
<xi:include href="mandos-options.xml"
323
xpointer="foreground"/>
328
<term><option>--no-zeroconf</option></term>
330
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
327
408
The server will, by default, continually check that the clients
328
409
are still up. If a client has not been confirmed as being up
329
410
for some time, the client is assumed to be compromised and is no
330
longer eligible to receive the encrypted password. The timeout,
331
checker program, and interval between checks can be configured
332
both globally and per client; see <citerefentry>
411
longer eligible to receive the encrypted password. (Manual
412
intervention is required to re-enable a client.) The timeout,
413
extended timeout, checker program, and interval between checks
414
can be configured both globally and per client; see
415
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
416
<manvolnum>5</manvolnum></citerefentry>.
420
<refsect1 id="approval">
421
<title>APPROVAL</title>
423
The server can be configured to require manual approval for a
424
client before it is sent its secret. The delay to wait for such
425
approval and the default action (approve or deny) can be
426
configured both globally and per client; see <citerefentry>
333
427
<refentrytitle>mandos-clients.conf</refentrytitle>
334
<manvolnum>5</manvolnum></citerefentry>.
428
<manvolnum>5</manvolnum></citerefentry>. By default all clients
429
will be approved immediately without delay.
432
This can be used to deny a client its secret if not manually
433
approved within a specified time. It can also be used to make
434
the server delay before giving a client its secret, allowing
435
optional manual denying of this specific client.
338
440
<refsect1 id="logging">
339
441
<title>LOGGING</title>
341
443
The server will send log message with various severity levels to
342
<filename>/dev/log</filename>. With the
444
<filename class="devicefile">/dev/log</filename>. With the
343
445
<option>--debug</option> option, it will log even more messages,
344
446
and also show them on the console.
450
<refsect1 id="persistent_state">
451
<title>PERSISTENT STATE</title>
453
Client settings, initially read from
454
<filename>clients.conf</filename>, are persistent across
455
restarts, and run-time changes will override settings in
456
<filename>clients.conf</filename>. However, if a setting is
457
<emphasis>changed</emphasis> (or a client added, or removed) in
458
<filename>clients.conf</filename>, this will take precedence.
348
462
<refsect1 id="dbus_interface">
349
463
<title>D-BUS INTERFACE</title>
351
465
The server will by default provide a D-Bus system bus interface.
352
466
This interface will only be accessible by the root user or a
353
Mandos-specific user, if such a user exists.
467
Mandos-specific user, if such a user exists. For documentation
468
of the D-Bus API, see the file <filename>DBUS-API</filename>.
415
<term><filename>/var/run/mandos.pid</filename></term>
418
The file containing the process id of
419
<command>&COMMANDNAME;</command>.
529
<term><filename>/run/mandos.pid</filename></term>
532
The file containing the process id of the
533
<command>&COMMANDNAME;</command> process started last.
534
<emphasis >Note:</emphasis> If the <filename
535
class="directory">/run</filename> directory does not
536
exist, <filename>/var/run/mandos.pid</filename> will be
542
<term><filename class="devicefile">/dev/log</filename></term>
546
class="directory">/var/lib/mandos</filename></term>
549
Directory where persistent state will be saved. Change
550
this with the <option>--statedir</option> option. See
551
also the <option>--no-restore</option> option.
450
582
backtrace. This could be considered a feature.
453
Currently, if a client is declared <quote>invalid</quote> due to
454
having timed out, the server does not record this fact onto
455
permanent storage. This has some security implications, see
456
<xref linkend="clients"/>.
459
There is currently no way of querying the server of the current
460
status of clients, other than analyzing its <systemitem
461
class="service">syslog</systemitem> output.
464
585
There is no fine-grained control over logging and debug output.
467
Debug mode is conflated with running in the foreground.
470
The console log messages do not show a time stamp.
473
588
This server does not check the expire time of clients’ OpenPGP
488
603
<informalexample>
490
605
Run the server in debug mode, read configuration files from
491
the <filename>~/mandos</filename> directory, and use the
492
Zeroconf service name <quote>Test</quote> to not collide with
493
any other official Mandos server on this host:
606
the <filename class="directory">~/mandos</filename> directory,
607
and use the Zeroconf service name <quote>Test</quote> to not
608
collide with any other official Mandos server on this host:
545
660
compromised if they are gone for too long.
548
If a client is compromised, its downtime should be duly noted
549
by the server which would therefore declare the client
550
invalid. But if the server was ever restarted, it would
551
re-read its client list from its configuration file and again
552
regard all clients therein as valid, and hence eligible to
553
receive their passwords. Therefore, be careful when
554
restarting servers if it is suspected that a client has, in
555
fact, been compromised by parties who may now be running a
556
fake Mandos client with the keys from the non-encrypted
557
initial <acronym>RAM</acronym> image of the client host. What
558
should be done in that case (if restarting the server program
559
really is necessary) is to stop the server program, edit the
560
configuration file to omit any suspect clients, and restart
564
663
For more details on client-side security, see
565
664
<citerefentry><refentrytitle>mandos-client</refentrytitle>
566
665
<manvolnum>8mandos</manvolnum></citerefentry>.
571
670
<refsect1 id="see_also">
572
671
<title>SEE ALSO</title>
575
<refentrytitle>mandos-clients.conf</refentrytitle>
576
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
577
<refentrytitle>mandos.conf</refentrytitle>
578
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
579
<refentrytitle>mandos-client</refentrytitle>
580
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
581
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
673
<citerefentry><refentrytitle>intro</refentrytitle>
674
<manvolnum>8mandos</manvolnum></citerefentry>,
675
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
676
<manvolnum>5</manvolnum></citerefentry>,
677
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
678
<manvolnum>5</manvolnum></citerefentry>,
679
<citerefentry><refentrytitle>mandos-client</refentrytitle>
680
<manvolnum>8mandos</manvolnum></citerefentry>,
681
<citerefentry><refentrytitle>sh</refentrytitle>
682
<manvolnum>1</manvolnum></citerefentry>
added
removed
mandos.xml
