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 "2010-09-26">
6
<!ENTITY % common SYSTEM "common.ent">
6
<!ENTITY TIMESTAMP "2008-09-02">
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>
86
83
<replaceable>DIRECTORY</replaceable></option></arg>
88
85
<arg><option>--debug</option></arg>
90
<arg><option>--no-dbus</option></arg>
92
<arg><option>--no-ipv6</option></arg>
95
88
<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"/>
257
233
<refsect1 id="overview">
258
234
<title>OVERVIEW</title>
259
235
<xi:include href="overview.xml"/>
322
298
</tbody></tgroup></table>
325
301
<refsect1 id="checking">
326
302
<title>CHECKING</title>
328
304
The server will, by default, continually check that the clients
329
305
are still up. If a client has not been confirmed as being up
330
306
for some time, the client is assumed to be compromised and is no
331
longer eligible to receive the encrypted password. (Manual
332
intervention is required to re-enable a client.) The timeout,
307
longer eligible to receive the encrypted password. The timeout,
333
308
checker program, and interval between checks can be configured
334
309
both globally and per client; see <citerefentry>
335
310
<refentrytitle>mandos-clients.conf</refentrytitle>
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.
311
<manvolnum>5</manvolnum></citerefentry>.
362
315
<refsect1 id="logging">
363
316
<title>LOGGING</title>
368
321
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>.
382
325
<refsect1 id="exit_status">
383
326
<title>EXIT STATUS</title>
439
<term><filename>/var/run/mandos.pid</filename></term>
382
<term><filename>/var/run/mandos/mandos.pid</filename></term>
442
The file containing the process id of the
443
<command>&COMMANDNAME;</command> process started last.
385
The file containing the process id of
386
<command>&COMMANDNAME;</command>.
474
417
backtrace. This could be considered a feature.
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"/>.
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.
482
431
There is no fine-grained control over logging and debug output.
485
434
Debug mode is conflated with running in the foreground.
488
The console log messages do not show a time stamp.
491
This server does not check the expire time of clients’ OpenPGP
437
The console log messages does not show a timestamp.
531
476
</informalexample>
534
479
<refsect1 id="security">
535
480
<title>SECURITY</title>
536
<refsect2 id="server">
481
<refsect2 id="SERVER">
537
482
<title>SERVER</title>
539
484
Running this <command>&COMMANDNAME;</command> server program
540
485
should not in itself present any security risk to the host
541
computer running it. The program switches to a non-root user
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.
545
<refsect2 id="clients">
490
<refsect2 id="CLIENTS">
546
491
<title>CLIENTS</title>
548
493
The server only gives out its stored data to clients which
555
500
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
556
501
<manvolnum>5</manvolnum></citerefentry>)
557
502
<emphasis>must</emphasis> be made non-readable by anyone
558
except the user starting the server (usually root).
503
except the user running the server.
561
506
As detailed in <xref linkend="checking"/>, the status of all
566
511
If a client is compromised, its downtime should be duly noted
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.
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
581
527
For more details on client-side security, see
582
<citerefentry><refentrytitle>mandos-client</refentrytitle>
528
<citerefentry><refentrytitle>password-request</refentrytitle>
583
529
<manvolnum>8mandos</manvolnum></citerefentry>.
588
534
<refsect1 id="see_also">
589
535
<title>SEE ALSO</title>
593
539
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
594
540
<refentrytitle>mandos.conf</refentrytitle>
595
541
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
596
<refentrytitle>mandos-client</refentrytitle>
542
<refentrytitle>password-request</refentrytitle>
597
543
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
598
544
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
added
removed
mandos.xml
