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>
96
<arg><option>--no-dbus</option></arg>
89
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>
92
111
<command>&COMMANDNAME;</command>
111
130
<command>&COMMANDNAME;</command> is a server daemon which
112
131
handles incoming request for passwords for a pre-defined list of
113
client host computers. The Mandos server uses Zeroconf to
114
announce itself on the local network, and uses TLS to
115
communicate securely with and to authenticate the clients. The
116
Mandos server uses IPv6 to allow Mandos clients to use IPv6
117
link-local addresses, since the clients will probably not have
118
any other addresses configured (see <xref linkend="overview"/>).
119
Any authenticated client is then given the stored pre-encrypted
120
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.
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>.
195
234
<term><option>--priority <replaceable>
196
235
PRIORITY</replaceable></option></term>
275
<term><option>--no-dbus</option></term>
277
<xi:include href="mandos-options.xml" xpointer="dbus"/>
279
See also <xref linkend="dbus_interface"/>.
236
285
<term><option>--no-ipv6</option></term>
238
287
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
292
<term><option>--no-restore</option></term>
294
<xi:include href="mandos-options.xml" xpointer="restore"/>
296
See also <xref linkend="persistent_state"/>.
302
<term><option>--statedir
303
<replaceable>DIRECTORY</replaceable></option></term>
305
<xi:include href="mandos-options.xml" xpointer="statedir"/>
310
<term><option>--socket
311
<replaceable>FD</replaceable></option></term>
313
<xi:include href="mandos-options.xml" xpointer="socket"/>
318
<term><option>--foreground</option></term>
320
<xi:include href="mandos-options.xml"
321
xpointer="foreground"/>
315
399
The server will, by default, continually check that the clients
316
400
are still up. If a client has not been confirmed as being up
317
401
for some time, the client is assumed to be compromised and is no
318
longer eligible to receive the encrypted password. The timeout,
319
checker program, and interval between checks can be configured
320
both globally and per client; see <citerefentry>
402
longer eligible to receive the encrypted password. (Manual
403
intervention is required to re-enable a client.) The timeout,
404
extended timeout, checker program, and interval between checks
405
can be configured both globally and per client; see
406
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
407
<manvolnum>5</manvolnum></citerefentry>.
411
<refsect1 id="approval">
412
<title>APPROVAL</title>
414
The server can be configured to require manual approval for a
415
client before it is sent its secret. The delay to wait for such
416
approval and the default action (approve or deny) can be
417
configured both globally and per client; see <citerefentry>
321
418
<refentrytitle>mandos-clients.conf</refentrytitle>
322
<manvolnum>5</manvolnum></citerefentry>.
419
<manvolnum>5</manvolnum></citerefentry>. By default all clients
420
will be approved immediately without delay.
423
This can be used to deny a client its secret if not manually
424
approved within a specified time. It can also be used to make
425
the server delay before giving a client its secret, allowing
426
optional manual denying of this specific client.
326
431
<refsect1 id="logging">
327
432
<title>LOGGING</title>
329
434
The server will send log message with various severity levels to
330
<filename>/dev/log</filename>. With the
435
<filename class="devicefile">/dev/log</filename>. With the
331
436
<option>--debug</option> option, it will log even more messages,
332
437
and also show them on the console.
441
<refsect1 id="persistent_state">
442
<title>PERSISTENT STATE</title>
444
Client settings, initially read from
445
<filename>clients.conf</filename>, are persistent across
446
restarts, and run-time changes will override settings in
447
<filename>clients.conf</filename>. However, if a setting is
448
<emphasis>changed</emphasis> (or a client added, or removed) in
449
<filename>clients.conf</filename>, this will take precedence.
453
<refsect1 id="dbus_interface">
454
<title>D-BUS INTERFACE</title>
456
The server will by default provide a D-Bus system bus interface.
457
This interface will only be accessible by the root user or a
458
Mandos-specific user, if such a user exists. For documentation
459
of the D-Bus API, see the file <filename>DBUS-API</filename>.
336
463
<refsect1 id="exit_status">
337
464
<title>EXIT STATUS</title>
393
<term><filename>/var/run/mandos.pid</filename></term>
396
The file containing the process id of
397
<command>&COMMANDNAME;</command>.
520
<term><filename>/run/mandos.pid</filename></term>
523
The file containing the process id of the
524
<command>&COMMANDNAME;</command> process started last.
529
<term><filename class="devicefile">/dev/log</filename></term>
533
class="directory">/var/lib/mandos</filename></term>
536
Directory where persistent state will be saved. Change
537
this with the <option>--statedir</option> option. See
538
also the <option>--no-restore</option> option.
428
569
backtrace. This could be considered a feature.
431
Currently, if a client is declared <quote>invalid</quote> due to
432
having timed out, the server does not record this fact onto
433
permanent storage. This has some security implications, see
434
<xref linkend="clients"/>.
437
There is currently no way of querying the server of the current
438
status of clients, other than analyzing its <systemitem
439
class="service">syslog</systemitem> output.
442
572
There is no fine-grained control over logging and debug output.
445
Debug mode is conflated with running in the foreground.
448
The console log messages do not show a time stamp.
451
575
This server does not check the expire time of clients’ OpenPGP
466
590
<informalexample>
468
592
Run the server in debug mode, read configuration files from
469
the <filename>~/mandos</filename> directory, and use the
470
Zeroconf service name <quote>Test</quote> to not collide with
471
any other official Mandos server on this host:
593
the <filename class="directory">~/mandos</filename> directory,
594
and use the Zeroconf service name <quote>Test</quote> to not
595
collide with any other official Mandos server on this host:
523
647
compromised if they are gone for too long.
526
If a client is compromised, its downtime should be duly noted
527
by the server which would therefore declare the client
528
invalid. But if the server was ever restarted, it would
529
re-read its client list from its configuration file and again
530
regard all clients therein as valid, and hence eligible to
531
receive their passwords. Therefore, be careful when
532
restarting servers if it is suspected that a client has, in
533
fact, been compromised by parties who may now be running a
534
fake Mandos client with the keys from the non-encrypted
535
initial <acronym>RAM</acronym> image of the client host. What
536
should be done in that case (if restarting the server program
537
really is necessary) is to stop the server program, edit the
538
configuration file to omit any suspect clients, and restart
542
650
For more details on client-side security, see
543
651
<citerefentry><refentrytitle>mandos-client</refentrytitle>
544
652
<manvolnum>8mandos</manvolnum></citerefentry>.
549
657
<refsect1 id="see_also">
550
658
<title>SEE ALSO</title>
553
<refentrytitle>mandos-clients.conf</refentrytitle>
554
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
555
<refentrytitle>mandos.conf</refentrytitle>
556
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
557
<refentrytitle>mandos-client</refentrytitle>
558
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
559
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
660
<citerefentry><refentrytitle>intro</refentrytitle>
661
<manvolnum>8mandos</manvolnum></citerefentry>,
662
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
663
<manvolnum>5</manvolnum></citerefentry>,
664
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
665
<manvolnum>5</manvolnum></citerefentry>,
666
<citerefentry><refentrytitle>mandos-client</refentrytitle>
667
<manvolnum>8mandos</manvolnum></citerefentry>,
668
<citerefentry><refentrytitle>sh</refentrytitle>
669
<manvolnum>1</manvolnum></citerefentry>