1
1
<?xml version="1.0" encoding="UTF-8"?>
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
<!ENTITY VERSION "1.0">
4
5
<!ENTITY COMMANDNAME "mandos">
5
<!ENTITY TIMESTAMP "2011-10-22">
6
<!ENTITY % common SYSTEM "common.ent">
6
<!ENTITY TIMESTAMP "2008-09-12">
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
<title>Mandos Manual</title>
13
12
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
14
<productnumber>&VERSION;</productnumber>
16
15
<date>&TIMESTAMP;</date>
19
18
<firstname>Björn</firstname>
20
19
<surname>Påhlsson</surname>
22
<email>belorn@recompile.se</email>
21
<email>belorn@fukt.bsnet.se</email>
26
25
<firstname>Teddy</firstname>
27
26
<surname>Hogeborn</surname>
29
<email>teddy@recompile.se</email>
28
<email>teddy@fukt.bsnet.se</email>
38
34
<holder>Teddy Hogeborn</holder>
39
35
<holder>Björn Påhlsson</holder>
87
83
<replaceable>DIRECTORY</replaceable></option></arg>
89
85
<arg><option>--debug</option></arg>
91
<arg><option>--debuglevel
92
<replaceable>LEVEL</replaceable></option></arg>
94
<arg><option>--no-dbus</option></arg>
96
<arg><option>--no-ipv6</option></arg>
98
<arg><option>--no-restore</option></arg>
101
88
<command>&COMMANDNAME;</command>
120
107
<command>&COMMANDNAME;</command> is a server daemon which
121
108
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.
109
client host computers. The Mandos server uses Zeroconf to
110
announce itself on the local network, and uses TLS to
111
communicate securely with and to authenticate the clients. The
112
Mandos server uses IPv6 to allow Mandos clients to use IPv6
113
link-local addresses, since the clients will probably not have
114
any other addresses configured (see <xref linkend="overview"/>).
115
Any authenticated client is then given the stored pre-encrypted
116
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
191
<term><option>--priority <replaceable>
225
192
PRIORITY</replaceable></option></term>
265
<term><option>--no-dbus</option></term>
267
<xi:include href="mandos-options.xml" xpointer="dbus"/>
269
See also <xref linkend="dbus_interface"/>.
275
<term><option>--no-ipv6</option></term>
277
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
282
<term><option>--no-restore</option></term>
284
<xi:include href="mandos-options.xml" xpointer="restore"/>
361
304
The server will, by default, continually check that the clients
362
305
are still up. If a client has not been confirmed as being up
363
306
for some time, the client is assumed to be compromised and is no
364
longer eligible to receive the encrypted password. (Manual
365
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>
307
longer eligible to receive the encrypted password. The timeout,
308
checker program, and interval between checks can be configured
309
both globally and per client; see <citerefentry>
382
310
<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.
311
<manvolnum>5</manvolnum></citerefentry>.
395
315
<refsect1 id="logging">
396
316
<title>LOGGING</title>
398
318
The server will send log message with various severity levels to
399
<filename class="devicefile">/dev/log</filename>. With the
319
<filename>/dev/log</filename>. With the
400
320
<option>--debug</option> option, it will log even more messages,
401
321
and also show them on the console.
405
<refsect1 id="dbus_interface">
406
<title>D-BUS INTERFACE</title>
408
The server will by default provide a D-Bus system bus interface.
409
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>.
415
325
<refsect1 id="exit_status">
416
326
<title>EXIT STATUS</title>
472
382
<term><filename>/var/run/mandos.pid</filename></term>
475
The file containing the process id of the
476
<command>&COMMANDNAME;</command> process started last.
385
The file containing the process id of
386
<command>&COMMANDNAME;</command>.
481
<term><filename class="devicefile">/dev/log</filename></term>
391
<term><filename>/dev/log</filename></term>
484
394
The Unix domain socket to where local syslog messages are
507
417
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"/>.
420
Currently, if a client is declared <quote>invalid</quote> due to
421
having timed out, the server does not record this fact onto
422
permanent storage. This has some security implications, see
423
<xref linkend="CLIENTS"/>.
426
There is currently no way of querying the server of the current
427
status of clients, other than analyzing its <systemitem
428
class="service">syslog</systemitem> output.
515
431
There is no fine-grained control over logging and debug output.
585
504
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
586
505
<manvolnum>5</manvolnum></citerefentry>)
587
506
<emphasis>must</emphasis> be made non-readable by anyone
588
except the user starting the server (usually root).
507
except the user running the server.
591
510
As detailed in <xref linkend="checking"/>, the status of all
596
515
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.
516
by the server which would therefore declare the client
517
invalid. But if the server was ever restarted, it would
518
re-read its client list from its configuration file and again
519
regard all clients therein as valid, and hence eligible to
520
receive their passwords. Therefore, be careful when
521
restarting servers if it is suspected that a client has, in
522
fact, been compromised by parties who may now be running a
523
fake Mandos client with the keys from the non-encrypted
524
initial <acronym>RAM</acronym> image of the client host. What
525
should be done in that case (if restarting the server program
526
really is necessary) is to stop the server program, edit the
527
configuration file to omit any suspect clients, and restart
611
531
For more details on client-side security, see
618
538
<refsect1 id="see_also">
619
539
<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>
542
<refentrytitle>mandos-clients.conf</refentrytitle>
543
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
<refentrytitle>mandos.conf</refentrytitle>
545
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
<refentrytitle>mandos-client</refentrytitle>
547
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
added
removed
mandos.xml
