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 "2011-11-26">
5
<!ENTITY TIMESTAMP "2009-01-04">
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>
38
35
<holder>Teddy Hogeborn</holder>
39
36
<holder>Björn Påhlsson</holder>
89
86
<arg><option>--debug</option></arg>
91
<arg><option>--debuglevel
92
<replaceable>LEVEL</replaceable></option></arg>
94
88
<arg><option>--no-dbus</option></arg>
96
<arg><option>--no-ipv6</option></arg>
98
<arg><option>--no-restore</option></arg>
100
<arg><option>--statedir
101
<replaceable>DIRECTORY</replaceable></option></arg>
104
91
<command>&COMMANDNAME;</command>
123
110
<command>&COMMANDNAME;</command> is a server daemon which
124
111
handles incoming request for passwords for a pre-defined list of
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.
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.
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>.
227
194
<term><option>--priority <replaceable>
228
195
PRIORITY</replaceable></option></term>
278
<term><option>--no-ipv6</option></term>
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"/>
372
317
The server will, by default, continually check that the clients
373
318
are still up. If a client has not been confirmed as being up
374
319
for some time, the client is assumed to be compromised and is no
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>
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>
393
323
<refentrytitle>mandos-clients.conf</refentrytitle>
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.
324
<manvolnum>5</manvolnum></citerefentry>.
406
328
<refsect1 id="logging">
407
329
<title>LOGGING</title>
409
331
The server will send log message with various severity levels to
410
<filename class="devicefile">/dev/log</filename>. With the
332
<filename>/dev/log</filename>. With the
411
333
<option>--debug</option> option, it will log even more messages,
412
334
and also show them on the console.
419
341
The server will by default provide a D-Bus system bus interface.
420
342
This interface will only be accessible by the root user or a
421
Mandos-specific user, if such a user exists. For documentation
422
of the D-Bus API, see the file <filename>DBUS-API</filename>.
343
Mandos-specific user, if such a user exists.
426
348
<refsect1 id="exit_status">
427
349
<title>EXIT STATUS</title>
483
405
<term><filename>/var/run/mandos.pid</filename></term>
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.
408
The file containing the process id of
409
<command>&COMMANDNAME;</command>.
532
440
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.
535
454
There is no fine-grained control over logging and debug output.
538
457
Debug mode is conflated with running in the foreground.
460
The console log messages does not show a time stamp.
541
463
This server does not check the expire time of clients’ OpenPGP
556
478
<informalexample>
558
480
Run the server in debug mode, read configuration files from
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:
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:
613
535
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
616
554
For more details on client-side security, see
617
555
<citerefentry><refentrytitle>mandos-client</refentrytitle>
618
556
<manvolnum>8mandos</manvolnum></citerefentry>.
623
561
<refsect1 id="see_also">
624
562
<title>SEE ALSO</title>
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>
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>
added
removed
mandos.xml
