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
4
<!ENTITY COMMANDNAME "mandos">
5
<!ENTITY TIMESTAMP "2009-01-04">
5
<!ENTITY TIMESTAMP "2012-01-01">
6
6
<!ENTITY % common SYSTEM "common.ent">
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>
35
39
<holder>Teddy Hogeborn</holder>
36
40
<holder>Björn Påhlsson</holder>
86
90
<arg><option>--debug</option></arg>
92
<arg><option>--debuglevel
93
<replaceable>LEVEL</replaceable></option></arg>
88
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>
91
105
<command>&COMMANDNAME;</command>
110
124
<command>&COMMANDNAME;</command> is a server daemon which
111
125
handles incoming request for passwords for a pre-defined list of
112
client host computers. The Mandos server uses Zeroconf to
113
announce itself on the local network, and uses TLS to
114
communicate securely with and to authenticate the clients. The
115
Mandos server uses IPv6 to allow Mandos clients to use IPv6
116
link-local addresses, since the clients will probably not have
117
any other addresses configured (see <xref linkend="overview"/>).
118
Any authenticated client is then given the stored pre-encrypted
119
password for that specific client.
126
client host computers. For an introduction, see
127
<citerefentry><refentrytitle>intro</refentrytitle>
128
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
129
uses Zeroconf to announce itself on the local network, and uses
130
TLS to communicate securely with and to authenticate the
131
clients. The Mandos server uses IPv6 to allow Mandos clients to
132
use IPv6 link-local addresses, since the clients will probably
133
not have any other addresses configured (see <xref
134
linkend="overview"/>). Any authenticated client is then given
135
the stored pre-encrypted password for that specific client.
210
<term><option>--debuglevel
211
<replaceable>LEVEL</replaceable></option></term>
214
Set the debugging log level.
215
<replaceable>LEVEL</replaceable> is a string, one of
216
<quote><literal>CRITICAL</literal></quote>,
217
<quote><literal>ERROR</literal></quote>,
218
<quote><literal>WARNING</literal></quote>,
219
<quote><literal>INFO</literal></quote>, or
220
<quote><literal>DEBUG</literal></quote>, in order of
221
increasing verbosity. The default level is
222
<quote><literal>WARNING</literal></quote>.
194
228
<term><option>--priority <replaceable>
195
229
PRIORITY</replaceable></option></term>
279
<term><option>--no-ipv6</option></term>
281
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
286
<term><option>--no-restore</option></term>
288
<xi:include href="mandos-options.xml" xpointer="restore"/>
293
<term><option>--statedir
294
<replaceable>DIRECTORY</replaceable></option></term>
296
<xi:include href="mandos-options.xml" xpointer="statedir"/>
317
373
The server will, by default, continually check that the clients
318
374
are still up. If a client has not been confirmed as being up
319
375
for some time, the client is assumed to be compromised and is no
320
longer eligible to receive the encrypted password. The timeout,
321
checker program, and interval between checks can be configured
322
both globally and per client; see <citerefentry>
376
longer eligible to receive the encrypted password. (Manual
377
intervention is required to re-enable a client.) The timeout,
378
extended timeout, checker program, and interval between checks
379
can be configured both globally and per client; see
380
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
381
<manvolnum>5</manvolnum></citerefentry>. A client successfully
382
receiving its password will also be treated as a successful
387
<refsect1 id="approval">
388
<title>APPROVAL</title>
390
The server can be configured to require manual approval for a
391
client before it is sent its secret. The delay to wait for such
392
approval and the default action (approve or deny) can be
393
configured both globally and per client; see <citerefentry>
323
394
<refentrytitle>mandos-clients.conf</refentrytitle>
324
<manvolnum>5</manvolnum></citerefentry>.
395
<manvolnum>5</manvolnum></citerefentry>. By default all clients
396
will be approved immediately without delay.
399
This can be used to deny a client its secret if not manually
400
approved within a specified time. It can also be used to make
401
the server delay before giving a client its secret, allowing
402
optional manual denying of this specific client.
328
407
<refsect1 id="logging">
329
408
<title>LOGGING</title>
331
410
The server will send log message with various severity levels to
332
<filename>/dev/log</filename>. With the
411
<filename class="devicefile">/dev/log</filename>. With the
333
412
<option>--debug</option> option, it will log even more messages,
334
413
and also show them on the console.
341
420
The server will by default provide a D-Bus system bus interface.
342
421
This interface will only be accessible by the root user or a
343
Mandos-specific user, if such a user exists.
422
Mandos-specific user, if such a user exists. For documentation
423
of the D-Bus API, see the file <filename>DBUS-API</filename>.
348
427
<refsect1 id="exit_status">
349
428
<title>EXIT STATUS</title>
405
484
<term><filename>/var/run/mandos.pid</filename></term>
408
The file containing the process id of
409
<command>&COMMANDNAME;</command>.
487
The file containing the process id of the
488
<command>&COMMANDNAME;</command> process started last.
493
<term><filename class="devicefile">/dev/log</filename></term>
497
class="directory">/var/lib/mandos</filename></term>
500
Directory where persistent state will be saved. Change
501
this with the <option>--statedir</option> option. See
502
also the <option>--no-restore</option> option.
440
533
backtrace. This could be considered a feature.
443
Currently, if a client is declared <quote>invalid</quote> due to
444
having timed out, the server does not record this fact onto
445
permanent storage. This has some security implications, see
446
<xref linkend="clients"/>.
449
There is currently no way of querying the server of the current
450
status of clients, other than analyzing its <systemitem
451
class="service">syslog</systemitem> output.
454
536
There is no fine-grained control over logging and debug output.
457
539
Debug mode is conflated with running in the foreground.
460
The console log messages does not show a time stamp.
463
542
This server does not check the expire time of clients’ OpenPGP
478
557
<informalexample>
480
559
Run the server in debug mode, read configuration files from
481
the <filename>~/mandos</filename> directory, and use the
482
Zeroconf service name <quote>Test</quote> to not collide with
483
any other official Mandos server on this host:
560
the <filename class="directory">~/mandos</filename> directory,
561
and use the Zeroconf service name <quote>Test</quote> to not
562
collide with any other official Mandos server on this host:
535
614
compromised if they are gone for too long.
538
If a client is compromised, its downtime should be duly noted
539
by the server which would therefore declare the client
540
invalid. But if the server was ever restarted, it would
541
re-read its client list from its configuration file and again
542
regard all clients therein as valid, and hence eligible to
543
receive their passwords. Therefore, be careful when
544
restarting servers if it is suspected that a client has, in
545
fact, been compromised by parties who may now be running a
546
fake Mandos client with the keys from the non-encrypted
547
initial <acronym>RAM</acronym> image of the client host. What
548
should be done in that case (if restarting the server program
549
really is necessary) is to stop the server program, edit the
550
configuration file to omit any suspect clients, and restart
554
617
For more details on client-side security, see
555
618
<citerefentry><refentrytitle>mandos-client</refentrytitle>
556
619
<manvolnum>8mandos</manvolnum></citerefentry>.
561
624
<refsect1 id="see_also">
562
625
<title>SEE ALSO</title>
565
<refentrytitle>mandos-clients.conf</refentrytitle>
566
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
567
<refentrytitle>mandos.conf</refentrytitle>
568
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
569
<refentrytitle>mandos-client</refentrytitle>
570
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
571
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
627
<citerefentry><refentrytitle>intro</refentrytitle>
628
<manvolnum>8mandos</manvolnum></citerefentry>,
629
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
630
<manvolnum>5</manvolnum></citerefentry>,
631
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
632
<manvolnum>5</manvolnum></citerefentry>,
633
<citerefentry><refentrytitle>mandos-client</refentrytitle>
634
<manvolnum>8mandos</manvolnum></citerefentry>,
635
<citerefentry><refentrytitle>sh</refentrytitle>
636
<manvolnum>1</manvolnum></citerefentry>