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-25">
6
<!ENTITY % common SYSTEM "common.ent">
6
<!ENTITY TIMESTAMP "2008-09-04">
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>
85
83
<replaceable>DIRECTORY</replaceable></option></arg>
87
85
<arg><option>--debug</option></arg>
89
<arg><option>--no-dbus</option></arg>
91
<arg><option>--no-ipv6</option></arg>
94
88
<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"/>
256
233
<refsect1 id="overview">
257
234
<title>OVERVIEW</title>
258
235
<xi:include href="overview.xml"/>
321
298
</tbody></tgroup></table>
324
301
<refsect1 id="checking">
325
302
<title>CHECKING</title>
327
304
The server will, by default, continually check that the clients
328
305
are still up. If a client has not been confirmed as being up
329
306
for some time, the client is assumed to be compromised and is no
330
longer eligible to receive the encrypted password. (Manual
331
intervention is required to re-enable a client.) The timeout,
307
longer eligible to receive the encrypted password. The timeout,
332
308
checker program, and interval between checks can be configured
333
309
both globally and per client; see <citerefentry>
334
310
<refentrytitle>mandos-clients.conf</refentrytitle>
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.
311
<manvolnum>5</manvolnum></citerefentry>.
361
315
<refsect1 id="logging">
362
316
<title>LOGGING</title>
367
321
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>.
381
325
<refsect1 id="exit_status">
382
326
<title>EXIT STATUS</title>
438
<term><filename>/var/run/mandos.pid</filename></term>
382
<term><filename>/var/run/mandos/mandos.pid</filename></term>
441
The file containing the process id of the
442
<command>&COMMANDNAME;</command> process started last.
385
The file containing the process id of
386
<command>&COMMANDNAME;</command>.
473
417
backtrace. This could be considered a feature.
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"/>.
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.
481
431
There is no fine-grained control over logging and debug output.
484
434
Debug mode is conflated with running in the foreground.
487
The console log messages do not show a time stamp.
437
The console log messages does not show a time stamp.
490
440
This server does not check the expire time of clients’ OpenPGP
530
480
</informalexample>
533
483
<refsect1 id="security">
534
484
<title>SECURITY</title>
535
<refsect2 id="server">
485
<refsect2 id="SERVER">
536
486
<title>SERVER</title>
538
488
Running this <command>&COMMANDNAME;</command> server program
539
489
should not in itself present any security risk to the host
540
computer running it. The program switches to a non-root user
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.
544
<refsect2 id="clients">
494
<refsect2 id="CLIENTS">
545
495
<title>CLIENTS</title>
547
497
The server only gives out its stored data to clients which
554
504
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
555
505
<manvolnum>5</manvolnum></citerefentry>)
556
506
<emphasis>must</emphasis> be made non-readable by anyone
557
except the user starting the server (usually root).
507
except the user running the server.
560
510
As detailed in <xref linkend="checking"/>, the status of all
565
515
If a client is compromised, its downtime should be duly noted
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.
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
580
531
For more details on client-side security, see
581
<citerefentry><refentrytitle>mandos-client</refentrytitle>
532
<citerefentry><refentrytitle>password-request</refentrytitle>
582
533
<manvolnum>8mandos</manvolnum></citerefentry>.
587
538
<refsect1 id="see_also">
588
539
<title>SEE ALSO</title>
592
543
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
593
544
<refentrytitle>mandos.conf</refentrytitle>
594
545
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
595
<refentrytitle>mandos-client</refentrytitle>
546
<refentrytitle>password-request</refentrytitle>
596
547
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
597
548
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
added
removed
mandos.xml
