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-02-13">
5
<!ENTITY TIMESTAMP "2011-11-26">
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>
36
38
<holder>Teddy Hogeborn</holder>
37
39
<holder>Björn Påhlsson</holder>
87
89
<arg><option>--debug</option></arg>
91
<arg><option>--debuglevel
92
<replaceable>LEVEL</replaceable></option></arg>
89
94
<arg><option>--no-dbus</option></arg>
91
96
<arg><option>--no-ipv6</option></arg>
98
<arg><option>--no-restore</option></arg>
100
<arg><option>--statedir
101
<replaceable>DIRECTORY</replaceable></option></arg>
94
104
<command>&COMMANDNAME;</command>
113
123
<command>&COMMANDNAME;</command> is a server daemon which
114
124
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.
125
client host computers. For an introduction, see
126
<citerefentry><refentrytitle>intro</refentrytitle>
127
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
128
uses Zeroconf to announce itself on the local network, and uses
129
TLS to communicate securely with and to authenticate the
130
clients. The Mandos server uses IPv6 to allow Mandos clients to
131
use IPv6 link-local addresses, since the clients will probably
132
not have any other addresses configured (see <xref
133
linkend="overview"/>). Any authenticated client is then given
134
the stored pre-encrypted password for that specific client.
209
<term><option>--debuglevel
210
<replaceable>LEVEL</replaceable></option></term>
213
Set the debugging log level.
214
<replaceable>LEVEL</replaceable> is a string, one of
215
<quote><literal>CRITICAL</literal></quote>,
216
<quote><literal>ERROR</literal></quote>,
217
<quote><literal>WARNING</literal></quote>,
218
<quote><literal>INFO</literal></quote>, or
219
<quote><literal>DEBUG</literal></quote>, in order of
220
increasing verbosity. The default level is
221
<quote><literal>WARNING</literal></quote>.
197
227
<term><option>--priority <replaceable>
198
228
PRIORITY</replaceable></option></term>
250
280
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
285
<term><option>--no-restore</option></term>
287
<xi:include href="mandos-options.xml" xpointer="restore"/>
292
<term><option>--statedir
293
<replaceable>DIRECTORY</replaceable></option></term>
295
<xi:include href="mandos-options.xml" xpointer="statedir"/>
327
372
The server will, by default, continually check that the clients
328
373
are still up. If a client has not been confirmed as being up
329
374
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>
375
longer eligible to receive the encrypted password. (Manual
376
intervention is required to re-enable a client.) The timeout,
377
extended timeout, checker program, and interval between checks
378
can be configured both globally and per client; see
379
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
380
<manvolnum>5</manvolnum></citerefentry>. A client successfully
381
receiving its password will also be treated as a successful
386
<refsect1 id="approval">
387
<title>APPROVAL</title>
389
The server can be configured to require manual approval for a
390
client before it is sent its secret. The delay to wait for such
391
approval and the default action (approve or deny) can be
392
configured both globally and per client; see <citerefentry>
333
393
<refentrytitle>mandos-clients.conf</refentrytitle>
334
<manvolnum>5</manvolnum></citerefentry>.
394
<manvolnum>5</manvolnum></citerefentry>. By default all clients
395
will be approved immediately without delay.
398
This can be used to deny a client its secret if not manually
399
approved within a specified time. It can also be used to make
400
the server delay before giving a client its secret, allowing
401
optional manual denying of this specific client.
338
406
<refsect1 id="logging">
339
407
<title>LOGGING</title>
341
409
The server will send log message with various severity levels to
342
<filename>/dev/log</filename>. With the
410
<filename class="devicefile">/dev/log</filename>. With the
343
411
<option>--debug</option> option, it will log even more messages,
344
412
and also show them on the console.
351
419
The server will by default provide a D-Bus system bus interface.
352
420
This interface will only be accessible by the root user or a
353
Mandos-specific user, if such a user exists.
421
Mandos-specific user, if such a user exists. For documentation
422
of the D-Bus API, see the file <filename>DBUS-API</filename>.
415
483
<term><filename>/var/run/mandos.pid</filename></term>
418
The file containing the process id of
419
<command>&COMMANDNAME;</command>.
486
The file containing the process id of the
487
<command>&COMMANDNAME;</command> process started last.
492
<term><filename class="devicefile">/dev/log</filename></term>
496
class="directory">/var/lib/mandos</filename></term>
499
Directory where persistent state will be saved. Change
500
this with the <option>--statedir</option> option. See
501
also the <option>--no-restore</option> option.
450
532
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
535
There is no fine-grained control over logging and debug output.
467
538
Debug mode is conflated with running in the foreground.
470
The console log messages does not show a time stamp.
473
541
This server does not check the expire time of clients’ OpenPGP
488
556
<informalexample>
490
558
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:
559
the <filename class="directory">~/mandos</filename> directory,
560
and use the Zeroconf service name <quote>Test</quote> to not
561
collide with any other official Mandos server on this host:
545
613
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
616
For more details on client-side security, see
565
617
<citerefentry><refentrytitle>mandos-client</refentrytitle>
566
618
<manvolnum>8mandos</manvolnum></citerefentry>.
571
623
<refsect1 id="see_also">
572
624
<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>
626
<citerefentry><refentrytitle>intro</refentrytitle>
627
<manvolnum>8mandos</manvolnum></citerefentry>,
628
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
629
<manvolnum>5</manvolnum></citerefentry>,
630
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
631
<manvolnum>5</manvolnum></citerefentry>,
632
<citerefentry><refentrytitle>mandos-client</refentrytitle>
633
<manvolnum>8mandos</manvolnum></citerefentry>,
634
<citerefentry><refentrytitle>sh</refentrytitle>
635
<manvolnum>1</manvolnum></citerefentry>
added
removed
mandos.xml
