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-10-22">
5
<!ENTITY TIMESTAMP "2009-09-10">
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
36
<holder>Teddy Hogeborn</holder>
39
37
<holder>Björn Påhlsson</holder>
89
87
<arg><option>--debug</option></arg>
91
<arg><option>--debuglevel
92
<replaceable>LEVEL</replaceable></option></arg>
94
89
<arg><option>--no-dbus</option></arg>
96
91
<arg><option>--no-ipv6</option></arg>
98
<arg><option>--no-restore</option></arg>
101
94
<command>&COMMANDNAME;</command>
120
113
<command>&COMMANDNAME;</command> is a server daemon which
121
114
handles incoming request for passwords for a pre-defined list of
122
client host computers. For an introduction, see
123
<citerefentry><refentrytitle>intro</refentrytitle>
124
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
125
uses Zeroconf to announce itself on the local network, and uses
126
TLS to communicate securely with and to authenticate the
127
clients. The Mandos server uses IPv6 to allow Mandos clients to
128
use IPv6 link-local addresses, since the clients will probably
129
not have any other addresses configured (see <xref
130
linkend="overview"/>). Any authenticated client is then given
131
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.
206
<term><option>--debuglevel
207
<replaceable>LEVEL</replaceable></option></term>
210
Set the debugging log level.
211
<replaceable>LEVEL</replaceable> is a string, one of
212
<quote><literal>CRITICAL</literal></quote>,
213
<quote><literal>ERROR</literal></quote>,
214
<quote><literal>WARNING</literal></quote>,
215
<quote><literal>INFO</literal></quote>, or
216
<quote><literal>DEBUG</literal></quote>, in order of
217
increasing verbosity. The default level is
218
<quote><literal>WARNING</literal></quote>.
224
197
<term><option>--priority <replaceable>
225
198
PRIORITY</replaceable></option></term>
363
329
for some time, the client is assumed to be compromised and is no
364
330
longer eligible to receive the encrypted password. (Manual
365
331
intervention is required to re-enable a client.) The timeout,
366
extended timeout, checker program, and interval between checks
367
can be configured both globally and per client; see
368
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
369
<manvolnum>5</manvolnum></citerefentry>. A client successfully
370
receiving its password will also be treated as a successful
375
<refsect1 id="approval">
376
<title>APPROVAL</title>
378
The server can be configured to require manual approval for a
379
client before it is sent its secret. The delay to wait for such
380
approval and the default action (approve or deny) can be
381
configured both globally and per client; see <citerefentry>
332
checker program, and interval between checks can be configured
333
both globally and per client; see <citerefentry>
382
334
<refentrytitle>mandos-clients.conf</refentrytitle>
383
<manvolnum>5</manvolnum></citerefentry>. By default all clients
384
will be approved immediately without delay.
387
This can be used to deny a client its secret if not manually
388
approved within a specified time. It can also be used to make
389
the server delay before giving a client its secret, allowing
390
optional manual denying of this specific client.
335
<manvolnum>5</manvolnum></citerefentry>.
395
339
<refsect1 id="logging">
396
340
<title>LOGGING</title>
398
342
The server will send log message with various severity levels to
399
<filename class="devicefile">/dev/log</filename>. With the
343
<filename>/dev/log</filename>. With the
400
344
<option>--debug</option> option, it will log even more messages,
401
345
and also show them on the console.
408
352
The server will by default provide a D-Bus system bus interface.
409
353
This interface will only be accessible by the root user or a
410
Mandos-specific user, if such a user exists. For documentation
411
of the D-Bus API, see the file <filename>DBUS-API</filename>.
354
Mandos-specific user, if such a user exists.
472
416
<term><filename>/var/run/mandos.pid</filename></term>
475
The file containing the process id of the
476
<command>&COMMANDNAME;</command> process started last.
419
The file containing the process id of
420
<command>&COMMANDNAME;</command>.
481
<term><filename class="devicefile">/dev/log</filename></term>
425
<term><filename>/dev/log</filename></term>
484
428
The Unix domain socket to where local syslog messages are
507
451
backtrace. This could be considered a feature.
510
Currently, if a client is disabled due to having timed out, the
511
server does not record this fact onto permanent storage. This
512
has some security implications, see <xref linkend="clients"/>.
454
Currently, if a client is declared <quote>invalid</quote> due to
455
having timed out, the server does not record this fact onto
456
permanent storage. This has some security implications, see
457
<xref linkend="clients"/>.
460
There is currently no way of querying the server of the current
461
status of clients, other than analyzing its <systemitem
462
class="service">syslog</systemitem> output.
515
465
There is no fine-grained control over logging and debug output.
596
549
If a client is compromised, its downtime should be duly noted
597
by the server which would therefore disable the client. But
598
if the server was ever restarted, it would re-read its client
599
list from its configuration file and again regard all clients
600
therein as enabled, and hence eligible to receive their
601
passwords. Therefore, be careful when restarting servers if
602
it is suspected that a client has, in fact, been compromised
603
by parties who may now be running a fake Mandos client with
604
the keys from the non-encrypted initial <acronym>RAM</acronym>
605
image of the client host. What should be done in that case
606
(if restarting the server program really is necessary) is to
607
stop the server program, edit the configuration file to omit
608
any suspect clients, and restart the server program.
550
by the server which would therefore declare the client
551
invalid. But if the server was ever restarted, it would
552
re-read its client list from its configuration file and again
553
regard all clients therein as valid, and hence eligible to
554
receive their passwords. Therefore, be careful when
555
restarting servers if it is suspected that a client has, in
556
fact, been compromised by parties who may now be running a
557
fake Mandos client with the keys from the non-encrypted
558
initial <acronym>RAM</acronym> image of the client host. What
559
should be done in that case (if restarting the server program
560
really is necessary) is to stop the server program, edit the
561
configuration file to omit any suspect clients, and restart
611
565
For more details on client-side security, see
618
572
<refsect1 id="see_also">
619
573
<title>SEE ALSO</title>
621
<citerefentry><refentrytitle>intro</refentrytitle>
622
<manvolnum>8mandos</manvolnum></citerefentry>,
623
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
624
<manvolnum>5</manvolnum></citerefentry>,
625
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
626
<manvolnum>5</manvolnum></citerefentry>,
627
<citerefentry><refentrytitle>mandos-client</refentrytitle>
628
<manvolnum>8mandos</manvolnum></citerefentry>,
629
<citerefentry><refentrytitle>sh</refentrytitle>
630
<manvolnum>1</manvolnum></citerefentry>
576
<refentrytitle>mandos-clients.conf</refentrytitle>
577
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
578
<refentrytitle>mandos.conf</refentrytitle>
579
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
580
<refentrytitle>mandos-client</refentrytitle>
581
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
582
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>