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-02">
5
<!ENTITY TIMESTAMP "2010-09-25">
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
85
<replaceable>DIRECTORY</replaceable></option></arg>
85
87
<arg><option>--debug</option></arg>
89
<arg><option>--no-dbus</option></arg>
91
<arg><option>--no-ipv6</option></arg>
88
94
<command>&COMMANDNAME;</command>
238
<term><option>--no-dbus</option></term>
240
<xi:include href="mandos-options.xml" xpointer="dbus"/>
242
See also <xref linkend="dbus_interface"/>.
248
<term><option>--no-ipv6</option></term>
250
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
233
256
<refsect1 id="overview">
234
257
<title>OVERVIEW</title>
235
258
<xi:include href="overview.xml"/>
298
321
</tbody></tgroup></table>
301
324
<refsect1 id="checking">
302
325
<title>CHECKING</title>
304
327
The server will, by default, continually check that the clients
305
328
are still up. If a client has not been confirmed as being up
306
329
for some time, the client is assumed to be compromised and is no
307
longer eligible to receive the encrypted password. The timeout,
330
longer eligible to receive the encrypted password. (Manual
331
intervention is required to re-enable a client.) The timeout,
308
332
checker program, and interval between checks can be configured
309
333
both globally and per client; see <citerefentry>
310
334
<refentrytitle>mandos-clients.conf</refentrytitle>
311
<manvolnum>5</manvolnum></citerefentry>.
335
<manvolnum>5</manvolnum></citerefentry>. A client successfully
336
receiving its password will also be treated as a successful
341
<refsect1 id="approval">
342
<title>APPROVAL</title>
344
The server can be configured to require manual approval for a
345
client before it is sent its secret. The delay to wait for such
346
approval and the default action (approve or deny) can be
347
configured both globally and per client; see <citerefentry>
348
<refentrytitle>mandos-clients.conf</refentrytitle>
349
<manvolnum>5</manvolnum></citerefentry>. By default all clients
350
will be approved immediately without delay.
353
This can be used to deny a client its secret if not manually
354
approved within a specified time. It can also be used to make
355
the server delay before giving a client its secret, allowing
356
optional manual denying of this specific client.
315
361
<refsect1 id="logging">
316
362
<title>LOGGING</title>
321
367
and also show them on the console.
371
<refsect1 id="dbus_interface">
372
<title>D-BUS INTERFACE</title>
374
The server will by default provide a D-Bus system bus interface.
375
This interface will only be accessible by the root user or a
376
Mandos-specific user, if such a user exists. For documentation
377
of the D-Bus API, see the file <filename>DBUS-API</filename>.
325
381
<refsect1 id="exit_status">
326
382
<title>EXIT STATUS</title>
382
<term><filename>/var/run/mandos/mandos.pid</filename></term>
438
<term><filename>/var/run/mandos.pid</filename></term>
385
The file containing the process id of
386
<command>&COMMANDNAME;</command>.
441
The file containing the process id of the
442
<command>&COMMANDNAME;</command> process started last.
417
473
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.
476
Currently, if a client is disabled due to having timed out, the
477
server does not record this fact onto permanent storage. This
478
has some security implications, see <xref linkend="clients"/>.
431
481
There is no fine-grained control over logging and debug output.
434
484
Debug mode is conflated with running in the foreground.
437
The console log messages does not show a timestamp.
487
The console log messages do not show a time stamp.
490
This server does not check the expire time of clients’ OpenPGP
476
530
</informalexample>
479
533
<refsect1 id="security">
480
534
<title>SECURITY</title>
481
<refsect2 id="SERVER">
535
<refsect2 id="server">
482
536
<title>SERVER</title>
484
538
Running this <command>&COMMANDNAME;</command> server program
485
539
should not in itself present any security risk to the host
486
computer running it. The program does not need any special
487
privileges to run, and is designed to run as a non-root user.
540
computer running it. The program switches to a non-root user
490
<refsect2 id="CLIENTS">
544
<refsect2 id="clients">
491
545
<title>CLIENTS</title>
493
547
The server only gives out its stored data to clients which
500
554
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
501
555
<manvolnum>5</manvolnum></citerefentry>)
502
556
<emphasis>must</emphasis> be made non-readable by anyone
503
except the user running the server.
557
except the user starting the server (usually root).
506
560
As detailed in <xref linkend="checking"/>, the status of all
511
565
If a client is compromised, its downtime should be duly noted
512
by the server which would therefore declare the client
513
invalid. But if the server was ever restarted, it would
514
re-read its client list from its configuration file and again
515
regard all clients therein as valid, and hence eligible to
516
receive their passwords. Therefore, be careful when
517
restarting servers if it is suspected that a client has, in
518
fact, been compromised by parties who may now be running a
519
fake Mandos client with the keys from the non-encrypted
520
initial <acronym>RAM</acronym> image of the client host. What
521
should be done in that case (if restarting the server program
522
really is necessary) is to stop the server program, edit the
523
configuration file to omit any suspect clients, and restart
566
by the server which would therefore disable the client. But
567
if the server was ever restarted, it would re-read its client
568
list from its configuration file and again regard all clients
569
therein as enabled, and hence eligible to receive their
570
passwords. Therefore, be careful when restarting servers if
571
it is suspected that a client has, in fact, been compromised
572
by parties who may now be running a fake Mandos client with
573
the keys from the non-encrypted initial <acronym>RAM</acronym>
574
image of the client host. What should be done in that case
575
(if restarting the server program really is necessary) is to
576
stop the server program, edit the configuration file to omit
577
any suspect clients, and restart the server program.
527
580
For more details on client-side security, see
528
<citerefentry><refentrytitle>password-request</refentrytitle>
581
<citerefentry><refentrytitle>mandos-client</refentrytitle>
529
582
<manvolnum>8mandos</manvolnum></citerefentry>.
534
587
<refsect1 id="see_also">
535
588
<title>SEE ALSO</title>
539
592
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
540
593
<refentrytitle>mandos.conf</refentrytitle>
541
594
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
542
<refentrytitle>password-request</refentrytitle>
595
<refentrytitle>mandos-client</refentrytitle>
543
596
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
544
597
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
added
removed
mandos.xml
