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
45
<holder>Teddy Hogeborn</holder>
37
46
<holder>Björn Påhlsson</holder>
85
94
<replaceable>DIRECTORY</replaceable></option></arg>
87
96
<arg><option>--debug</option></arg>
98
<arg><option>--debuglevel
99
<replaceable>LEVEL</replaceable></option></arg>
101
<arg><option>--no-dbus</option></arg>
103
<arg><option>--no-ipv6</option></arg>
105
<arg><option>--no-restore</option></arg>
107
<arg><option>--statedir
108
<replaceable>DIRECTORY</replaceable></option></arg>
110
<arg><option>--socket
111
<replaceable>FD</replaceable></option></arg>
113
<arg><option>--foreground</option></arg>
115
<arg><option>--no-zeroconf</option></arg>
90
118
<command>&COMMANDNAME;</command>
109
137
<command>&COMMANDNAME;</command> is a server daemon which
110
138
handles incoming request for passwords for a pre-defined list of
111
client host computers. The Mandos server uses Zeroconf to
112
announce itself on the local network, and uses TLS to
113
communicate securely with and to authenticate the clients. The
114
Mandos server uses IPv6 to allow Mandos clients to use IPv6
115
link-local addresses, since the clients will probably not have
116
any other addresses configured (see <xref linkend="overview"/>).
117
Any authenticated client is then given the stored pre-encrypted
118
password for that specific client.
139
client host computers. For an introduction, see
140
<citerefentry><refentrytitle>intro</refentrytitle>
141
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
142
uses Zeroconf to announce itself on the local network, and uses
143
TLS to communicate securely with and to authenticate the
144
clients. The Mandos server uses IPv6 to allow Mandos clients to
145
use IPv6 link-local addresses, since the clients will probably
146
not have any other addresses configured (see <xref
147
linkend="overview"/>). Any authenticated client is then given
148
the stored pre-encrypted password for that specific client.
223
<term><option>--debuglevel
224
<replaceable>LEVEL</replaceable></option></term>
227
Set the debugging log level.
228
<replaceable>LEVEL</replaceable> is a string, one of
229
<quote><literal>CRITICAL</literal></quote>,
230
<quote><literal>ERROR</literal></quote>,
231
<quote><literal>WARNING</literal></quote>,
232
<quote><literal>INFO</literal></quote>, or
233
<quote><literal>DEBUG</literal></quote>, in order of
234
increasing verbosity. The default level is
235
<quote><literal>WARNING</literal></quote>.
193
241
<term><option>--priority <replaceable>
194
242
PRIORITY</replaceable></option></term>
282
<term><option>--no-dbus</option></term>
284
<xi:include href="mandos-options.xml" xpointer="dbus"/>
286
See also <xref linkend="dbus_interface"/>.
292
<term><option>--no-ipv6</option></term>
294
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
299
<term><option>--no-restore</option></term>
301
<xi:include href="mandos-options.xml" xpointer="restore"/>
303
See also <xref linkend="persistent_state"/>.
309
<term><option>--statedir
310
<replaceable>DIRECTORY</replaceable></option></term>
312
<xi:include href="mandos-options.xml" xpointer="statedir"/>
317
<term><option>--socket
318
<replaceable>FD</replaceable></option></term>
320
<xi:include href="mandos-options.xml" xpointer="socket"/>
325
<term><option>--foreground</option></term>
327
<xi:include href="mandos-options.xml"
328
xpointer="foreground"/>
333
<term><option>--no-zeroconf</option></term>
335
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
306
413
The server will, by default, continually check that the clients
307
414
are still up. If a client has not been confirmed as being up
308
415
for some time, the client is assumed to be compromised and is no
309
longer eligible to receive the encrypted password. The timeout,
310
checker program, and interval between checks can be configured
311
both globally and per client; see <citerefentry>
416
longer eligible to receive the encrypted password. (Manual
417
intervention is required to re-enable a client.) The timeout,
418
extended timeout, checker program, and interval between checks
419
can be configured both globally and per client; see
420
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
421
<manvolnum>5</manvolnum></citerefentry>.
425
<refsect1 id="approval">
426
<title>APPROVAL</title>
428
The server can be configured to require manual approval for a
429
client before it is sent its secret. The delay to wait for such
430
approval and the default action (approve or deny) can be
431
configured both globally and per client; see <citerefentry>
312
432
<refentrytitle>mandos-clients.conf</refentrytitle>
313
<manvolnum>5</manvolnum></citerefentry>.
433
<manvolnum>5</manvolnum></citerefentry>. By default all clients
434
will be approved immediately without delay.
437
This can be used to deny a client its secret if not manually
438
approved within a specified time. It can also be used to make
439
the server delay before giving a client its secret, allowing
440
optional manual denying of this specific client.
317
445
<refsect1 id="logging">
318
446
<title>LOGGING</title>
320
448
The server will send log message with various severity levels to
321
<filename>/dev/log</filename>. With the
449
<filename class="devicefile">/dev/log</filename>. With the
322
450
<option>--debug</option> option, it will log even more messages,
323
451
and also show them on the console.
455
<refsect1 id="persistent_state">
456
<title>PERSISTENT STATE</title>
458
Client settings, initially read from
459
<filename>clients.conf</filename>, are persistent across
460
restarts, and run-time changes will override settings in
461
<filename>clients.conf</filename>. However, if a setting is
462
<emphasis>changed</emphasis> (or a client added, or removed) in
463
<filename>clients.conf</filename>, this will take precedence.
467
<refsect1 id="dbus_interface">
468
<title>D-BUS INTERFACE</title>
470
The server will by default provide a D-Bus system bus interface.
471
This interface will only be accessible by the root user or a
472
Mandos-specific user, if such a user exists. For documentation
473
of the D-Bus API, see the file <filename>DBUS-API</filename>.
327
477
<refsect1 id="exit_status">
328
478
<title>EXIT STATUS</title>
384
<term><filename>/var/run/mandos.pid</filename></term>
387
The file containing the process id of
388
<command>&COMMANDNAME;</command>.
393
<term><filename>/dev/log</filename></term>
534
<term><filename>/run/mandos.pid</filename></term>
537
The file containing the process id of the
538
<command>&COMMANDNAME;</command> process started last.
539
<emphasis >Note:</emphasis> If the <filename
540
class="directory">/run</filename> directory does not
541
exist, <filename>/var/run/mandos.pid</filename> will be
548
class="directory">/var/lib/mandos</filename></term>
551
Directory where persistent state will be saved. Change
552
this with the <option>--statedir</option> option. See
553
also the <option>--no-restore</option> option.
558
<term><filename class="devicefile">/dev/log</filename></term>
396
561
The Unix domain socket to where local syslog messages are
419
584
backtrace. This could be considered a feature.
422
Currently, if a client is declared <quote>invalid</quote> due to
423
having timed out, the server does not record this fact onto
424
permanent storage. This has some security implications, see
425
<xref linkend="clients"/>.
428
There is currently no way of querying the server of the current
429
status of clients, other than analyzing its <systemitem
430
class="service">syslog</systemitem> output.
433
587
There is no fine-grained control over logging and debug output.
436
Debug mode is conflated with running in the foreground.
439
The console log messages does not show a time stamp.
442
590
This server does not check the expire time of clients’ OpenPGP
593
<xi:include href="bugs.xml"/>
447
596
<refsect1 id="example">
457
606
<informalexample>
459
608
Run the server in debug mode, read configuration files from
460
the <filename>~/mandos</filename> directory, and use the
461
Zeroconf service name <quote>Test</quote> to not collide with
462
any other official Mandos server on this host:
609
the <filename class="directory">~/mandos</filename> directory,
610
and use the Zeroconf service name <quote>Test</quote> to not
611
collide with any other official Mandos server on this host:
514
663
compromised if they are gone for too long.
517
If a client is compromised, its downtime should be duly noted
518
by the server which would therefore declare the client
519
invalid. But if the server was ever restarted, it would
520
re-read its client list from its configuration file and again
521
regard all clients therein as valid, and hence eligible to
522
receive their passwords. Therefore, be careful when
523
restarting servers if it is suspected that a client has, in
524
fact, been compromised by parties who may now be running a
525
fake Mandos client with the keys from the non-encrypted
526
initial <acronym>RAM</acronym> image of the client host. What
527
should be done in that case (if restarting the server program
528
really is necessary) is to stop the server program, edit the
529
configuration file to omit any suspect clients, and restart
533
666
For more details on client-side security, see
534
667
<citerefentry><refentrytitle>mandos-client</refentrytitle>
535
668
<manvolnum>8mandos</manvolnum></citerefentry>.
540
673
<refsect1 id="see_also">
541
674
<title>SEE ALSO</title>
544
<refentrytitle>mandos-clients.conf</refentrytitle>
545
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
<refentrytitle>mandos.conf</refentrytitle>
547
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
548
<refentrytitle>mandos-client</refentrytitle>
549
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
550
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
676
<citerefentry><refentrytitle>intro</refentrytitle>
677
<manvolnum>8mandos</manvolnum></citerefentry>,
678
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
679
<manvolnum>5</manvolnum></citerefentry>,
680
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
681
<manvolnum>5</manvolnum></citerefentry>,
682
<citerefentry><refentrytitle>mandos-client</refentrytitle>
683
<manvolnum>8mandos</manvolnum></citerefentry>,
684
<citerefentry><refentrytitle>sh</refentrytitle>
685
<manvolnum>1</manvolnum></citerefentry>
added
removed
mandos.xml
