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 "2012-01-01">
5
<!ENTITY TIMESTAMP "2009-09-17">
6
6
<!ENTITY % common SYSTEM "common.ent">
19
19
<firstname>Björn</firstname>
20
20
<surname>Påhlsson</surname>
22
<email>belorn@recompile.se</email>
22
<email>belorn@fukt.bsnet.se</email>
26
26
<firstname>Teddy</firstname>
27
27
<surname>Hogeborn</surname>
29
<email>teddy@recompile.se</email>
29
<email>teddy@fukt.bsnet.se</email>
39
36
<holder>Teddy Hogeborn</holder>
40
37
<holder>Björn Påhlsson</holder>
90
87
<arg><option>--debug</option></arg>
92
<arg><option>--debuglevel
93
<replaceable>LEVEL</replaceable></option></arg>
95
89
<arg><option>--no-dbus</option></arg>
97
91
<arg><option>--no-ipv6</option></arg>
99
<arg><option>--no-restore</option></arg>
101
<arg><option>--statedir
102
<replaceable>DIRECTORY</replaceable></option></arg>
105
94
<command>&COMMANDNAME;</command>
124
113
<command>&COMMANDNAME;</command> is a server daemon which
125
114
handles incoming request for passwords for a pre-defined list of
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.
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.
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>.
228
197
<term><option>--priority <replaceable>
229
198
PRIORITY</replaceable></option></term>
281
250
<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"/>
375
329
for some time, the client is assumed to be compromised and is no
376
330
longer eligible to receive the encrypted password. (Manual
377
331
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>
332
checker program, and interval between checks can be configured
333
both globally and per client; see <citerefentry>
334
<refentrytitle>mandos-clients.conf</refentrytitle>
381
335
<manvolnum>5</manvolnum></citerefentry>. A client successfully
382
336
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>
394
<refentrytitle>mandos-clients.conf</refentrytitle>
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.
407
341
<refsect1 id="logging">
408
342
<title>LOGGING</title>
410
344
The server will send log message with various severity levels to
411
<filename class="devicefile">/dev/log</filename>. With the
345
<filename>/dev/log</filename>. With the
412
346
<option>--debug</option> option, it will log even more messages,
413
347
and also show them on the console.
420
354
The server will by default provide a D-Bus system bus interface.
421
355
This interface will only be accessible by the root user or a
422
Mandos-specific user, if such a user exists. For documentation
423
of the D-Bus API, see the file <filename>DBUS-API</filename>.
356
Mandos-specific user, if such a user exists.
484
418
<term><filename>/var/run/mandos.pid</filename></term>
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.
421
The file containing the process id of
422
<command>&COMMANDNAME;</command>.
533
453
backtrace. This could be considered a feature.
456
Currently, if a client is declared <quote>invalid</quote> due to
457
having timed out, the server does not record this fact onto
458
permanent storage. This has some security implications, see
459
<xref linkend="clients"/>.
462
There is currently no way of querying the server of the current
463
status of clients, other than analyzing its <systemitem
464
class="service">syslog</systemitem> output.
536
467
There is no fine-grained control over logging and debug output.
539
470
Debug mode is conflated with running in the foreground.
473
The console log messages do not show a time stamp.
542
476
This server does not check the expire time of clients’ OpenPGP
557
491
<informalexample>
559
493
Run the server in debug mode, read configuration files from
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:
494
the <filename>~/mandos</filename> directory, and use the
495
Zeroconf service name <quote>Test</quote> to not collide with
496
any other official Mandos server on this host:
614
548
compromised if they are gone for too long.
551
If a client is compromised, its downtime should be duly noted
552
by the server which would therefore declare the client
553
invalid. But if the server was ever restarted, it would
554
re-read its client list from its configuration file and again
555
regard all clients therein as valid, and hence eligible to
556
receive their passwords. Therefore, be careful when
557
restarting servers if it is suspected that a client has, in
558
fact, been compromised by parties who may now be running a
559
fake Mandos client with the keys from the non-encrypted
560
initial <acronym>RAM</acronym> image of the client host. What
561
should be done in that case (if restarting the server program
562
really is necessary) is to stop the server program, edit the
563
configuration file to omit any suspect clients, and restart
617
567
For more details on client-side security, see
618
568
<citerefentry><refentrytitle>mandos-client</refentrytitle>
619
569
<manvolnum>8mandos</manvolnum></citerefentry>.
624
574
<refsect1 id="see_also">
625
575
<title>SEE ALSO</title>
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>
578
<refentrytitle>mandos-clients.conf</refentrytitle>
579
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
580
<refentrytitle>mandos.conf</refentrytitle>
581
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
582
<refentrytitle>mandos-client</refentrytitle>
583
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
584
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
added
removed
mandos.xml
