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">
5
4
<!ENTITY COMMANDNAME "mandos">
6
<!ENTITY TIMESTAMP "2008-09-04">
5
<!ENTITY TIMESTAMP "2010-09-26">
6
<!ENTITY % common SYSTEM "common.ent">
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
<title>Mandos Manual</title>
12
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
<productname>Mandos</productname>
14
<productnumber>&VERSION;</productnumber>
15
<productnumber>&version;</productnumber>
15
16
<date>&TIMESTAMP;</date>
83
86
<replaceable>DIRECTORY</replaceable></option></arg>
85
88
<arg><option>--debug</option></arg>
90
<arg><option>--no-dbus</option></arg>
92
<arg><option>--no-ipv6</option></arg>
88
95
<command>&COMMANDNAME;</command>
239
<term><option>--no-dbus</option></term>
241
<xi:include href="mandos-options.xml" xpointer="dbus"/>
243
See also <xref linkend="dbus_interface"/>.
249
<term><option>--no-ipv6</option></term>
251
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
233
257
<refsect1 id="overview">
234
258
<title>OVERVIEW</title>
235
259
<xi:include href="overview.xml"/>
298
322
</tbody></tgroup></table>
301
325
<refsect1 id="checking">
302
326
<title>CHECKING</title>
304
328
The server will, by default, continually check that the clients
305
329
are still up. If a client has not been confirmed as being up
306
330
for some time, the client is assumed to be compromised and is no
307
longer eligible to receive the encrypted password. The timeout,
331
longer eligible to receive the encrypted password. (Manual
332
intervention is required to re-enable a client.) The timeout,
308
333
checker program, and interval between checks can be configured
309
334
both globally and per client; see <citerefentry>
310
335
<refentrytitle>mandos-clients.conf</refentrytitle>
311
<manvolnum>5</manvolnum></citerefentry>.
336
<manvolnum>5</manvolnum></citerefentry>. A client successfully
337
receiving its password will also be treated as a successful
342
<refsect1 id="approval">
343
<title>APPROVAL</title>
345
The server can be configured to require manual approval for a
346
client before it is sent its secret. The delay to wait for such
347
approval and the default action (approve or deny) can be
348
configured both globally and per client; see <citerefentry>
349
<refentrytitle>mandos-clients.conf</refentrytitle>
350
<manvolnum>5</manvolnum></citerefentry>. By default all clients
351
will be approved immediately without delay.
354
This can be used to deny a client its secret if not manually
355
approved within a specified time. It can also be used to make
356
the server delay before giving a client its secret, allowing
357
optional manual denying of this specific client.
315
362
<refsect1 id="logging">
316
363
<title>LOGGING</title>
321
368
and also show them on the console.
372
<refsect1 id="dbus_interface">
373
<title>D-BUS INTERFACE</title>
375
The server will by default provide a D-Bus system bus interface.
376
This interface will only be accessible by the root user or a
377
Mandos-specific user, if such a user exists. For documentation
378
of the D-Bus API, see the file <filename>DBUS-API</filename>.
325
382
<refsect1 id="exit_status">
326
383
<title>EXIT STATUS</title>
382
<term><filename>/var/run/mandos/mandos.pid</filename></term>
439
<term><filename>/var/run/mandos.pid</filename></term>
385
The file containing the process id of
386
<command>&COMMANDNAME;</command>.
442
The file containing the process id of the
443
<command>&COMMANDNAME;</command> process started last.
417
474
backtrace. This could be considered a feature.
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.
477
Currently, if a client is disabled due to having timed out, the
478
server does not record this fact onto permanent storage. This
479
has some security implications, see <xref linkend="clients"/>.
431
482
There is no fine-grained control over logging and debug output.
434
485
Debug mode is conflated with running in the foreground.
437
The console log messages does not show a time stamp.
488
The console log messages do not show a time stamp.
440
491
This server does not check the expire time of clients’ OpenPGP
480
531
</informalexample>
483
534
<refsect1 id="security">
484
535
<title>SECURITY</title>
485
<refsect2 id="SERVER">
536
<refsect2 id="server">
486
537
<title>SERVER</title>
488
539
Running this <command>&COMMANDNAME;</command> server program
489
540
should not in itself present any security risk to the host
490
computer running it. The program does not need any special
491
privileges to run, and is designed to run as a non-root user.
541
computer running it. The program switches to a non-root user
494
<refsect2 id="CLIENTS">
545
<refsect2 id="clients">
495
546
<title>CLIENTS</title>
497
548
The server only gives out its stored data to clients which
504
555
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
556
<manvolnum>5</manvolnum></citerefentry>)
506
557
<emphasis>must</emphasis> be made non-readable by anyone
507
except the user running the server.
558
except the user starting the server (usually root).
510
561
As detailed in <xref linkend="checking"/>, the status of all
515
566
If a client is compromised, its downtime should be duly noted
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
567
by the server which would therefore disable the client. But
568
if the server was ever restarted, it would re-read its client
569
list from its configuration file and again regard all clients
570
therein as enabled, and hence eligible to receive their
571
passwords. Therefore, be careful when restarting servers if
572
it is suspected that a client has, in fact, been compromised
573
by parties who may now be running a fake Mandos client with
574
the keys from the non-encrypted initial <acronym>RAM</acronym>
575
image of the client host. What should be done in that case
576
(if restarting the server program really is necessary) is to
577
stop the server program, edit the configuration file to omit
578
any suspect clients, and restart the server program.
531
581
For more details on client-side security, see
532
<citerefentry><refentrytitle>password-request</refentrytitle>
582
<citerefentry><refentrytitle>mandos-client</refentrytitle>
533
583
<manvolnum>8mandos</manvolnum></citerefentry>.
538
588
<refsect1 id="see_also">
539
589
<title>SEE ALSO</title>
543
593
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
594
<refentrytitle>mandos.conf</refentrytitle>
545
595
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
<refentrytitle>password-request</refentrytitle>
596
<refentrytitle>mandos-client</refentrytitle>
547
597
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
598
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
added
removed
mandos.xml
