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-11">
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>
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
311
<manvolnum>5</manvolnum></citerefentry>.
341
315
<refsect1 id="logging">
342
316
<title>LOGGING</title>
347
321
and also show them on the console.
351
<refsect1 id="dbus_interface">
352
<title>D-BUS INTERFACE</title>
354
The server will by default provide a D-Bus system bus interface.
355
This interface will only be accessible by the root user or a
356
Mandos-specific user, if such a user exists. For documentation
357
of the D-Bus API, see the file <filename>DBUS-API</filename>.
361
325
<refsect1 id="exit_status">
362
326
<title>EXIT STATUS</title>
453
417
backtrace. This could be considered a feature.
456
Currently, if a client is disabled due to having timed out, the
457
server does not record this fact onto permanent storage. This
458
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.
461
431
There is no fine-grained control over logging and debug output.
464
434
Debug mode is conflated with running in the foreground.
467
The console log messages do not show a time stamp.
470
This server does not check the expire time of clients’ OpenPGP
437
The console log messages does not show a timestamp.
510
476
</informalexample>
513
479
<refsect1 id="security">
514
480
<title>SECURITY</title>
515
<refsect2 id="server">
481
<refsect2 id="SERVER">
516
482
<title>SERVER</title>
518
484
Running this <command>&COMMANDNAME;</command> server program
519
485
should not in itself present any security risk to the host
520
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.
524
<refsect2 id="clients">
490
<refsect2 id="CLIENTS">
525
491
<title>CLIENTS</title>
527
493
The server only gives out its stored data to clients which
534
500
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
535
501
<manvolnum>5</manvolnum></citerefentry>)
536
502
<emphasis>must</emphasis> be made non-readable by anyone
537
except the user starting the server (usually root).
503
except the user running the server.
540
506
As detailed in <xref linkend="checking"/>, the status of all
545
511
If a client is compromised, its downtime should be duly noted
546
by the server which would therefore disable the client. But
547
if the server was ever restarted, it would re-read its client
548
list from its configuration file and again regard all clients
549
therein as enabled, and hence eligible to receive their
550
passwords. Therefore, be careful when restarting servers if
551
it is suspected that a client has, in fact, been compromised
552
by parties who may now be running a fake Mandos client with
553
the keys from the non-encrypted initial <acronym>RAM</acronym>
554
image of the client host. What should be done in that case
555
(if restarting the server program really is necessary) is to
556
stop the server program, edit the configuration file to omit
557
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
560
527
For more details on client-side security, see
561
<citerefentry><refentrytitle>mandos-client</refentrytitle>
528
<citerefentry><refentrytitle>password-request</refentrytitle>
562
529
<manvolnum>8mandos</manvolnum></citerefentry>.
567
534
<refsect1 id="see_also">
568
535
<title>SEE ALSO</title>
572
539
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
573
540
<refentrytitle>mandos.conf</refentrytitle>
574
541
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
575
<refentrytitle>mandos-client</refentrytitle>
542
<refentrytitle>password-request</refentrytitle>
576
543
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
577
544
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
added
removed
mandos.xml
